> ## 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. # List Payment Methods > Retrieves a paginated list of payment methods. Retrieve a paginated list of all payment methods associated with your business. ## OpenAPI ````yaml GET /api/v1/payment-method openapi: 3.1.0 info: title: Afriex Business API version: 1.0.8 description: >- Welcome to the Afriex Business API. This API allows you to manage customers, process payments, handle payouts, and receive real-time notifications via webhooks. For detailed guidance on authentication, pagination, error handling, and webhooks, please refer to the [dedicated guides](https://docs.afriex.com) in the top bar. The guide provides a step-by-step instructions to help you integrate seamlessly. termsOfService: https://www.afriex.com/terms-and-condition contact: name: Afriex API Support email: eng@afriex.co url: https://docs.afriex.com license: name: Proprietary url: https://www.afriex.com/terms-and-condition servers: - url: https://sandbox.api.afriex.com description: Staging Base URL - url: https://api.afriex.com description: Production Base URL security: - ApiKey: [] tags: - name: Customers description: Create and manage your customers. - name: Payment Methods description: Register and resolve customer payout and collection methods. - name: Transactions description: Create and track deposits, withdrawals, and swaps. - name: Balance description: View and top up your business wallet balances. - name: Rates description: Fetch real-time exchange rates. - name: Checkout Sessions description: Create hosted checkout sessions. - name: Webhooks description: Webhook event payloads and sandbox webhook testing. - name: Media description: Generate presigned URLs for secure file uploads. paths: /api/v1/payment-method: parameters: - $ref: '#/components/parameters/x-api-signature' - $ref: '#/components/parameters/x-api-version' get: tags: - Payment Methods summary: Get payment method list description: Retrieves a paginated list of payment methods. operationId: listPaymentMethods parameters: - name: page in: query description: Page number for pagination (starting from 0) required: false schema: type: integer minimum: 0 default: 0 - name: limit in: query description: Number of items per page required: false schema: type: integer minimum: 1 maximum: 100 default: 10 - name: channel in: query description: >- Filter by one or more payment channels. Use a comma-separated list for multiple values (e.g. `?channel=BANK_ACCOUNT,MOBILE_MONEY`). required: false schema: type: array items: type: string enum: - BANK_ACCOUNT - MOBILE_MONEY - INTERAC - UPI - WE_CHAT - VIRTUAL_BANK_ACCOUNT - RFP - SWIFT style: form explode: false - name: currencies in: query description: >- Filter by one or more 3-letter ISO 4217 currency codes. Use a comma-separated list for multiple values (e.g. `?currencies=USD,NGN`). required: false schema: type: array items: type: string style: form explode: false - name: capabilities in: query description: >- Filter by payment method capability. Only `WITHDRAW` is currently supported. Defaults to `WITHDRAW` when omitted. required: false schema: type: array items: type: string enum: - WITHDRAW default: - WITHDRAW style: form explode: false - name: status in: query description: >- Filter by one or more payment method statuses. Defaults to `active,pending` when omitted. required: false schema: type: array items: type: string enum: - active - pending default: - active - pending style: form explode: false responses: '200': description: List of payment methods retrieved successfully. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/PaymentMethod' page: type: integer description: Current page number total: type: integer description: Total number of payment methods matching the query examples: success: summary: Payment method list retrieved value: 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 '400': description: Invalid request parameters. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: validationError: summary: Validation error value: code: VALIDATION_ERROR error: 'Failed to parse request. Issues: ''page'' must be a number' details: {} '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingApiKey: summary: Missing API key value: code: AUTHENTICATION_ERROR error: Authorization header is missing details: {} invalidApiKey: summary: Invalid API key value: code: AUTHENTICATION_ERROR error: Invalid authorization header details: {} '500': description: Server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: serverError: summary: Unexpected server error value: code: INTERNAL_SERVER_ERROR error: It's not you, it's us, please reach out to support details: {} x-codeSamples: - lang: TypeScript label: Afriex SDK source: | const response = await afriex.paymentMethods.list({ page: 1, limit: 20, }); components: parameters: x-api-signature: name: x-api-signature in: header required: false description: >- Signature of the request payload, used for request authentication where payload signing is enabled for your business. schema: type: string x-api-version: name: x-api-version in: header required: false description: >- API version in ISO 8601 format (e.g. 2025-12-28). Defaults to latest stable. schema: type: string schemas: PaymentMethod: type: object description: >- A payment method. Empty fields are omitted. Account-shaped channels (BANK_ACCOUNT, MOBILE_MONEY, SWIFT, etc.) populate accountName, accountNumber, and institution; the CARD channel instead populates last4, brand, expiration, and cardName. properties: paymentMethodId: type: string description: The unique identifier for the payment method. customerId: $ref: '#/components/schemas/customerId' reference: type: string description: Identifier to reconcile incoming deposits against. institution: $ref: '#/components/schemas/PaymentMethodInstitution' transaction: $ref: '#/components/schemas/PaymentMethodTransaction' recipient: $ref: '#/components/schemas/PaymentMethodRecipient' channel: type: string enum: - BANK_ACCOUNT - MOBILE_MONEY - SWIFT - INTERAC - UPI - WE_CHAT - ALIPAY - CARD - CRYPTO - VIRTUAL_BANK_ACCOUNT - POOL_ACCOUNT - ACH_BANK_ACCOUNT - PAYBILL_TILL - RFP - VIRTUAL_CARD description: The payment method channel. countryCode: type: string description: The ISO 3166-1 alpha-2 country code. currency: type: string description: >- The payment method's currency (ISO 4217). Use this instead of inferring currency from countryCode, which is ambiguous (e.g. a USD account in a non-US country). capabilities: type: array items: type: string description: >- The operations this payment method is enabled for (e.g. DEPOSIT, WITHDRAW). Use it to select deposit-capable vs withdraw-capable methods. Also filterable via the `capabilities` query parameter. accountName: type: string description: Name of the account holder. Present for account-shaped channels. accountNumber: type: string description: Account number. Present for account-shaped channels. routingNumber: type: string description: >- Bank routing number. Present for account-shaped channels that carry one (e.g. ACH bank accounts). status: type: string enum: - active - pending - deleted - expired - blocked description: Lifecycle status of the payment method. last4: type: string description: Last 4 digits of the card. CARD channel only. brand: type: string enum: - Visa - MasterCard - Discover - American Express - JCB - Diners Club - Eftpos Australia - UnionPay - Unknown description: Card brand. CARD channel only. expiration: type: object description: Card expiration. CARD channel only. properties: month: type: integer year: type: integer cardName: type: string description: Name on the card. CARD channel only. expiresInMinutes: type: integer description: Minutes until a dynamic virtual account expires, when applicable. amount: type: number description: Requested amount for a dynamic virtual account, when applicable. extra: type: object description: Additional channel-specific properties. additionalProperties: true meta: type: object description: Optional meta data you attached to the payment method. ErrorResponse: type: object properties: code: type: string description: Machine-readable error code. error: type: string description: Human-readable error message. details: $ref: '#/components/schemas/ErrorDetails' customerId: type: string description: The unique identifier of the customer. PaymentMethodInstitution: type: object properties: institutionId: type: string description: >- The unique identifier of the bank or mobile money provider if required. institutionName: type: string description: The name of the bank or mobile money provider if required. institutionCode: type: string description: The code of the bank or mobile money provider. institutionAddress: type: string description: The address of the bank or mobile money provider if required. correspondentBankName: type: string description: >- The correspondent (intermediary) bank name. Mandatory for USD (SWIFT) payout payment methods; required to produce settlement advices/invoices. correspondentBankAccountNumber: type: string description: >- The correspondent (intermediary) bank account number. Mandatory for USD (SWIFT) payout payment methods; required to produce settlement advices/invoices. PaymentMethodTransaction: type: object properties: transactionInvoice: type: string description: >- The invoice filename (S3 object key) for the transaction, as returned by the media upload endpoint. transactionNarration: type: string description: The optional reason for the transaction. PaymentMethodRecipient: type: object properties: recipientEmail: type: string format: email description: The email address of the recipient if needed. recipientPhone: type: string description: The phone number of the recipient in E.164 format. recipientAddress: type: string description: The address of the recipient if needed. recipientName: type: string description: The name of the recipient if needed. ErrorDetails: type: object properties: errorMessage: type: string description: Detailed/technical error message. friendlyMessage: type: string description: User-facing error message safe to display. data: type: object description: >- Optional caller-safe context for the error. On a customer-create uniqueness conflict (EMAIL_ALREADY_EXISTS / PHONE_NUMBER_ALREADY_EXISTS) this carries the existing customer's id, so you can adopt it without a follow-up lookup. properties: customerId: type: string description: Id of the existing customer (on a create conflict). securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: >- 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. ````