Skip to main content
POST
Preview bulk payment batches
Preview bulk payment batches before creating them to review fees and totals.

Body

application/json
batchName
string
required

Batch name

recipients
object[]
required

Recipients list

walletSelections
object[]
required

Currency wallet selections

batchDescription
string

Batch description

callbackUrl
string

Callback URL for notifications

integratorId
string

For admin use - integrator ID

Response

200 - application/json

Preview of bulk payment batch

totalBatches
number
required

Total batches to be created

totalRecipients
number
required

Total recipients across all batches

currencyBreakdown
object[]
required

Breakdown by currency - never add amounts from different currencies