List transactions
Get a paginated transaction list with filtering
Retrieves a paginated list of your payment transactions.
Authorizations
Query parameters
searchstringOptional
Search parameter to use while filtering the list
pageinteger · int32Optional
The target page to retrieve if available. Minimum value is 1.
page_sizeinteger · int32Optional
Required page size. Acceptable range is from 1 to 100.
order_bystringOptional
filter.idstringOptional
Id of the transaction to retrieve
filter.tx_refstringOptional
The transaction reference to find
filter.currencystringOptional
Transaction currency to filter with
filter.amountnumber · doubleOptional
filter.minimum_amountnumber · doubleOptional
filter.maximum_amountnumber · doubleOptional
filter.bearerstring · enumOptionalPossible values:
filter.gateway_codestringOptional
The gateway codes used to complete payment
filter.sale_idstringOptional
Id of the sale that was made using the transaction
filter.invoice_idstringOptional
Id of the invoice that was raised for the transaction
filter.dedicated_virtual_account_referencestringOptional
Reference of the Dedicated Virtual Account the payment was made to
filter.is_dedicated_virtual_account_transactionbooleanOptional
Flag to only retrieve transactions made via dedicated virtual accounts
filter.customer_idstringOptional
Id of the customer used for filtering
filter.customer_emailstringOptional
The email of the customer used for filtering
statusstring · enumOptionalPossible values:
start_datestring · date-timeOptional
end_datestring · date-timeOptional
Responses
200
Returns 200 and a paged response containing the transactions
application/json
400
Returns 400 if the query is invalid
401
Returns 401 when authorization details is invalid
get
GET /v1/transactions HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"status": "success",
"message": "text",
"data": {
"id": "text",
"is_live": true,
"gateway_code": "text",
"tx_ref": "text",
"dedicated_virtual_account_reference": "text",
"currency": "text",
"amount": 1,
"charged_amount": 1,
"amount_settled": 1,
"app_fee": 1,
"merchant_fee": 1,
"bearer": "customer",
"status": "successful",
"metadata": "text",
"redirect_url": "text",
"payment_type": "text",
"is_direct_card_charge": true,
"is_virtual_account_checkout": true,
"is_dedicated_virtual_account_checkout": true,
"device_fingerprint": "text",
"ip": "text",
"narration": "text",
"processor_response": "text",
"auth_model": "text",
"card_pan": "text",
"card_issuer": "text",
"card_country": "text",
"card_type": "text",
"card_expiry": "text",
"bank_trsf_country": "text",
"bank_trsf_bank_code": "text",
"bank_trsf_bank_name": "text",
"bank_trsf_account_number": "text",
"bank_trsf_account_name": "text",
"bank_trsf_swift": "text",
"bank_trsf_iban": "text",
"bank_trsf_session_id": "text",
"title": "text",
"logo_url": "text",
"description": "text",
"customer": {
"id": "text",
"full_name": "text",
"email": "text",
"phone_number": "text",
"address": "text",
"status": "active",
"created_at": "2025-07-07T04:07:48.081Z",
"edited_at": "2025-07-07T04:07:48.081Z"
},
"paid_at": "2025-07-07T04:07:48.081Z",
"created_at": "2025-07-07T04:07:48.081Z",
"edited_at": "2025-07-07T04:07:48.081Z"
},
"meta": {
"page_meta": {
"page_count": 1,
"item_count": 1,
"search": "text",
"page": 1,
"page_size": 1
}
},
"errors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"is_error": true
}
curl -G https://api.switchappgo.com/v1/transactions \
-H "authorization: 'bearer sk_test_nTgS42KNdKr6Ts798DT'" \
-d page='3' \
Last updated