Documentation
OUR SOLUTIONCOUNTRIESCUSTOMERSCONTACT US
Search…
Documentation
v2.1
dLocal Documentation
Solutions
Payins
Payouts
Local Issuing
API DOCUMENTATION
Payins API Reference
Payouts API Reference
Environments
Security
Submit a payout
Get balance
Get Payout
Check status
Cancel payout
Release On hold payout
Currency exchange
Notification parameters
Payout Flows
API codes
Local Issuing API Reference
Products
Smart Fields
GUIDES
API integration guide
PCI Compliance
Google Pay™
Shopify setup
Tienda Nube setup
Lightspeed setup
Reporting
Guides
Other
Dashboard Manual
Changelog
Status Page
Chinese 中文文档
Powered By GitBook
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

{
"currency": "USD",
"available_balance": 42123.12,
"previous_day_closing_balance": 200000.00,
"current_balance_date": "2020-08-26
}
​
Previous
Vietnam
Next
Get Payout
Last modified 10mo ago
Copy link
On this page
Headers
Response body