Checkout API

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

The following parameters are mandatory for Peruvian 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 - pe for Peru.

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.
  • pagoefectivo: PagoEfectivo.
  • safetypay: SafetyPay, will offer the customer to choose between SafetyPay Cash and SafetyPay Online.

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: PEN, 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.

The following parameters are mandatory for Peruvian 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 - pe for Peru.

payment.payment_type_code

string

The payment method chosen by the customer. Supported values:

  • pagoefectivo: PagoEfectivo.
  • safetypay-cash: SafetyPay Cash.
  • safetypay-online: SafetyPay Online.

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: PEN, USD

payment.amount_total

float

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

PagoEfectivo

The following parameters are specific for the PagoEfectivo payment method:

payment.payment_type_code

string

Value must be pagoefectivo for PagoEfectivo payments.

A successful request will return a JSON expression similar to the one below. The PagoEfectivo link will be the value of payment.cip_url.

SafetyPay

The following parameters are specific for the SafetyPay payment method:

payment.payment_type_code

string

The payment method chosen by the customer. Supported values:

  • safetypay-cash: SafetyPay Cash.
  • safetypay-online: SafetyPay Online.

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 SafetyPay’s website.