Cash-in

Overview

Cash-in is a payment method that allows customers to make payments in cash through terminals and ATMs that support cash deposits. You can perform purchases through this method by using Payment Page and Gate.

General information

Payment method type Cash payments through payment terminals
Countries and regions RU
Payment currencies RUB
Currency conversion
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
Onboarding and access fee Refer to your key account manager ECommPay

Interaction diagram

Payment processing by using the Cash-in payment method requires merchant's web service, one of interfaces and the ECommPay payment platform, as well as Cash-in payment terminals.



Operations support

  Interfaces Amounts
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum
Purchases + + 1.00

Processing scenarios

In the Cash-in method, to perform a purchase operation, a customer needs to receive a payment code on Payment Page or on the merchant's web service side to perform a purchase at one of the available payment terminals or ATMs.

Figure: Purchase by using Payment Page procedure



Figure: Purchase by using Gate procedure



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.

Purchase by using Payment Page

General information

In the Cash-in method, to perform a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Cash-in method selected. For more information about preselecting payment methods, see in Preselecting payment method.

The full sequence and particularities of the purchase process are provided below.



Figure: Purchase sequence by using Payment Page

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Cash-interminals payment method.
  8. The page requesting the phone number is displayed to the customer on Payment Page.
  9. The customer enters the phone number on Payment Page.
  10. The payment platform receives the purchase request for payment processing through Cash-in terminals.
  11. The payment platform performs the internal purchase request processing and sends it to the Cash-in service.
  12. The purchase request is processed on the Cash-in terminals service side.
  13. The Cash-in service generates the link containing a payment code and a payment instruction for the customer and sends it to the payment platform.
  14. The payment platform sends the link to Payment Page.
  15. The link with the code and instruction is displayed to the customer.
  16. The customer completes the payment at one of the available Cash-in payment terminals or ATMs.
  17. The payment is processed on the Cash-in service side.
  18. The result is displayed to the customer at the Cash-in terminal.
  19. The Cash-in service sends the result notification to the payment platform.
  20. The payment platform sends a callback with the payment result to the web service.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Cash-in payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you need to consider when using the Cash-in method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • customer_id—the unique ID of the customer within your project
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor units
  2. The currency of payment can only be RUB.
  3. There is one more mandatory parameter—customer_phone.
  4. If you need to have payment form displayed with the Cash-in method selected, set the force_payment_method parameter to cash-in.
  5. If required, you can also add any other additional parameters Payment Page supports. For more information about all parameters available in the Cash-in method, see Payment Page invocation parameters.
  6. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Cash-in method must include project, customer and payment IDs, the currency and the amount of a payment in the appropriate currency, customer phone, as shown in the following example:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'RUB',
      customer_id: '123', 
      project_id: 35, 
      customer_phone: "89123456789"
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

Callback format

The Cash-in method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 100,00 RUB purchase made by the fav_customer customer in the 1100 project.

Figure: Example of a successful purchase callback

{
        "project_id": 1100,
        "payment": {
            "id": "yandex_cash",
            "type": "purchase",
            "status": "success",
            "date": "2018-07-18T08:10:39+0000",
            "method": "cash-in",
            "sum": {
                "amount": 10000,
                "currency": "RUB"
            },
            "description": "TEST_1531899099620"
        },
        "customer": {
            "id": "fav_customer"
        },
        "operation": {
            "id": 13383000000701,
            "type": "sale",
            "status": "success",
            "date": "2018-07-18T08:10:39+0000",
            "created_date": "2018-07-18T08:02:00+0000",
            "request_id": "d079593b8a108002b",
            "sum_initial": {
                "amount": 10000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "RUB"
            },
            "provider": {
                "id": 1068,
                "payment_id": "2000002913475",
                "date": "2018-07-18T08:10:37+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "6QdVNs5xjDf2kCEZnCGiBSzX+9pHdonOnMlrsxhYRE77EjoiCze6i6EwZbpUPrPFQ=="
    }

The following is the example of a callback for a purchase declined due to the time-out.

Figure: Example of a declined purchase callback

{
        "project_id": 1100,
        "payment": {
            "id": "5c90bb0385e71413a7ecfdd2",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-20T09:48:56+0000",
            "method": "cash-in",
            "sum": {
                "amount": 500,
                "currency": "RUB"
            },
            "description": "test payment"
        },
        "customer": {
            "id": "5c90b3c63cb3d13d03b928b9"
        },
        "operation": {
            "id": 36150000000595,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-20T09:48:56+0000",
            "created_date": "2019-03-19T09:48:56+0000",
            "request_id": "1e993a7850a680caa1023d5434adf2522",
            "sum_initial": {
                "amount": 500,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 500,
                "currency": "RUB"
            },
            "provider": {
                "id": 1068,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20602",
            "message": "Time-out"
        },
        "signature": "qTxNQ+9CpNm9dvIHDPLGuoS+8mi4wGNBy8GSpxqH6owP15wTPhY+htebODVS4X4CQ=="
    }

Related topics

The following topics might be useful when implementing payments through Payment Page:

Purchase by using Gate

General information

In the Cash-in methods, when processing a purchase by using Gate, the merchant web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Perform redirecting customer to the Cash-in form.
  3. Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.



Figure: Purchase sequence by using Gate

  1. A customer initiates a purchase through the Cash-in terminals on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The ECommPay payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the Cash-in terminals service.
  7. The request is processed on the Cash-in service side.
  8. The Cash-in service sends the data for redirecting the customer.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the Cash-in service site.
  11. The customer enters the necessary data to receive the code and instructions for payment at a terminal.
  12. The generated payment code and instructions are displayed to the customer.
  13. The customer performs the payment at one of the available Cash-in terminals or ATMs by code, following the instructions.
  14. The payment is processed on the Cash-in service side.
  15. The result is displayed to the customer at the Cash-in terminal.
  16. The Cash-in service sends the payment result notification to the payment platform.
  17. The ECommPay payment platform sends a callback to the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Cash-in payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when using purchase requests in the Cash-in method:
  1. You perform purchase by sending the /v2/payment/cash/yandex/sale request by using POST (HTTP) method. This request refers to a group of requests for receiving payments from customers through the Cash-in terminals: /v2/payment/cash/{payment_method}/sale
  2. The following objects and parameters must be specified in any request:
    • Object general—general purchase information:
      • project_id—project identifier
      • payment_id—unique purchase 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—the unique ID of the customer within your project
      • ip_address—customer IP address
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—payout currency in the ISO-4217 alpha-3 format.
  3. The currency of purchase can only be RUB.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Cash-in method must include project, customer and payment IDs, currency and amount of the purchase, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
        "project_id": 35,
        "payment_id": "Payment 12",
        "signature": "2tlMuYxLW9Yu6RETr8pdCfmi0UPE8euD+o4EVPjLyfbOQ+9ajAteg5lPk96Q=="
  },
    "customer": {
        "id": "123",
        "ip_address": "1.1.1.1" 
  },
    "payment": {
        "amount": 10000,
        "currency": "RUB"
  }
}

Formats of the customer redirection data

To redirect a customer from the web service to the Cash-in site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the HTML page using the method specified in the redirect_data.method parameter.

The following is the callback fragment containing the token for purchase.


"redirect_data": {
            "method": "POST",
            "body": {
                "shopId": 187706,
                "scid": "561690",
                "sum": "100.00",
                "customerNumber": "87.245.207.226",
                "orderNumber": 1338,
                "paymentType": "GP",
                "payment_system_code": "CashPaymentViaYandexRUB",
                "shopArticleId": 523830,
                "shopDefaultURL": "",
                "shopSuccessURL": "https://site.com/process/complete-redirect?wsid=t81n72g5d",
                "shopFailURL": "https://site.com/process/complete-redirect?wsid=t81n72g5d",
                "cps_email": ""
            },
            "encrypted": [],
            "url": "https://demomoney.yandex.ru/eshop.xml"
        }

Callback format

The Cash-in method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 100.00 RUB purchase made by the fav_customer customer in the 1100 project.

Figure: Example of a successful purchase callback

 {
        "project_id": 1100,
        "payment": {
            "id": "yandex_cash",
            "type": "purchase",
            "status": "success",
            "date": "2018-07-18T08:10:39+0000",
            "method": "cash-in",
            "sum": {
                "amount": 10000,
                "currency": "RUB"
            },
            "description": "TEST_1531899099620"
        },
        "customer": {
            "id": "fav_customer"
        },
        "operation": {
            "id": 13383000000701,
            "type": "sale",
            "status": "success",
            "date": "2018-07-18T08:10:39+0000",
            "created_date": "2018-07-18T08:02:00+0000",
            "request_id": "d079593b8a108002b",
            "sum_initial": {
                "amount": 10000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "RUB"
            },
            "provider": {
                "id": 1068,
                "payment_id": "2000002913475",
                "date": "2018-07-18T08:10:37+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "6QdVNs5xjDf2kCEZnCGiBSzX+9pHdonOnMlrsxhYRE77EjoiCze6i6EwZbpUPrPFQ=="
    }

The following is the example of a callback for a purchase declined due to the time-out.

Figure: Example of a declined purchase callback

{
        "project_id": 1100,
        "payment": {
            "id": "5c90bb0385e71413a7ecfdd2",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-20T09:48:56+0000",
            "method": "cash-in",
            "sum": {
                "amount": 500,
                "currency": "RUB"
            },
            "description": "test payment"
        },
        "customer": {
            "id": "5c90b3c63cb3d13d03b928b9"
        },
        "operation": {
            "id": 36150000000595,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-20T09:48:56+0000",
            "created_date": "2019-03-19T09:48:56+0000",
            "request_id": "1e993a7850a680caa1023d5434adf2522",
            "sum_initial": {
                "amount": 500,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 500,
                "currency": "RUB"
            },
            "provider": {
                "id": 1068,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20602",
            "message": "Time-out"
        },
        "signature": "qTxNQ+9CpNm9dvIHDPLGuoS+8mi4wGNBy8GSpxqH6owP15wTPhY+htebODVS4X4CQ=="
    }

Related topics

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

Testing

General information

For the Cash-in method the testing of purchases by using Payment Page and Gate..

Testing can be performed within a test project, to enable and disable the testing availability, contact ECommPay technical support via support@ecommpay.com.

When performing a test payment, take into account that you must specify the identifier of the test project in the requests and the interfaces of the payment forms emulator of Payment Page and Cash-in may differ from the ones used in the production environment.



Test payments statuses

When testing purchases, the final payment status is determined by the amount specified in the request:

  • decline status with 40000 or 40400 amount
  • success status with any other amount

Purchases by using Payment Page

To perform a test purchase by using Payment Page, do the following:

  1. Send a correct test request for Payment Page opening to the payment platform.
  2. If the cash-in method was not specified in the request—select the method on the emulator page.
  3. Click the Success or Decline button (depending on the amount specified in the request).
  4. Accept a callback with information about the payment result.

If, while on the web page of the Cash-in payment form emulator, the Success or Decline button is not clicked within 30 minutes, the payment status is set to decline and the corresponding callback is sent from the payment platform side (regardless of the amount indicated in the request).

The full information about purchase process by using Cash-in through Payment Page is provided in the section Purchase by using Payment Page.

Purchases by using Gate

To perform a test purchase by using Gate, do the following:

  1. Send a correct test request for purchase to the payment platform.
  2. Accept a callback with redirection data.
  3. Go to the received URL and click the Success or Decline button (depending on the amount specified in the request).
  4. Accept a callback with information about the payment result.

If, while on the web page of the Cash-in payment form emulator, the Success or Decline button is not clicked within 30 minutes, the payment status is set to decline and the corresponding callback is sent from the payment platform side (regardless of the amount indicated in the request).

The full information about purchase process by using Cash-in through Gate is provided in the section Purchase by using Gate.

Analysis of payments results

As with other payment methods ECommPay offers, when using the Cash-in 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.