Incoming Payment Callback

PSI will notify the Partner when a payment is completed by the customer. The purpose of this call is to ask the partner if they wish to accept or deny the incoming Interac e-Transfer.

In addition to vetting and checks that should be done before making a payment request, The Incoming Payment notification is the final point where any checks by the Partner should happen, for example Limit Checking. See examples here.

If Partner denies the payment, an Interac email notification to be sent to the customer's bank email address notifying them of the canceled payment. The Partner is responsible for any further communication about the denial reason.

NOTE!! This request must be responded to within 28 seconds or it will timeout and mark the payment request as DECLINED.

POST   http://{IncomingUrlProvidedByPartner}/{PartnerPaySeq}

Incoming Request from PSI

PartnerPaySeq

IntegerMax Size: 16 digits

Unique identifier for this payment.

PaymentType

StringMax Size: 20 characters

Payment type for this payment.

Value: InteracRFM

CreatedDate

StringMax Size: 25 characters

Datetime of when this payment was created (in UTC).

PaymentRef

StringMax Size: 200 characters

Unique identifier for this payment.

CustomerRef

StringMax Size: 100 characters

Unique identifier for this customer.

Email

StringMax Size: 100 characters

Email address to send the payment link to (if you use the email method)

Phone

StringMax Size: 100 characters

Phone number to send the payment link to. (Required if no Email)

FirstName

StringMax Size: 50 characters

First name of customer.

LastName

StringMax Size: 50 characters

Last name of customer.

Amount

Number (8, 2 decimals)Max Size: 11

Total amount for the payment to charge the customer.

Language

StringSize: 2 characters

Customer's preferred language.

Values: en or fr | Default: en

PayerName

StringMax Size: 100 characters

Full name of the person sending the funds.

PayerEmail

StringMax Size: 64 characters

Email of the person sending the funds.

PayerFiName

StringMax Size: 50 characters

Name of the Financial Institution sending the funds.

Example 

{

  "PartnerPaySeq": 4420031720534876,

  "PaymentType": "InteracRFM", 

  "CreatedDate": "2021-03-31T22:18:21.000Z",

"PaymentRef": "98765444",

  "CustomerRef": "ABCDE12345",

"Email": "example@gmail.com",

"FirstName": "John",

"LastName": "Doe",

"Amount": 98.25,

"Language": "en",

"PayerName": "Sam Hill",

"PayerEmail": "SamHill@someplace.com",

"PayerFiName": "Bank Name"

}

Response to PSI 

To accept the payment

Return result code 200 with Result set to SUCCESS.
This must be done in 8 seconds or less.

Result

Enum

Indicates if the payment should be accepted or denied.

Only results of SUCCESS are accepted.

Values: SUCCESS, DECLINED, COMPLIANCE_REJECT  or LIMIT_EXCEEDED

Message

StringMax Size: 200 characters

Free form field for adding extra into.







Example 

{

  "Result": "SUCCESS",

  "Message": ""

}