Callback Events

Every callback payload has a parameter named event and its purpose is to communicate the reason for the callback. The section below describes the various values the parameter can take.

Depending on the workflow (collection, invoice generation/payment, service payment, disbursement etc) being used, the gateway will send appropriate events to the appropriate callback URLs. For every workflow type, the applicable events are described below;

Collections

Event	Transaction Status	Description
request.failed	FAILED	Request failed and could not be processed by the gateway. Failure reason is part of the callback payload
transaction.charges	PENDING	Communicates success of the first collection leg (initialization) and the charges to be levied. The collection confirmation request should be sent after this event is received
transaction.processing	PROCESSING	Notifies the merchant that transaction processing is ongoing. Returns mobile money instructions (when payment method is MOBILE_MONEY) or the card payment URL (when payment method is CARD)
transaction.failed	FAILED	The gateway tried to process the transaction but failed e.g. insufficient balance on the account. Failure reason is part of the callback payload
transaction.completed	COMPLETED	The gateway processed the collection successfully.

Service Payments (PRNs etc)

Event	Description
request.failed	Request failed and could not be processed by the gateway. Failure reason is part of the callback payload
validation.failed	The event is sent in some situations when the validation of a service account e.g. PRN fails. Failure reason is always sent as part of the payload
payment.failed	When the service payment fails e.g. when payment of the URA payment fails. Error message is part of the callback payload
payment.completed	When the service payment is successfully e.g. when payment of the URA payment is processed successfully

Invoices (Generation & Payment)

Event	Description
request.failed	Request failed and could not be processed by the gateway. Failure reason is part of the callback payload
invoice.generated	Event sent at successful generation of the invoice. Details of the invoice would be shared as part of the payload
invoice.paid	Event sent when the invoice is paid for. Part of the payload is the reference for the collection that fulfilled the invoice

Samples of payloads with these events will be provided in the different sections of the documentation