list payout schedules

GET

/v1/payout-schedules

curl --request GET \
  --url 'https://api.flowpayra.com/v1/payout-schedules?status=active' \
  --header 'X-Api-Key: <X-Api-Key>' \
  --header 'X-Nonce: <X-Nonce>' \
  --header 'X-Signature: <X-Signature>' \
  --header 'X-Timestamp: <X-Timestamp>'

Authorizations

• HmacApiKey
• HmacSignature
• HmacTimestamp
• HmacNonce

Parameters

Query Parameters

status

string

Allowed values: active paused retired

currency_id

string

>= 1 characters <= 128 characters

target_chain_id

string

>= 1 characters <= 128 characters

cursor

string

limit

integer format: int64

>= 1 <= 100

Responses

200

Successful response

Media typeapplication/json

object

schedules

required

Array<object>

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

string format: date-time

null

null

next_cursor

required

One of:

string

string

null

null

Example

{
  "schedules": [
    {
      "mode": "auto_request",
      "status": "active"
    }
  ]
}

400

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

401

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

404

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

409

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

422

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}