Create a crypto withdrawal offer

This endpoint allows users to initiate a cryptocurrency withdrawal by submitting details such as the amount to withdraw, the destination address, blockchain destination tags (memo_id, memo_text), returning a structured offer that outlines the terms and conditions of the withdrawal including fees. Such an offer can later be confirmed by the user.

SecuritybearerAuth
Request
header Parameters
bp-user-id
required
string <uuid>
Example: 12312312-2be6-4522-977e-ea4d92c45e86
Idempotency-Key
required
string <uuid>

A unique key that the server uses to recognize subsequent retries of the same request

Request Body schema: application/json

The withdrawal offer

coin_network_id
required
string <uuid>

The coin network ID

asset_amount
required
string

The asset amount the user intends to withdraw. It is the initial amount specified by the user before any deductions are made.

recipient_address
required
string

Recipient address

destination_tag
string or null

Blockchain destination tag

destination_tag_type
string or null

Blockchain destination tag type

Enum: "memo_id" "memo_text"
Responses
200

Success Response (Subsequent Idempotent Request)

201

Success Response (Created)

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

422

Validation Error

500

Internal Error

503

Service unavailable

post/v1/crypto-transfers/withdrawals/offer
Request samples
application/json
{
  • "coin_network_id": "1ede43b2-6f0d-6392-be44-4d7a070c78a7",
  • "asset_amount": "0.2",
  • "recipient_address": "16UjcYNBG9GTK4uq2f7yYEbuifqCzoLMGS",
  • "destination_tag": "123845678",
  • "destination_tag_type": "memo_id"
}
Response samples
application/json
{
  • "data": {
    }
}