{
"id": "8f14e45f-ceea-4e7a-9f1d-6b1c2a3d4e5f",
"event": "PAYMENT_METHOD.CREATED",
"createdAt": "2026-04-24T09:13:33.883Z",
"data": {
"paymentMethodId": "69528259ba52c13b669fb241",
"channel": "BANK_ACCOUNT",
"customerId": "69528240ba52c13b669fb239",
"institution": {
"institutionName": "United Bank for Africa"
},
"accountName": "John Doe",
"accountNumber": "0123456789",
"countryCode": "NG",
"currency": "NGN",
"capabilities": [
"WITHDRAW"
],
"status": "active"
}
}Payment Method Events
Afriex delivers real-time notifications to your configured webhook URL whenever a payment method is created, updated, or deleted for a customer.
A call to GET /api/v1/payment-method/pool-account also sends PAYMENT_METHOD.UPDATED for the pool account, on every call.
The payload structure is identical across all events. Only the event field changes.
Security: Every request includes an x-webhook-signature header and an x-afriex-business-id header carrying your business id. You must verify this signature using Afriex’s public key before processing. The key is an elliptic-curve (secp384r1 / P-384) key, not RSA. The signature is ECDSA with SHA-256, DER-encoded and then base64-encoded, computed over the exact raw request body, so verify it before parsing or re-serialising the JSON. See the Webhooks Overview & Security section for verification instructions.
{
"id": "8f14e45f-ceea-4e7a-9f1d-6b1c2a3d4e5f",
"event": "PAYMENT_METHOD.CREATED",
"createdAt": "2026-04-24T09:13:33.883Z",
"data": {
"paymentMethodId": "69528259ba52c13b669fb241",
"channel": "BANK_ACCOUNT",
"customerId": "69528240ba52c13b669fb239",
"institution": {
"institutionName": "United Bank for Africa"
},
"accountName": "John Doe",
"accountNumber": "0123456789",
"countryCode": "NG",
"currency": "NGN",
"capabilities": [
"WITHDRAW"
],
"status": "active"
}
}Event Types
PAYMENT_METHOD.CREATED- A new payment method has been createdPAYMENT_METHOD.UPDATED- Payment method information has been updatedPAYMENT_METHOD.DELETED- A payment method has been deleted
Sample Payloads
Payment Method Created
{
"id": "30965945-ffa8-53d6-aef7-24b14dbbe129",
"event": "PAYMENT_METHOD.CREATED",
"createdAt": "2026-04-24T09:13:33.883Z",
"data": {
"paymentMethodId": "6936b8774f987b2994865b73",
"channel": "BANK_ACCOUNT",
"customerId": "6922e4520a53e858ab42efa8",
"institution": {
"institutionCode": "000013",
"institutionName": "Guaranty Trust Bank (GTBank) Plc"
},
"accountName": "John Doe",
"accountNumber": "1234567890",
"countryCode": "NG"
}
}
Payment Method Updated
{
"id": "b2a99d6b-9ce2-592f-9426-3e2df8f786ce",
"event": "PAYMENT_METHOD.UPDATED",
"createdAt": "2026-04-24T09:13:33.883Z",
"data": {
"paymentMethodId": "6936b8774f987b2994865b73",
"channel": "BANK_ACCOUNT",
"customerId": "6922e4520a53e858ab42efa8",
"institution": {
"institutionCode": "000013",
"institutionName": "Guaranty Trust Bank (GTBank) Plc"
},
"accountName": "John Smith",
"accountNumber": "1234567890",
"countryCode": "NG"
}
}
Payment Method Deleted
{
"id": "39e222bf-f2f9-5d0b-81ef-713c9ebc2346",
"event": "PAYMENT_METHOD.DELETED",
"createdAt": "2026-04-24T09:13:33.883Z",
"data": {
"paymentMethodId": "69f87b0dcc0ee96511560796",
"channel": "BANK_ACCOUNT",
"customerId": "6922e4520a53e858ab42efa8",
"institution": {
"institutionCode": "000013",
"institutionName": "Guaranty Trust Bank (GTBank) Plc"
},
"accountName": "John Smith",
"accountNumber": "1234567890",
"countryCode": "NG"
}
}
Body
Unique ID of this event. Every delivery attempt of the same event carries the same id, so use it to ignore a delivery you have already processed.
"8f14e45f-ceea-4e7a-9f1d-6b1c2a3d4e5f"
Identifies which payment method event occurred
PAYMENT_METHOD.CREATED, PAYMENT_METHOD.UPDATED, PAYMENT_METHOD.DELETED "PAYMENT_METHOD.UPDATED"
When Afriex created the event. Retries keep this value, and the signature covers it, so you can reject a delivery that is older than you expect.
"2026-04-24T09:13:33.883Z"
The payment method data relevant to this event, with the fields of the REST PaymentMethod. Unlike the REST response, institution, transaction and recipient carry every subfield stored with the payment method (see PaymentMethodInstitution and PaymentMethodRecipient), including recipientIdType and recipientIdNumber. Empty values (empty strings, null and empty objects, at every depth) are omitted, so meta, institution, transaction and recipient appear only when they carry something. CARD-channel payment methods omit accountName/accountNumber/institution and instead include card fields (last4, brand, expiration, cardName); dynamic virtual accounts may additionally include expiresInMinutes, amount, and extra.
Show child attributes
Show child attributes
Response
Acknowledge receipt. Return any 2xx status code quickly. Response body is ignored.