The Paysafe Payments API supports Interac e-Transfer as a payment instrument. Interac e-Transfer is a funds transfer service between personal and business institutions that allows merchants to collect funds from Canadian consumers to pay for the goods.

Interac e-Transfer supports below two transactions:

• Payments

  It is used to transfer money from customer's bank account to merchant account. Post successful payments, merchant credits the customer's wallet. Request money interac flow is implemented to allow customers to deposit money. Merchant will be the requestor of money and customer will be the approver.

• Withdrawal

  It is used to transfer money from merchant account to customer's bank account. Send money interac flow is implemented to allow customers to withdraw money.

When processing an Interac request money payment request, perform the following steps:

1. Create a Payment Handle with the transactionType parameter set to PAYMENT and the paymentType parameter set to INTERAC_ETRANSFER
   • Post : paymenthub/v1/paymenthandles
2. Since the customer has to complete payment by selecting bank account on interac page, Paysafe returns a response with the following:
   • The action parameter is set to REDIRECT
   • A redirect_payment link points to the Interac redirect URL
3. Redirect the customer to the Interac redirect URL.
   • On redirecting the customer to redirection link, status of the Payment Handle becomes PAYABLE and you will be notified with webhook for PAYMENT_HANDLE_PAYABLE event
   • On redirection page, customer selects the bank, provides credentials, and accepts the request of transfer-money.
4. Use the paymentHandleToken returned in the response to process the Payment request via Payments API using the private key. You must initiate a POST request to the endpoint:
   • Post : paymenthub/v1/payments
5. Once the merchant processes the payment via Payments API, the payment will be indicated as PENDING. When the consumer successfully completes the payment within the payment time to live, the merchant will receive the SETTLEMENT COMPLETED/ PAYMENT COMPLETED event (Since this is settlewithauth= true, we can assume that both are same). You can safely credit the cash to the customer's account/ship the goods once you get these events.

When you want to process an Interac payment request, perform the following steps:

1. Create a payment handle with method set to SEND_MONEY, transactionType set to PAYMENT, paymentType set to INTERAC_ETRANSFER, and paymentrefexpiryminutes set to the period of time the merchant wants the transaction to be open (minimum is 120).

   • Post: paymenthub/v1/paymenthandles

2. Since the customer needs instructions on how to complete the payment, Paysafe returns a response with the following:

   • The action parameter is set to PAYABLE

   • A unique payment reference is returned

3. View the payment instructions on your hosted page, including the merchant name, merchant email, amount, and memo reflecting the value from the payment reference.

   • When you redirect a customer to a redirection link, the Payment Handle's status changes to PAYABLE, and you will be notified via a webhook for the PAYMENT_HANDLE_PAYABLE event.

   • On the redirection page, the customer chooses the bank, enters credentials, and accepts the transfer-money request.

4. Process the payment request via Payments API by using the paymentHandleToken supplied in the response and the private key. A POST request needs to be sent to the endpoint:

   • Post: paymenthub/v1/payments

5. After the merchant processes the payment using the Payments API, The status of the payment will change to PENDING. The merchant will receive a SETTLEMENT_COMPLETED/PAYMENT_COMPLETED event when the customer successfully completes the payment within the payment time to live. Since settlewithauth=true, we can assume that both are the same. You can dispatch the goods or safely credit the amount to the customer's account once you get these events.

When you want to process a Interac withdrawal request, do the following:

1. Ask customer the email ID to initiate a withdrawal.

2. Check if the email ID is registered for Auto deposit. You can use Verification API to do the same. You get Auto Deposit status and max transferrable amount in response.

3. Depending on auto-deposit registration status, below mentioned steps need to be implemented.

Registered for Auto Deposit Flow

1. Create a Payment Handle with the transactionType parameter set to STANDALONE_CREDIT and the paymentType parameter set to INTERAC_ETRANSFER.

2. This Payment Handle should immediately have the status of PAYABLE.

3. Use the paymentHandleToken returned in the response to process the Withdrawal request via Standalone Credit API using the private key. You must initiate a POST request to the endpoint:

   • Post: /paymenthub/v1/standalonecredits
4. Once the Withdrawal request is successfully completed, the status of the withdrawal (STANDALONE_CREDIT) will be in PROCESSING state. And funds are transferred to the customer's account upon which the status will be changed to COMPLETED.

Not registered for Auto Deposit Flow

1. For non Auto deposit withdrawals, you have to pass the security question and answer to the API. This can be done either by asking customer to pass question & answer or you can have preconfigured question & answer (and share this with customer).
2. Create a Payment Handle with the transactionType parameter set to STANDALONE_CREDIT, the paymentType parameter set to INTERAC_ETRANSFER and pass the set of question & answer in the API.
3. This Payment Handle should immediately have the status of PAYABLE.
4. Use the paymentHandleToken returned in the response to process the Withdrawal request via Standalone Credit API using the private key. You must initiate a POST request to the endpoint:
   • Post: /paymenthub/v1/standalonecredits
5. Customer will receive the link via email and customer has to complete the process of answering the question via interac/bank page.
6. You will receive webhook for the "SA_CREDIT_COMPLETED" event and once funds are credited into customer account.

Payments

Payment Handle Request Example

You have to pass Interac e-Transfer object in the payment Handle request:

To know more about each parameter, you can visit Payments.

Payment Hanle Request Example

To know more about each parameter, you can visit Payment Handles.

Non Auto-Deposit

Payment Handle Request Example

To know more about each parameter, you can visit Payment Handles.

To know more about each parameter, you can visit Standalone Credits.

Payment Handle

A Payment Handle represents tokenized information about the payment method that you set up for your customer. Once the Payment Handle is created, you can then include the paymentHandleToken returned in the Payment Handle request-response in a new payment request.

Payments Flow:

1. Create Payment Handle API request.
2. In Payment Handle API response, you will get redirect link and paymentHandleToken.
   • A Payment Handle can be used in a payment request only if it has the status of PAYABLE.
   • PaymentHandleToken expires in 899 seconds
3. Redirect user to the redirect link, provided in Payment handle response.
   • You will receive a Webhook with paymentHandleToken status as "PAYABLE"
4. Wait for 10 mins and let user complete the transaction on Interac page.

   Interac doesn't redirect the customer to Merchant page once customer completes the payment. Hence you are advised to show a message to customer while redirecting to Interac page. You may show a message 'Please close the tab and come back to this page after completing the payment'. In addition, you can have listeners on tab close (on redirection Interac page) and once tab close event is received, you can do a GET API call to pull the status.

   • To find out what user has done on Interac page (closed or cancelled or completed the transaction), you can do a GET API Call.
5. Make POST "/payments" API call only when the paymentHandleToken status is "PAYABLE"
   • Customer has completed the transaction:
     • If Interac has notified Paysafe then you will receive "status" as COMPLETED in response and also you will receive PAYMENT_COMPLETED webhook.
     • If Interac has not notified Paysafe then you will receive "status" as PROCESSING in response

        

       • Interac takes max 30 mins to notify Paysafe after user completes the transaction on bank page.

       • Once POST "/payments" API call is made, status of paymentHandleToken changes from "PAYABLE" to "COMPLETED".

   • Customer has declined or not completed the transaction:

     If merchant does not make /payments call within 899 seconds for a paymentHandleToken:

     • Customer has completed the transaction via bankpage then Paysafe will complete payment on merchant's behalf and merchant will receive - a) PAYMENT_COMPLETED or b) PAYMENT_PROCESSING followed by PAYMENT_COMPLETED.

     • Customer has declined or not completed the transaction, we will fail the transaction and you will receive PAYMENT_HANDLE_FAILED event.

     • Your payment handle becomes Completed and Payment status will be in Processing.

     • 2 days later, we will mark the transaction as Failed and you will receive "PAYMENT_FAILED" notification.

Withdrawal Flow

Withdrawal flow can be implement in two ways:

• Verification API + Standalone Credit API.
  • In this model, you will get to know max withdrawal limit and whether user has registered for Auto deposit or not and accordingly you can decide the user experience.

• Standalone Credit API.

Verification API

1. Create Payment Handle API request with transactionType parameter set to VERIFICATION and the paymentType parameter set to INTERAC_ETRANSFER.
2. This Payment Handle should immediately have the status of PAYABLE.
3. Make POST "/verifications" API call with "PAYABLE" paymentHandleToken.
   • You will receive Auto-deposit status and max limit.

Standalone Credit API

1. Create Payment Handle API request with transactionType parameter set to STANDALONE_CREDIT and the paymentType parameter set to INTERAC_ETRANSFER.

2. This Payment Handle status will either be PAYABLE or FAILED.
3. Make POST "/standalonecredits" API call only if paymentHandleToken is "PAYABLE"
   • In Auto-deposit flow, money gets directly credited into user account. You will receive SA_CREDIT_PROCESSING immediately and SA_CREDIT_COMPLETED on T+1
   • If it is non-Auto-deposit flow, you will receive status as "PROCESSING"
     • Once customer completes the transaction within 30 days then you will receive the webhook SA_CREDIT_COMPLETED.
   • PaymentHandleToken expires in 899 seconds
   • If merchant does not send /standalonecredits call within 899 seconds for a paymentHandleToken then paymentHandleToken will expire and you will received PAYMENT_HANDLE_EXPIRED webhook.

Webhooks

• PAYMENT_HANDLE_PAYABLE - On receiving this webhook, merchant has to initiate the paymenthub/v1/payments call
• PAYMENT_COMPLETED/SETTLEMENT_COMPLETED - The payment was completed successfully.
• PAYMENT_PROCESSING: The payment in is in progress. For some cases it may be waiting an action by the customer or the merchant.
• And the below optional webhooks
  • PAYMENT_HANDLE_EXPIRED - This webhook is sent when the customer has not completed the payment on the bank page within the paymentHandle token TTL time. So the merchant can close the transaction as not completed.
  • PAYMENT_HANDLE_COMPLETED - The payment handle token is used before expiry.
  • PAYMENT_FAILED - The payment has failed and the downstream PSP has returned an error (http status 402).
  • PAYMENT_ERRORED - The payment has an error (non http status 402 error).
  • SETTLEMENT_FAILED - Consume this to know when the Settlement status becomes FAILED.
  • SETTLEMENT_ERRORED - Consume this to know when the Settlement status becomes ERRORED.