v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Gift Cards

Getcustomertransactions

Get All Customer Transactions

Returns paginated transaction history across all gift cards belonging to the customer.

get/v2/giftcards/customer/transactions

Query parameters

programIdstring
Example:5eb7cf5a86d9755df3a6c593
cardIdstring
Example:5eb7cf5a86d9755df3a6c593
qstring nullable
pageinteger
limitinteger
offsetinteger nullable

Headers

X-Eposn-Customer-Tokenstring nullable
X-Eposn-Merchant-Tokenstring nullable

Response

Successful Response

idstring required
transactionType'PURCHASE' | 'ACTIVATION' | 'RELOAD' | 'REDEMPTION' | 'CONSOLIDATION' | 'VOID' | 'TRANSFER_OUT' | 'TRANSFER_IN' | 'OWNERSHIP_TRANSFER' | 'RESEND_CODE' | 'REFUND' required

Gift card transaction type enumeration.

amountstring required
balanceBeforestring required
balanceAfterstring required
referenceIdstring nullable required
descriptionstring nullable required
createdAtstring date-time required
processedAtstring date-time required
merchantIdstring required
posTransactionIdstring nullable required
cashierIdstring nullable required
terminalIdstring nullable required

Example response

[
  {
    "id": "5eb7cf5a86d9755df3a6c593",
    "merchantId": "5eb7cf5a86d9755df3a6c593"
  }
]