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

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.

external_address_id
required
string <uuid>

A unique identifier (UUID) assigned to the newly created crypto address. This ID is returned by the Create Address endpoint and is used to reference, track, and manage the specific address within the system.

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
Request samples
application/json
{
  • "asset_amount": "0.2",
  • "external_address_id": "1ed83487-f684-62a2-a155-fe633f0db292"
}
Response samples
application/json
{
  • "data": {
    }
}