eCashout

Overview

eCashout is a Canadian payment method for processing payout by using bank transferring services. Payouts are performed by using Gate and Dashboard.


Payment method type	bank transfer
Countries and regions	Canada
Payment currencies	CAD
Currency conversion
Purchases
Payouts
COF payments
Full refunds
Partial refunds
Chargebacks
Notes
Onboarding and access fee	refer to your Monetix key account manager

Interaction diagram

Payment processing by using the eCashout payment method requires merchant's web service, one of Monetix interfaces, and the Monetix payment platform, as well as provider's the technical facilities.

Operations support


	Interfaces			Amounts, CAD
	Payment Page	Gate	Dashboard	minimum	maximum
Payouts					10, 000.00

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section and click the Payment methods tab.

Processing scenarios

In the eCashout method, to perform a payout you need to notify of a customer via the web service.

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

Payout by using Gate

General information

To perform a payout through the eCashout method, merchant's web service sends a request with all the required parameters and signature to Monetix URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.

Figure 2. Payout sequence by using Gate

Merchant's web service sends the payout request for processing the payout by using Gate to the appropriate Monetix URL.
Gate redirects the request to the Monetix payment platform.
The payment platform performs all the necessary check and processes the request.
The reply with the request processing results is sent to the merchant's web service. For more information, see Response structure.
The payment platform redirects the payout request to the eCashout service.
The payout is processed on the eCashout side.
eCashout sends the result notification to the payment platform.
The payment platform sends a callback with the payment result to the web service.
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 eCashout 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 eCashout method:

You perform payouts by sending one of the /v2/payment/bank-transfer/interac/payout request by using POST (HTTP) method. This is a bank transfer payment request group: /v2/payment/bank-transfer/{payment_method}/payout
The following objects and parameters must be specified in any request:
- general—object with 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
- customer—object with customer information:
  - id—identification number in the project
  - ip_address— customer device IP
  - first_name—first name
  - last_name—last name
  - email—email address
  - phone—phone number
- payment—object with payout information:
  - amount—payout amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
  - currency—payout currency
- account—object with customer account information:
  - number—account number (the display name of the corresponding input field must be Account Number)
  - fin—financial institution number (the display name of the corresponding input field must be Financial Institution Number)
  - iban—account transit number (the display name of the corresponding input field must be Transit or Branch).
The currency of payout can only be CAD.
If required, you can also add any other additional parameters that are supported by Gate .

Here is an example of data from a payout request.

Figure 3. Payout request example

 {
  "general": {
    "project_id": 3027,
    "payment_id": "Payout 12",
    "signature": "M1vT4q9c8hA8xCjEwGFSANwbxHS+9XAaq7vt3/Jkn+aJmGA4...=="
  },
   "customer": {
     "id": "customer_u",
     "ip_address": "198.51.100.47",
     "first_name": "John",
     "last_name": "Doe",      
     "email": "johndoe@example.com",  
     "phone": "16132354341"
  },
   "account": {    
     "number": "1234567",
     "fin": "111",
     "iban": "12345"
  },
  "payment": {
     "amount": 10000,
     "currency": "CAD"
  }
}

Callback format

In the eCashout method, the callbacks that deliver payout results use the standard format described in Callbacks in Gate.

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 4. Example of a successful payout callback

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

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

Figure 5. Example of a declined payout callback

{
{
        "project_id": 763,
        "payment": {
            "id": "577",
            "type": "payout",
            "status": "decline",
            "date": "2019-04-23T11:21:33+0000",
            "method": "BankTransferViaInterac",
            "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": "eF5LBsZWb4tuAGXDih1H0l6akYdzIB1gm88z7M0z4zWxNOg=="
        }
}

Payout by using Dashboard

To make a payout through Dashboard, the merchant sends a request and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard:

single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

Analysis of payments results

As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.

You can load and analyze all the necessary information in Dashboard (dash-light.trxhost.com), for instance you can use the analytic panels in the Analytics section for this purpose.

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 format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
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 means of sending requests to the /operations/get endpoint.

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