Cards

Close a card

Close an issued card and release any unused reserve back to the wallet.

POST/v1/cards/{id}/close

Authorization: Bearerid

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

idstringrequired

The card id.

Response200application/json

idstring

The card id.

statusstring

closed.

released_displaystring

The reserve returned to the wallet, as a display string such as $20.00.

available_to_issue_displaystring

The wallet's available after the release.

request_idstring

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

Errors

Status	Code	When
404	`card_not_found`	No such card on your account.
502	`close_failed`	The issuer could not close the card. Retry.

Close a card

curl -X POST https://api.joomjoo.com/v1/cards/card_8f2a.../close \
  -H "Authorization: Bearer $AGENTPAY_API_KEY"

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

const agentpay = new AgentPay(process.env.AGENTPAY_API_KEY);
const closed = await agentpay.cards.close("card_8f2a...");

import os
from agentpay import AgentPay

agentpay = AgentPay(api_key=os.environ["AGENTPAY_API_KEY"])
closed = agentpay.cards.close("card_8f2a...")

200

{
  "id": "card_8f2a...",
  "status": "closed",
  "released_display": "$20.00",
  "available_to_issue_display": "$140.00",
  "request_id": "req_a1b2c3"
}