SettlementListResponse

successbooleanrequired

data object

Response payload for successful operations.

items object[]required

Array [

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 1

Example: USD

Example 2

Example: EUR

Example 3

Example: GBP

openedAtstring<date-time>required

closedAtstring<date-time>nullable

settledAtstring<date-time>nullable

]

pagination objectrequired

limitintegerrequired

Possible values: >= 1

offsetintegerrequired

Possible values: >= 0

totalintegerrequired

Possible values: >= 0

hasMorebooleanrequired

errorstring

Machine-readable error code.

messagestring

Human-readable response message.

SettlementListResponse

{
  "success": true,
  "data": {
    "items": [
      {
        "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"
      }
    ],
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0,
      "hasMore": true
    }
  },
  "error": "string",
  "message": "string"
}