Skip to main content
POST
/
v1
/
withdrawals
cURL
curl --request POST \
  --url https://api.sandbox.forte.cc/v1/withdrawals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "withdrawalAccountId": "c43c87ed-65fd-4937-8b4d-5a93789aa997",
  "amount": "10"
}
'
[
  {
    "id": "b56d7c9b-e794-4581-a931-c529007d8f50",
    "withdrawalAccountId": "c43c87ed-65fd-4937-8b4d-5a93789aa997",
    "network": "polygon",
    "venue": "wallet",
    "label": "Wallet [polygon]",
    "currency": "AUDF",
    "amount": "10",
    "createdAt": "2024-06-23T21:10:22.828Z",
    "withdrawalAccount": {
      "id": "c43c87ed-65fd-4937-8b4d-5a93789aa997",
      "currency": "AUDF",
      "details": {
        "beneficiary": {
          "address": "0x7CF327ab41927941b1Ad47e79cb62c7C9F452965"
        }
      }
    },
    "details": {}
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Withdrawal request.

​
withdrawalAccountId
string<uuid>
required

Identifier of the withdrawal account to use.

Example:

"c43c87ed-65fd-4937-8b4d-5a93789aa997"

​
amount
string
required

Amount to withdraw.

Example:

"10"

Response

200 - application/json

Requested withdrawal. The response format varies slightly depending on the withdrawal network.

​
id
string<uuid>

Withdrawal identifier.

Example:

"b56d7c9b-e794-4581-a931-c529007d8f50"

​
label
string

Human-readable withdrawal label.

Example:

"Wallet [polygon]"

​
network
string

Network of the withdrawal.

Example:

"polygon"

​
currency
string

Currency of the withdrawal.

Example:

"AUDF"

​
amount
string

Amount of the withdrawal.

Example:

"10"

​
withdrawalAccount
object

A withdrawal account. The exact shape may vary depending on the network.

​
createdAt
string<date-time>

Creation timestamp (ISO 8601).

Example:

"2024-06-23T21:10:22.828Z"

​
processedAt
string<date-time>

Processed timestamp (ISO 8601).

Example:

"2024-06-23T21:10:22.828Z"

​
details
object

Network-specific withdrawal details.

Example:
{}