capabilities.work

Quote and Request Payout

A 4-step recipe with dLocal. We can help you get access.

Recipe · 4 steps

Quote and Request Payout

with dLocal

Lock an FX quote and disburse a payout to a beneficiary.

  1. Retrieve the merchant's available payout balance to confirm sufficient funds before disbursing.
  2. Generate an FX quote that locks the exchange rate for the disbursement amount.
  3. Request a payout to the beneficiary that references the locked FX quote.
  4. Retrieve the payout to confirm its current status after the request.
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.
  • currencyToPay: Currency the beneficiary is paid in.
  • paymentMethodId: Payout method (BANK_TRANSFER, INSTANT_PAYMENT, CARD, CASH_PICK_UP).
  • purpose: Payout purpose (e.g. REMITTANCES, PAYROLL, SUPPLIER_PAYMENT).
  • flowType: Transaction flow type (B2C, B2B, P2P).
  • beneficiaryFirstName: Beneficiary first name.
  • beneficiaryLastName: Beneficiary last name.
  • beneficiaryDocument: Beneficiary national identification document.
  • notificationUrl: URL to receive asynchronous payout notifications.
For your developer

Arazzo workflow d-local:quote-and-request-payout, 4 operations: getPayoutsBalance → createQuote → requestPayout → getPayout. Specs on APIs.io.

More recipes with dLocal

Authorize and Capture PaymentCancel Pending PaymentCreate and Resolve KYC VerificationCreate Payment and Confirm StatusEnroll and Charge RecurringFX Preview and PayHold and Release PayoutList and Inspect Payment RefundsManage Account Bank AccountsOnboard Sub-Merchant Account