Consult Payee

About this guide

This guide quickly demonstrates how to consult 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 consult 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 retrieve a payee. Check the table below for more details.

   Field	Description
   integration_key	Your unique and secret integration key
   payee_uuid	Payee uuid received on create endpoint response

2. Send your payout request to EBANX

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

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

   -d 'integration_key=your_test_integration_key' \

   -d 'payee_uuid=11bfcdc3-f323-4dd1-becc-a75235857fed' \

   And a successful creation will return a JSON Object with type "success" and the payee information.

   • The following example is an individual payee retrieve response:
   {

   "type": "success",

   "payee": {

   "uuid": "00648b6b-ac00-0100-0023-6b303689aaea",

   "name": "Han Solo",

   "email": "chew@bac.ca",

   "phone": "+5544919772017",

   "document": "85351346893",

   "document_type": "CPF",

   "birth_date": "11/18/1977",

   "status": "OP"

   }

   }
   • The following example is a company payee retrieve response:
   {

   "type": "success",

   "payee": {

   "uuid": "00648b6b-ac00-0100-0023-6b30368911ea",

   "name": "Star Wars Enterprise",

   "email": "lucas.george@sw.un",

   "phone": "+5544919772017",

   "document": "85351346800093",

   "document_type": "CNPJ",

   "birth_date": "11/18/1997",

   "status": "OP",

   "shareholders": [

   {

   "name": "Han Solo",

   "email": "chew@bac.ca",

   "phone": "+5544919772017",

   "document": "85351346893",

   "document_type": "CPF",

   "birth_date": "11/18/1977",

   "ownership_percent": "20",

   "country": "br"

   }

   ]

   }

   }

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.