Skip to main content
PUT
Edit (re-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)

Path Parameters

id
string
required

Body

application/json
payloadKind
enum<string>
required

SINGLE | BATCH.

Available options:
SINGLE,
BATCH
payload
object
required

The replacement frozen payout spec (re-screened on edit).

name
string

New label (rename). Omit to keep the current name.

Required string length: 1 - 120
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

pin
string

Transaction PIN, required on the dashboard path to re-authorize the edit (verified server-side). Not required on the api-key path.

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