Create withdrawal

Create withdrawal

When to use this: Withdraw funds from collateral contract to destination.

Required scope: withdrawals.write.

Requires idempotency-key header.

POST /user/v1/withdrawals

Create withdrawal

cURL

curl --request POST \
  --url https://api.machines.cash/user/v1/withdrawals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '{}'

200

{
  "ok": true,
  "data": {},
  "summary": "success"
}

Authorizations

Authorization · string · header · required

Bearer session token for User API operations. Legacy UserSessionBearer naming remains supported.

Headers

idempotency-key · string · required

Required for state-changing financial writes.

Minimum string length: 8

Body

application/json

The body is of type object.

Response

200

application/json

Success

ok · boolean

data · object

summary · string

errors · object[]

Show child attributes

next · string