Interac Combined Pay-in

Overview

Interac Combined Pay-in is a Canadian payment method that allows customers to make payments through bank transfers and online banking services. Purchases are performed by using Payment Page and Gate.

General information

Payment method type
  • bank transfer
  • 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 Combined Pay-in 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 by using the Interac Combined Pay-in payment method requires merchant's web service, one of ECommPay interfaces, and the ECommPay payment platform, as well as Interac technical facilities.



Operations support

  Interfaces Amounts, CAD
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum
Purchases + + * *

* The maximum allowed purchase amount per customer per day is 2,500.00 CAD.

Processing scenarios

In the Interac Combined Pay-in method, to perform a purchase operation, you need to redirect customer to the Interac service.

Figure: Purchase by using Payment Page



Figure: Purchase by using Gate



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 Combined Pay-in method, when processing 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 one of the Interac Combined Pay-in methods selected. For more information about preselecting payment methods, see in Preselecting payment methods. The full sequence and particularities of the purchase process are provided below.



Figure: Purchase 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 Combined Pay-in method.
  8. The payment platform receives the purchase request for payment processing from Payment Page.
  9. The payment platform performs the internal purchase request processing and sends it to the Interac service.
  10. The purchase request is processed on the Interac service side.
  11. The Interac service generates the data for redirecting the customer to its website form 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 website.
  14. The customer completes all the payment steps required.
  15. The payment is processed on the Interac side.
  16. The result is displayed to the customer on the Interac website.
  17. The customer is redirected to Payment Page.
  18. The Interac service sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result to the web service.
  20. The payment platform sends the result to Payment Page.
  21. A page with the payment result information is displayed to the customer on Payment Page.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Interac Combined Pay-in 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 Combined Pay-in method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_amount—payment amount in minor units
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • customer_id—the unique ID of the customer within your project
  2. It is recommended to specify the first and last names, phone number and e-mail address of the customer in the customer_first_name, customer_last_name, customer_phone and customer_email additional parameters. If the request is missing the parameters, on Payment Page the additional fields are displaying to the customer to input missing data. For more details about clarification, see Submission of additional payment information.
  3. The currency of payment can only be CAD.
  4. If you need to have payment form displayed with the Interac Combined Pay-in method selected, set the force_payment_method parameter to interac-cpi.
  5. If required, you can also add any other additional parameters Payment Page supports.
  6. 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 Combined Pay-in method must include project, customer, and payment IDs, customer information, the currency and the amount of the payment, as shown in the following example:

EPayWidget.run(
    { payment_id: 'ID_183', 
      payment_amount: 1000, 
      payment_currency: 'CAD', 
      project_id: 238,  
      customer_id: 'customer1',
      customer_first_name: 'Jane',
      customer_last_name: 'Doe',
      customer_phone: '12345678',
      customer_email: 'jane@example.com',
      signature: "hlhydUV+SmGJYhm6G47NknsqVx2TdMZrnJ9V5Ly...=="
    }
)

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

Callback format

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

Note that unlike other payment methods, in the Interac Combined Pay-in method, the callbacks contain the first, last names, phone number, email and IP addresses of the customer in the first_name, last_name, phone, email, ip_address parameters of the customer_data object.

The following is the example of a callback with an information about successful 10.00 CAD purchase made in the 8283 project.

Figure: Example of a successful purchase callback

 {
        "project_id": 8283,
        "payment": {
            "id": "EP4a54-1d00",
            "type": "purchase",
            "status": "success",
            "date": "2020-12-01T07:32:53+0000",
            "method": "OnlineBankingViaInteracCpi",
            "sum": {
                "amount": 1000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        }, 
        "customer_data": {
            "first_name": "Jane",
            "last_name": "Doe",
            "phone": "1234567890",
            "email": "doe@example.com",
            "ip_address": "192.168.20.1"
        },
        "fee": {
            "amount": 0,
            "currency": "CAD"
        },
        "merchant_account_id": 8283,
        "operation": {
            "id": 50,
            "type": "sale",
            "status": "success",
            "date": "2020-12-01T07:32:53+0000",
            "created_date": "2020-12-01T07:32:39+0000",
            "request_id": "5318b90295e48d49e0087f353aceb6ad889589bd06ed64-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "CAD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 8283,
                "payment_id": "50",
                "auth_code": "",
                "endpoint_id": "IDP"
            }
        },
        "signature": "OpG9CTFTy5b81NzxYKZbyVNq8XJDOhjCwiym5z6Ig9gQwUWIs7Dpw=="
    }

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

Figure: Example of a declined purchase callback

{
        "project_id": 8283,
        "payment": {
            "id": "EP8399-a2e9",
            "type": "purchase",
            "status": "decline",
            "date": "2020-11-24T13:19:33+0000",
            "method": "OnlineBankingViaInteracCpi",
            "sum": {
                "amount": 10000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Jane",
            "last_name": "Doe",
            "phone": "1234567890",
            "email": "doe@example.com",
            "ip_address": "192.168.20.1"
        },
        "fee": { 
            "amount": 0,
            "currency": "CAD"
        },
        "merchant_account_id": 8283, 
        "operation": {
            "id": 58,
            "type": "sale",
            "status": "decline",
            "date": "2020-11-24T13:19:33+0000",
            "created_date": "2020-11-24T13:18:51+0000",
            "request_id": "dbc44e0f97e11bffff8eeaf51bef076e3363662d97d-00000001",
            "sum_initial": {
                "amount": 10000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CAD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 8283,
                "payment_id": "58",
                "auth_code": ""
            }
        },
        "signature": "SjrAIoboAsVeNF2r89BDBkIjZEXHNddUY9GaiWlbJfTIn0shkdDRg=="
    }

Related topics

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

Purchase by using Gate

General information

In the Interac Combined Pay-in method, 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 the redirection of a customer to the Interac service.
  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 by using Gate

  1. A customer initiates a purchase through Interac Combined Pay-in 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 service.
  7. The request is processed on the Interac side.
  8. The Interac service sends the data for redirecting the customer to the Interac service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the Interac service.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the Interac side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant's web service.
  15. The Interac service sends the payment result notification to the payment platform.
  16. The payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

It is necessary to use the internal Interac Combined Pay-in style guide while developing the payment page displayed to customers. Display the specific service design(s) (logos), or wordmark (e.g. the text “INTERAC Combined Pay-in”). 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 Combined Pay-in payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when using purchase requests in the Interac Combined Pay-in method:
  1. You perform purchase by sending the /v2/payment/online-banking/interac-cpi/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 any request:
    • Object general—general request identification information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • 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—customer IP address
    • Object payment—payment information:
      • amount—purchase amount in minor units
      • currency—purchase currency in ISO-4217 alpha-3 format
  3. It is recommended to specify the first and last names, phone number and IP address of the customer. If the request is missing the parameters, the list of parameters is sent in the clarification callback. For more details, see Submission of additional payment information.

    It is recommended to specify the following parameters:

    • Object customer—customer information:
      • first_name—first name
      • last_name—last name
      • phone—phone number
      • email—email address
  4. The currency of purchase can only be CAD.
  5. If required, you can also add any other additional parameters Gate supports.
  6. 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 Combined Pay-in method must include project, customer and payment IDs, customer information, currency and amount of the purchase, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
    "project_id": 125,
    "payment_id": "ID_184",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
  },
  "customer": {
    "ip_address": "123.56.38.76",
    "first_name": "Jane",
    "last_name": "Doe",
    "phone": "12345678",
    "email": "jane@example.com",
    "id": "123"
    },
  "payment": {
    "amount": 1000,
    "currency": "CAD"
  }
}

Formats of the customer redirection data

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

The following is the callback fragment containing the redirection data.

{
"type":"redirect",
"code":"0",
 "redirect_data": {
    "body": [],
    "method": "POST",
    "url": "https://example.com/webflow?transaction=12345&token=eyJhbGciOiJI"
  }
}

Callback format

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

Note that unlike other payment methods, in the Interac Combined Pay-in method, the callbacks contain the first, last names, phone number, email and IP addresses of the customer in the first_name, last_name, phone, email, ip_address parameters of the customer_data object.

The following is the example of a callback with an information about successful 10.00 CAD purchase made in the 8283 project.

Figure: Example of a successful purchase callback

 {
        "project_id": 8283,
        "payment": {
            "id": "EP4a54-1d00",
            "type": "purchase",
            "status": "success",
            "date": "2020-12-01T07:32:53+0000",
            "method": "OnlineBankingViaInteracCpi",
            "sum": {
                "amount": 1000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        }, 
        "customer_data": {
            "first_name": "Jane",
            "last_name": "Doe",
            "phone": "1234567890",
            "email": "doe@example.com",
            "ip_address": "192.168.20.1"
        },
        "fee": {
            "amount": 0,
            "currency": "CAD"
        },
        "merchant_account_id": 8283,
        "operation": {
            "id": 50,
            "type": "sale",
            "status": "success",
            "date": "2020-12-01T07:32:53+0000",
            "created_date": "2020-12-01T07:32:39+0000",
            "request_id": "5318b90295e48d49e0087f353aceb6ad889589bd06ed64-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "CAD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 8283,
                "payment_id": "50",
                "auth_code": "",
                "endpoint_id": "IDP"
            }
        },
        "signature": "OpG9CTFTy5b81NzxYKZbyVNq8XJDOhjCwiym5z6Ig9gQwUWIs7Dpw=="
    }

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

Figure: Example of a declined purchase callback

{
        "project_id": 8283,
        "payment": {
            "id": "EP8399-a2e9",
            "type": "purchase",
            "status": "decline",
            "date": "2020-11-24T13:19:33+0000",
            "method": "OnlineBankingViaInteracCpi",
            "sum": {
                "amount": 10000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Jane",
            "last_name": "Doe",
            "phone": "1234567890",
            "email": "doe@example.com",
            "ip_address": "192.168.20.1"
        },
        "fee": { 
            "amount": 0,
            "currency": "CAD"
        },
        "merchant_account_id": 8283, 
        "operation": {
            "id": 58,
            "type": "sale",
            "status": "decline",
            "date": "2020-11-24T13:19:33+0000",
            "created_date": "2020-11-24T13:18:51+0000",
            "request_id": "dbc44e0f97e11bffff8eeaf51bef076e3363662d97d-00000001",
            "sum_initial": {
                "amount": 10000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CAD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 8283,
                "payment_id": "58",
                "auth_code": ""
            }
        },
        "signature": "SjrAIoboAsVeNF2r89BDBkIjZEXHNddUY9GaiWlbJfTIn0shkdDRg=="
    }

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 Combined Pay-in 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 (Old 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 (Old 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.