Skip to main content
GET
Afriex SDK
Results are paginated. See Pagination for the response shape and the order the transactions come back in.
Want your transactions as a file instead of paging through them? Ask for daily transaction reports. Afriex delivers them as a CSV over SFTP, in production only.

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. Manage your keys and their permissions under Developer → API keys in the dashboard.

A request whose key does not carry the permission the target endpoint requires is rejected with 401 Unauthorized, the same response an unrecognised, malformed, revoked or disabled key returns. The API does not distinguish the two cases on the wire.

See the Permissions reference for the permission each endpoint requires.

Headers

x-api-signature
string

Signature of the request payload, used for request authentication where payload signing is enabled for your business.

x-api-version
string

API version in ISO 8601 format. The only supported version is 2026-05-18, which is also the default when the header is omitted. Any other value is rejected with a 400 Bad Request.

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, or by the reference you supplied in meta.reference.

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

The current status of the transaction.

IN_REVIEW and RFI_REQUESTED are review states: the transaction is still in flight and is waiting on a review, not on you. Treat them as non-terminal and keep polling or listening for TRANSACTION.UPDATED. RFI_REQUESTED may result in someone contacting you for more information about the transfer.

Available options:
PENDING,
PROCESSING,
SUCCESS,
FAILED,
CANCELLED,
REFUNDED,
RETRY,
UNKNOWN,
SCHEDULED,
CUSTOMER_ACTION_REQUIRED,
REJECTED,
IN_REVIEW,
RFI_REQUESTED,
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). Besides the types you can create, REVERSAL, SCHEDULED and SEND can appear on transactions your business did not create through this API.

Available options:
DEPOSIT,
WITHDRAW,
SWAP,
REVERSAL,
SCHEDULED,
SEND
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,
POOL_ACCOUNT,
ACH_BANK_ACCOUNT,
INTERAC,
PAYBILL_TILL,
RFP,
UPI,
VIRTUAL_CARD,
SWIFT,
WE_CHAT,
ALIPAY,
WALLET,
PAYMENT_LINQ,
ADMIN
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