Optimize your outgoing payments in a fast, guided, and fully automated way.

<aside> ⚠️

This product is highly sensitive, as it involves the outflow of money. For this reason, we recommend maintaining high security standards and always remembering that all credentials must remain under strict protection and should not be shared through any communication channel.

If any credential is exposed or there is a suspicion of compromise, we recommend contacting our support team immediately at [email protected] and changing the credentials.

</aside>

Flow Summary

  1. LOGIN ****We start by logging in through the API authentication route, which will allow you to obtain an authorization token necessary 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 which we will receive an immediate response from the API confirming whether the request was successfully made/processed.
  3. PROCESS WEBHOOK NOTIFICATION We process the final status notification for each Payout individually. In this step, you must set up an API for asynchronous processing (webhook). This step is mandatory to obtain Payout approval.

Additional Options

  1. CHECK ACCOUNT BALANCE ****You can check the account balance at any time. Consider checking the current balance before making a "bulk" Payout.
  2. CHECK PAYOUT STATUS ****You can check the current status of a Payout using its unique identifier. This will allow you to check or update the status in case of questions. However, this method should never be the primary method for updating Payout statuses.
  3. QUERY PAYOUTS BY DATE RANGE You can check the status of all your Payouts within a specific date range defined during the API query.
  4. ERROR CODES The etpay integration team can configure your profile with this feature. Payout error codes are a simpler way to map errors.

Definitions

Parameter Description
merchant_code The unique merchant identification code, which will vary between sandbox and production environments. Provided by ETpay when starting the communication chain for integration.
merchant_api_token The authentication token for API use, which will vary between sandbox and production environments. Provided by ETpay when starting the communication chain for integration.
username The username corresponds to the email address provided during the Onboarding process. This user will be defined as the account owner and will have the ability to execute Payouts.
password The password will be generated upon receiving the invitation to join the platform (it is important to remember that this password should not be shared).
api_url The API URL for services and login, which will vary between sandbox and production environments. Provided by ETpay when starting the communication chain for integration.
authorization_token The authorization token will allow proper validation of the user attempting to make the payouts.

Base Flow

1. Login

To begin, you must log in, which will allow you to use the payouts service. This is to provide greater security when making money movements.

You must POST to the endpoint detailed below: