Hold and Release Payout
A 4-step recipe with dLocal. We can help you get access.
Recipe · 4 steps
Hold and Release Payout
with dLocal
Create a held payout and release or cancel it after review.
- Request a payout with on_hold=true so the disbursement is created but not yet released to the beneficiary.
- Retrieve the held payout to review its status before deciding to release or cancel.
- Release the previously held payout so the funds are disbursed to the beneficiary.
- Cancel the held payout when the review determines it should not be disbursed.
What you'll need to have ready
- externalId: Merchant-provided unique payout identifier.
- country: Destination country ISO 3166-1 alpha-2 code.
- amount: Payout amount in the source currency.
- currency: ISO-4217 source currency code.
- paymentMethodId: Payout method (BANK_TRANSFER, INSTANT_PAYMENT, CARD, CASH_PICK_UP).
- purpose: Payout purpose (e.g. REMITTANCES, PAYROLL).
- flowType: Transaction flow type (B2C, B2B, P2P).
- beneficiaryFirstName: Beneficiary first name.
- beneficiaryLastName: Beneficiary last name.
- beneficiaryDocument: Beneficiary national identification document.
For your developer
Arazzo workflow d-local:hold-and-release-payout, 4 operations: requestPayout → getPayout → releasePayout → cancelPayout. Specs on APIs.io.