Skip to main content

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.

Afriex delivers real-time notifications to your configured webhook URL whenever a payment method is created, updated, or deleted.

​
Security

See Webhooks Introduction for setup, signature validation, and retry behavior.

​
Event Types

  • PAYMENT_METHOD.CREATED - A new payment method has been created
  • PAYMENT_METHOD.UPDATED - Payment method information has been updated
  • PAYMENT_METHOD.DELETED - A payment method has been deleted

​
Sample Payloads

​
Payment Method Created

{
  "event": "PAYMENT_METHOD.CREATED",
  "data": {
    "paymentMethodId": "6936b8774f987b2994865b73",
    "channel": "BANK_ACCOUNT",
    "customerId": "6922e4520a53e858ab42efa8",
    "institution": {
      "institutionCode": "058",
      "institutionName": "GTBank"
    },
    "accountName": "John Doe",
    "accountNumber": "1234567890",
    "countryCode": "NG"
  }
}

​
Payment Method Updated

{
  "event": "PAYMENT_METHOD.UPDATED",
  "data": {
    "paymentMethodId": "6936b8774f987b2994865b73",
    "channel": "BANK_ACCOUNT",
    "customerId": "6922e4520a53e858ab42efa8",
    "institution": {
      "institutionCode": "058",
      "institutionName": "GTBank"
    },
    "accountName": "John Smith",
    "accountNumber": "1234567890",
    "countryCode": "NG",
    "updatedAt": "2026-02-11T15:30:45.123Z"
  }
}

​
Payment Method Deleted

{
  "event": "PAYMENT_METHOD.DELETED",
  "data": {
    "paymentMethodId": "69f87b0dcc0ee96511560796",
    "channel": "BANK_ACCOUNT",
    "customerId": "6922e4520a53e858ab42efa8",
    "institution": {
      "institutionCode": "058",
      "institutionName": "GTBank"
    },
    "accountName": "John Smith",
    "accountNumber": "1234567890",
    "countryCode": "NG"
  }
}
The event field will be PAYMENT_METHOD.CREATED, PAYMENT_METHOD.UPDATED, or PAYMENT_METHOD.DELETED depending on the action that triggered the notification.

​
Response

Return 200 (or another 2xx) after successful validation and processing.