Interac Online

Overview

Interac Online is a payment method that allows customers to make payments through online banking services of Canadian banks. Purchases are performed by using Payment Page and Gate, refunds—by using Gate.

General information

Payment method type online banking
Countries and regions CA
Payment currencies CAD
Currency conversion
Purchases +
Payouts
Stored credentials payments
Full refunds +
Partial refunds +
Chargebacks
Notes It is necessary to use the internal Interac Online style guide while developing the payment page displayed to customers
Onboarding and access fee Refer to your key account manager ECommPay

Interaction diagram

Payment processing through the Interac Online payment method requires merchant's web service, one of the interfaces and the payment platform of ECommPay, Interac Online technical facilities, as well as a bank service that supports working with this method.



Operations support

  Interfaces Amounts, CAD
Payment Page CMS Plug-ins Gate Dashboard minimum maximum
Purchases + + 5.00 3.000,00
Full refunds +
Partial refunds +

Processing scenarios

In the Interac Online method, to perform a purchase operation, you need to redirect a customer to the Interac Online service, while a refund is performed with the notification of a customer via web service.

Figure: Purchase by using Payment Page procedure diagram



Figure: Purchase by using Gate procedure diagram



Figure: Refund by using Gate procedure diagram



The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchase by using Payment Page

General information

In the Interac Online method, to perform a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Interac Online method selected. For more information about preselecting payment methods, see in Preselecting payment method.

The full sequence and particularities of the purchase process are provided below.



Figure: Purchase sequence by using Payment Page

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Interac Online payment method.
  8. The payment platform receives the purchase request for payment processing.
  9. The payment platform performs the internal purchase request processing and sends it to the Interac Online service.
  10. The purchase request is processed on the Interac Online service side.
  11. The Interac Online service generates the data for redirecting the customer to its service and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the Interac Online service.
  14. The customer selects a bank from the list.
  15. The customer is redirected to the selected bank website.
  16. The customer completes all the payment steps required on the bank website.
  17. The payment is processed on the bank side.
  18. The result is displayed to the customer on the bank website.
  19. The bank service sends the result notification to the Interac Online service.
  20. The Interac Online service sends the result notification to the payment platform.
  21. The payment platform sends a callback with the payment result to the web service.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Interac Online payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you need to consider when using the Interac Online method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • customer_id—the unique ID of the customer within your project
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor units
  2. The currency of payment can only be CAD
  3. To preselect Interac Online as the payment method on Payment Page for customers, pass the code interac-online in the force_payment_method parameter in the request for opening.
  4. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the Interac Online method, see Payment Page invocation parameters.
  5. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Interac Online method must include project, customer and payment IDs, the currency and the amount of a payment, the account number of a customer, and the signature as shown in the following example:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'CAD', 
      project_id: 35, 
      customer_id: 'u_customer',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the Interac Online method , see Payment Page invocation parameters.

Callback format

The Interac Online method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 100.00 CAD purchase made by the u_customer customer in the 3955 project.

Figure: Example of a successful purchase callback

{
{
        "project_id": 3955,
        "customer": {
            "id": "u_customer"
        },
        "payment": {
            "id": "EPd4b6-9544",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-23T13:33:05+0000",
            "method": "OnlineBankingViaInterac",
            "sum": {
                "amount": 10000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Aleksandrs",
            "last_name": "Ralovecs",
            "phone": "3712946371",
            "email": "a@mail.com",
            "ip_address": "192.168.15.1"
        },
        "operation": {
            "id": 30,
            "type": "sale",
            "status": "success",
            "date": "2019-04-23T13:33:05+0000",
            "created_date": "2019-04-23T13:32:37+0000",
            "request_id": "7923864cafc27ed6ac069688b",
            "sum_initial": {
                "amount": 10000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CAD"
            },
            "provider": {
                "id": 39551,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "9HiZID5GxZecmIIyvj+SXxcxbALPsdAXtkC4zkrhPohj7PXs4UxtFwP7RwHEdEe74/pbgV4LwA=="
    }
}

The following is the example of a callback for a purchase declined.

Figure: Example of a declined purchase callback

{
{
        "project_id": 3955,
        "customer": {
            "id": "u_customer"
        },
        "payment": {
            "id": "EPd4b6-9544",
            "type": "purchase",
            "status": "decline",
            "date": "2019-04-23T13:33:05+0000",
            "method": "OnlineBankingViaInterac",
            "sum": {
                "amount": 10000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Aleksandrs",
            "last_name": "Ralovecs",
            "phone": "3712946371",
            "email": "a@mail.com",
            "ip_address": "192.168.15.1"
        },
        "operation": {
            "id": 30,
            "type": "sale",
            "status": "decline",
            "date": "2019-04-23T13:33:05+0000",
            "created_date": "2019-04-23T13:32:37+0000",
            "request_id": "7923864cafc27ed6ac069688b",
            "sum_initial": {
                "amount": 10000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CAD"
            },
            "provider": {
                "id": 39551,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "100",
            "message": "General decline"
         },
        "signature": "9HiZID5GxZecmIIyvj+SXxcxbALPsdAXtkC4zkrhPohj7PXs4UxtFwP7RwHEdEe74/pbgV4LwA=="
    }
}

Related topics

The following topics might be useful when implementing payments through Payment Page:

Purchase by using Gate

General information

In the Interac Online methods, when processing a purchase by using Gate, the merchant web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Perform redirecting customer to the Interac Online form.
  3. Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.



Figure: Purchase sequence by using Gate

  1. A customer initiates a purchase through one of the Interac Online group banks on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the Interac Online service.
  7. The request is processed on the Interac Online side.
  8. The Interac Online service sends the data for redirecting the customer to its service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the return_url object to the web service.
  10. The customer is redirected from the web service to the Interac Online service.
  11. The customer selects a bank from the list.
  12. The customer is redirected to the selected bank website.
  13. The customer completes all the payment steps required on the bank website.
  14. The payment is processed on the bank side.
  15. The result is displayed to the customer on the bank website.
  16. The bank service sends the payment result notification to the Interac Online.
  17. The Interac Online service sends the payment result notification to the payment platform.
  18. The ECommPay payment platform sends a callback to the web service.

It is necessary to use the internal Interac Online style guide while developing the payment page displayed to customers. Display the specific service design(s) (logos), or wordmark (e.g. the text “INTERAC Online”). The first use of the INTERAC wordmark has the ® notation beside the word “INTERAC” in superscript text. For example, “Interac®” (English). Show the following footnote on the same page as the wordmark: “® Trade-mark of Interac Corp. Used under license”. The style guide and logos you can obtain from your ECommPay key account manager.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Interac Online payment method and provide the information about formats of the data for redirecting customers and the information about the format of callbacks with payment results. The general information about working with API see in the API Description section.

Request format

There are several things you must consider when using purchase requests in the Interac Online method:
  1. You perform purchase by sending the /v2/payment/online-banking/interac/sale request by using POST (HTTP) method. This request refers to the online banking payment requests group: /v2/payment/online-banking/{payment_method}/sale
  2. The following objects and parameters must be specified in the request:
    • Object general—general purchase information:
      • project_id—project identifier
      • payment_id—unique payment identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address— IP address
      • first_name—first name
      • last_name—last name
      • email—email address
      • phone—phone number
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—purchase currency in the ISO-4217 alpha-3 format
  3. The currency of payment can only be CAD
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Interac Online method must include project, customer and payment IDs, the currency and the amount of a payment, customer data, and the signature as shown in the following example:

Figure: Purchase request example

{
    "general": {
        "project_id": 35,
        "payment_id": "Payment 12",
        "signature": "2tlMuYxLW9Yu6RETr8pdCfmi0UPE8euD+o4EVPjLyfbOQ+9ajAteg5lPk96Q=="
  },
    "customer": {
        "id": "customer_u",
        "ip_address": "1.1.1.1",
        "first_name": "John",
        "last_name": "Johnson",      
        "email": "johnson@mail.com",  
        "phone": "16132354341"
  },
    "payment": {
        "amount": 10000,
        "currency": "CAD"
  }
}

Formats of the customer redirection data

To redirect a customer from the web service to the bank site, you must receive a callback from the payment platform containing the URL for redirection in the return_url.url parameter and data to be sent in the request body in the return_url.body parameter, and use these parameters when opening the bank’s HTML page using the method specified in the return_url.method parameter.

The following is the callback fragment containing the token for purchase.

 "body": {
                        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
                        "transaction": 5003288000015062
                    },
                    "method": "GET",
                    "url": "https://interac.express-connect.com/webflow?"
                },

Callback format

The Interac Online method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 100.00 CAD purchase made by the u_customer customer in the 3955 project.

Figure: Example of a successful purchase callback

{
{
        "project_id": 3955,
        "customer": {
            "id": "u_customer"
        },
        "payment": {
            "id": "EPd4b6-9544",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-23T13:33:05+0000",
            "method": "OnlineBankingViaInterac",
            "sum": {
                "amount": 10000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Aleksandrs",
            "last_name": "Ralovecs",
            "phone": "3712946371",
            "email": "a@mail.com",
            "ip_address": "192.168.15.1"
        },
        "operation": {
            "id": 30,
            "type": "sale",
            "status": "success",
            "date": "2019-04-23T13:33:05+0000",
            "created_date": "2019-04-23T13:32:37+0000",
            "request_id": "7923864cafc27ed6ac069688b",
            "sum_initial": {
                "amount": 10000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CAD"
            },
            "provider": {
                "id": 39551,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "9HiZID5GxZecmIIyvj+SXxcxbALPsdAXtkC4zkrhPohj7PXs4UxtFwP7RwHEdEe74/pbgV4LwA=="
    }
}

The following is the example of a callback for a purchase declined.

Figure: Example of a declined purchase callback

{
{
        "project_id": 3955,
        "customer": {
            "id": "u_customer"
        },
        "payment": {
            "id": "EPd4b6-9544",
            "type": "purchase",
            "status": "decline",
            "date": "2019-04-23T13:33:05+0000",
            "method": "OnlineBankingViaInterac",
            "sum": {
                "amount": 10000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Aleksandrs",
            "last_name": "Ralovecs",
            "phone": "3712946371",
            "email": "a@mail.com",
            "ip_address": "192.168.15.1"
        },
        "operation": {
            "id": 30,
            "type": "sale",
            "status": "decline",
            "date": "2019-04-23T13:33:05+0000",
            "created_date": "2019-04-23T13:32:37+0000",
            "request_id": "7923864cafc27ed6ac069688b",
            "sum_initial": {
                "amount": 10000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CAD"
            },
            "provider": {
                "id": 39551,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "100",
            "message": "General decline"
        },
        "signature": "9HiZID5GxZecmIIyvj+SXxcxbALPsdAXtkC4zkrhPohj7PXs4UxtFwP7RwHEdEe74/pbgV4LwA=="
    }
}

Related topics

The following topics might be useful when implementing payments through Gate:

Refund by using Gate

General information

Interac Online supports full and partial refunds processing. To perform a refund through the Interac Online method, merchant's web service sends a request with all the required parameters and signature to ECommPay URL, and receives a callback with the payment result. The full sequence of the refund process is provided below.



Figure: Refund sequence by using Gate

  1. A customer orders a refund on the merchant's web service side.
  2. Merchant's web service sends the request for the refund processing by using Gate to the appropriate ECommPay URL.
  3. Gate redirects the request to the ECommPay payment platform.
  4. The payment platform performs all the necessary checks and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  6. The payment platform redirects the refund request to the Interac Online service.
  7. The payment is processed on the Interac Online side.
  8. Interac Online sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the refund result from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Interac Online payment method and provide the information on the format of callbacks with refund results.

Request format

There are several things you must consider when using refund requests in the Interac Online method:
  1. You perform refund by sending the /v2/payment/online-banking/interac/refund request by using POST (HTTP) method. This request refers to the online banking payment requests group: /v2/payment/online-banking/{payment_method}/refund
  2. The following objects and parameters must be specified in any request:
    • Object general—general refund information:
      • project_id—project identifier
      • payment_id—unique refund identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object customer—customer information:
      • ip_address—customer IP address
    • Object payment—refund information:
      • description—comment or description
      • amount—refund amount in minor units (mandatory for partial refund only)
      • currency—refund currency in ISO-4217 alpha-3 format (mandatory for partial refund only)
  3. If required, you can also add any other additional parameters Gate supports.

Thus, a correct refund request in the Interac Online method must include project and payment IDs, customer IP address, currency, amount, and the description of the refund, as shown in the following example:

Figure: Example of a refund request

{
   "general": {    
    "project_id": 239,    
    "payment_id": "refund_02",   
    "signature": "of8k9xerKSK4XL1QFaDH3p9Mh0CIcjmOwSwKJ7Kdfgds/\dsf3fbsa3LTZYO56lCv+f1M0Sf/7eg=="
  },  
   "customer": {    
     "ip_address": "1.2.3.4" 
  },  
   "payment": {    
     "amount": 10000,    
     "currency": "CAD",
     "description": "refund"
  }
}

Callback format

The Interac Online method uses the standard format for callbacks to deliver refund results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 100.00 CAD refund for the customer account in the 3955 project.

Figure: Example of a successful refund callback

{
 {
        "project_id": 3955,
        "customer": {
            "id": "22007b"
        },
        "payment": {
            "id": "EPd4b6-9544",
            "type": "purchase",
            "status": "refunded",
            "date": "2019-04-23T13:37:58+0000",
            "method": "OnlineBankingViaInterac",
            "sum": {
                "amount": 2000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Aleksandrs",
            "last_name": "Ralovecs",
            "phone": "3712946371",
            "email": "a@mail.com",
            "ip_address": "192.168.15.1"
        },
        "fee": {
            "amount": 0,
            "currency": "CAD"
        },
        "operation": {
            "id": 31,
            "type": "refund",
            "status": "success",
            "date": "2019-04-23T13:37:58+0000",
            "created_date": "2019-04-23T13:37:53+0000",
            "request_id": "72a34023909e209a32a666c2f322dd7ca7f2",
            "sum_initial": {
                "amount": 2000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 2000,
                "currency": "CAD"
            },
            "provider": {
                "id": 39551,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "jxpv2GmZmQi2W6cEy3m9IyjfAAXNByn6RxpHOY7Je0A8rN7FfEvsDs4HC9X0Im3vQ61xJ0Ag=="
    }
}

The following is the example of a callback for a refund declined.

Figure: Example of a declined refund callback

{
 {
        "project_id": 3955,
        "customer": {
            "id": "22007b"
        },
        "payment": {
            "id": "EPd4b6-9544",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-23T13:37:58+0000",
            "method": "OnlineBankingViaInterac",
            "sum": {
                "amount": 1000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Aleksandrs",
            "last_name": "Ralovecs",
            "phone": "3712946371",
            "email": "a@mail.com",
            "ip_address": "192.168.15.1"
        },
        "fee": {
            "amount": 0,
            "currency": "CAD"
        },
        "operation": {
            "id": 31,
            "type": "refund",
            "status": "decline",
            "date": "2019-04-23T13:37:58+0000",
            "created_date": "2019-04-23T13:37:53+0000",
            "request_id": "e209a32a666c2f322dd7ca7f2",
            "sum_initial": {
                "amount": 1000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "CAD"
            },
            "provider": {
                "id": 39551,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "100",
            "message": "General decline"
        },
        "signature": "jxpv2GmZmQi2W6cEy3m9IyjfAAXNByn6RxpHOY7Je0A8rN7FfEvsDs4HC9X0Im3vQ61xJ0Ag=="
    }
}

Related topics

The following topics might be useful when implementing payments through Gate:

Analysis of payments results

As with other payment methods ECommPay offers, when using the Interac Online method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

  • Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ECommPay technical support.