This page's content:

Payment Page API

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

The following parameters are mandatory for Ecuadorian payment methods using EBANX Payment Page. Depending on your business model, more information can be required for a payment request:

integration_key string

Your unique and secret integration key.

name string

Customer name.

email string

Customer email address.

country string

Two-letter country code ec for Ecuador.

payment_type_code string

The customer chooses the payment method. Supported values:

  • _all: all available payment methods for the merchant account in this country.
  • 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: 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 Payment Page 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 Ecuadorian payment methods using EBANX Direct. Depending on your business model, more information can be required for a payment request:

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 ec for Ecuador.

payment.payment_type_code string

The customer chooses the payment method. Supported values:

  • 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: USD

payment.amount_total float

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

SafetyPay – Direct API

The following parameters are specific to the SafetyPay payment method. Depending on your business model, more information can be required for a payment request:

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.