v2.1
Solutions
API DOCUMENTATION
Products
GUIDES
Get balance
Sandbox environment: GET https://sandbox.dlocal.com/payouts/balances
Production environment: GET https://api.dlocal.com/payouts/balances
Headers
Header
Type
Description
x-Date
String
ISO8601 Datetime with Timezone. Eg 2020-07-12T13:46:28.629Z
x-Login
String
Merchant xLogin
x-Trans-Key
String
Merchant xTransKey
Content-Type
String
application/json
x-Version
String
Api Version
User-Agent
String
API Used to identify the application type, operating system, software vendor or software version of the requesting software user agent.
Authorization
String
<auth version>, Signature: <hmac(secretKey, "X-Login+X-Date Header+RequestBody")>
Considerations: 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.
Response body
Fields
Type
Description
currency
string
Balance currency
available balance
numeric
Balance available for payouts
previous day closing balance
numeric
Merchants current balance at the end of the previous day (GMT +0)
current balance
date
Data date
Example response body
1
{
2
"currency": "USD",
3
"available_balance": 42123.12,
4
"previous_day_closing_balance": 200000.00,
5
"current_balance_date": "2020-08-26
6
}
7
Copied!
Last modified 6mo ago
Copy link