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
}

Documentation Index

Fetch the complete documentation index at: https://docs.afriex.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a paginated list of all payment methods associated with your business.

Authorizations

​
x-api-key
string
header
required

Static business API key from the dashboard

Query Parameters

​
page
integer
default:0

Page number for pagination (starting from 1)

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

Number of items per page

Required range: 1 <= x <= 50

Response

List of payment methods retrieved successfully.

​
data
object[]
​
page
integer

Current page number

​
total
integer

Total number of pages