Checkout API

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

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

integration_key

string

Your unique and secret integration key.

payment.name

string

Customer name.

payment.email

string

Customer email address.

payment.country

string

Two-letter country code - co for Colombia.

payment.document

string

Customer unique document identifier (taxpayer identification number). It must be a valid one.

payment.payment_type_code

string

The payment method chosen by the customer. Supported values:

  • eft: Colombian bank transfer.

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: COP, USD and EUR

payment.amount_total

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.

The following parameters are mandatory for Colombian 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 - co for Colombia.

payment.document

string

Customer unique document identifier (taxpayer identification number). It must be a valid one.

payment.payment_type_code

string

The payment method chosen by the customer. Supported values:

  • eft: Colombian bank transfer.

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: COP, USD and EUR

payment.amount_total

float

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

eft

The following parameters are specific for the eft payment method:

payment.eft_code

string

Value must be the bank’s code provided in the ws/getBankList operation.

A successful request will return a JSON expression similar to the one below. You will need to redirect the customer to redirect_url – he’ll then be automatically redirected to PagoEfectivo’s website.