Mexico Online Banking

Overview

Mexico Online Banking is a payment method that uses the online banking mechanism for payments through banks of Mexico. You can perform purchases through this method by using Payment Page and Gate.

Download the logo in vector format here.
Payment method type online banking
Countries and regions Mexico
Payment currencies USD
Currency conversion
Purchases
Payouts for payout processing refer to your Monetix key account manager
COF payments
Full refunds
Partial refunds
Chargebacks
Special considerations all payment amounts are integer
Onboarding and access fee refer to your Monetix key account manager

Interaction diagram

Payment processing by using the Mexico Online Banking payment method requires merchant's web service, one of Monetix interfaces, and the Monetix payment platform, as well as provider's technical facilities.

Operations support

Interfaces Amounts, USD Times
Payment Page Gate Dashboard minimum maximum basic threshold
Purchases 1.00 3,000.00 within 5 minutes

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 Mexico Online Banking method, to perform a purchase operation, you need to redirect customer to the provider service.

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

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 Mexico Online Banking method, when processing 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 the Mexico Online Banking 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 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 Mexico Online Banking method.
  8. The payment platform receives the purchase request for payment processing from Payment Page.
  9. The payment platform performs the internal purchase request processing and sends it to the provider service.
  10. The purchase request is processed on the provider service side.
  11. The provider service generates the data for redirecting the customer to its website form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the provider website.
  14. The customer completes all the payment steps required.
  15. The payment is processed on the provider side.
  16. The result is displayed to the customer on the provider website.
  17. The customer is redirected to Payment Page.
  18. The provider service sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result to the web service.
  20. The payment platform sends the result to Payment Page.
  21. A page with the payment result information is displayed to the customer on Payment Page.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Mexico Online Banking 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 Mexico Online Banking 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—the project ID obtained from Monetix
    • payment_id—payment ID unique within the project
    • payment_currency—currency code in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. 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.
    • customer_id—unique ID of the customer within your project
    • customer_first_name—customer first name
    • customer_last_name—customer last name
    • customer_email—customer email address
  2. The currency of payment can only be USD.
  3. If you need to have payment form displayed with the Mexico Online Banking method selected, set the force_payment_method parameter to online-mexico-banks.
  4. If required, you can also add any other additional parameters Payment Page supports.
  5. 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(    
    { 
        payment_id: 'X03936', 
        payment_amount: 1000, 
        payment_currency: 'USD',
        customer_id: 'customer1',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@email.com', 
        project_id: 123, 
        signature: "kUi2x9dKHAVNU0FYldJRLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the Mexico Online Banking method, see Payment Page invocation parameters.

Callback format

The Mexico Online Banking 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 10.00 USD purchase made in the 239 project.

Figure 4. Example of data in a successful purchase callback
{
        "project_id": 239,
        "payment": {
            "id": "S0100_20200626_102701_21215202",
            "type": "purchase",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "method": "mexico",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 1592,
            "type": "sale",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "created_date": "2020-06-26T07:27:02+0000",
            "request_id": "dd536f8cbe316cb418170a81a6be7ad1c900e2b2056-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2174,
                "payment_id": "1593156426371",
                "auth_code": "",
                "date": "2020-06-26T07:27:06+0000"
            }
        },
        "signature": "a9/KmYMksEr+0ZAMCBA0F8tEhts55i3IxSl/bdLVvzhhMFg=="
    }
}

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

Figure 5. Example of data in a declined purchase callback
{
        "project_id": 2511,
        "payment": {
            "id": "D0100_20200626_103733_29570862",
            "type": "purchase",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "method": "mexico",
            "sum": {
                "amount": 20500,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 1593,
            "type": "sale",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "created_date": "2020-06-26T07:37:33+0000",
            "request_id": "13f5e69966da766f2fbbdf836f481c-00000001",
            "sum_initial": {
                "amount": 20500,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 20500,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2174,
                "payment_id": "1593157057421",
                "auth_code": "",
                "date": "2020-06-26T07:37:37+0000"
            }
        },
        "signature": "+ydiKiPFRjEVgpbSMi6U2BwiWYKgjt1DHr6Nqwg4SsrA=="
    }
}

Related topics

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

Purchase by using Gate

General information

In the Mexico Online Banking method, 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 the redirection of a customer to the provider service.
  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 by using Gate
  1. A customer initiates a purchase through Mexico Online Banking 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 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 provider service.
  7. The request is processed on the provider side.
  8. The provider service sends the data for redirecting the customer to the provider service to the payment platform.
  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 provider service.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the provider side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant's web service.
  15. The provider service sends the payment result notification to the payment platform.
  16. The payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Mexico Online Banking 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 Mexico Online Banking method:
  1. You perform purchases by sending the /v2/payment/banks/mexico/sale request by using POST (HTTP) method. This is the online-banking payments request group: /v2/payment/banks/{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 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.
    • payment—object with purchase information:
      • amount—purchase amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. 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
    • customer—object with customer information:
      • id—the unique ID of the customer within your project
      • ip_address—customer device IP
      • first_name—customer first name
      • last_name—customer last name
      • email—customer email address
  3. The currency of purchase can only be USD.
  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 Mexico Online Banking method.

Figure 7. Example of a purchase request
{
    "general": {
        "project_id": 1233,
        "payment_id": "test_payment_1",
        "signature": "fgret983tyufghndfh*YURGJhuufgsdf=="
    },
    "payment": {
        "amount": 1000,
        "currency": "USD"  
    }
    "customer": {
        "id": "customer123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    }
}

Format of 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 provider 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": "POST",
    "body": {
        "example_parameter_1": "value_1",
        "example_parameter_2": "value_2"
    },
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback format

The Mexico Online Banking 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 10.00 USD purchase made in the 239 project.

Figure 8. Example of data in a successful purchase callback
{
        "project_id": 239,
        "payment": {
            "id": "S0100_20200626_102701_21215202",
            "type": "purchase",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "method": "mexico",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 1592,
            "type": "sale",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "created_date": "2020-06-26T07:27:02+0000",
            "request_id": "dd536f8cbe316cb418170a81a6be7ad1c900e2b2056-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2174,
                "payment_id": "1593156426371",
                "auth_code": "",
                "date": "2020-06-26T07:27:06+0000"
            }
        },
        "signature": "a9/KmYMksEr+0ZAMCBA0F8tEhts55i3IxSl/bdLVvzhhMFg=="
    }
}

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

Figure 9. Example of data in a declined purchase callback
{
        "project_id": 2511,
        "payment": {
            "id": "D0100_20200626_103733_29570862",
            "type": "purchase",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "method": "mexico",
            "sum": {
                "amount": 20500,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 1593,
            "type": "sale",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "created_date": "2020-06-26T07:37:33+0000",
            "request_id": "13f5e69966da766f2fbbdf836f481c-00000001",
            "sum_initial": {
                "amount": 20500,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 20500,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2174,
                "payment_id": "1593157057421",
                "auth_code": "",
                "date": "2020-06-26T07:37:37+0000"
            }
        },
        "signature": "+ydiKiPFRjEVgpbSMi6U2BwiWYKgjt1DHr6Nqwg4SsrA=="
    }
}

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.