Skip to main content

Payout Engine

Payout Engine covers batch-based disbursement flows with recipients, instructions, reports, and retries.

Current API surface​

The backend currently exposes:

  • GET/POST /api/v1/payout-engine/batches
  • GET /api/v1/payout-engine/batches/{id}
  • POST /api/v1/payout-engine/batches/{batchId}/execute
  • POST /api/v1/payout-engine/batches/{batchId}/retry-failed
  • GET /api/v1/payout-engine/batches/{batchId}/instructions
  • GET /api/v1/payout-engine/batches/{batchId}/execution-logs
  • GET /api/v1/payout-engine/batches/{batchId}/report
  • GET /api/v1/payout-engine/batches/{batchId}/export.csv
  • GET/POST /api/v1/payout-engine/recipients
  • POST /api/v1/payout-engine/recipients/{id}/archive

Use the generated API reference for the complete endpoint inventory.