This page's content:

Endpoints

https://api.ebanxpay.com/ws/payout/create

https://sandbox.ebanxpay.com/ws/payout/create

HTTP Method

POST

Response

JSON

This method allows you to create a payout.

Request parameters

integration_key string, length 100, required

Your unique and secret integration key.

external_reference string, length 6-40, required

The unique payout ID provided by you.

country string, length 2, required

The two-letter country code for the customer country. The available codes are:

  • br: Brazil.
  • cl: Chile.
  • co: Colombia.
  • mx: Mexico.
  • pe: Peru.
amount float, required

The amount in the specified currency (currency_code). E.g.,: 100.50.

currency_code string, length 3, ISO 4217, required

Three-letter code of the payout currency. Supported currencies:

  • Brazil: BRL, EUR, USD, GBP.
  • Chile: CLP, EUR, USD, GBP.
  • Colombia: COP, EUR, USD, GBP.
  • Mexico: MXN, EUR, USD, GBP.
  • Peru: PEN, EUR, USD, GBP.
target string, optional

Payout target. Supported targets:

  • ebanx_wallet: Payee’s EBANX Wallet. (Available only in Brazil and Mexico)
  • bank_account: Payee’s bank account.

The default value is bank_account.

payee JSON, required

JSON with Payee information.

payee.name string, length 3-100, required

Payee full name.

payee.email string, length 10-100, required

Payee email address.

payee.phone string, length 10-15, optional

Payee phone number.

payee.birthdate string, length 10, required*

Payee birthdate in the format yyyy-mm-dd. E.g., 1977-05-25 Optional in Brazil when the Payee document type is CNPJ.

payee.document string, length 32, required*

Payee national identification number.

  • Brazil: CPF (natural person taxpayer ID) or CNPJ (business taxpayer ID).
  • Chile: RUT (Chilean taxation unique contributor roll identification number).
  • Colombia: Cédula de Ciudadanía – CC (National Identity Document) or Cédula de Extranjería – CE (National Identity Document for Immigrants).
  • Peru: DNI (National Identity Document).
  • Mexico: Payee document is optional for Mexico.
payee.document_type string, length 5, required*

Payee national identification number type.

  • Brazil: CPF or CNPJ.
  • Chile: RUT.
  • Colombia: CC or CE.
  • Peru: DNI.
  • Mexico: Payee document type is optional for Mexico.
payee.bank_info JSON, optional

JSON with Payee bank account information.

payee.bank_info.bank_name string, required

Bank name, check the list here.

payee.bank_info.bank_branch string, optional*

Bank branch number.

Required for Brazil.

payee.bank_info.bank_account string, required*

Bank account number.

Optional for Mexico, except when the bank is: BANME − BANCO SANTANDER.

payee.bank_info.account_type chat, length 1, required

Bank account type.

  • C – for checking account.
  • S – for savings account.
payee.bank_info.bank_details string, optional*

Additional information of the bank account.

  • Brazil: 3 digits operation code if bank is 104 Caixa Econômica, check the list here.
  • Colombia: city name, check the list here.
  • Mexico: Clabe (Mexican standardized banking cipher).

This method call will return a JSON object with the payout data.

Response parameters

type string

The type of the response (success, api_error, authentication_error, invalid_request_error, or request_error).

payout JSON

A JSON object that represents the payout.

payout.uid string, length 50, unique

The payout uid (EBANX unique identifier).

payout.external_reference string, length 6-40

The unique payout ID provided by you.

payout.status string, length 2

The payout status. The following statuses are available:

  • OP: the payout is waiting to start the payment process. It can change either to CA or to PE.
  • PE: the payout is in payment process.
  • PA: the payout is paid.
  • CA: the payout is canceled.
payout.request_date string, length 19, UTC Date

The date and hour of when the payout was requested.

payout.status_date string, length 19, UTC Date

The date and hour of the last status change.

payout.paid_date string, length 19, UTC Date

The date and hour of when the payout was paid.

payout.cancel_date string, length 19, UTC Date

The date and hour of when the payout was cancelled.

payout.payee JSON

JSON with Payee information.

payout.payee.name string, length 3-100

Payee full name.

payout.payee.email string, length 10-100

Payee email address.

payout.payee.phone string, length 10-15

Payee phone number.

payout.payee.birthdate string, length 10

Payee birthdate in the format yyyy-mm-dd.

payout.payee.document string, length 32

Payee national identification number.

payout.payee.document_type string, length 5

Payee national identification number type.

payout.payee.bank_info JSON

JSON with Payee bank account information.

payout.payee.bank_info.bank_name string

Bank name.

payout.payee.bank_info.bank_branch string

Bank branch number.

payout.payee.bank_info.bank_account string

Bank account number.

payout.payee.bank_info.account_type chat, length 1

Bank account type.

payout.payee.bank_info.bank_details string

Additional information of bank account.

payout.request_amount float

The amount in the original request currency.

payout.request_currency string, length 3, ISO 4217 three letter code

Three-letter code of the original request currency.

payout.request_exchange_rate float

The exchange rate used in the payout to calculate the debited amount.

payout.debit_amount float

The total amount debited to your account referring this payout and fee.

payout.debit_fee float

The fee amount of the payout.

payout.debit_amount_total float

The total amount debited in your account referring this payout and fee.

payout.debit_currency string, length 3, ISO 4217 three letter code

Three-letter code for the debit amount currency.

payout.target string

Payout target. E.g., bank_account or ebanx_wallet