Get Payout
The Get Payout service brings the payout information based on the Payout ID or the External ID.
Sandbox: https://sandbox.dlocal.com/payouts
Production: https://api.dlocal.com/payouts
get
httpa://api.dlocal.com/payouts
This service will bring the payouts details for an specific payout id.
Response Parameters
Parameter
Description
status_description
Payout’s status
status_code
Payout’s status code
error_code
In case the payout is rejected the error code of the rejection
error_description
In case the payout is rejected the error code description of the rejection
external_id
Id sent by the merchant to identify the payout
payout_id
Id created by dlocal for the payout
amount
Amount sent on the payout creation request
currency
Currency sent on the payout creation request
creation_date
Date the payout was requested
country
Payout’s country
exchange_rate
FX applied to the payout
amount_details
Object with all the amounts calculated after getting the request.
Amount_details → amount_to_pay
Amount to pay to beneficiary
Amount_details → currency_to_pay
Currency of the amount to pay to beneficiary
Amount_details→ debit_note
Object with amount and currency that will be debited from merchant dlocals balance
Amount_details → taxes
Object with the total amount of taxes and details of each tax, with the currency that will be the same as the one used for the debit note.
Amount_details →fees
Object with the fee that will apply for the payout
beneficiary
Object with the beneficiaries details send by the merchant on the request
processing_id
Only if payout is completed and the country banks/wallets have processing Ids. This Id is the one that the beneficiary can use to ask the bank about the transaction.
Copy link