Payouts to bank accounts in Russia

Overview

Payouts to bank accounts in Russia is a payment method which allows making payouts to customers by bank transfers in Russia. Payouts can be made by using Gate or Dashboard (Old Dashboard).

General information

Payment method type bank transfers
Countries and regions RU
Payment currencies RUB
Currency conversion
Purchases
Payouts +
Credential-on-file (COF) purchases
Full refunds
Partial refunds
Chargebacks
Special considerations
  • The Payouts to bank accounts in Russia method supports making urgent payouts by using Banking Electronic Speedy Payment System (BESP). Urgent payout is processed within 2 hours to 1 business day depending on the bank. For information about making urgent payouts, contact your ECommPay Key Account Manager.
  • In some cases successful payout can be reversed by the bank; reversal of payout can also be initiated by customer through the bank. Reversal is processed within 1 to 5 business days depending on the bank.
Obtaining access to the payment method and access fee Refer to your ECommPay Key Account Manager

Interaction diagram

Payment processing by using the Payouts to bank accounts in Russia payment method requires the use of merchant's web service, one of the ECommPay interfaces, and the ECommPay payment platform, as well as provider's technical facilities.



Operations support

  Interfaces Amounts, RUB Timespans**
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum basic time threshold time
Payouts + + *

* The maximum payout amount per month to one bank account is 2,000,000.00 RUB.

** The basic time and the threshold time are defined as follows:
  • The basic time is an average time from the moment a payment is initiated in the payment platform to the moment the information about 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 from the moment a payment is initiated in the payment platform to the moment the information about the payment result is sent to the initiator. 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

To initiate a payout by using the Payouts to bank accounts in Russia method you need to notify the customer via merchant's web service.

Figure: Payout by using Gate



The following sections provide detailed information about what you need to do 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 Russia 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. A customer orders 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. The provider sends information about the result to the payment platform.
  9. The payment platform sends a callback with information about the payment result to the web service.
  10. Information about the payout result is sent from the web service to the customer.

The following sections discuss in more details the request format and the Gate parameters to use in the Payouts to bank accounts in Russia 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 Russia method:
  1. You send payout requests by sending the request to /v2/payment/banks/russia/payout by using POST (HTTP) method. This is an online banking request group: /v2/payment/banks/{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 customer—customer information:
      • ip_address—customer IP address
      • id—customer ID unique within the project
    • Object account—customer account information:
      • number—customer account number
      • bik—bank identification code (BIK) which is assigned to banks of Russia
      • customer_name—the first name, patronymic and the last name of the customer
    • Object payment—payout information:
      • amount—payout amount in minor currency units
      • currency—payout currency in the ISO-4217 alpha-3 format
      • description—payment description. The description should include the following information:
        • Currency operation code. This code can be obtained from ECommPay Key Account Manager. The code should be specified in curly brackets at the beginning of the payment description, should start with VO and contain 5 digits after VO. Example: {VO12345}.
        • Operation type. Example: transfer of funds
        • Reason for payment. Example: contract № 1234567890
        • Name of goods, services or activities. Example: watch repair
        • Indication if the VAT is included or not. Example: VAT free

        Example: {VO12345} Transfer of funds under the contract № 1234567890 watch repair VAT free

  3. It may also be required to specify the following parameters in the request:
    • Object customer—customer information:
      • first_name—customer first name
      • middle_name—customer patronymic
      • last_name—customer last name
    • Object sender—sender information:
      • first_name—sender's first name
      • middle_name—sender's patronymic
      • last_name—sender's last name
      • Object billing—information about sender's registered address:
        • address—sender's registered address
        • country—country code in the ISO 3166-1 alpha-2 format
        • city—sender's city
    • Object payment—payout information:
      • is_fast—indication if the payout is urgent (BESP) or not. Available values: true—the payout is urgent (BESP), false— the payout is not urgent.

        You can specify this parameter in the request if the functionality of making urgent payouts by using the BESP system is enabled and if you need to indicate the type of payout (urgent or not) for a particular payment. For information about processing urgent payouts, refer to ECommPay Key Account Manager.

    For information about the necessity of using these parameters, contact ECommPay Key Account Manager. If the request is missing the parameters required for payment processing, the payment is declined and an error message is sent to the web service. In this case a payout should be initiated again.

  4. The currency of payout can only be RUB.
  5. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Payouts to bank accounts in Russia method must include project, payment and customer IDs, customer and bank account information, sender information, currency and amount of the payout, and signature, as shown in the following example:

Figure: Example of a payout request

{
    "general": {
        "project_id": 11111,
        "payment_id": "abc1234567",
        "signature": "signature"
    },
    "customer": {
        "id": "customer1",
        "ip_address": "1.1.1.1",
        "first_name": "Ivan",
        "middle_name": "Ivanovich",
        "last_name": "Ivanov"
    },
    "sender": {
        "first_name": "Pyotr",
        "middle_name": "Petrovich",
        "last_name": "Petrov",
        "billing":{
            "address": "ul. Mira",
            "country": "RU",
            "city": "Saint Petersburg",
            "postal": "123321"
        }
    },
    "account": {
        "number": "01234567890000123456",
        "bik": "123456789",
        "customer_name": "Ivanov Ivan Ivanovich"
    },
    "payment": {
        "amount": 10000,
        "currency": "RUB",
        "description": "{VO12345} Transfer of funds under the contract № 1234567890 watch repair VAT free",
        "is_fast": "false"
    }
}

Callback format

The Payouts to bank accounts in Russia 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 100.00 RUB payout to account 01234567890 made by the customer1 customer in the 123 project.

Figure: Example of a successful payout callback

{
        "customer": {
            "id": "customer1"
        },
        "account": {
            "number": "01234567890"
        },
        "project_id": 123,
        "payment": {
            "id": "TEST_PAYMENT_20210819_001",
            "type": "payout",
            "status": "success",
            "date": "2021-08-19T07:59:50+0000",
            "method": "russian-banks",
            "sum": {
                "amount": 10000,
                "currency": "RUB"
            },
            "description": "example"
        },
        "operation": {
            "id": 50541010068181,
            "type": "payout",
            "status": "success",
            "date": "2021-08-19T07:59:50+0000",
            "created_date": "2021-08-19T07:59:28+0000",
            "request_id": "2d4df26c24a15eac604c...a7e932a8acb694f79ff75-00050542",
            "sum_initial": {
                "amount": 10000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "RUB"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 5911,
                "payment_id": "12347368",
                "auth_code": "",
                "date": "2021-08-19T07:59:39+0000"
            }
        },
        "signature": "r9zjPkwOn4sd4n8Cdn8ZEU...adXmuJDolqJMj8kQxTnvh7dxg=="
    }
}

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

Figure: Example of a declined payout callback

{
        "customer": {
            "id": "customer2"
        },
        "account": {
            "number": "01234567890"
        },
        "project_id": 10801,
        "payment": {
            "id": "TEST_PAYMENT_20210819_001",
            "type": "payout",
            "status": "decline",
            "date": "2021-08-19T07:59:50+0000",
            "method": "russian-banks",
            "sum": {
                "amount": 10000,
                "currency": "RUB"
            },
            "description": "example"
        },
        "operation": {
            "id": 50541010068181,
            "type": "payout",
            "status": "decline",
            "date": "2021-08-19T07:59:50+0000",
            "created_date": "2021-08-19T07:59:28+0000",
            "request_id": "2d4df26c24a15eac604c...a7e932a8acb694f79ff75-00050542",
            "sum_initial": {
                "amount": 10000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "RUB"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 5911,
                "payment_id": "12347",
                "auth_code": "",
                "date": "2021-08-19T07:59:39+0000"
            }
        },
        "signature": "r9zjPkwOn4sd4n8Cdn8ZEUHY9YlI1UL...adXmuJDolqJMj8kQxTnvh7dxg=="
    }
}

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 Payout by using 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 payment results

As with other payment methods ECommPay offers, when using the Payouts to bank accounts in Russia 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.