Transaction

idstring<uuid>required

typeTransactionTyperequired

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

statusTransactionStatusrequired

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

transactionChannelstringnullable

Trusted originating checkout surface; null or absent for legacy and non-attributed transactions.

Possible values: [VIRTUAL_TERMINAL, ONLINE_CHECKOUT, PAYMENT_LINK]

totalAmountintegerrequired

Total amount in cents (amount + tipAmount).

Possible values: >= 0

currencyCurrencyCoderequired

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

Examples:

Example 1
Example 2
Example 3

Example: USD

Example: EUR

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

metadata objectrequired

property name*string

createdAtstring<date-time>required

updatedAtstring<date-time>required

Transaction
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "SALE",
  "status": "APPROVED",
  "amount": 0,
  "tipAmount": 0,
  "transactionChannel": "VIRTUAL_TERMINAL",
  "totalAmount": 0,
  "currency": "USD",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "approvalCode": "string",
  "cardBrand": "VISA",
  "lastFour": "string",
  "cardholderName": "string",
  "deviceId": "string",
  "metadata": {},
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}