To create a payment using a fixed exchange rate, you must first enable this feature with EBANX integration team.

After that, you must create an FX Token for this operation.

Creating a payment using the FX Token

These are the parameters that you should use for the request:

integration_key

string

Your unique and secret integration key.

fx_token

string

The token to be used in fixed exchange rate operations

payment.merchant_payment_code

string

Unique identifier for this payment (usually the order number from your system).

payment.amount_total

float

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

payment.currency_code

string

The currency code of your transaction. Supported values: BRL, CLP, COP, MXN, ARS, PEN

payment.country

string

Two-letter country code. Supported values:

  • br: Brazil.
  • ar: Argentina.
  • co: Colombia.
  • mx: Mexico.
  • pe: Peru.
  • cl: Chile.

payment.email

string

Customer email address.

payment_type_code

string, length 32, required

The code of the payment method. The supported codes are:

  • amex: American Express credit card (Brazil, Mexico, Colombia).
  • aura: Aura credit card (Brazil).
  • baloto: Baloto (Colombia).
  • bancodobrasil: Banco do Brasil bank transfer (Brazil).
  • banrisul: Banrisul bank transfer (Brazil).
  • boleto: Boleto bancário (Brazil).
  • bradesco: Bradesco bank transfer (Brazil).
  • carnet: CARNET credit card (Mexico).
  • diners: Diners credit card (Brazil, Colombia).
  • discover: Discover credit card (Brazil).
  • ebanxaccount: EBANX Account (Brazil).
  • eft: Bank Transfer (Colombia).
  • elo: Elo credit card (Brazil).
  • hipercard: Hipercard credit card (Brazil).
  • itau: Itaú bank transfer (Brazil).
  • mastercard: MasterCard credit card (Brazil, Mexico, Colombia).
  • multicaja: Multicaja (Chile).
  • oxxo: OXXO (Mexico).
  • pagoefectivo: PagoEfectivo (Peru).
  • safetypay: SafetyPay (Peru, Checkout only).
  • safetypay-cash: SafetyPay Cash (Peru).
  • safetypay-online: SafetyPay Online (Peru).
  • sencillito: Sencillito (Chile).
  • servipag: Servipag (Chile).
  • spei: SPEI bank transfer method (Mexico).
  • visa: Visa credit card (Brazil, Mexico, Colombia).
  • webpay: Webpay (Chile).

payment.name

string

Customer name.

payment.document

string

Customer document like CPF, RUT, or DNI. Must be a valid document in the origin country of the customer.

payment.phone_number

string

Customer phone number with area code.

A successful request will return a JSON expression similar to the one below. You will need to redirect the customer to redirect_url – the customer then be automatically redirected to the bank website to complete the payment.