Wallet

Read the wallet

The balance every card and checkout draws on, what is free to assign, what sits on open cards, and the cards that already hold money.

GET/v1/wallet

Authorization: Bearer

Live API. A POST to /v1/cards issues a real card.

Authorizations

Authorizationstringrequired

Bearer token: Authorization: Bearer mk_live_.... Create a key in the AgentPay console under Developer, API keys.

Response200application/json

currencystring

USD.

onboardedboolean

Whether the account finished onboarding.

balancenumber

Everything in the wallet, in dollars.

availablenumber

balance minus reserved. What a new card can be capped at.

reservednumber

Money sitting on open cards.

pendingnumber

Declared bank money that has not landed. Not spendable.

balance_displaystring

The same four figures as display strings, e.g. $32.96. Also available_display, reserved_display, pending_display.

cards_readyarray

Open single-use cards that were never charged. A checkout whose total fits one pays with it, with no new card.

last4string

networkstring

holdsnumber

The card's limit in dollars.

ready_to_spendnumber

available plus what cards_ready hold. The honest answer to "can the agent buy this".

charges_in_flightarray

Charges authorized and still settling. The card holding each stays reserved until the network clears it.

amountnumber

card_last4string

networkstring

merchantstring

statusstring

authorized, settling.

after_settlementnumber

What balance becomes once the charges in flight clear.

notestring

A plain-words summary of the above, written for an agent.

request_idstring

The request id, also in the X-Mooj-Request-Id header.

Errors

Status	Code	When
502	`wallet_read_failed`	The wallet could not be read. Retry.

Read the wallet

curl https://api.joomjoo.com/v1/wallet \
  -H "Authorization: Bearer $AGENTPAY_API_KEY"

import { AgentPay } from "@agentpay-global/sdk";

const agentpay = new AgentPay(process.env.AGENTPAY_API_KEY);
const wallet = await agentpay.wallet.get();

import os
from agentpay import AgentPay

agentpay = AgentPay(api_key=os.environ["AGENTPAY_API_KEY"])
wallet = agentpay.wallet.get()

200

{
  "currency": "USD",
  "onboarded": true,
  "balance": 32.96,
  "available": 22.96,
  "reserved": 10,
  "pending": 0,
  "balance_display": "$32.96",
  "available_display": "$22.96",
  "reserved_display": "$10.00",
  "pending_display": "$0.00",
  "cards_ready": [
    {
      "last4": "8339",
      "network": "visa",
      "holds": 10
    }
  ],
  "ready_to_spend": 32.96,
  "charges_in_flight": [],
  "after_settlement": 32.96,
  "note": "A checkout whose total fits one of the 1 card(s) in cards_ready pays with it, no new card and no top-up needed. Call complete_purchase.",
  "request_id": "req_a1b2c3"
}