Interac
This alternative payment method supports the following operations:
Payment
Request
Send a payment request with the following additional parameters:
| Parameter | Type | Description |
|---|---|---|
| method | object | A section of the payment method. |
| type * required |
string | interac |
| login_id * required |
string | The customer's ID in your system. For each customer login_id should be unique. |
| channel * required |
string | A paymemt method. Possible values: ETI - Interac® e-Transfer;Online - Interac® Online;CPI - the customer selects what a payment method (Online or ETI) he/she will use to pay. |
| customer | object | A section of the customer details. |
| first_name * required |
string | The customer's first name. |
| last_name * required |
string | The customer's last name. |
| email * required |
string | The customer's email address. |
| phone * required |
string | The customer's phone number. |
Response
The interac response section will have the parameters copied from the request and additionally the form parameter will be returned to build a form where you should redirect the customer to finalize the payment.
Payout
Request
Send a payout request with the following additional parameters:
| Parameter | Type | Description |
|---|---|---|
| method | object | A section of the payment method information. |
| type * required |
string | interac |
| login_id * required |
string | The customer's ID in your system. For each customer login_id should be unique. |
| channel * required |
A payout method. Possible values: ETO - Interac® e-Transfer Outbound;ACH - a payout directly to customer's bank account. |
For a payout via the ACH channel, add the following data in the method section:
| Parameter | Type | Description |
|---|---|---|
| method | object | A section of the payment method information. |
| account * required |
string | The customer's account number. |
| bank_code * required |
string | The customer's bank number. |
| bank_bic_number * required |
string | The customer's transit number. |
| customer | object | A section with the customer details. |
| first_name * required |
string | The customer's first name. |
| last_name * required |
string | The customer's last name. |
For a payout via the ETO, add the following data in the customer section:
| Parameter | Type | Description |
|---|---|---|
| customer | object | A section with the customer details. |
| first_name * required |
string | The customer's first name. |
| last_name * required |
string | The customer's last name. |
| email * required |
string | The customer's email address. |
| phone * required |
string | The customer's phone number. |
Response
The interac response section will have the parameters copied from the request.