Notifications will be sent when the status of account changes.
The notifications will be delivered to the notification_url sent in the account creation request.
Until dLocal receives a 200 status code confirmation on these notifications, it will retry once an hour for 7 days.
Signature Notifications
An HMAC signature is calculated using a request's key-value pairs and a secret key, which is known only to you and dLocal. By verifying this signature, you'll confirm that the notification was not modified during transmission.
dLocal will be signing each POST notification using the same method described on the Security section (HMAC-SHA256 hash function).
Simply take the Signature HTTP header from the notification, and compare it with the one generated by you using your X-Login and secretKey, and the X-Date and Request body of the notification received. If the signature generated by you matched the one received on the Signature HTTP header, then it is safe to assume that this is a valid message from dLocal.
Request Fields
| Body Field | Type | Description |
|---|---|---|
event_type | String | Notification type. Values: - ACCOUNT_STATUS_UPDATE- PRICING_LEVEL_UPDATE- INDUSTRY_UPDATE- INSTALLMENTS_RESPONSIBLE_UPDATE- CAPABILITIES_STATUS_UPDATE- PROOF_OF_LIFE_UPDATE- BANK_ACCOUNT_STATUS_UPDATE- MERCHANT_TRANSFER_STATUS_UPDATE- INTERNAL_TRANSFER_STATUS_UPDATE |
account_id | String | dLocal account ID. |
account_external_reference | String | Account external ID. |
notification_date | Date (ISO-8601) | Notification’s timestamp. |
payload | Object | Notification payload may vary between notification types. Please see details. |
Example request
If you are missing some examples, try positioning the cursor on the title row and use the horizontal scroll to navigate.
{
"account_id":"d907f733-5e17-4470-b963-c2ac2c11a440",
"event_type": "ACCOUNT_STATUS_UPDATE",
"account_external_reference":"2352362346",
"notification_date":"2021-07-12T13:07:08.000Z",
"payload": {
"last_updated":"2021-07-12T13:07:08.000Z",
"status":"APPROVED",
"status_code": 200,
"status_detail": "approved"
}
}
{
"account_id":"d907f733-5e17-4470-b963-c2ac2c11a440",
"event_type": "PRICING_LEVEL_UPDATE",
"account_external_reference":"2352362346",
"notification_date":"2021-07-12T13:07:08.000Z",
"payload": {
"last_updated":"2021-07-12T13:07:08",
"new_price_level": "freemium",
"new_settlement_period": 7,
"old_price_level": "smbs_1",
"old_settlement_period": 14
}
}
{
"account_id":"d907f733-5e17-4470-b963-c2ac2c11a440",
"event_type": "INDUSTRY_UPDATE",
"account_external_reference":"2352362346",
"notification_date":"2021-07-12T13:07:08.000Z",
"payload": {
"last_updated":"2021-07-12T13:07:08",
"new_industry_type": "PLAN_AHORA_INDUMENTARIA",
"old_industry_type": "PLAN_AHORA_OTHER"
}
}
{
"account_id":"d907f733-5e17-4470-b963-c2ac2c11a440",
"event_type": "INSTALLMENTS_RESPONSIBLE_UPDATE",
"account_external_reference":"2352362346",
"notification_date":"2021-07-12T13:07:08.000Z",
"payload": {
"last_updated":"2021-07-12T13:07:08",
"new_installment_responsible": "CUSTOMER",
"old_installment_responsible": "MERCHANT"
}
}
{
"account_id":"d907f733-5e17-4470-b963-c2ac2c11a440",
"event_type": "CAPABILITIES_STATUS_UPDATE",
"account_external_reference":"2352362346",
"notification_date":"2021-07-12T13:07:08.000Z",
"payload": {
"last_updated":"2021-07-12T13:07:08.000Z",
"capabilities": [
{
"capability_name": "PAYINS",
"capability_status": "DISABLED",
"restrictions": [
{
"requested_by": "BY_FRAUD",
"date": "2023-12-06"
},
{
"requested_by": "BY_LEGAL",
"date": "2023-12-01"
}
]
},
{
"capability_name": "PAYOUTS",
"capability_status": "ENABLED",
"restrictions": []
},
{
"capability_name": "SETTLEMENTS",
"capability_status": "ENABLED",
"restrictions": []
},
{
"capability_name": "REFUNDS",
"capability_status": "ENABLED",
"restrictions": [
{
"requested_by": "BY_ADMIN",
"date": "2023-12-06T12:00:00"
}
],
"override": {
"requested_by": "BY_ADMIN",
"date": "2023-12-06T13:00:00"
}
}
]
}
}
{
"account_id":"d907f733-5e17-4470-b963-c2ac2c11a440",
"event_type": "PROOF_OF_LIFE_UPDATE",
"account_external_reference":"2352362346",
"notification_date":"2021-07-12T13:07:08.000Z",
"payload": {
"last_updated":"2021-07-12T13:07:08",
"new_proof_of_life_status": "COMPLETED",
"old_proof_of_life_status": "PENDING"
}
}
{
"event_type": "BANK_ACCOUNT_STATUS_UPDATE",
"account_id":"d907f733-5e17-4470-b963-c2ac2c11a440",
"account_external_reference":"2352362346",
"notification_date":"2021-07-12T13:07:08.000Z",
"payload": {
"status":"ACTIVE",
"status_code": 200,
"status_detail": "",
"bank_account_id": "46a64be0-82f7-4d8c-9906-bfcfcaca8396",
"last_updated":"2021-07-12T13:07:08.000Z"
}
}
{
"event_type": "MERCHANT_TRANSFER_STATUS_UPDATE",
"notification_date": "2024-07-19T17:00:31",
"payload": {
"external_id": "e043ca72-3530-4c2f-8458-99d89f1f2d8a",
"id": "a47f44c3-c115-4ddc-bd3d-900640bd33f4",
"last_updated_date": "2024-07-19T17:00:31.918380621Z",
"previous_status": "PENDING",
"status": "RELEASED",
"status_code": 200,
"type": "INSTANT"
}
}
{
"event_type": "INTERNAL_TRANSFER_STATUS_UPDATE",
"notification_date": "2024-07-19T17:00:31",
"payload": {
"id": "TF-a47f44c3-c115-4ddc-bd3d-900640bd33f4",
"transaction_id":"REF-115-4ddc-bd3d-900640",
"origin": "AC-d907f733-5e17-4470-b963-c2ac2c11a440",
"destination": "AC-303ccb43-f346-4365-a245-910aeafea032",
"amount": 120000.00,
"currency": "BRL",
"last_updated_date": "2024-07-19T17:00:31.918380621Z",
"previous_status": "PENDING",
"status": "RELEASED",
"status_code": 200,
"type": "INSTANT"
}
}