Payment Methods

Get payment method list

Retrieves a paginated list of payment methods.

get/api/v1/payment-method

Request

Base URL
https://sandbox.api.afriex.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/payment-method/get.ts
A function with typed inputs. Its response is checked against the schema.

pageinteger

Page number for pagination (starting from 0)

limitinteger

Number of items per page

channelstring[]

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

currenciesstring[]

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

capabilitiesstring[]

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

statusstring[]

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

List of payment methods retrieved successfully.

pageinteger

Current page number

totalinteger

Total number of payment methods matching the query

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