Skip to main content
PATCH
/
v1
/
reconciliation-rules
/
{ruleId}
Update a reconciliation rule
curl --request PATCH \
  --url http://localhost:3001/v1/reconciliation-rules/{ruleId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "isActive": true,
  "amountTolerance": "<string>",
  "timeWindowMinutes": 4503599627370495,
  "expectedCompletionMinutes": 4503599627370495,
  "delayedSettlementThresholdMinutes": 4503599627370495,
  "sourceSlaMinutes": 4503599627370495,
  "intermediaryInSlaMinutes": 4503599627370495,
  "transferSlaMinutes": 4503599627370495,
  "intermediaryOutSlaMinutes": 4503599627370495,
  "destinationSlaMinutes": 4503599627370495,
  "allowProviderIdMatch": true,
  "allowTxHashMatch": true,
  "allowReferenceExactMatch": true,
  "allowAmountAndTimeWindowMatch": true,
  "requireAllRequiredLegs": true,
  "metadata": {}
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "paymentType": "<string>",
  "sourceType": "<string>",
  "isActive": true,
  "amountTolerance": "<string>",
  "timeWindowMinutes": 123,
  "expectedCompletionMinutes": 123,
  "delayedSettlementThresholdMinutes": 123,
  "sourceSlaMinutes": 123,
  "intermediaryInSlaMinutes": 123,
  "transferSlaMinutes": 123,
  "intermediaryOutSlaMinutes": 123,
  "destinationSlaMinutes": 123,
  "allowProviderIdMatch": true,
  "allowTxHashMatch": true,
  "allowReferenceExactMatch": true,
  "allowAmountAndTimeWindowMatch": true,
  "requireAllRequiredLegs": true,
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Headers

authorization
string
Minimum string length: 1
x-organization-id
string
Minimum string length: 1

Path Parameters

ruleId
string
required
Minimum string length: 1

Body

application/json
name
string
Minimum string length: 1
paymentType
enum<string>
Available options:
stablecoin,
bank,
cross_border,
other
sourceType
enum<string>
Available options:
client_transfer_report,
client_internal_ledger,
bank_statement,
onchain_report,
psp_report,
manual
isActive
boolean
amountTolerance
string
Pattern: ^-?\d+(\.\d+)?$
timeWindowMinutes
integer | null
Required range: 0 <= x <= 9007199254740991
expectedCompletionMinutes
integer | null
Required range: 0 <= x <= 9007199254740991
delayedSettlementThresholdMinutes
integer | null
Required range: 0 <= x <= 9007199254740991
sourceSlaMinutes
integer | null
Required range: 0 <= x <= 9007199254740991
intermediaryInSlaMinutes
integer | null
Required range: 0 <= x <= 9007199254740991
transferSlaMinutes
integer | null
Required range: 0 <= x <= 9007199254740991
intermediaryOutSlaMinutes
integer | null
Required range: 0 <= x <= 9007199254740991
destinationSlaMinutes
integer | null
Required range: 0 <= x <= 9007199254740991
allowProviderIdMatch
boolean
allowTxHashMatch
boolean
allowReferenceExactMatch
boolean
allowAmountAndTimeWindowMatch
boolean
requireAllRequiredLegs
boolean
metadata
object

Response

Default Response

id
string
required
organizationId
string
required
name
string
required
paymentType
null | string
required
sourceType
null | string
required
isActive
boolean
required
amountTolerance
null | string
required
timeWindowMinutes
null | integer
required
expectedCompletionMinutes
null | integer
required
delayedSettlementThresholdMinutes
null | integer
required
sourceSlaMinutes
null | integer
required
intermediaryInSlaMinutes
null | integer
required
transferSlaMinutes
null | integer
required
intermediaryOutSlaMinutes
null | integer
required
destinationSlaMinutes
null | integer
required
allowProviderIdMatch
boolean
required
allowTxHashMatch
boolean
required
allowReferenceExactMatch
boolean
required
allowAmountAndTimeWindowMatch
boolean
required
requireAllRequiredLegs
boolean
required
metadata
object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required