SPEI - Scenario 2. Purchase with payment instructions

When performing a purchase, 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	Mexico
Payment currencies	MXN
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 Note: Ask your key account manager at Monetix whether the following payment processing considerations are relevant to you. If the customer enters an amount which is different from the amount specified in the purchase request, the payment processing will proceed as described in Handling payments with amount changed by customer. Contact your key account manager at Monetix for more information.

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 SPEI payment method:

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

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

Figure 1. Purchase processing steps for a purchase by using Payment Page

The customer initiates a purchase in your system.
Your system sends the request for the purchase through Payment Page to the Monetix URL.
The checkout page is displayed to the customer.
The customer chooses to make a purchase with the SPEI payment method.
The checkout page displays the payment instructions to the customer.
The customer completes the purchase.
The bank service sends the purchase result information to the payment platform.
The payment platform sends a callback with the payment result to your system.
The payment platform displays the payment result to the customer on the checkout page.

Request

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

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.

✱—the parameter may not be required in some cases. Contact your account manager at Monetix for details.

Parameter Description

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
strictly required

Customer's email.

Example: johndoe@example.com

identify_doc_number
string
required✱

Customer's CURP number (contains 18 digits).

Example: 123456789012345678

payment_currency
string
strictly required

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

Example: MXN

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 codes.

Example: 10,000.00 MXN must be sent as 1000000

force_payment_method
string
optional

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

To enforce the SPEI payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to spei. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'spei'

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_account_id
string
required✱

Customer RFC document number (contains 13 digits).

Example: 1234567891234

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: '123456789012345678',
		payment_currency: 'MXN',
		payment_amount: 1000000,
		force_payment_method: 'spei',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==',
		customer_account_id: '1234567891234'
	}
)

Callback

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

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": "spei",
        "sum": {
            "amount": 1000000,
            "currency": "MXN"
        },
        "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": 1000000,
            "currency": "MXN"
        },
        "sum_converted": {
            "amount": 1000000,
            "currency": "MXN"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "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": "spei",
        "sum": {
            "amount": 1000000,
            "currency": "MXN"
        },
        "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": 1000000,
            "currency": "MXN"
        },
        "sum_converted": {
            "amount": 1000000,
            "currency": "MXN"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Purchase by using Gate

General information

To perform a purchase by using Gate with the SPEI payment method:

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

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

Figure 4. Purchase processing flow when performing a purchase by using Gate

The customer initiates a purchase in your system.
Your system sends the purchase request to the Monetix payment platform.
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.)
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.
Your system displays the payment instructions to the customer.
The customer completes the purchase.
The bank service informs the payment platform about the purchase result.
The payment platform sends the callback with the payment result to your system.
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 SPEI payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	`/v2/payment/bank-transfer/spei/sale`
Full API endpoint specification	/v2/payment/bank-transfer/{payment_method}/sale

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.

✱—the parameter may not be required in some cases. Contact your account manager at Monetix for details.

Object Object/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

account_id
string
required✱

Customer RFC document number (contains 13 digits).

Example: 1234567891234

identify
object
required✱

doc_number
string
required✱

Customer's CURP number (contains 18 digits).

Example: 123456789012345678

payment
object
strictly required

currency
string
strictly required

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

Example: MXN

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.

Example: 10,000.00 MXN must be sent as 1000000

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 SPEI 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",
        "account_id": "1234567891234",
        "identify": {
            "doc_number": "123456789012345678"
        }
    },
    "payment": {
        "currency": "MXN",
        "amount": 1000000
    }
}

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.

There are two ways the display_data array can be structured. All of them are described below. Ask your key account manager at Monetix which option is relevant to you.

Option 1

Each element of this array contains the following parameters:

type—element type. its value is always add_info.
title—name of the payment instruction data, can take one the following values:
- merchant_name—payment recipient
- account_number—account number of the payment recipient
- payment_amount_show—payment amount in major currency units
- invoice_number—transaction identifier
- destination_bank—recipient's bank
data—payment instruction data

Here is an example of the callback snippet with the data for displaying the payment instructions to the customer.

"display_data": [
    {
        "type": "add_info",
        "title": "merchant_name",
        "data": "COSMOSHOP"
    },
    {
        "type": "add_info",
        "title": "account_number",
        "data": "123456789012345678"
    },
    {
        "type": "add_info",
        "title": "payment_amount_show",
        "data": "2499.50"
    },
    {
        "type": "add_info",
        "title": "invoice_number",
        "data": "1234567890123456"
    },
    {
        "type": "add_info",
        "title": "destination_bank",
        "data": "STP"
    }
]

Option 2

Each element of this array contains the following parameters:

type—element type. its value is always add_info.
title—name of the payment instruction data, can take one the following values:
- bank—payment recipient's bank
- clabe—payment recipient's CLABE number
- payment_amount_show—payment amount in major currency units
- operation_id—transaction ID on the provider's side
- site_url—the URL to redirect the customer to after they press the button to confirm that they've completed the payment
data—payment instruction data

Here is an example of the callback snippet with the data for displaying the payment instructions to the customer.

"display_data": [
    {
        "type": "add_info",
        "title": "bank",
        "data": "STP"
    },
    {
        "type": "add_info",
        "title": "clabe",
        "data": "123456789012345678"
    },
    {
        "type": "add_info",
        "title": "payment_amount_show",
        "data": "2499.50"
    },
    {
        "type": "add_info",
        "title": "operation_id",
        "data": "1234567890123456"
    },
    {
        "type": "add_info",
        "title": "site_url",
        "data": "http://example.com"
    }
]

Callback

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

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": "spei",
        "sum": {
            "amount": 1000000,
            "currency": "MXN"
        },
        "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": 1000000,
            "currency": "MXN"
        },
        "sum_converted": {
            "amount": 1000000,
            "currency": "MXN"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "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": "spei",
        "sum": {
            "amount": 1000000,
            "currency": "MXN"
        },
        "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": 1000000,
            "currency": "MXN"
        },
        "sum_converted": {
            "amount": 1000000,
            "currency": "MXN"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

SPEI - Scenario 2. Purchase with payment instructions

Operations support

Purchase by using Payment Page

General information

Request

Callback

Related topics

Purchase by using Gate

General information

Request

Displaying the payment instructions to the customer

Callback

Related topics