Payment Notification Callback

Pay in person at Canada Post

Payment Notification Callback

To receive notifications partners will create a listener and then Payment Source sends notifications of payment events to that URL by sending an HTTP POST containing notification information as name-value pairs in POST body. The listener page then passes to various backend program partner applications for processing.

The connection is secured by encrypted SSL as well as by each program partner by providing a secret key that will be returned to them with each notification.

Basic-Auth with api-key header is supported if the partner gateway requires it.

Depending on your partner account configuration, you will receive a Pending to accept or deny a payment, or only Completed/Reversed payment notifications.

POST [Partner provided URL]

Incoming Request from PSI

TransTime

StringMax Size: 19 characters

The datetime when the payment is made (in UTC)

TransNo

NumberMax Size: 13 characters

A unique reference to the deposit record. This should be stored to aid in reconciliation

LHRef

StringMax Size: 6 characters

A unique reference to the QR Code. This should be stored to aid in reconciliation.

ClientRef

StringMax Size: 30 characters

The Partner's ClientRef value that was stored in the QR Code.

PaidAmt

Number (8,2)

Customer's payment amount in dollars and cents WITHOUT the fee. For example: 120.50

FeeAmt

Number (8,2)

Transaction fee that the customer paid in dollars and cents. For example: 1.50

Status

StringMax Size: 1 character

P=Pending, C=Completed, R=Reversed

Password

StringMax Size: 20 characters

A secret key that Payment Source provides to the partner. Use this to confirm the message was from Payment Source.

LocationID

NumberMax Size: 6 characters

Unique ID for the store location.

PaymentMethod

StringMax Size: 20 characters

Method of payment used reported from CPC.

Comma-delimited list with possible values: Cash, Credit, Debit, USCash, ClerkCheck, Cheque

Example

New line characters were added for readability.

TransTime=2016-04-15 12:51:40&

TransNo=0070000249999&

LHRef=473827&

ClientRef=000CTD&

PaidAmt=120.50&

FeeAmt=1.50&

Status=P&

Password=GD23123hw567&

LocationId=123&

PaymentMethod=Cash

Response to PSI

Note: There is a timeout threshold of 15 seconds.

*Do not confuse this 'code' with HTTP Status code. HTTP Status code should always be 200 OK.

For Pending (Status=P)

Return { 'code':'code', 'message':'message'} to accept or deny the payment. See Codes below.

For Completed (Status=C)

Return { 'code':'200', 'message':'Acknowledged'} to acknowledge the successful payment.

For Reversals (Status=R)

Return { 'code':'200', 'message':'Reversed'} to show acceptance of the reversal.

Code

Reason

Result

200

Accept - Partner accepts the payment.

Customer's payment will be taken and processed by Payment Source.

7150

Account not valid - Partner declined the payment due to an issue with the customer's account.