Manage payouts

Get balance

This service allows you to check your available balance for making payouts.


<div style="background-color: #101917; padding: 20px; border-radius: 8px; border-left: 4px solid #4e80ee;"> <span style="color: #F1FDF7; font-weight: bold; font-size: 17px;">&#9432; Considerations</span> <br><br> <span style="color: #A7B1A8;"> In a sandbox environment the service will always return 1000.00 as we don’t have a merchant balance service (internal app) available in this environment. </span> </div>
get/payouts/v3/balance

Request

  • Base URL
    https://api.dlocal.com
  • URL
    https://api.dlocal.com/payouts/v3/balance
  • Auth
    API key in header X-Date and API key in header X-Version and API key in header Authorization

Response

Balance retrieved

currencystring

Balance currency

available_balancenumber

Balance available for payouts

previous_day_closing_balancenumber

Merchants current balance at the end of the previous day (GMT +0)

current_balance_datestring date

Data date

Example response

{
  "currency": "USD",
  "available_balance": 42123.12,
  "previous_day_closing_balance": 200000,
  "current_balance_date": "2020-08-26"
}

Changes

No recorded changes to this operation across all 1 revision of this API.