Webhook

⚠️ Important Notes

• We only send webhook for Completed and Failed

  Payceler sends webhook events only when a transaction reaches a terminal state: completed or failed.

• Only terminate a payout to your end customer when the transaction status is COMPLETED.

  A payout should not be considered delivered or successful unless the status returned by Payceler is explicitly "COMPLETED".

  Avoid acting on pending or processing statuses.

• To know the status of transactions, we recommend that you listen to our webhook, because you’ll be affected by rate limiting/throttling if you query too frequently

  Webhooks are the recommended mechanism for receiving transaction updates. Relying on polling (/query) may lead to throttling.

• It happens sometimes that webhook is sent more than once, although rare. Handle idempotency

  Duplicate webhook deliveries can occur. Ensure your system is idempotent — use the transaction reference to deduplicate.

• Header X-signature. It will come in the header of the webhook request. Encoded string using HMAC-SHA256. You’ll need to decode it using your secret key

  Verify incoming webhooks using the X-signature header and your Payceler secret key.

Retrieve transaction

get

Path parameters

idstringRequired

The transaction ID

Example: 4a162406-5320-474b-9462-c11a52416f73

Responses

200

Transaction information retrieved successfully.

application/json

idintegerOptional

The transaction ID

Example: 2

referencestringOptional

Unique reference for the transaction

Example: 49434b7a-9b79-44ab-b1fd-a7d5c93dcd91

currency_codestringOptional

The currency code

Example: GBP

amountstringOptional

The amount of the transaction

Example: 100

chargesstringOptional

The charges for the transaction

Example: 0

statusstringOptional

The status of the transaction

Example: Processing

narrationstringOptional

A description or reason for the transaction

Example: Test Payout

typestringOptional

The type of the transaction

Example: Debit

merchant_referencestringOptional

The merchant's reference for the transaction

Example: sdkfjsldfj

get

/v1/payment/transaction/{id}

HTTPcURLJavaScriptPython

GET /v1/payment/transaction/{id} HTTP/1.1
Host: disbuzapi.celergate.net
Accept: */*

200

Transaction information retrieved successfully.

{
  "id": 2,
  "reference": "49434b7a-9b79-44ab-b1fd-a7d5c93dcd91",
  "currency_code": "GBP",
  "amount": 100,
  "charges": 0,
  "status": "Processing",
  "beneficiary": {
    "account_number": 523647790,
    "bank_code": 52,
    "bank_name": "GT Bank",
    "account_name": "Oladayo Azeez"
  },
  "narration": "Test Payout",
  "type": "Debit",
  "merchant_reference": "sdkfjsldfj"
}