Update Payee

About this guide

This guide quickly demonstrates how to update 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 update 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 update 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 update a Payee, you will use the /ws/payee/update endpoint.

   • The following example is a update of the payee's bank information:
   curl -X POST 'https://sandbox.ebanxpay.com/ws/payee/update' \

   -d 'integration_key=your_test_integration_key' \

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

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

   -d 'bank_branch=3708' \

   -d 'bank_account=08251777-6' \

   -d 'account_type=C' \

   -d 'bank_details=001' \

   And a successful creation will return a JSON Object with type "success" and the 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"

   }

   Basic information

   Note that the basic payee information such as name, document, document_type or email can not be updated.

   You can either update a payee document file:

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

   -d 'integration_key=your_test_integration_key' \

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

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

   Payee as Company

   Note that you can update the shareholders informations from a payee.

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

   -d 'integration_key=your_test_integration_key' \

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

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

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

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

   -d 'shareholders[0][email]=princess@leia.sw' \

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

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 ou this form and our comercial 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.