Payment Processing Notification

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

This method allows the Bank to send a notification about a payment. This can be a successful payment, a payment in progress or pending, or a payment that has not been processed due to an error. In the latter case, the error is detailed in the response.

Header Parameters
TZ The timezone header is optional. If provided, the header value will be applied to the API response's date and time fields. If the timezone header is not included, the default UTC timezone will be used and returned to the response.

Request Body — REQUIRED
reference string
paidAmount number
currency string
paymentDate date-time
statusDetails string Possible values: length ≤ 255
collectedBy string Possible values: length ≤ 255
collectorCode string
bankTransactionReference string
invoiceRefNumber string
bankPaymentType string
bankPayerId string
debitedAccount string Possible values: length ≤ 255
status string

Responses
200 OK Schema — OPTIONAL paymentReference string — OPTIONAL modifiedAt date-time — OPTIONAL paidAt date-time — OPTIONAL zonedModifiedAt date-time — OPTIONAL zonedPaidAt date-time — OPTIONAL errors object[] — OPTIONAL id string — OPTIONAL message string — OPTIONAL