request withdrawal

POST

/v1/withdrawals

curl --request POST \
  --url https://api.flowpayra.com/v1/withdrawals \
  --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", "amount": "example", "withdraw_address_id": "example" }'

Authorizations

• HmacApiKey
• HmacSignature
• HmacTimestamp
• HmacNonce

Parameters

Header Parameters

Idempotency-Key

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

currency_id

required

string

>= 1 characters <= 128 characters

target_chain_id

required

string

>= 1 characters <= 128 characters

amount

required

string

<= 128 characters /^(0|[1-9][0-9]*)(\.[0-9]+)?$/

withdraw_address_id

required

string

>= 1 characters <= 128 characters

Example^generated

{
  "currency_id": "example",
  "target_chain_id": "example",
  "amount": "example",
  "withdraw_address_id": "example"
}

Responses

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

send_amount_raw

required

string

<= 78 characters /^(0|[1-9][0-9]*)$/

withdrawal_fee_raw

required

string

<= 78 characters /^(0|[1-9][0-9]*)$/

total_debit_raw

required

string

<= 78 characters /^(0|[1-9][0-9]*)$/

status

required

string

>= 1 characters <= 64 characters

Example^generated

{
  "id": "example",
  "currency_id": "example",
  "currency_chain_id": "example",
  "target_chain_id": "example",
  "send_amount_raw": "example",
  "withdrawal_fee_raw": "example",
  "total_debit_raw": "example",
  "status": "example"
}

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