Retrieving Transactions
Learn about retrieving transactions.
Overview
Whenever you submit a payment request, whether it's for card payments, recurring payments, faster payments, Pay by Bank, or Apple Pay/Google Pay, you receive a transaction_id
. This ID allows you to access all transaction details via our transactions endpoint. Depending on the transaction type, various parameters are returned. For a comprehensive overview of these parameters, please refer to our documentation here.
We offer two transactions endpoints:
/transactions/{transaction_id}
/transactions/{transaction_id}
This endpoint offers the capability to refine a transaction query based on its transaction_id
.
Additionally, you have the flexibility to filter the parameters returned in the response for a specific transaction. You can filter by any parameters available in the response.
Example:
In this example we are filtering the response of an individual transaction to just include status
and reason
.
GET /transactions/{transaction_id}?filter=status,reason
{
"status": "declined",
"reason": "closed_account"
}
In the next example we are filtering the request to return more parameters in the response.
GET /transactions/{transaction_id}?filter=status,reason,mid,payment_product,payment_method,transaction_type
{
"status": "success",
"reason": "",
"mid": "a36c8fdb-bec8-c121-ac30-9cc41878f3d7",
"payment_product": "card",
"payment_method": "authorisation",
"transaction_type": "payment_in"
}
/transactions
/transactions
This endpoint facilitates the retrieval of all transactions, with the added capability to refine results using various parameters such as start_date
, end_date
, order_id
, status
, currency
, reason
, payment_method
, transaction_type
, and recurring_type
. It offers the flexibility to filter transactions based on specific criteria, rather than solely relying on the transaction_id
.
For example, the following request would provide detailed information on a transaction filtered by the order_id
:
GET /transactions?order_id=9d69ba7b-d00c-44d9-87ca-1224a4d4d94d
Updated 8 months ago