Skip to content
FlowPayraFlowPayra Docs

create payout schedule

POST
/v1/payout-schedules
curl --request POST \
  --url https://api.flowpayra.com/v1/payout-schedules \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --header 'X-Api-Key: <X-Api-Key>' \
  --header 'X-Nonce: <X-Nonce>' \
  --header 'X-Signature: <X-Signature>' \
  --header 'X-Timestamp: <X-Timestamp>' \
  --data '{ "currency_id": "example", "target_chain_id": "example", "withdraw_address_id": "example", "interval_secs": 1, "min_send_amount": "example", "mode": "auto_request", "first_run_at": "2026-04-15T12:00:00Z" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
>= 1 characters <= 128 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
currency_id
required
string
>= 1 characters <= 128 characters
target_chain_id
required
string
>= 1 characters <= 128 characters
withdraw_address_id
required
string
>= 1 characters <= 128 characters
interval_secs
required
integer format: int64
>= 60 <= 31536000
min_send_amount
required
string
<= 128 characters /^(0|[1-9][0-9]*)(\.[0-9]+)?$/
mode
required
string
Allowed values: auto_request notify_only
first_run_at
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
id
required
string
>= 1 characters <= 128 characters
currency_id
required
string
>= 1 characters <= 128 characters
currency_chain_id
required
string
>= 1 characters <= 128 characters
target_chain_id
required
string
>= 1 characters <= 128 characters
withdraw_address_id
required
string
>= 1 characters <= 128 characters
interval_secs
required
integer format: int64
min_send_amount
required
string
<= 128 characters /^(0|[1-9][0-9]*)(\.[0-9]+)?$/
min_send_raw
required
string
<= 78 characters /^(0|[1-9][0-9]*)$/
mode
required
string
Allowed values: auto_request notify_only
status
required
string
Allowed values: active paused retired
enabled
required
boolean
next_run_at
required
string format: date-time
created_at
required
string format: date-time
updated_at
required
string format: date-time
retired_at
required
One of:
string format: date-time
Example
{
  "mode": "auto_request",
  "status": "active"
}

400

Section titled “400”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}

401

Section titled “401”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}

404

Section titled “404”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}

409

Section titled “409”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}

422

Section titled “422”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}