Payouts to bank accounts in other countries

Overview

Payouts to bank accounts in other countries is a payment method that allows you to perform payouts to customers by bank transfers. Payouts through this method are available by using Gate.

General information

Payment method type bank transfers
Countries and regions AR, AU, BR, CA, CN, CO, CL, Europe (SEPA countries), GB, HK, KR, IN, ID, LK, MX, MY, NP, PE, PH, SG, TH, TR, US, UY, VN
Payment currencies AUD, ARS, BRL, CAD, CLP, CNY, COP, EUR, GBP, HKD, INR, IDR, KRW, LKR, MYR, MXN, NPR, PEN, PHP, SGD, THB, TRY, USD, UYU, VND
Currency conversion
Purchases
Payouts +
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes payment processing in each country supports only the country's national currency
Onboarding and access fee refer to your ecommpay key account manager

Interaction diagram

Payment processing by using the Payouts to bank accounts in other countries payment method requires merchant's web service and the ecommpay payment platform, as well as provider's technical facilities that provide interaction with banking services.



Operations support

  Interfaces Amounts Times *
Payment Page CMS Plug-ins Gate Dashboard minimum maximum basic threshold
Payouts + + 30 days
* The basic and threshold times are defined as follows:
  • The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
  • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ecommpay technical support.

Processing scenarios

In the Payouts to bank accounts in other countries method, to perform a payout, you need to notify customer via merchant's 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.

Payouts by using Gate

General information

To perform a payout through the Payouts to bank accounts in other countries 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. The customer requests a payout.
  2. Merchant's web service sends the request for the payout 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 payout request to the provider service.
  7. The payout is processed on the provider side.
  8. Provider service 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 notification about 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 Payouts to bank accounts in other countries 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 Payouts to bank accounts in other countries method:
  1. You send payout requests by sending the /v2/payment/bank-transfer/world/payout request by using HTTP method POST. This request refers to the bank transferring requests group: /v2/payment/bank-transfer/{payment_method}/payout.
  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 payment—payout information:
      • amount—payout amount
      • currency—payout currency in the ISO-4217 alpha-3 format
    • Object customer—recepient information:
      • id—identifier
      • ip_address—IP address
  3. In requests specifying EUR and GBP currencies, when working with some providers, it may be necessary to pass the recipient's country code in the ISO 3166-1 alpha-2 format in the value of two parameters: payment.extra_param and customer.country. This is relevant for recipients from the following countries: AR, AU, BR, CA, CN, CO, CL, GB, HK, KR, IN, ID, LK, MX, MY, NP, PE, PH, SG, TH, TR, US, UY, VN.

    Refer to your ecommpay key account manager for clarification regarding the requirement for such an indication of the country code.

  4. It is recommended to specify a number of additional parameters. If the request is missing the parameters, the list of parameters is sent in the clarification callback. The callback body is formed in accordance with the JSON-Schema specification. For more details, see Submission of additional payment information.

    It is recommended to use the following objects and parameters:

    • Object customer—recipient information:
      • address—address
      • country—country code in the ISO 3166-1 alpha-2 format
      • person_type—account type (available values: individual for accounts of individuals, company for accounts of companies)
      • first_name—name of the recipient (only the first name is sufficient) or title of the company
    • Object account—recipient account information:
      • number—account number
      • routing_type—type of interbank transfer system, allowed values: ACH CODE—for USA, BANK CODE—for Hong Kong, BSB CODE—for Australia, IFSC—for India, SORT CODE—for UK, TRANSIT NUMBER—for Canada, BRANCH CODE—for Brazil, SWIFT—for other countries supported by this payment method
      • routing_number—bank identifier in the interbank transfer system
  5. Also, depending on the specifics of a particular payment and the peculiarities of different banks, other parameters may be needed to process a payment. In this case, an additional clarification callback is sent to clarify information about the payment. These parameters include:
    • Object payment—payout information:
      • local_conversion_currency—currency code of the recipient country in the ISO-4217 alpha-3 format (can be required if US or CA country code is specified in the customer.country parameter; however, in certain cases, the absence of this parameter in the initial request may lead to a declined payment; refer to ecommpay technical support if you have questions about using this parameter)
    • Object sender—sender information:
      • beneficiary_relationship—legal relationship between the sender and the recipient (for example employee, buyer, etc.)
    • Objectcustomer—recipient information:
      • city—city
      • email—email address
      • phone—must be specified using a country code and without punctuation or special characters, for example 79031234567
      • state—state or region
      • zip—zip code
      • Object identify—information about the document which establishes identity:
        • doc_type—type of the identity document, for example Passport, Company Organization Code, Company Social Credit Code, etc.
        • doc_number—number of the identity document
    • Object account—recipient account information:
      • type—type of bank account, for exampleChecking for specifying a checking account, Saving for a savings account, etc.)
      • bank_name—recipient bank name
      • bank_code—recipient bank code (consists of three digits, can be required if BRL, HKD or CAD currency code is specified in the payment.currency parameter; refer to your ecommpay key account manager for the list of allowed bank codes)
  6. Payment currency can be only one of the supported ones.
  7. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Payouts to bank accounts in other countries method must include project and payment IDs, signature, currency and amount of the payout, customer and account information (with additional information if required), as shown in the following example:

Figure: Example of a payout request

 {
  "general": {
    "project_id": 3027,
    "payment_id": "payout1",
    "signature": "M1vT4q9c8hA8xCjEwGFSANI+aJmGA4jH6bgBOp8DTf8d/XdoV+vd7Q=="
  },
   "payment": {
     "amount": 1000,
     "currency": "EUR"
     "local_conversion_currency": "EUR",
     "extra_param": "US"
  },
   "sender": {
     "beneficiary_relationship": "Employee"
  },
   "customer": {
     "id": "customer1",
     "ip_address": "1.2.3.4",
     "address": "12 Spring Rd",
     "country": "US",
     "person_type": "individual",
     "first_name": "John",
     "city": "Los Angeles",
     "email": "customer@example.com",
     "phone": "145600198754",
     "state": "California",
     "zip": "12345",
     "identify": { 
         "doc_type": "Passport",
         "doc_number": "1234"
      }
  },
   "account": {
     "number": "1020304010",
     "routing_type": "SWIFT",
     "routing_number": "ADCBINBB"
     "type": "Saving",
     "bank_name": "Example Bank",
     "bank_code": "123"
  }
}

Callback format

The Payouts to bank accounts in other countries method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 1,00 EUR payout made in the 1774 project.

Figure: Example of a successful payout callback

{
        "customer": {
            "id": "1"
        },
        "account": {
            "number": "LV81HABA06"
        },
        "project_id": 22351,
        "payment": {
            "id": "TEST_2_17022022",
            "type": "payout",
            "status": "success",
            "date": "2022-02-17T13:45:34+0000",
            "method": "world",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 55969010087671,
            "type": "payout",
            "status": "success",
            "date": "2022-02-17T13:45:34+0000",
            "created_date": "2022-02-17T13:45:06+0000",
            "request_id": "0d9e9a0199baccc886a320da858e93919ce-00055970",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2421,
                "payment_id": "PY23297248",
                "auth_code": "",
                "date": "2022-02-17T13:45:26+0000"
            }
        },
        "signature": "dRj303+vVN+HghppyhEAK0c658yzVALLB4v192P6Bb8vhmA=="
    }

The following is the example of a callback for a payout declined due to insufficient funds on merchant balance.

Figure: Example of a declined payout callback

{
    "project_id": 1774,
    "payment": {
        "id": "1234567891",
        "type": "payout",
        "status": "decline",
        "date": "2020-04-06T11:34:51+0000",
        "method": "world",
        "sum": {
            "amount": 100,
            "currency": "EUR"
        },
        "description": "Order 67"
    },
    "account": {
        "number": "123"
    },
    "customer": {
        "id": "31234"
    },
    "operation": {
        "id": 538,
        "type": "payout",
        "status": "decline",
        "date": "2020-04-06T11:33:51+0000",
        "created_date": "2020-04-06T11:33:44+0000",
        "request_id": "ea8cf9c100f6ce886540493cfc99be653d03e76e0500b8-00000002",
        "sum_initial": {
            "amount": 100,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 100,
            "currency": "EUR"
        },
        "code": "3028",
        "message": "Insufficient funds on merchant balance",
        "provider": {
            "id": 1971,
            "payment_id": "15861728285",
            "auth_code": "",
            "date": "2020-04-06T11:33:50+0000"
        }
    },
    "signature": "Q8xo7IGQBS+HSqBLSwLMgV8FO0qrHsDnlbUqOdN8fa3frn9tgg=="
}

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 Payouts to bank accounts in other countries 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.