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.

name

string

Customer name.

email

string

Customer email address.

country

string

Two-letter country code - co for Colombia.

payment_type_code

string

The customer chooses the payment method. Supported values:

  • _all: all available payment methods for the merchant account in this country.
  • eft: Colombian bank transfer.
  • baloto: BALOTO cash payment.
  • _creditcard: Visa, Mastercard, Amex and Diners Credit Card.

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

To adapt to the banknotes and coins that circulate in Colombia which are always divided by 50, EBANX is changing how Cash Payments are processed. Starting January 8th, all payments done with Baloto will be rounded accordingly to the following scheme:

  • 1 – 24 COPs will be round off to 00 COPs
  • 25 – 49 COPs will be round off to 50 COPs
  • 51 – 74 COPs will be round off to 50 COPs
  • 75 – 99 COPs will be round off to 100 COPs

So if a person pays COP 5,523 and chooses to pay using a Colombian cash payment with EBANX, the amount will be automatically rounded off to COP 5,500. That applies only whether the transaction is using COP.

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 customer chooses the payment method. 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

To adapt to the banknotes and coins that circulate in Colombia which are always divided by 50, EBANX is changing how Cash Payments are processed. Starting January 8th, all payments done with Baloto will be rounded accordingly to the following scheme:

  • 1 – 24 COPs will be round off to 00 COPs
  • 25 – 49 COPs will be round off to 50 COPs
  • 51 – 74 COPs will be round off to 50 COPs
  • 75 – 99 COPs will be round off to 100 COPs

So if a person pays COP 5,523 and chooses to pay using a Colombian cash payment with EBANX, the amount will be automatically rounded off to COP 5,500. That applies only whether the transaction is using COP.

payment.amount_total

float

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

EFT – API Request

The following parameters are specific to the EFT payment method:

payment.payment_type_code

string

The value must be etf for EFT payments.

payment.eft_code

string

The 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 to the Baloto payment method:

payment.payment_type_code

string

The 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 to the credit card payment method:

payment.payment_type_code

string

The supported values for credit card payments are:

  • amex: American Express credit card.
  • diners: Diners credit card.
  • mastercard: Mastercard credit card.
  • visa: Visa credit card.

If you are going to use tokenization, we strongly suggest to create the token during the payment request in order to improve the conversion rate. For more details, check here.

payment.document

string

Customer NIT / CC (Número de Identificación Tributaria). It must be a valid one.

payment.zipcode

string

Customer zip code.

payment.address

string

Customer address (street name).

payment.street_number

string

Customer street number.

payment.city

string

Customer city’s name.

payment.state

string

Customer state name.

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 customer’s 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

true: the payment will be captured automatically by EBANX. For the moment, the false option(where the payment is captured automatically by the Merchant) is not supported in Colombia.

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