Purchase 1: displaying payment instructions

The customer follows the payment instructions displayed on the checkout page or in your system (when performing the purchase by using Gate).

Countries and regions Ecuador
Payment currencies USD
Payment amount limits Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time Contact your key account manager at Monetix for details.
Currency conversion On the Monetix side
Refund
Onboarding and access fee Contact your key account manager at Monetix for details.
Special considerations
  • The payment details must be used for purchase only once. The customer has to initiate a new purchase for performing future payments.
  • The payment will be declined if the customer doesn't complete the purchase within a certain period after the payment was initiated.

Operations support

Interfaces
Payment Page Gate Dashboard
Purchase

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 then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Purchase by using Payment Page

General information

To perform a purchase by using Payment Page with the Cash in Ecuador payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Accept the callback with the purchase result from the payment platform.

The following figure shows the complete purchase processing flow in the Cash in Ecuador payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page
  1. The customer initiates a purchase in your system.
  2. Your system sends the request for the purchase through Payment Page to the Monetix URL.
  3. The checkout page is displayed to the customer.
  4. The customer chooses to make a purchase with the Cash in Ecuador payment method.
  5. The checkout page displays the payment instructions to the customer.
  6. The customer completes the purchase.
  7. The provider service sends the purchase result information to the payment platform.
  8. The payment platform sends a callback with the payment result to your system.
  9. The payment platform displays the payment result to the customer on the checkout page.

Request

The following table lists the parameters that you have to include in the request for purchase through the checkout page with the Cash in Ecuador payment method.

Table 1. Basic parameters of requests to Payment Page

strictly required—the parameter must be in the initial request.

required—the parameter is required for purchase processing but using it in the initial request is optional. If you don't specify this parameter in your request, the checkout page will contain an additional field for the customer to enter the missing information. For more information on how to act in such cases, see Submission of additional payment information.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.
ParameterDescription

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

customer_id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

customer_first_name
string
strictly required

Customer's first name.

Example: John

customer_last_name
string
strictly required

Customer's last name.

Example: Doe

customer_email
string
required

Customer's email.

Example: johndoe@example.com

identify_doc_number
string
required

Identity document number. The number should correspond to the document type submitted in the doc_type parameter.

Example: 1234567890

identify_doc_type
string
optional

Type of an identity document.

Possible values:

  • CC—when submitting Cédula de Ciudadanía (Citizenship Card)
  • CI—when submitting the number of ID card (Cédula de Identidad)

Example: CI

payment_currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: USD

payment_amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency units and Currency codes.

Example: 100.00 USD must be sent as 10000

force_payment_method
string
optional

Parameter that allows you to enforce the Cash in Ecuador payment method for your customer and skip the page with payment method selections.

To enforce the Cash in Ecuador payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to cash-ecuador. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'cash-ecuador'

account_bank_id
integer
required

Customer's bank ID.

Example: 123456

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.
You can also add any other optional parameters to the request, if necessary. For the list of all the parameters possible in requests to Payment Page, see Payment Page invocation parameters.

Here is an example of the data from a request to open the checkout page by using EPayWidget:

EPayWidget.run(
	{
		project_id: 1234,
		payment_id: 'payment_47',
		customer_id: 'customer_123',
		customer_first_name: 'John',
		customer_last_name: 'Doe',
		customer_email: 'johndoe@example.com',
		identify_doc_number: '1234567890',
		identify_doc_type: 'CI',
		payment_currency: 'USD',
		payment_amount: 10000,
		force_payment_method: 'cash-ecuador',
		account_bank_id: 123456,
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Callback

In the Cash in Ecuador payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.

In this payment method, callbacks also have the account object with the number, customer_name, and type parameters containing information about the customer's phone number, their full name, and their mobile network operator. Customer name might not be present in the callback, contact your key account manager at Monetix for details.

The following is an example of a callback body with information about a successfully completed purchase.

Figure 2. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Cash Ecuador",
        "sum": {
            "amount": 10000,
            "currency": "USD"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "USD"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "USD"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "233123456789",
        "type": "ORANGE",
        "customer_name": "John Doe"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 3. Example of the data from a declined purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Cash Ecuador",
        "sum": {
            "amount": 10000,
            "currency": "USD"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "USD"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "USD"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "233123456789",
        "type": "ORANGE",
        "customer_name": "John Doe"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

Purchase by using Gate

General information

To perform a purchase by using Gate with the Cash in Ecuador payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Show the screen with payment instructions to the customer.
  3. Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the Cash in Ecuador payment method.

Figure 4. Purchase processing flow when performing a purchase by using Gate
  1. The customer initiates a purchase in your system.
  2. Your system sends the purchase request to the Monetix payment platform.
  3. The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
  4. The payment platform generates the data for displaying the payment instructions to the customer and sends the data to your system in the display_data array.
  5. Your system displays the payment instructions to the customer.
  6. The customer completes the purchase.
  7. The provider service informs the payment platform about the purchase result.
  8. The payment platform sends the callback with the payment result to your system.
  9. Your system sends the payment result to the customer.

Request

This section provides the instructions on how to build the request for purchase with the Cash in Ecuador payment method.

HTTP request method POST
Request body format JSON
API endpoint/v2/payment/cash/ecuador/sale
Full API endpoint specification /v2/payment/cash/{payment_method}/sale
Table 2. Basic parameters of a purchase request

strictly required—the parameter must be in the initial request.

required—the parameter is required for purchase processing but using it in the initial request is optional. If you omit this parameter from the request, the payment platform will request the parameter by sending your system a callback with the list of all the missing parameters you are required to submit. For more information on how to act in such cases, see Submission of additional payment information.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.
ObjectObject/Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

identify
object
required

doc_number
string
required

Identity document number. The number should correspond to the document type submitted in the doc_type parameter.

Example: 1234567890

doc_type
string
optional

Type of an identity document.

Possible values:

  • CC—when submitting Cédula de Ciudadanía (Citizenship Card)
  • CI—when submitting the number of ID card (Cédula de Identidad)

Example: CI

account
object
required

bank_id
integer
required

Customer's bank ID.

Example: 123456

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: XAF

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency units and Currency codes.

Example: 100 XAF must be sent as 100

You can also add any other optional parameters to the purchase request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a purchase with the Cash in Ecuador payment method:

Figure 5. Example of the purchase request body
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com",
        "identify": {
            "doc_number": "1234567890",
            "doc_type": "CI"
        }
    },
    "account": {
        "bank_id": 123456
    },
    "payment": {
        "currency": "XAF",
        "amount": 100
    }
}

Displaying the payment instructions to the customer

After receiving and processing your purchase request, the payment platform sends you the callback with the data for displaying the payment instructions to the customer.

Use the data from the display_data array to display the payment instructions to the customer.

Table 3. Description of the display_data array
Element Description 
{
    "type": "add_info",
    "title": "amount",
    "data": "600"
}
 Payment amount.

Example: 600

 
{
    "type": "add_info",
    "title": "currency",
    "data": "USD"
}
 Payment currency.

Example: USD

 
{
    "type": "add_info",
    "title": "reference",
    "data": "90913183049"
}
 Payment reference for the cash desk.

Example: 90913183049

The following is the callback fragment containing display_data array.

"display_data": [
    {
        "type": "add_info",
        "title": "amount",
        "data": "600"
    },
    {
        "type": "add_info",
        "title": "currency",
        "data": "USD"
    },
    {
        "type": "add_info",
        "title": "reference",
        "data": "90913183049"
    }
]

Callback

In the Cash in Ecuador payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Gate.

In this payment method, callbacks also have the account object with the number, customer_name, and type parameters containing information about the customer's phone number, their full name, and their mobile network operator. Customer name might not be present in the callback, contact your key account manager at Monetix for details.

The following is an example of a callback body with the information about a successfully completed purchase.

Figure 6. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Cash Ecuador",
        "sum": {
            "amount": 10000,
            "currency": "USD"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "USD"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "USD"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "233123456789",
        "type": "ORANGE",
        "customer_name": "John Doe"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 7. Example of the data from a declined purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Cash Ecuador",
        "sum": {
            "amount": 10000,
            "currency": "USD"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "USD"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "USD"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "233123456789",
        "type": "ORANGE",
        "customer_name": "John Doe"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

Banks available for purchase

Supported banks

In the Cash in Ecuador payment method, payments are performed through the banks the payment method supports. For the purchase to be performed, your request must contain the ID of the customer's bank in the account.bank_id parameter.

The table below lists the banks available for purchase in the Cash in Ecuador payment method.

Table 4. Banks available for purchase
BankID
RapiActivo118482
Wester Union118472
OmniSwitch118442
GAMERECAR118422
BEMOVIL118412

The table with the list of banks is provided for informational purposes only. It may change without notice. To get the current list of banks the Cash in Ecuador payment method supports, reach out to the Monetix support team (support@monetix.pro).