Skip to main content
PATCH
Pause / resume / rename 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
name
string

New label (rename).

Required string length: 1 - 120
status
enum<number>

Pause (PAUSED) or resume (ACTIVE) only. Changing the payload or amount is NOT allowed — recreate the schedule (re-authorization required).

Available options:
[object Object]

Response

OK

success
boolean
required
Example:

true

data
object
required