SettlementDetailResponse

successbooleanrequired

data object

Response payload for successful operations.

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

transactions object[]required

Array [

idstring<uuid>required

typeTransactionType (string)required

Possible values: [SALE, AUTH, CAPTURE, VOID, REFUND]

statusTransactionStatus (string)required

Possible values: [APPROVED, DECLINED, PENDING, VOIDED, REFUNDED, SETTLED]

amountintegerrequired

Base transaction amount in cents.

Possible values: >= 1

tipAmountintegerrequired

Tip amount in cents.

Possible values: >= 0

totalAmountintegerrequired

Total amount in cents (amount + tipAmount).

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

merchantIdstring<uuid>required

referencestringrequired

Possible values: <= 64 characters

approvalCodestringnullable

Possible values: <= 12 characters

cardBrandstringnullable

Possible values: [VISA, MASTERCARD, AMEX, DISCOVER, INTERAC, OTHER]

lastFourstringnullable

Possible values: Value must match regular expression ^[0-9]{4}$

cardholderNamestringnullable

deviceIdstringnullable

Possible values: <= 64 characters

createdAtstring<date-time>required

updatedAtstring<date-time>required

]

errorstring

Machine-readable error code.

messagestring

Human-readable response message.

SettlementDetailResponse

{
  "success": true,
  "data": {
    "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",
    "transactions": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "SALE",
        "status": "APPROVED",
        "amount": 0,
        "tipAmount": 0,
        "totalAmount": 0,
        "currency": "USD",
        "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "reference": "string",
        "approvalCode": "string",
        "cardBrand": "VISA",
        "lastFour": "string",
        "cardholderName": "string",
        "deviceId": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z"
      }
    ]
  },
  "error": "string",
  "message": "string"
}