Documentation
OUR SOLUTIONCOUNTRIESCUSTOMERSCONTACT US
Search…
Documentation
v2.1
dLocal Documentation
Solutions
Payins
Payouts
Direct Issuing
API DOCUMENTATION
Payins API Reference
Payouts API Reference
Environments
Security
Submit a payout
Validation account endpoint - Nigeria
Check status
Cancel payout
Release On hold payout
Currency exchange
Notification parameters
Payout Flows
API codes
Direct 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
Notification parameters
The Payouts API will send notifications to your Notification URL using the POST protocol whenever there is a payout status change. The following is a list of the parameters included in the notification POST message:
Field
Format
Description
Example
external_id
String (max. 100 chars)
Payout identification (at the merchant site)
payout1234
cashout_id
Number (max. 10 chars)
Payout identification (at dLocal site)
10050
date
Format: YYYY-MM-DD HH:MM:SS (GMT)
The date when the status changed
2015-10-03 15:32:01
bank_reference_id
String (max. 50 chars)
Number reference at the bank
513512.04198.5
comments
String (max. 200 chars)
Payout comment
This is a comment

Example

1
Content-Type: application/x-www-form-urlencoded
2
external_id=ext123
3
cashout_id=123456
4
date=2021-04-29 02:16:24
5
bank_reference_id=ref321
6
comments=Merchant
7
comments&control=6C40B2B4E7F43EF7EA3C6C0F386C11865D60892591301CDF6C62FBE6A5FFEF1D
Copied!
Previous
Currency exchange
Next
Payout Flows
Last modified 5mo ago
Copy link
Contents
Example