Skip to main content
GET
/
api
/
v1
/
transaction
Get transaction list
curl --request GET \
  --url https://sandbox.api.afriex.com/api/v1/transaction \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "status": "SUCCESS",
      "type": "SWAP",
      "channel": "WALLET",
      "sourceAmount": "10",
      "sourceCurrency": "USD",
      "destinationAmount": "14101.041",
      "destinationCurrency": "NGN",
      "destinationId": "",
      "customerId": "68e6717848e1f632e9686460",
      "transactionId": "69d3c79531c0234586ad5ee0",
      "meta": {
        "reference": "ref-swap-minimal-002",
        "idempotencyKey": "idem-swap-minimal-002"
      },
      "createdAt": "2026-04-06T14:47:49.166Z",
      "updatedAt": "2026-04-06T14:47:49.166Z"
    },
    {
      "status": "PENDING",
      "type": "WITHDRAW",
      "channel": "BANK_ACCOUNT",
      "sourceAmount": "3.28847",
      "sourceCurrency": "USD",
      "destinationAmount": "5000",
      "destinationCurrency": "NGN",
      "destinationId": "690df3281c11eea59108fcaf",
      "customerId": "69528240ba52c13b669fb239",
      "transactionId": "69d60071ab82306f11b03393",
      "meta": {
        "reference": "ref-withdraw-001",
        "idempotencyKey": "idem-withdraw-001"
      },
      "createdAt": "2026-04-08T07:14:57.444Z",
      "updatedAt": "2026-04-08T07:14:57.444Z"
    }
  ],
  "total": 285,
  "page": 0
}
Retrieve a paginated list of all transactions associated with your business.

Authorizations

​
x-api-key
string
header
required

Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Requests made with a key that does not include the permission required by the target endpoint will be rejected with a 403 Forbidden response; an unrecognised, malformed or revoked key returns 401 Unauthorized. Manage your keys and their permissions under Developer → API keys in the dashboard.

Headers

​
x-api-version
string

API version in ISO 8601 format (e.g. 2025-12-28). Defaults to latest stable.

Query Parameters

​
page
integer
default:0

Zero-based page number for pagination.

Required range: x >= 0
​
limit
integer
default:10

Number of items per page (max 100).

Required range: 1 <= x <= 100
​
transactionId
string

Filter by the Afriex transaction ID (transactionId) returned when the transaction was created.

​
reference
string

Filter by the merchant-supplied reference set in meta.reference at transaction creation.

​
status
enum<string>[]

Filter by one or more transaction statuses. Use a comma-separated list for multiple values (e.g. ?status=PENDING,PROCESSING).

Available options:
PENDING,
PROCESSING,
SUCCESS,
FAILED,
CANCELLED,
REFUNDED,
RETRY,
UNKNOWN,
SCHEDULED,
CUSTOMER_ACTION_REQUIRED,
REJECTED,
IN_REVIEW,
DISPUTED,
DISPUTE_RESOLVED,
DISPUTE_WON,
DISPUTE_LOST,
DISPUTE_EVIDENCE_SUBMITTED
​
type
enum<string>[]

Filter by one or more transaction types. Use a comma-separated list for multiple values (e.g. ?type=DEPOSIT,WITHDRAW).

Available options:
DEPOSIT,
WITHDRAW,
SWAP
​
channel
enum<string>[]

Filter by one or more payment channels (source or destination). Use a comma-separated list for multiple values (e.g. ?channel=BANK_ACCOUNT,MOBILE_MONEY).

Available options:
BANK_ACCOUNT,
MOBILE_MONEY,
CARD,
CRYPTO,
VIRTUAL_BANK_ACCOUNT,
ACH_BANK_ACCOUNT,
INTERAC,
PAYBILL_TILL,
RFP,
UPI,
VIRTUAL_CARD,
SWIFT,
WE_CHAT,
ALIPAY,
WALLET
​
currency
string[]

Filter by one or more 3-letter ISO 4217 currency codes (source or destination). Use a comma-separated list for multiple values (e.g. ?currency=USD,NGN).

​
fromDate
string<date-time>

Return only transactions created on or after this ISO 8601 date-time (e.g. 2025-01-01T00:00:00.000Z).

​
toDate
string<date-time>

Return only transactions created on or before this ISO 8601 date-time. Must be equal to or later than fromDate.

Response

List of transactions retrieved successfully.

​
data
object[]
​
page
integer

Current page number

​
total
integer

Total number of transactions matching the query