Payouts to bank accounts in Russia

General information

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

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

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

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.

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

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:

{
    "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.

{
        "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.

{
        "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:

• Interaction models
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

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.