Create Exchange Withdrawal

Edit online

Creates a new exchange withdrawal transaction.

HTTP request
POST/exchanges/{exchangeId}/accounts/{accountId}/withdrawals
Authentication
Authentication Type Supported
Organization User (CustomerEmployee) Yes
Delegated User (EndUser) No
Service Account Yes
Required permissions
Exchanges:Withdrawals:Create (always required)
Authorization requirements
Header Type Required Description
Authorization string Yes Bearer token used to authenticate the request. See Authentication flows for details.
X-DFNS-USERACTION string Yes User Action Signature used to sign change‑inducing requests. See User Action Signing flows for details.
Path parameters
Parameter Type Required Description
exchangeId string Yes Exchange identifier returned by the Create Exchange endpoint. Minimum length is 1.
accountId string Yes Unique identifier for the exchange account, such as spot. Minimum length is 1.
Request body
Native assets:
Field Type Required
kind enum string Yes
amount string Yes
walletId string Yes
priority enum string No
createDestinationAccount boolean No
offer boolean No
expiresAt string (date-time) No
externalId string No
travelRule object No
feeSponsorId string No
otp string No 
curl --request POST \
  --url https://api.digitalassets.ibm.com/exchanges/{exchangeId}/accounts/{accountId}/withdrawals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DFNS-USERACTION: <api-key>' \
  --data '
{
  "kind": "Native",
  "amount": "<string>",
  "walletId": "<string>",
  "priority": "Slow",
  "createDestinationAccount": true,
  "offer": true,
  "expiresAt": "2023-11-07T05:31:56Z",
  "externalId": "<string>",
  "travelRule": {
    "kind": "Notabene",
    "originator": {},
    "beneficiary": {},
    "beneficiaryVASPdid": "<string>",
    "beneficiaryProof": {}
  },
  "feeSponsorId": "fs-5vqdl-gliqk-b4rfukqauov1sp7j",
  "otp": "<string>"
}
'
Response
200: Success

Example response:

{
  "id": "<string>",
  "exchangeId": "<string>",
  "accountId": "<string>",
  "kind": "Withdrawal",
  "walletId": "<string>",
  "requester": {
    "userId": "<string>",
    "tokenId": "<string>"
  },
  "requestBody": {
    "kind": "Native",
    "amount": "<string>",
    "walletId": "<string>",
    "priority": "Slow",
    "createDestinationAccount": true,
    "offer": true,
    "expiresAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "travelRule": {
      "kind": "Notabene",
      "originator": {},
      "beneficiary": {},
      "beneficiaryVASPdid": "<string>",
      "beneficiaryProof": {}
    },
    "feeSponsorId": "fs-5vqdl-gliqk-b4rfukqauov1sp7j",
    "otp": "<string>"
  },
  "dateCreated": "<string>",
  "transferId": "<string>",
  "exchangeReference": "<string>"
}