Skip to main content
GET
/
api
/
v1
/
payment-method
Get payment method list
curl --request GET \
  --url https://sandbox.api.afriex.com/api/v1/payment-method \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "paymentMethodId": "6936b8774f987b2994865b73",
      "channel": "BANK_ACCOUNT",
      "customerId": "6922e4520a53e858ab42efa8",
      "institution": {
        "institutionCode": "000013",
        "institutionName": "GTBank"
      },
      "accountName": "John Doe",
      "accountNumber": "1234567890",
      "countryCode": "NG"
    },
    {
      "paymentMethodId": "6936b8e54f987b2994865b8b",
      "channel": "BANK_ACCOUNT",
      "customerId": "6928515c6befd180bc451622",
      "institution": {
        "institutionCode": "000017",
        "institutionName": "WEMA BANK"
      },
      "accountName": "Test Account",
      "accountNumber": "1213131313",
      "countryCode": "NG"
    }
  ],
  "total": 1006,
  "page": 0
}
Retrieve a paginated list of all payment methods 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-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 (e.g. 2025-12-28). Defaults to latest stable.

Query Parameters

​
page
integer
default:0

Page number for pagination (starting from 0)

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

Number of items per page

Required range: 1 <= x <= 100
​
channel
enum<string>[]

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

Available options:
BANK_ACCOUNT,
MOBILE_MONEY,
INTERAC,
UPI,
WE_CHAT,
VIRTUAL_BANK_ACCOUNT,
RFP,
SWIFT
​
currencies
string[]

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

​
capabilities
enum<string>[]

Filter by payment method capability. Only WITHDRAW is currently supported. Defaults to WITHDRAW when omitted.

Available options:
WITHDRAW
​
status
enum<string>[]

Filter by one or more payment method statuses. Defaults to active,pending when omitted.

Available options:
active,
pending

Response

List of payment methods retrieved successfully.

​
data
object[]
​
page
integer

Current page number

​
total
integer

Total number of payment methods matching the query