Checkout API

To create a payment using EBANX Checkout, you must call the API method request.

In Mexico, Credit and Debit cards have the same payment flow so you don’t need to specify the type of the card.

The following parameters are mandatory for Mexican payment methods using EBANX Checkout:

integration_key

string

Your unique and secret integration key.

name

string

Customer name.

email

string

Customer email address.

country

string

Two-letter country code – mx for Mexico.

payment_type_code

string

The payment method chosen by the customer. Supported values:

  • _all: all available payment methods for the merchant account in this country.
  • _creditcard: Visa, Mastercard and American Express credit cards.
  • spei: SPEI.
  • oxxo: OXXO.

merchant_payment_code

string

Unique identifier for this payment (usually the order number from your system).

currency_code

string

The currency code of your transaction. Supported values: MXN, USD

amount

float

Transaction amount, in the specified currency. E.g.: 100.50

A successful request will return a JSON expression similar to the one below. You will need to redirect the customer to the EBANX Checkout using the redirect_url.

Direct API

To create a payment using EBANX Direct, you must call the API method direct.

In Mexico, Credit and Debit cards have the same payment flow so you don’t need to specify the type of the card.

The following parameters are mandatory for Mexican payment methods using EBANX Direct:

integration_key

string

Your unique and secret integration key.

payment.name

string

Customer name.

payment.email

string

Customer email address.

payment.phone_number

string

Customer phone number with area code.

payment.country

string

Two-letter country code – mx for Mexico.

payment.payment_type_code

string

The payment method chosen by the customer. Supported values:

  • amex: American Express credit card.
  • carnet: CARNET credit card.
  • mastercard: Mastercard credit card.
  • oxxo: OXXO.
  • spei: SPEI.
  • visa: Visa credit card.

payment.merchant_payment_code

string

Unique identifier for this payment (usually the order number from your system).

payment.currency_code

string

The currency code of your transaction. Supported values: MXN, USD

payment.amount_total

float

Transaction amount, in the specified currency. E.g.: 100.50

Credit card

In Mexico, Credit and Debit cards have the same payment flow so you don’t need to specify the type of the card.

The following parameters are specific for the credit card payment method:

payment.payment_type_code

string

The supported values for bank transfer payments are:

  • amex: American Express credit card.
  • mastercard: Mastercard credit card.
  • visa: Visa credit card.
  • carnet: CARNET credit card.

payment.instalments

integer

The number of instalments of the payment, supported values are:

  • amex: 3, 6 ,9 or 12.
  • mastercard: 3, 6, 9 or 12.
  • visa: 3, 6, 9 or 12.

payment.zipcode

string

Customer zipcode.

payment.address

string

Customer address (street name).

payment.street_number

string

Customer street number.

payment.city

string

Customer city name.

payment.state

string

Customer two-letter region code.

payment.phone_number

string

Customer phone number with area code.

payment.creditcard

JSON

Object containing the customers credit card information.

payment.creditcard.card_number

string

Credit card number.

payment.creditcard.card_name

string

Credit card cardholder name.

payment.creditcard.card_due_date

string

Credit card due date (“valid thru”) in the format mm/yyyy.

payment.creditcard.card_cvv

string

Credit card security code.

payment.creditcard.auto_capture

boolean

If true, the payment will be captured automatically by EBANX; if false, the payment will have to be captured by the [merchant using the [API method capture]().

A successful request will return a JSON expression similar to the one below.

OXXO

The following parameters are specific for the OXXO payment method:

payment.payment_type_code

string

Value must be oxxo for OXXO payments.

A successful request will return a JSON expression similar to the one below. The slip link will be the value of payment.oxxo_url, and the slip barcode will be the value of payment.oxxo_barcode.

SPEI

The following parameters are specific for the SPEI payment method:

payment.payment_type_code

string

Value must be spei for SPEI payments.

A successful request will return a JSON expression similar to the one below. The customer’s CLABE account will be the value of payment.clabe_account, and the reference for the current payment will be the value of payment.clabe_reference