register withdraw address

POST

/v1/withdraw-addresses

curl --request POST \
  --url https://api.flowpayra.com/v1/withdraw-addresses \
  --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 '{ "chain_id": "example", "address": "example", "destination_type": "owner", "label": "example" }'

Authorizations

• HmacApiKey
• HmacSignature
• HmacTimestamp
• HmacNonce

Parameters

Header Parameters

Idempotency-Key

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

chain_id

required

string

>= 1 characters <= 128 characters

address

required

string

>= 1 characters <= 256 characters

destination_type

string

Allowed values: owner token_account

label

string

<= 256 characters

Responses

200

Successful response

Media typeapplication/json

object

id

required

string

>= 1 characters <= 128 characters

chain_id

required

string

>= 1 characters <= 128 characters

address

required

string

destination_type

required

One of:

string

string

Allowed values: owner token_account

null

null

status

required

string

>= 1 characters <= 64 characters

cooling_until

required

One of:

string

string format: date-time

null

null

Example

{
  "destination_type": "owner"
}

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"
}