Account status
Learn about the account statuses for the User accounts for the dLocal for Platforms integration.
Status flow
Status detail
It's important to understand what each account status means in order to execute the appropriate actions. This reference table will help you track and manage the status of an account.
Status | Description |
---|---|
CREATING | The account is being created at dLocal. |
PENDING | The account is in process, waiting for documentation or under compliance review. |
APPROVED | The account is approved. |
BLOCKED | The account is blocked. Can be triggered by dLocal or Platform account. |
CANCELED | The account is canceled. Can be triggered by dLocal or Platform account. It's a final state. |
REJECTED | The account is rejected. |
This table provides a quick overview to facilitate efficient tracking and management of account statuses. You can also check the whole list of statuses and status details.
Pending accounts
- Pending accounts are in the process of review, creation, and setup necessary for payment processing.
- Pending accounts are restricted from receiving payments, processing refunds, and requesting settlements or payouts, but they can still receive chargebacks.
Blocked and unblocked accounts
- You can block and unblock an account from your end. When you unblock an account, it will revert to its previous status. For example, if the account was in
status: PENDING
andstatus_detail: documentation
unblocking it will return it to the same status before being blocked. - Blocked accounts are restricted from receiving payments, processing refunds, and requesting settlements or payouts, but they can still receive chargebacks.
Canceled accounts
- You also can cancel an account from your end. Canceled accounts are restricted from receiving payments, processing refunds, and requesting settlements or payouts, but they can still receive chargebacks.
- It's essential to note that once an account is canceled, reactivation is not possible. It's a final state.
Rejected accounts
- dLocal has the authority to reject an account for reasons related to tax ID not being valid or active, merchants selling restricted or prohibited products -in case of a marketplace or retail-, fraud, legal issues, or high risk.
- Rejected accounts are restricted from receiving payments, or requesting settlements or payouts, but they can still receive chargebacks or process refunds.
Account Capabilities
Based on the account status, merchants gain specific capabilities, including receiving payments, processing refunds, handling chargebacks, and initiating settlements or payouts. Refer to the table below for a clear understanding of which status allows these actions:
Status | Payins | Payouts | Settlements | Refunds |
---|---|---|---|---|
CREATING | ❌ | ❌ | ❌ | ❌ |
PENDING | ❌ | ❌ | ❌ | ❌ |
APPROVED | ✅ | ✅ | ✅ | ✅ |
BLOCKED | ❌ | ❌ | ❌ | ❌ |
CANCELED | ❌ | ❌ | ❌ | ❌ |
REJECTED | ❌ | ❌ | ❌ | ❌ |
This table provides a comprehensive overview of the actions permitted for each account status.
Allowed Operations
For each status, there are specific operations that can be performed. Refer to the table below to understand the possible operations you can perform under each account status:
To view the information for all the cards, position the cursor over the table and use the horizontal scroll to navigate.
Endpoint | CREATING | PENDING | APPROVED | BLOCKED | CANCELED | REJECTED |
---|---|---|---|---|---|---|
Update account information and upload documents | ❌ | ✅ Only when the account status detail is documentation .❌ If the account account status detail is compliance_review operations are restricted. This is necessary to ensure the immutability of the account during compliance reviews. | ✅ Only when the account status detail is pending_documentation .❌ If the account status detail is either approved or pending_compliance_review operations are restricted. This is necessary to ensure the immutability of the account after compliance reviews. | ❌ | ❌ | ❌ |
Get account KYC information | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
Get account credentials | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
Get account | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Update account settings | ❌ | ❌ | ✅ Only when the account status detail is either approved or pending_documentation .❌ If the account status detail is pending_compliance_review operations are restricted. This is necessary to ensure the immutability of the account after compliance reviews. | ❌ | ❌ | ❌ |
Block account | ❌ | ✅ | ✅ | ❌ | ❌ | ❌ |
Unblock account | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ |
Cancel account | ❌ | ✅ | ✅ | ❌ | ❌ | ❌ |
Get account balance | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
Add a bank account to an account | ❌ | ✅ | ✅ | ❌ | ❌ | ❌ |
Get bank account | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
If you attempt an action that is not compatible with the current status and account status detail, you'll receive an error message: Invalid account status
with an HTTP Status 400
.
Updated 8 months ago