Documents
Start typing to search…

Payouts

The Payout API enables businesses to send funds internationally using a locked FX rate based on a previously created quotation.
Supported payout methods include both SWIFT and LOCAL transfers. Currency, country, and payout method are all dynamically determined based on the quotation.

Payout Flow

Depending on your service agreement with SentBiz, sender and invoice creation may be optional or pre-approved

  1. Register Sender / Beneficiary / Invoice (if applicable)
    Before generating a quotation or executing a payout, the following must be registered or prepared:

    • Sender (Remitter): The legal entity making the payment. This may be pre-configured based on your SentBiz contract.

    • Beneficiary: The payout recipient. Includes name, bank account details, country, currency, and payout method (SWIFT or LOCAL).

    • Invoice (optional): In some cases, an invoice file must be uploaded before a payout can proceed. This requirement varies by contract or destination.

  2. Create Quotation
    Use the /v2/quotations API to generate a locked-rate quotation. You'll receive an fxRate, fee, destinationAmount, and a quotationId valid for 5–60 minutes.

  3. Review Quotation
    Confirm the rate, fee, and destination amount before the quotation expires.

  4. Execute Payout
    Use /v2/pay-outs with the quotationId and registered beneficiary information to initiate the transfer.

  5. Track Payout Status
    Monitor payout status using /v2/pay-outs/{pay_out_id} or webhook notifications.

  6. (Optional) Manage Documents
    Upload supporting documents (if required) or download receipts and confirmations for reconciliation or compliance.

Use Cases

  • Remit KRW collected in Korea to global merchants, sellers, or partners
  • Execute overseas payroll or vendor payments in local currencies
  • Enable platform-level cross-border disbursements in a compliant, automated way

API Summary

MethodEndpointDescription
POST/v2/pay-outs/upload-invoiceUploads an invoice file. If multiple files are sent, only the first one is stored.
POST/v2/pay-outsExecutes a payout using a locked quotation and beneficiary information.
GET/v2/pay-outsRetrieves a list of payout transactions.
POST/v2/pay-outs/searchSearches payout records using filters such as status, currency, or date range.
GET/v2/pay-outs/{pay_out_id}Retrieves full details and status of a specific payout.
GET/v2/pay-outs/{pay_out_id}/receiptDownloads the payout receipt as a PDF.
POST/v2/pay-outs/{pay_out_id}/documentsUploads up to 5 supporting documents for a payout.
GET/v2/pay-outs/{pay_out_id}/documents/{supporting_document_id}Downloads a specific supporting document.

Requirements

  • A valid quotationId is required to execute any payout
  • The quotation must be used before it expires (expiresAt)
  • Beneficiary must be registered and match the required format per payout method
  • Invoice or supporting document upload may be required depending on payout route, amount, or compliance policy

Updated 5 months ago