Request venue withdrawal

Creates a new withdrawal request to transfer funds from a venue to a blockchain address or fiat destination. The withdrawal will be processed asynchronously and may require approval depending on configuration.

POST /trade/v1/venues/withdrawals

cURL

Blockchain withdrawal

curl --request POST \
  --url https://api.staging.layer1.com/trade/v1/venues/withdrawals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "asset": {
    "code": "ETH"
  },
  "amount": "0.5",
  "venue": "binance",
  "reference": "WITHDRAW-ETH-001",
  "blockchainDestination": {
    "address": 6.6325114945411165e+47,
    "network": "ETH",
    "tag": null
  }
}
'

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "asset": {
    "code": "ETH"
  },
  "venue": "binance",
  "status": "PENDING_APPROVAL",
  "amount": "0.5",
  "blockchainDestination": {
    "address": 6.6325114945411165e+47,
    "network": "ETH"
  },
  "reference": "WITHDRAW-ETH-001",
  "venueTransferId": null,
  "createdAt": "2023-10-01T12:00:00Z",
  "updatedAt": "2023-10-01T12:00:00Z",
  "blockchainMetadata": null,
  "fiatMetadata": null,
  "failureMessage": null
}

Body

application/json

Withdrawal request containing asset, amount, venue, and destination details

asset · string

The asset to withdraw

Example:

"ETH"

amount · number

Amount to withdraw

Example:

1.5

venue · string

The venue where the withdrawal should be processed

Example:

"binance"

reference · string

Unique reference for the withdrawal

Example:

"WITHDRAW-123"

blockchainDestination · object

Blockchain destination details for the withdrawal

Show child attributes

fiatDestination · object

Fiat destination details for the withdrawal

Show child attributes

Response

201

application/json

Withdrawal request created successfully

id · string<uuid>

Unique identifier of the withdrawal

Example:

"123e4567-e89b-12d3-a456-426614174000"

asset · string

The asset being withdrawn

Example:

"ETH"

venue · string

The venue where the withdrawal was made

Example:

"binance"

status · enum<string>

Current status of the withdrawal

Available options: SIMULATED, APPROVAL_REQUESTED, PENDING, SUBMITTED, COMPLETED, FAILED, CANCELLED

Example:

"COMPLETED"

amount · number

Amount of the withdrawal

Example:

1.5

blockchainDestination · object

Blockchain destination details for the withdrawal

Show child attributes

fiatDestination · object

Fiat destination details for the withdrawal

Show child attributes

reference · string

Unique reference for the withdrawal

Example:

"WITHDRAW-123"

venueTransferId · string

Unique identifier of the withdrawal at the venue

Example:

"WITHDRAW-456"

createdAt · string<date-time>

Timestamp when the withdrawal was created

updatedAt · string<date-time>

Timestamp when the withdrawal was last updated

blockchainMetadata · object

Additional blockchain-related metadata for the withdrawal

Show child attributes

fiatMetadata · any

Additional fiat-related metadata for the withdrawal

failureMessage · string

Error message if the withdrawal failed

Example:

"Insufficient funds"