Synchronization

Synchronization

This web service call will be used by CBS to notify the integrating system of payment against an invoice. Please note that notifications for the same payment might be sent multiple times, so it is expected that you take into consideration the payment ref before effecting changes on your system. There is a maximum of 10 retries if we don't get a 200 from you endpoint.

• URL
  Callback URL provided during invoice generation

• Method
  POST

Input Parameters [content-type - JSON]

Property	Description	Data Format	Mandatory
InvoiceNumber	Invoice Number	string	Y
PaymentRef	Payment ref returned from the payment channel	string	Y
PaymentDate	Date of the payment	string	Y
BankCode	Bank code	string	N
BankName	Bank name	string	N
BankBranch	Bank branch	string	N
Channel	Channel of payment	string	N
AmountPaid	Amount paid against the invoice	decimal (2)	Y
TransactionDate	Date of transaction	string	Y
Mac	HMAC hash on the concat of InvoiceNumber, PaymentRef, AmountPaid (2 decimal places) and Request Reference	string	Y
IsReversal	Indication if it's a reversal	boolean	N

Sample Input parameter JSON payload

{
    "InvoiceNumber": "1xxxxxxxxxx",
    "PaymentRef": "xxxxxxxxxxx ",
    "PaymentDate": "13/04/2019 15:11:20",
    "BankCode": null,
    "BankName": null,
    "BankBranch": null,
    "AmountPaid": 2000.00,
    "TransactionDate": "13/04/2019 15:10:18",
    "TransactionRef": null,
    "Channel": "Web",
    "PaymentProvider": "Bank3D",
    "Mac": "6QMnc4aMHY6+KM1QN/4/DZZjU/5F5aoxrUvSX/hJHJ0=",
    "ResponseCode": "0000",
    "ResponseMessage": "Ok",
    "RequestReference": "6075b3ebc5015",
    "IsReversal": false
}

Available Payment Providers

Payment Provider	Value
NetPay	NetPay
Remita	Remita
PayDirect	PayDirect
BankCollect	BankCollect
NIBSS(Ebills Pay)	NIBSS

Error Codes and description

Code	description
PPS1	Invalid Signature
PPIE	Internal Server Exception
PPU1	User Not Found
PPVE	Form validation Error
PPCK	Client Identity Could Not Be Found In The Request Header