v34

latestOpenAPI 3.0.1raw.githubusercontent.com2026-01-20203250.6 KB
Transactions

Search transactions by query params. Same endpoint can be used to download CSV (with Accept header="text/csv"). Refer to code for details

get/v1/transaction

Query parameters

status_versioninteger

Set to '2' to return failed transaction states FAILED_REJECTED/FAILED_EXPIRED/FAILED_CANCELLED mapped to declined/timedout/cancelled external status respectively.Otherwise these transaction states will all be mapped to failed status

exact_reference_matchboolean

Set to 'true' to search for transactions by exact reference. Otherwise reference is partially matched

emailstring
referencestring
cardholder_namestring
last_digits_card_numberstring
first_digits_card_numberstring
notEmptyboolean
parametersstring[]
rawStringstring

Comma delimited payment states.

statestring
notEmptyboolean
parametersstring[]
rawStringstring

Comma delimited refund states.

notEmptyboolean
parametersstring[]
rawStringstring

Comma delimited card brands.

from_datestring

From date of transactions to be searched (this date is inclusive).

to_datestring

To date of transactions to be searched (this date is inclusive).

transaction_type'PAYMENT' | 'REFUND' | 'DISPUTE'
gateway_payout_idstring
from_settled_datestring

From date of transactions settled date to be searched (this date is inclusive).

to_settled_datestring

To date of transactions settled date to be searched (this date is inclusive).

metadata_valuestring
agreement_idstring
pageinteger
display_sizeinteger
limit_totalboolean

Set to 'true' to limit the search counting the total number of transactions to 'limit_total_size' param

limit_total_sizeinteger
gateway_transaction_idstring
notEmptyboolean
parametersstring[]
rawStringstring

Comma delimited dispute states.

override_account_id_restrictionboolean

Set to true to list transactions for all accounts.

account_idstring

Comma delimited gateway account IDs. Required except when override_account_id_restriction=true

Response

OK

countinteger
pageinteger
totalinteger