Spend

Get spend status

Whether a card issued with POST /v1/cards was charged, and whether the charge settled.

GET/v1/spend/{spend_request_id}

Authorization: Bearerspend_request_id

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.

Path parameters

spend_request_idstringrequired

From the create-card response.

Response200application/json

spend_request_idstring

decisionstring

The policy decision at issue time, APPROVED for a card that was minted.

merchantstring

The merchant the card was issued for.

requested_usdnumber

The cap that was requested.

statusstring

The charge state.

Available options: not_started, authorized, cleared, declined

settledboolean

true once the network cleared the charge, usually by the next day.

amountnumber

The charged amount in dollars, null before a charge.

decline_reasonstring

On declined, why.

request_idstring

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

Errors

Status	Code	When
404	`spend_not_found`	No such spend on your account.
502	`spend_status_failed`	The status could not be read. Retry.

Get spend status

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

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

const agentpay = new AgentPay(process.env.AGENTPAY_API_KEY);
const spend = await agentpay.spend.get("spr_1c9d...");

import os
from agentpay import AgentPay

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

200

{
  "spend_request_id": "spr_1c9d...",
  "decision": "APPROVED",
  "merchant": "namecheap",
  "requested_usd": 20,
  "status": "cleared",
  "settled": true,
  "amount": 1.98,
  "decline_reason": null,
  "request_id": "req_a1b2c3"
}