Interac E-Transfer Pay-out

Overview

Interac E-Transfer Pay-out is a Canadian payment method for processing payout by using bank transferring services. Payouts are performed by using Gate and Dashboard (Old Dashboard).

General information

Payment method type bank transfer
Countries and regions CA
Payment currencies CAD
Currency conversion
Purchases
Payouts +
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
Onboarding and access fee refer to your ECommPay key account manager

Interaction diagram

Payment processing by using the Interac E-Transfer Pay-out payment method requires merchant's web service, one of ECommPay interfaces, and the ECommPay payment platform, as well as provider's the technical facilities.



Operations support

  Interfaces Amounts, CAD
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum
Payouts + + 10, 000.00

Processing scenarios

In the Interac E-Transfer Pay-out method, to perform a payout you need to notify of a customer via the web service.

Figure: Payout 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.

Payout by using Gate

General information

To perform a payout through the Interac E-Transfer Pay-out 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 payout process is provided below.



Figure: Payout by using Gate

  1. Merchant's web service sends the payout request for processing the payout by using Gate to the appropriate ECommPay URL.
  2. Gate redirects the request to the ECommPay payment platform.
  3. The payment platform performs all the necessary check and processes the request.
  4. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  5. The payment platform redirects the payout request to the Interac E-Transfer Pay-out service.
  6. The payout is processed on the Interac E-Transfer Pay-out side.
  7. Interac E-Transfer Pay-out sends the result notification to the payment platform.
  8. The payment platform sends a callback with the payment result to the web service.
  9. The customer receives the payout 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 E-Transfer Pay-out payment method and provide the information on the format of callbacks with payout results.

Request format

There are several things you must consider when using payout requests in the Interac E-Transfer Pay-out method:
  1. You perform payouts by sending one the /v2/payment/interac/payout request by using POST (HTTP) method:
  2. The following objects and parameters must be specified in any request:
    • Object general—general payout information:
      • project_id—project identifier
      • payment_id—unique payout 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—identification number in the project
      • ip_address— IP address
      • first_name—first name
      • last_name—last name
      • email—email address
      • phone—phone number
    • Object payment—payout information:
      • amount—payout amount
      • currency—payout currency
  3. The currency of payout can only be CAD.
  4. If required, you can also add any other additional parameters that are supported by Gate .

Thus, a correct payout request in the Interac E-Transfer Pay-out method must include project, payment, customer, and bank IDs, customer data, currency and amount of the payout, as shown in the following example:

Figure: Payout request example

 {
  "general": {
    "project_id": 3027,
    "payment_id": "Payout 12",
    "signature": "M1vT4q9c8hA8xCjEwGFSANwbxHS+9XAaq7vt3/Jkn+aJmGA4...=="
  },
   "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"
  }
}

Callback format

In the Interac E-Transfer Pay-out method, the callbacks that deliver payout results use the standard format described in Callbacks.

The following is the example of a callback with the information about successful 100.00 CAD payout made to the customer_u customer in the 763 project.

Figure: Example of a successful payout callback

{
 {
        "project_id": 763,
        "payment": {
            "id": "227",
            "type": "payout",
            "status": "success",
            "date": "2019-04-23T11:20:55+0000",
            "method": "Interac",
            "sum": {
                "amount": 10000,
                "currency": "CAD"
            },
            "description": ""
        },
        "customer": {
            "id": "customer_u",
            "phone": "9510000000"
        },
        "operation": {
            "id": 66,
            "type": "payout",
            "status": "success",
            "date": "2019-04-23T11:20:55+0000",
            "created_date": "2019-04-23T11:20:50+0000",
            "request_id": "88cbdf4e4d",
            "sum_initial": {
                "amount": 10000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CAD"
            },
            "provider": {
                "id": 1394,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "eF5LBsZWb4tuAGXDih1H0l65akYdzIB1gm88z7M0z4zWxNOg=="
        }
}

The following is the example of a callback for a payout rejected.

Figure: Example of a declined payout callback

{
{
        "project_id": 763,
        "payment": {
            "id": "577",
            "type": "payout",
            "status": "decline",
            "date": "2019-04-23T11:21:33+0000",
            "method": "Interac",
            "sum": {
                "amount": 100000,
                "currency": "CAD"
            },
            "description": ""
        },
        "account": {
            "number": "1234567"
        },
        "customer": {
            "id": "customer_u"
        },
        "operation": {
            "id": 1000000063,
            "type": "payout",
            "status": "decline",
            "date": "2019-04-23T11:21:33+0000",
            "created_date": "2019-04-23T11:21:25+0000",
            "request_id": "96eb9ba72a2131a22a705c5b27e9",
            "sum_initial": {
                "amount": 100000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "CAD"
            },
            "provider": {
                "id": 1393,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "100",
            "message": "General decline"
            },
        "signature": "eF5LBsZWb4tuAGXDih1H0l67WkYdzIB1gm88z7M0z4zWxNOg=="
        }
}

Related topics

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

Payouts by using Dashboard (Old Dashboard)

To make a payout through Dashboard (Old Dashboard), the merchant sends a request, and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard (Old Dashboard):
  • as a single payout—in this case, you must specify the currency and amount for a payout available for this method, and fill in all fields required on the Dashboard (Old Dashboard) interface in accordance with the selected payment method
  • as a part of a mass payment—in this case, all parameters are specified in a CSV file in accordance with the requirements in the Выплаты через Gate section (except for the signature)

Information about performed payouts is displayed in the Payments section of Dashboard (Old Dashboard).

More detailed information on the payout processing by using Dashboard (Old Dashboard) is provided in the Performing payouts section.

Analysis of payments results

As with other payment methods ECommPay offers, when using the Interac E-Transfer Pay-out 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.