With our Payouts service you will be able to withdraw money to the account you indicate in case it is necessary.

Flow summary

  1. *MAKE LOGIN* We start by logging in through the authentication path of the api, this will allow you to get an authorization token needed to interact with the rest of the functions.
  2. *GENERATE PAYOUT* We indicate the fields of the account to which the Payout will be made, after that we will receive immediate response from the API confirming if the request was made/processed successfully.
  3. PROCESS WEBHOOK NOTIFICATION We process the final status notification of each Payout individually, in this step you must raise an API for asynchronous processing (webhook).

Additional options

  1. *CHECK ACCOUNT BALANCE* You can check the account balance at any time, consider checking the current balance before making a “massive” payout.
  2. *CHECK STATUS OF A PAYOUT* You can check the current status of a Payout through its unique identifier, this will allow you to check or update the status when in doubt, however, this method should never be the main method of updating Payout statuses.
  3. QUERY PAYOUTS BY DATE RANGE You can query the status of all your Payouts in a given date range defined during the API query.

Definitions:

Parameter Description
merchant_code Unique merchant identification code, will vary between sandbox and productive environments. Delivered by ETpay at the moment of initiating the communication chain for the integration.
merchant_api_token Authentication token for API use, will vary between sandbox and pre-production/production environments. Provided by ETpay at the moment of initiating the communication chain for integration.
username User name provided by ETpay at the moment of initiating the communication chain for the integration.
password Password provided by ETpay at the moment of initiating the chain of communications for the integration.
api_url Service API URL and login, will vary between sandbox and pre-production/production environments. Provided by ETpay at the time of initiating the communication chain for integration.
authorization_token Authorization token generated during the login step.

Base Flow

Login

To begin, we request that you can make a login, with that you can make use of the payouts service, this in order to provide greater security when making money movements.