Handle accounts
Learn account management essentials.
Through dLocal for Platforms API, you can easily manage your Liable accounts and User accounts.
With straightforward endpoints, you can efficiently perform tasks such as retrieving accounts, updating settings, blocking and unblocking, and canceling accounts whenever you need.
Get balance
Get the account balance with the account ID.
You can get the available balance and the amount pending to settle.
Check the balance of an existing account >
Please note that you can only payout/withdraw the amount available in balance to withdraw.
Get accounts
Retrieve all the information for an account by querying with the account ID.
Some use cases of using this endpoint:
- During the onboarding process, you can check the status of your accounts. Any errors will be displayed alongside the status information. You can then update the relevant details as needed. Additionally, you can subscribe to our webhook to receive notifications about any changes in account status.
- To access the detailed information about the account at any time.
Update account settings
In addition to the overall settings applied to your Platform account, we also support updating settings for Liable accounts and User accounts via API during your daily operations.
The settings that can be updated are:
- Pricing level. The specific user accounts or liable accounts can have different pricing levels compared to the general setting.
- Settlement period. Accounts can have a different settlement period than the general settings.
- Installment fee responsibility. You can specify whether the payin installment fee applies to users or end customers.
Adjust account configurations >
Block and unblock accounts
This function temporarily blocks or unblocks accounts, reverting status upon unblocking.
When you block accounts:
- Payins and refund requests for blocked accounts will be rejected.
- Payouts or withdrawal requests for blocked accounts will be rejected.
There are some circumstances that dLocal might block accounts for risk reasons mainly. We will inform you while webhooks with detailed reason to protect you away from the risks and help you to investigate further and solve the potential issues.
Cancel accounts
When the account is no longer being used, you can cancel an account.
Compared with block and unblock, this is an activity that can not be rollback.
Updated about 2 months ago