Checkout API

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

The following parameters are mandatory for Bitcoin 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.

payment_type_code

string

The payment method:

  • bitcoin: Bitcoin payment.

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. USD is the only supported value.

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 Bitcoin 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.country

string

Two-letter country code.

payment.payment_type_code

string

The payment method:

  • bitcoin: Bitcoin payment.

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. USD is the only supported value.

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 redirect_url – he’ll then be automatically redirected to Bitpay’s website.

You can also show the Bitpay’s payment website with it’s iframe within invoice.iframe_url