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

Query parameters

Response

200400401

Returns 200 and a paged response containing the transactions

Body

application/json

statusApiStatusResponse (enum)

successerror

messagenullable string

dataViewTransactionListDto (object)

metaPagedMeta (object)

errorsnullable object

is_errorboolean

Request

JavaScriptCurlPython

const response = await fetch('/v1/transactions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "status": "success",
  "message": "text",
  "data": {
    "id": "text",
    "is_live": false,
    "gateway_code": "text",
    "tx_ref": "text",
    "dedicated_virtual_account_reference": "text",
    "currency": "text",
    "amount": 0,
    "charged_amount": 0,
    "amount_settled": 0,
    "app_fee": 0,
    "merchant_fee": 0,
    "bearer": "customer",
    "status": "successful",
    "metadata": "text",
    "redirect_url": "text",
    "payment_type": "text",
    "is_direct_card_charge": false,
    "is_virtual_account_checkout": false,
    "is_dedicated_virtual_account_checkout": false,
    "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": "2024-11-16T16:17:15.832Z",
      "edited_at": "2024-11-16T16:17:15.832Z"
    },
    "paid_at": "2024-11-16T16:17:15.832Z",
    "created_at": "2024-11-16T16:17:15.832Z",
    "edited_at": "2024-11-16T16:17:15.832Z"
  },
  "meta": {
    "page_meta": {
      "search": "text"
    }
  },
  "is_error": false
}

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
})