PartnerPay Service: Interac e-Transfer
PartnerPay Service: Interac e-Transfer
Request Payment
Request a payment link to be created and returned back in the API response.Request Payment
Embedded Files
POST /v1/payment/request
Request
Request
PaymentRef
StringMax Size: 200 charactersPaymentRef
Unique identifier for this payment.
CustomerRef
StringMax Size: 200 charactersCustomerRef
Unique identifier for this customer.
This can be an email address and it can be the same value as the Email field.ReturnURL (Required for Hosted Payment Page integrations)
StringMax Size: 300 charactersReturnURL (Required for Hosted Payment Page integrations)
URL to re-direct the User back to the Partner's page.
Email
StringMax Size: 100 charactersEmail
Email address to send the payment link to. (Required if no Phone Number)
Phone (Required if Email is empty)
String - Regex Allowed Pattern: ^\(?([2-9][0-8][0-9])\)?([2-9][0-9]{2})?([0-9]{4})$Max Size: 100 charactersPhone (Required if Email is empty)
Canadian phone number to send the payment link to.
FirstName
String - Regex Allowed Pattern: ^[a-zA-Z0-9àâäèéêëîïôœùûüÿçÀÂÄÈÉÊËÎÏÔŒÙÛÜŸÇ'-]+$ Max Size: 50 charactersFirstName
First name of customer. Used for communication during the payment.
LastName
String - Regex Allowed Pattern: ^[a-zA-Z0-9àâäèéêëîïôœùûüÿçÀÂÄÈÉÊËÎÏÔŒÙÛÜŸÇ'-]+$ Max Size: 50 charactersLastName
Last name of customer. Used for communication during the payment.
Amount
Number (8, 2 decimals)Max Size: 11Amount
Total amount for the payment to charge the customer.
Language
StringSize: 2 charactersLanguage
Customer's preferred language.
Values: en or fr | Default: en
Example
Example
{
"PaymentRef": "98765444",
"CustomerRef": "ABCDE12345",
"ReturnURL": "https://mysite.ca/receipt",
"Email": "example@gmail.com",
"FirstName": "John",
"LastName": "Doe",
"Amount": 98.25,
"Language": "en"
}
Response
Response
PartnerPaySeq
StringMax Size: 16 charactersPartnerPaySeq
Unique identifier for this payment.
Status
StringMax Size: 20 charactersStatus
AVAILABLE when created.
DUPLICATE when the same PaymentRef is used.
PaymentURL
URLPaymentURL
URL to give to the customer to complete their payment. (If you use the URL method)
CreatedDate
StringMax Size: 25 charactersCreatedDate
Datetime of when this payment was created (in UTC).
PaymentRef
StringMax Size: 200 charactersPaymentRef
Unique identifier for this payment.
CustomerRef
StringMax Size: 200 charactersCustomerRef
Unique identifier for this customer.
ReturnURL
StringMax Size: 300 charactersReturnURL
Only returned if passed in the Request. URL to re-direct the User back to the Partner's page.
Email
StringMax Size: 100 charactersEmail
Email address to send the payment link to (if you use the email method)
PhoneNumber
StringMax Size: 100 charactersPhoneNumber
Canadian phone number to send the payment link to.
Amount
Number (8, 2 decimals)Max Size: 11Amount
Total amount for the payment to charge the customer.
Language
StringSize: 2 charactersLanguage
Customer's preferred language.
Values: en or fr | Default: en
Example
Example
{
"PartnerPaySeq": 4420031720534876,
"Status": "AVAILABLE",
"PaymentURL": "https://paymentlink.ca",
"CreatedDate": "2021-03-31T22:18:21.000Z"
"PaymentRef": "98765444",
"CustomerRef": "ABCDE12345",
"ReturnURL": "https://mysite.ca/receipt",
"Email": "example@gmail.com",
"Amount": 98.25,
"Language": "en"
}
Page updated
Report abuse