Skip to main content
GET
/
wallet
/
balance
Get wallet balance
curl --request GET \
  --url https://api.natural.co/wallet/balance \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "type": "wallet_balance",
    "id": "wal_019cd3444a6f73db8ef1f4afd074c166",
    "attributes": {
      "balances": [
        {
          "asset_code": "USD",
          "breakdown": {
            "operating_funded": {
              "amount_minor": 1000000,
              "amount_dollars": "10000.00"
            },
            "operating_advanced": {
              "amount_minor": 0,
              "amount_dollars": "0.00"
            },
            "escrow_funded_settled": {
              "amount_minor": 0,
              "amount_dollars": "0.00"
            },
            "escrow_advanced": {
              "amount_minor": 0,
              "amount_dollars": "0.00"
            },
            "holds_outbound": {
              "amount_minor": 50000,
              "amount_dollars": "500.00"
            }
          },
          "available": {
            "amount_minor": 950000,
            "amount_dollars": "9500.00"
          },
          "metadata": null
        }
      ],
      "pending_claim_amount_minor": 0,
      "pending_claim_count": 0
    },
    "relationships": {
      "party": {
        "data": {
          "type": "party",
          "id": "pty_019cd1798d617f65a79cb965dda9eac3"
        }
      }
    }
  }
}

Authorizations

Authorization
string
header
required

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

Headers

X-Agent-ID
string | null

Agent ID (agt_xxx) identifying which agent is making the request.

X-Instance-ID
string | null

Agent session/conversation ID for observability.

Maximum string length: 1024

Query Parameters

party_id
string | null

Party ID to get balance for. Omit to get own balance.

Response

Successful Response

Wallet balance response.

data
WalletBalanceResource · object
required

Resource object