Skip to main content

TransactionListResponse

successbooleanrequired
data object

Response payload for successful operations.

items 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: USD
    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
  • ]
    • 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.

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