Debit a wallet

POST /api/wallets/wallets/{id}/debit

Try it

Debit a wallet

cURL

curl --request POST \
  --url http://localhost/api/wallets/wallets/{id}/debit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": {
    "asset": "USD/2",
    "amount": 100
  },
  "metadata": {
    "key": ""
  },
  "pending": true
}
'

201

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "walletID": "<string>",
    "metadata": {},
    "asset": "<string>",
    "description": "<string>",
    "destination": {
      "type": "<string>",
      "identifier": "<string>"
    }
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key · string

Use an idempotency key

Path Parameters

id · string · required

Body

application/json

amount · object · required

Show child attributes

amount. asset · string · required

The asset of the monetary value.

amount. amount · integer<bigint> · required

The amount of the monetary value.

metadata · object · required

Metadata associated with the wallet.

Show child attributes

metadata. {key} · string

pending · boolean

Set to true to create a pending hold. If false, the wallet will be debited immediately.

description · string

destination · object

Option 1

Show child attributes

destination. type · string · required

destination. identifier · string · required

balances · string[]

A targeted balance (use '*' for all)

timestamp · string<date-time>

cannot be used in conjunction with pending property

Response

201

application/json

Wallet successfully debited as a pending hold

data · object · required

Show child attributes

data. id · string<uuid> · required

The unique ID of the hold.

data. walletID · string · required

The ID of the wallet the hold is associated with.

data. metadata · object · required

Metadata associated with the hold.

Show child attributes

data.metadata. {key} · string

data. asset · string · required

data. description · string · required

data. destination · object

Option 1

Show child attributes

data.destination. type · string · required

data.destination. identifier · string · required