Skip to main content
GET
/
api
/
v1
/
payment-method
/
{paymentMethodId}
Afriex SDK
const paymentMethod = await afriex.paymentMethods.get("payment-method-id");
{
  "data": {
    "paymentMethodId": "6936b8774f987b2994865b73",
    "channel": "BANK_ACCOUNT",
    "customerId": "6922e4520a53e858ab42efa8",
    "institution": {
      "institutionCode": "000013",
      "institutionName": "GTBank"
    },
    "accountName": "John Doe",
    "accountNumber": "1234567890",
    "countryCode": "NG"
  }
}
Retrieve a specific payment method by its unique identifier.

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.

Path Parameters

​
paymentMethodId
string
required

The unique identifier of the payment method

Response

Payment method retrieved successfully.

​
data
object

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.