Skip to main content
GET
/
api
/
v1
/
payment-method
Get payment method list
curl --request GET \
  --url https://staging.afx-server.com/api/v1/payment-method \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "paymentMethodId": "<string>",
      "customerId": "<string>",
      "institution": {
        "institutionId": "<string>",
        "institutionName": "<string>",
        "institutionCode": "<string>",
        "institutionAddress": "<string>"
      },
      "transaction": {
        "transactionInvoice": "<string>",
        "transactionNarration": "<string>"
      },
      "channel": "BANK_ACCOUNT",
      "countryCode": "<string>",
      "accountName": "<string>",
      "accountNumber": "<string>",
      "meta": {}
    }
  ],
  "page": 123,
  "total": 123
}
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