Skip to main content

Handle callback notifications

This endpoint is for handling callback notifications sent by the payment gateway.

Request Body REQUIRED
timestamp string REQUIRED

yyyymmddhhmiss

reference string REQUIRED

Unique, used for reconciliation

customerReference string

Additional field for special purpose, default NULL

amount number REQUIRED

Transaction amount

type string REQUIRED

Type of transaction, e.g., CHARGE

merchantAccountId string REQUIRED

Merchant name

status string REQUIRED

Status code/message (success/failed)

customer object REQUIRED
firstname string

First name of the customer

lastname string

Last name of the customer

phoneNumber string

Phone number of the customer

mno string

Network of the customer

payloadSignature string REQUIRED

For Integrity validation. Generated by the following formula: SHA256(reference + timestamp + amount + phoneNumber + secret)

Responses
200

Webhook processed successfully

Schema OPTIONAL
timestamp string

yyyymmddhhmiss

reference string

Unique, used for reconciliation

customerReference string OPTIONAL

Additional field for special purpose, default NULL

amount number

Transaction amount

type string

Type of transaction, e.g., CHARGE

merchantAccountId string

Merchant name

status string

Status code/message (success/failed)

customer object
firstname string OPTIONAL

First name of the customer

lastname string OPTIONAL

Last name of the customer

phoneNumber string OPTIONAL

Phone number of the customer

mno string OPTIONAL

Network of the customer

payloadSignature string

For Integrity validation. Generated by the following formula: SHA256(reference + timestamp + amount + phoneNumber + secret)

400

Bad request, such as invalid input

Schema OPTIONAL
code int32

Error code representing the type of error.

message string

Error message detailing what went wrong.

401

Unauthorized access

Schema OPTIONAL
code int32

Error code representing the type of error.

message string

Error message detailing what went wrong.

500

Internal Server Error

Schema OPTIONAL
code int32

Error code representing the type of error.

message string

Error message detailing what went wrong.