CashtoCode

Overview

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

Download the logo in vector format here.
Payment method type cash payments through payment kiosks
Countries and regions Global (limits apply)
Payment currencies
  • In Austria and Germany—EUR
  • In Russia—RUB
  • In all countries, except European Economic Area countries—USD
Currency conversion
Purchases
Payouts
COF payments
Full refunds
Partial refunds
Chargebacks
Notes only payments for fixed amounts are supported, the table below provides information on these amounts
Onboarding and access fee Refer to your key account manager at Monetix

Interaction diagram

Payment processing by using the CashtoCode payment method requires merchant's web service, one of interfaces and the Monetix payment platform, as well as CashtoCode payment kiosks.

Operations support

Interfaces Amounts
Payment Page Gate Dashboard EUR in Austria EUR in Germany RUB in Russia USD
Purchase
  • 10
  • 25
  • 50
  • 100
  • 200
  • 300
  • 400
  • 500
  • 10
  • 25
  • 50
  • 100
  • 1000
  • 2500
  • 10 000
  • 15 000
  • 5
  • 10
  • 15
  • 25
  • 50
  • 100
  • 200

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 CashtoCode method, a customer needs to receive a payment barcode or number on the CashtoCode service side to perform a purchase at one of the available payment kiosks.

Figure 1. Purchase by using Payment Page procedure
Figure 2. Purchase by using Gate procedure

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.

Purchase by using Payment Page

General information

In the CashtoCode 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 Monetix 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 CashtoCode method selected. For more information about preselecting payment methods, see in Preselecting payment methods.

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

Figure 3. 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 Monetix 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 Monetix 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 CashtoCode kiosks payment method.
  8. The page requesting the customer data is displayed to the customer on Payment Page (if it was not passed in the request for opening).
  9. The customer enters personal data on Payment Page.
  10. The payment platform receives the payment request for payment processing in the CashtoCode service.
  11. The payment platform performs the internal payment request processing and sends it to the CashtoCode service.
  12. The payment request is processed on the CashtoCode side.
  13. The CashtoCode service generates the data for redirecting the customer to the CashtoCode form and sends it to the payment platform.
  14. The payment platform sends to Payment Page the data for redirecting the customer to the CashtoCode service.
  15. The customer is redirected to the CashtoCode service.
  16. The customer selects a payment terminal from the list.
  17. The CashtoCode service generates and displays the codes and instruction to the customer. Code expiry date can be set up.
  18. The customer completes the payment at one of the available CashtoCode payment kiosks according to the instructions.
  19. The payment is processed on the CashtoCode service side.
  20. The CashtoCode service sends the result notification to the payment platform.
  21. 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 CashtoCode 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 CashtoCode method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are required for any payment method:
    • project_id—project ID you obtained from Monetix
    • payment_id—payment ID unique within the project
    • customer_id—the unique ID of the customer within your project
    • customer_email—customer email
    • customer_first_name—customer first name
    • customer_last_name—customer last name
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor currency units without any decimal point or comma in accordance with the table above.

      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.

  2. The currency of payment can be any of those supported for this method.
  3. Additionally you can use the customer_day_of_birth and customer_country parameters. If these parameters are not passed in the request for opening—they are requested from a customer on Payment Page, the country is determined by the IP address.
  4. If you need to have payment form displayed with the CashtoCode method selected, set the force_payment_method parameter to cashtocode.
  5. If required, you can also add any other additional parameters Payment Page supports. For more information about all parameters available in the CashtoCode 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.

Here is an example of data from a request for Payment Page opening:

EPayWidget.run(
    {
        project_id: 1234, 
        payment_id: 'payment_47',
        customer_id: 'customer_123',
        payment_currency: 'EUR',
        payment_amount: 10000,
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@email.com',
        customer_country: 'DE',
        customer_day_of_birth: '12-12-1990',
        signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

Callback format

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

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

Figure 4. Example of a successful purchase callback
{
        "project_id": 4473,
        "payment": {
            "id": "EPccf4-792a",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-27T12:21:46+0000",
            "method": "cashtocode",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "day_of_birth": "12-12-1992",
            "first_name": "John",
            "last_name": "Doe",
            "country": "AT",
            "ip_address": "12.1.20.1"
        },
        "merchant_account_id": 4473,
        "operation": {
            "id": 2000000018,
            "type": "sale",
            "status": "success",
            "date": "2019-06-27T12:21:46+0000",
            "created_date": "2019-06-27T12:19:40+0000",
            "request_id": "cf3d4fd91294c9ecbc125a81f011e4",
            "sum_initial": {
                "amount": 10000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 4473,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "xZFu7a5GH/wrX3QlcAbFq2aqgsvz1AZdjK2YTazmnkqclwfwB/o4uuCKUz7Tfw=="
    }
}

The following is the example of a callback for a purchase declined due to the inappropriate payment amount.

Figure 5. Example of a declined purchase callback
{
        "project_id": 4473,
        "payment": {
            "id": "EPccf4-792a",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-27T12:21:46+0000",
            "method": "cashtocode",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "day_of_birth": "12-12-1992",
            "first_name": "John",
            "last_name": "Doe",
            "country": "AT",
            "ip_address": "12.1.20.1"
        },
        "merchant_account_id": 4473,
        "operation": {
            "id": 2000000018,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-27T12:21:46+0000",
            "created_date": "2019-06-27T12:19:40+0000",
            "request_id": "cf3d4fd91294c9ecbc125a81f011e4",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 4473,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "xZFu7a5GH/wrX3QlcAbFq2aqgsvz1AZdjK2YTazmnkqclwfwB/o4uuCKUz7Tfw=="
    }
}

Related topics

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

Purchase by using Gate

General information

In the CashtoCode 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 Monetix URL.
  2. Perform redirecting customer to the CashtoCode 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 6. Purchase sequence by using Gate
  1. A customer initiates a purchase through the CashtoCode kiosks on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified Monetix URL.
  3. The Monetix 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 structure.
  6. The payment platform performs the internal payment request processing and redirects the request to the CashtoCode service.
  7. The request is processed on the CashtoCode service side.
  8. The CashtoCode 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 CashtoCode service site.
  11. The customer selects a terminal for payment performing.
  12. The generated payment codes and instructions are displayed to the customer. Code expiry date can be set up.
  13. The customer performs the payment at one of the available CashtoCode kiosks by the code, following the instructions.
  14. The payment is processed on the CashtoCode service side.
  15. The result is displayed to the customer at the CashtoCode terminal.
  16. The CashtoCode service sends the payment result notification to the payment platform.
  17. The Monetix 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 CashtoCode 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 CashtoCode method:
  1. You perform purchase by sending the /v2/payment/cash/cashtocode/sale request by using POST (HTTP) method. This request refers to a group of requests for receiving payments from customers through the CashtoCode kiosks: /v2/payment/cash/{payment_method}/sale
  2. The following objects and parameters must be specified in any request:
    • general—object with general request identification information:
      • project_id—the project ID you obtained from Monetix
      • payment_id—payment ID unique within the project
      • 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—the unique ID of the customer within your project
      • ip_address—customer device IP
      • email—customer email
      • first_name—customer first name
      • last_name—customer last name
      • day_of_birth—date of birth
      • country—country (if not passed the country is determined by IP address)
    • payment—object with purchase information:
      • amount—purchase amount in minor currency units without any decimal point or comma in accordance with the table above.

        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—code of purchase currency in the ISO-4217 alpha-3 format
  3. The currency of payment can be any of those supported for this method.
  4. The following parameters with the return URLs are optional, but we strongly advise you to specify them in the request to provide your customer a better user experience. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix.
    • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
      • success—the URL to redirect the customer to after the payment is successfully completed.
      • decline—the URL to redirect the customer to after the payment is declined.
      • return—the URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request.
  5. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a purchase request in the CashtoCode method.

Figure 7. Example of data from a purchase request
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com",
        "day_of_birth": "02-10-2002"
    },
    "payment": {
        "amount": 10000,
        "currency": "EUR"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
}

Formats of the customer redirection data

After receiving and processing your purchase request, the payment platform sends a callback to your web service containing the data to redirect the customer to the CashtoCode service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

  • url—the URL to redirect the customer to
  • body—the data to be sent in the request body
  • method—the HTTP method to get an HTML page of the website (for example, POST or GET)
  • encrypted—this is the service parameter. Ignore the data it contains.

Here is an example of a piece of callback containing the data to redirect the customer.


"redirect_data": {
    "method": "GET",
    "body": [],
    "encrypted": [],
    "url": "https://example.com/redirect"
        }

Callback format

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

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

Figure 8. Example of a successful purchase callback
{
        "project_id": 4473,
        "payment": {
            "id": "EPccf4-792a",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-27T12:21:46+0000",
            "method": "cashtocode",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "day_of_birth": "12-12-1992",
            "first_name": "John",
            "last_name": "Doe",
            "country": "AT",
            "ip_address": "12.1.20.1"
        },
        "merchant_account_id": 4473,
        "operation": {
            "id": 2000000018,
            "type": "sale",
            "status": "success",
            "date": "2019-06-27T12:21:46+0000",
            "created_date": "2019-06-27T12:19:40+0000",
            "request_id": "cf3d4fd91294c9ecbc125a81f011e4",
            "sum_initial": {
                "amount": 10000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 4473,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "xZFu7a5GH/wrX3QlcAbFq2aqgsvz1AZdjK2YTazmnkqclwfwB/o4uuCKUz7Tfw=="
    }
}

The following is the example of a callback for a purchase declined due to the inappropriate payment amount.

Figure 9. Example of a declined purchase callback
{
        "project_id": 4473,
        "payment": {
            "id": "EPccf4-792a",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-27T12:21:46+0000",
            "method": "cashtocode",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "day_of_birth": "12-12-1992",
            "first_name": "John",
            "last_name": "Doe",
            "country": "AT",
            "ip_address": "12.1.20.1"
        },
        "merchant_account_id": 4473,
        "operation": {
            "id": 2000000018,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-27T12:21:46+0000",
            "created_date": "2019-06-27T12:19:40+0000",
            "request_id": "cf3d4fd91294c9ecbc125a81f011e4",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 4473,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "xZFu7a5GH/wrX3QlcAbFq2aqgsvz1AZdjK2YTazmnkqclwfwB/o4uuCKUz7Tfw=="
    }
}

Related topics

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

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.