Skip to main content

Settlement

batchIdstring<uuid>required
merchantIdstring<uuid>required
statusSettlementStatus (string)required

Possible values: [OPEN, CLOSED, SETTLED, FAILED]

transactionCountintegerrequired

Possible values: >= 0

totalAmountintegerrequired

Possible values: >= 0

currencyCurrencyCode (string)required

Possible values: Value must match regular expression ^[A-Z]{3}$

Examples:
Example: USD
openedAtstring<date-time>required
closedAtstring<date-time>nullable
settledAtstring<date-time>nullable
Settlement
{
  "batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "OPEN",
  "transactionCount": 0,
  "totalAmount": 0,
  "currency": "USD",
  "openedAt": "2024-07-29T15:51:28.071Z",
  "closedAt": "2024-07-29T15:51:28.071Z",
  "settledAt": "2024-07-29T15:51:28.071Z"
}