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.

General information

Payment method type Cash payments through payment kiosks
Countries and regions AT, DE
Payment currencies EUR
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 CashtoCode payment method requires merchant's web service, one of interfaces and the ECommPay payment platform, as well as CashtoCode payment kiosks.



Operations support

  Interfaces Amounts, EUR
Payment Page CMS Plug-ins Gate Dashboard Fixed
Purchases + + Austria:
  • 10
  • 25
  • 50
  • 100
  • 200
  • 300
  • 400
  • 500
Germany:
  • 10
  • 25
  • 50
  • 100

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: 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 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 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 CashtoCode 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 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 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 EUR.
  3. Additionally you can use the customer_first_name, customer_last_name, customer_day_of_birth, 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.

Thus, a correct payment request in the CashtoCode method must include project, customer and payment IDs, the currency and the amount of a payment, customer data, and signature, as shown in the following example:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'EUR', 
      project_id: 35, 
      customer_id: 'customer1',
      customer_country: 'DE',
      customer_first_name: 'John',
      customer_last_name: 'Johnson',
      customer_day_of_birth: '12-12-1990',
      signature: "kUi2x9dKHAVNU0FYldJrxo+52Kt8\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

Callback format

The CashtoCode 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 EUR purchase made by the customer in the 4473 project.

Figure: 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: 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 ECommPay 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: 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 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 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 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 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:
    • 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
      • first_name—first name
      • last_name—last name
      • day_of_birth—date of birth
      • country—country (if not passed the country is determined by 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 EUR.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the CashtoCode 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": 238,
    "payment_id": "payment",
    "signature": "8ff12bcdfa8496f8e93fd937f563d07e8be45353b1f60e1cad0d4bbe4c527be",
  },
  "customer": {
    "id": "customer1",
    "first_name": "John",
    "last_name": "Doe",
    "ip_address": "185.123.111.222",
    "day_of_birth": "02-10-2002"
  },
  "payment": {
    "amount": 10000,
    "currency": "EUR"
  }
}

Formats of the customer redirection data

To redirect a customer from the web service to the CashtoCode 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": "GET",
            "body": { },
            "url": "https://test.cashtocode.com?token=MmQyNDdlNDMtNTcxOS00YmRhLTkwY2YtMjRlNWZkN2ViMjMw"
        }

Callback format

The CashtoCode 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 EUR purchase made by the customer in the 4473 project.

Figure: 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: 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 ECommPay offers, when using the CashtoCode 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.