Skip to main content
POST
Create a draft batch payout (payroll) + preview

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Axra-Business-Id
string

Active business context

x-api-key
string

Merchant API key (alternative to dashboard JWT)

Body

application/json
idempotencyKey
string
required

Idempotency key — unique per (business, key). A replay returns the same batch.

Required string length: 8 - 64
items
object[]
required

Line items (one per recipient).

source
enum<string>
default:MANUAL

How the batch was authored. Defaults to MANUAL.

Available options:
MANUAL,
CSV,
API,
SCHEDULE,
CHANNEL
metadata
object

Optional caller metadata persisted on the batch.

Response

OK

success
boolean
required
Example:

true

data
object
required