Create a batch of payouts to multiple users. Each payout in the batch is processed independently with its own idempotency key. The batch itself can also have an idempotency key to prevent duplicate batch submissions. All payouts in a batch must have fund=true.
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Request to create a batch of payouts
List of individual payouts to create in the batch.
1 - 5000 elementsUUID that will be used to idempotently handle the batch request. Batches with existing idempotency keys will be rejected.
Set of key-value pairs that you can attach to the batch. This can be useful for storing additional information about the batch in a structured format.
OK
The created payout batch.
Unique identifier for the payout batch.
Timestamp when the batch was created.
Current status of the batch processing.
created, processing, paying_out, completed The idempotency key provided when creating the batch.
The metadata attached to the batch.