freeze an agent card

POST

/dashboard/v1/merchants/{merchantId}/{mode}/agent_cards/{id}/freeze

curl --request POST \
  --url https://api.xaalis.org/dashboard/v1/merchants/example/test/agent_cards/example/freeze \
  --header 'idempotency-key: example' \
  --cookie better-auth.session_token=<better-auth.session_token>

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

id

required

string

Header Parameters

idempotency-key

required

Required retry-safe key; reuse it only for the same operation and request body

string

>= 1 characters <= 255 characters

Required retry-safe key; reuse it only for the same operation and request body

Responses

200

Card

Media typeapplication/json

object

object

required

string

Allowed values: agent_card

id

required

string

wallet_id

required

string

livemode

required

boolean

kind

required

string

Allowed values: merchant_locked single_use

status

required

string

Allowed values: provisioning active frozen cancelled

brand

required

string

Allowed values: visa

last4

required

string

/^\d{4}$/

currency

required

string

Allowed values: USD

remaining_today

List responses only: remaining gross daily cap bounded by this card cap, in USD cents; not a balance promise

integer

mcc_allowlist

required

Array<string>

network_merchant_id

required

string | null

amount_cap

required

integer

>= 1 <= 100000000

created_at

required

string

Example

{
  "object": "agent_card",
  "kind": "merchant_locked",
  "status": "provisioning",
  "brand": "visa",
  "currency": "USD"
}

400

Validation error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Authentication required

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Forbidden

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Not found

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Idempotency conflict or invalid state

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Policy limit or insufficient funds

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

429

Rate limited

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

503

Service unavailable

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}