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

string

The payment method chosen by the customer. Supported values:

  • eft: Colombian bank transfer.
  • baloto: BALOTO cash payment.
  • _creditcard: Visa, Mastercard, Amex and Diners 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: 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.

You can also make a request using the baloto payment method.

The response is similar to eft.

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

string

The payment method chosen by the customer. Supported values:

  • eft: Colombian bank transfer.
  • baloto: BALOTO cash payment.
  • credit_card: Visa, Mastercard, Amex and Diners 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: COP, USD and EUR

payment.amount_total

float

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

EFT – API Request

The following parameters are specific for the EFT payment method:

payment.payment_type_code

string

Value must be etf for EFT payments.

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.

Baloto – API Request

The following parameters are specific for the Baloto payment method:

payment.payment_type_code

string

Value must be baloto for Baloto payments.

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

Credit Card – API Request

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.
  • diners: Diners credit card.
  • mastercard: Mastercard credit card.
  • visa: Visa credit card.

payment.document

string

Customer DNI (Dirección Nacional de Inteligencia). It must be a valid one.

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

integer

The number of instalments* of the payment (from 1 to 36).

payment.creditcard

JSON

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