AFafriex
Transactions

Get transaction list

Retrieves a paginated list of transactions.

get/api/v1/transaction

Request

Query parameters

pageinteger

Zero-based page number for pagination.

limitinteger

Number of items per page (max 100).

transactionIdstring

Filter by the Afriex transaction ID (transactionId) returned when the transaction was created, or by the reference you supplied in meta.reference.

referencestring

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

statusTransactionStatus[]

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

typestring[]

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.

channelstring[]

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

currencystring[]

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

[
  "USD"
]
fromDatestring date-time

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

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

pageinteger

Current page number

totalinteger

Total number of transactions matching the query

Example response

{
  "data": [
    {
      "meta": {
        "failureReason": {
          "code": "AFX_VELOCITY_LIMIT_EXCEEDED"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.