Create Payee

About this guide

This guide quickly demonstrates how to create a payee in EBANX. We will walk you through the basic steps to achieve this goal using your already existing Direct API integration.

How it works

To create a payee through EBANX Direct API, please follow the steps below.

1. Make sure you have all the mandatory fields in your request

   There are a few key parameters you need to provide to create a payee. Check the table below for more details.

   Field	Description
   integration_key	Your unique and secret integration key.
   name	Payee name
   email	Payee email address
   document	Payee Tax ID number
   document_type	Type of Tax ID document
   country	The two-letter country code for the customer country. In this case, we'll show the method to br (Brazil)

   Document Types Allowed:

   These types of documents are used by the payees or shareholders.

   Document type	Country	Description
   DNI	Argentina	National Identity Document, with 8 digits.
   CUIL	Argentina	Tax identification for working individuals, with 11 digits.
   CUIT	Argentina	Tax identification for companies, with 11 digits.
   CPF	Brazil	Tax identification number for individuals, with 11 digits.
   CNPJ	Brazil	Tax identification number for companies, with 14 digits.
   RUN	Chile	National unique role.
   RUT	Chile	Tax identification number for individuals and companies
   CC	Colombia	Cedula de Ciudadania (identification number) with 10 digits
   CE	Colombia	Identification number for foreigners, with 13 digits .
   NIT	Colombia	Tax identification number for companies, with 10 digits
   RFC	Mexico	Tax identification number for companies and individuals, with 12 or 13 digits
   CURP	Mexico	Tax identification information for individuals, with 18 digits (alpha numeric)

2. Send your payout request to EBANX

   To create a new Payee, you will use the /ws/payee/create endpoint.

   The following example is a payee create request with only mandatory fields:

   curl -X POST 'https://sandbox.ebanxpay.com/ws/payee/create' \

   -d 'integration_key=your_test_integration_key' \

   -d 'name=Han Solo' \

   -d 'email=chew@bac.ca' \

   -d 'document=85351346893' \

   -d 'document_type=cpf' \

   -d 'country=br' \

   And a successful creation will return a JSON Object with type "success" and a payee UUID (Universally Unique IDentifier) unique key which will allows you to update and/or consult payee.

   {

   "type": "success",

   "uuid": "11bfcdc3-f323-4dd1-becc-a75235857fed"

   }

   Besides basic mandatory information, you can provide extras such as: bank information, document uploads, company payee with shareholder information. The response will always returns the same structure.

   • The following example is a payee create request with bank information, which will be used for payouts via bank transfer:
   curl -X POST 'https://sandbox.ebanxpay.com/ws/payee/create' \

   -d 'integration_key=your_test_integration_key' \

   -d 'name=Han Solo' \

   -d 'email=chew@bac.ca' \

   -d 'document=85351346893' \

   -d 'document_type=cpf' \

   -d 'country=br' \

   -d 'bank_name=104 Caixa Econômica' \

   -d 'bank_branch=3708' \

   -d 'bank_account=08251777-6' \

   -d 'account_type=C' \

   -d 'bank_details=001' \
   • The following example is a payee create request with file upload. This is not mandatory, but the payee documents are required for receivers that reach 10k USD in lifetime receivables:

   Upload

   There are some constraints to upload files: limited to 3.5MB each. Allowed only to png, pdf and jpeg file types.

   curl -X POST 'https://sandbox.ebanxpay.com/ws/payee/create' \

   -d 'integration_key=your_test_integration_key' \

   -d 'name=Han Solo' \

   -d 'email=chew@bac.ca' \

   -d 'document=85351346893' \

   -d 'document_type=cpf' \

   -d 'country=br' \

   -F 'proof_of_identity=@path/to/local/file' \

   Payee as Company

   Note that you can create payees for a company and for that, you need to provide the main shareholder information.

   • The following example is a payee create request for company:
   curl -X POST 'https://sandbox.ebanxpay.com/ws/payee/create' \

   -d 'integration_key=your_test_integration_key' \

   -d 'name=Han Solo' \

   -d 'email=chew@bac.ca' \

   -d 'document=95575888000105' \

   -d 'document_type=cnpj' \

   -d 'country=br' \

   -d 'shareholders[0][name]=Princess Leia' \

   -d 'shareholders[0][document]=58017604076' \

   -d 'shareholders[0][document_type]=cpf' \

   -d 'shareholders[0][ownership_percent]=50' \

   Company Upload

   Note that when sending document uploads for a company payee you should send company documentation (proof_of_business) and the main shareholder documentation (proof_of_identity). Proof of business being the legal social contract with the company's tax ID and shareholder information. Proof of identity being an official document (tax ID) with the individual's image.

   • The following example is a payee create request for company with file (POB and POI) upload:
   curl -X POST 'https://sandbox.ebanxpay.com/ws/payee/create' \

   -d 'integration_key=your_test_integration_key' \

   -d 'name=Han Solo' \

   -d 'email=chew@bac.ca' \

   -d 'document=95575888000105' \

   -d 'document_type=cnpj' \

   -d 'country=br' \

   -d 'shareholders[0][name]=Princess Leia' \

   -d 'shareholders[0][document]=58017604076' \

   -d 'shareholders[0][document_type]=cpf' \

   -d 'shareholders[0][ownership_percent]=50' \

   -F 'proof_of_identity=@path/to/local/file' \

   -F 'proof_of_business=@path/to/local/file' \

Getting help

We hope this article was enlightening, but in case we’ve failed to take out your doubts you have the following options to keep on seeking for answers:

• If you’re not our partner yet and would like to know more about our prices and conditions please fill our this form and our commercial team will get in touch with you.
• In case you’re already our partner please get in touch with our support team at integration@ebanx.com.