Skip to main content
POST
Create + authorize a scheduled payout

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
name
string
required

Human label, e.g. "Monthly payroll".

Required string length: 1 - 120
cadence
enum<string>
required

ONCE | WEEKLY | BIWEEKLY | MONTHLY.

Available options:
ONCE,
WEEKLY,
BIWEEKLY,
MONTHLY
payloadKind
enum<string>
required

SINGLE | BATCH.

Available options:
SINGLE,
BATCH
payload
object
required

The frozen payout spec.

dayOfMonth
number

MONTHLY only: day-of-month (1–28) to fire on. Absent → the creation day-of-month. Ignored for other cadences.

Required range: 1 <= x <= 28
maxRunAmountUsd
number

Per-run USD cap (compliance). Defaults to SCHEDULE_RUN_USD_DEFAULT ($50k); rejected if above the SCHEDULE_RUN_USD_CEILING admin cap ($250k).

Example:

50000

endAt
string

Optional natural end. After this instant the schedule auto-completes.

pin
string

Transaction PIN, required on the dashboard path to authorize the schedule (verified server-side). Not required on the api-key path. Future runs execute automatically.

metadata
object

Optional caller metadata persisted on the schedule.

maxRunLocalCaps
object[]

Optional per-currency caps for locally-denominated runs. A currency listed here is checked against the run total in that currency and is immune to FX movement; every other currency still falls under maxRunAmountUsd. Omit for USD-only capping (the existing behaviour).

Response

OK

success
boolean
required
Example:

true

data
object
required