Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Transactions

Get Transactions List

Retrieves a list of transactions for the specified account, with optional filters for date range, transaction type, status, and purse. Supports inclusion of all authorizations. Returns transaction details and metadata.

get/programs/{programCode}/accounts/{accountIdentifier}/transactions

Path parameters

programCodestring required

The program code associated with the account.

accountIdentifierstring required

The unique identifier (UID or GUID) of the account whose transactions are being retrieved.

Query parameters

startDatestring

The start date (inclusive) for filtering transactions, in ISO 8601 format (yyyy-MM-dd). Optional.

endDatestring

The end date (inclusive) for filtering transactions, in ISO 8601 format (yyyy-MM-dd). Optional.

offsetinteger

The zero-based index of the first transaction to return. Used for pagination. Optional.

limitinteger

The maximum number of transactions to return in the response. Optional.

transactionTypestring

The type of transaction to filter by (e.g., "purchase", "deposit"). Optional.

transactionStatusstring

The status of the transaction to filter by (e.g., "posted", "refund"). Optional.

purseIdentifierstring

The unique identifier of the purse to filter transactions. Optional.

includeAllAuthorizationsboolean

If true, includes all authorization transactions in the response. Optional.

Headers

X-GD-RequestIdstring required

A unique identifier for tracking the request, provided in the X-GD-RequestId header.

Response

OK

totalRecordCountinteger

The total number of transaction records matching the query.