Skip to main content
How a batch is processed:
  1. The whole batch is checked first. If any item is invalid, nothing is sent, and you get 400 invalid_batch_item with the item number in message. For example: item 3: amount must be a positive whole number of cents.
  2. The balance must cover all of it. For a payout batch from your Cloudpay balance, if the main balance can’t cover every amount plus every fee, you get 422 insufficient_funds, and nothing is sent.
  3. You get 202 with the batch id. The items then start in the background.
  4. Track the batch. GET …/bulk/{id} gives item counts by status. To see the items, use GET …/disbursements?batch_id={id} or …/collections?batch_id={id}.
Each item has its own idempotency_key, up to 60 characters and unique within the batch. Items fail and succeed independently. To retry the failed items, send them in a new batch with new keys. Collection batches aren’t limited to 3 prompts per phone.