List transactions

Get a paginated transaction list with filtering

Retrieves a paginated list of your payment transactions.

NOTE: This list contains all transactions including failed transactions. To get only successful transactions, filter using the transaction status query parameter.

Retrieves all transactions for a merchant profile

get

/v1/transactions

Authorizations

Query parameters

searchstring

Search parameter to use while filtering the list

pageinteger · int32

The target page to retrieve if available. Minimum value is 1.

page_sizeinteger · int32

Required page size. Acceptable range is from 1 to 100.

order_bystring

filter.idstring

Id of the transaction to retrieve

filter.tx_refstring

The transaction reference to find

filter.currencystring

Transaction currency to filter with

filter.amountnumber · double

filter.minimum_amountnumber · double

filter.maximum_amountnumber · double

filter.bearerstring · enum

Options: customer, merchant

filter.gateway_codestring

The gateway codes used to complete payment

filter.sale_idstring

Id of the sale that was made using the transaction

filter.invoice_idstring

Id of the invoice that was raised for the transaction

filter.dedicated_virtual_account_referencestring

Reference of the Dedicated Virtual Account the payment was made to

filter.is_dedicated_virtual_account_transactionboolean

Flag to only retrieve transactions made via dedicated virtual accounts

filter.customer_idstring

Id of the customer used for filtering

filter.customer_emailstring

The email of the customer used for filtering

filter.statusesstring · enum[]

A list of statuses to filter by

statusstring · enum

Options: successful, processing, abandoned, refunded, failed, pending

start_datestring · date-time

end_datestring · date-time

searchstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/transactions' \
  --header 'Authorization: YOUR_API_KEY'

200

400

401

200

{
  "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-02-20T19:24:05.874Z",
      "edited_at": "2025-02-20T19:24:05.874Z"
    },
    "paid_at": "2025-02-20T19:24:05.874Z",
    "created_at": "2025-02-20T19:24:05.874Z",
    "edited_at": "2025-02-20T19:24:05.874Z"
  },
  "meta": {
    "page_meta": {
      "page_count": 1,
      "item_count": 1,
      "search": "text",
      "page": 1,
      "page_size": 1
    }
  },
  "is_error": true,
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Returns 200 and a paged response containing the transactions

curl

curl -G https://api.switchappgo.com/v1/transactions \
    -H "authorization: 'bearer sk_test_nTgS42KNdKr6Ts798DT'" \
    -d page='3' \

node

const switchapp = require('switchapp')('sk_test_nTgS42KNdKr6Ts798DT');

const newTx = await switchapp.transactions.list({
    page: 3,
    pageSize: 150
})