Batch Payouts

Batch Payouts let you group up to 100 individual payouts into a single batch and dispatch them in one submission. Draft a batch, add items and preview indicative totals, fees and rates per currency pair, submit for approval, and monitor progress from a single ID — the workflow fits payroll runs, supplier settlements, marketplace payouts, and any recurring bulk disbursement.

Lifecycle

  1. Create an empty batch to obtain a batch
    id
    .
  1. Add items with beneficiary, amount, and payout preferences (up to 10 items per request, 100 items per batch).
  1. Remove items while the batch is in
    INIT
    to correct invalid entries.
  1. Calculate the batch to preview indicative totals, fees, and rates per currency pair — for reference only; final amounts and exchange rates are determined at payout processing.
  1. Submit the batch. If approval is required the batch moves to
    PENDING_APPROVAL
    ; otherwise it moves to
    PROCESSING
    and payouts are dispatched.
  1. Query the batch or List items at any time to monitor status. Item-level state is exposed via
    BatchPayoutItemStatus
    ; drill into a specific payout using its
    payoutId
    .
  1. Cancel a created batch while it is still in
    INIT
    or
    PENDING_APPROVAL
    — once processing starts, cancellation is no longer available. Use Delete to remove drafts in
    INIT
    .

Endpoints

Enum Reference

BatchPayoutStatus

BatchPayoutItemStatus