Skip to main content

Cards Overview

Issue and manage tenant-scoped cards through the reviewed public gateway surface.

Overview

This section documents the current reviewed public card-issuing surface available on the BaaS gateway.

Current Gateway Endpoints

  • POST /api/v1/cards
  • GET /api/v1/cards
  • POST /api/v1/cards/{card_id}/fund
  • GET /api/v1/cards/{card_id}/balance
  • GET /api/v1/cards/{card_id}/funding/history
  • GET /api/v1/cards/{card_id}/auto-reload
  • PUT /api/v1/cards/{card_id}/auto-reload
  • POST /api/v1/cards/{card_id}/jit-fund
  • GET /api/v1/cards/{card_id}/alerts/preferences
  • PUT /api/v1/cards/{card_id}/alerts/preferences
  • GET /api/v1/cards/alerts
  • POST /api/v1/cards/alerts/{alert_id}/read
  • GET /api/v1/cards/{card_id}/security
  • PUT /api/v1/cards/{card_id}/security
  • POST /api/v1/cards/{card_id}/lock
  • POST /api/v1/cards/{card_id}/unlock

Notes On Legacy Terminology

  • Older docs and SDK examples may still refer to freeze and unfreeze. In the reviewed public HTTP contract those operations are exposed as lock and unlock.
  • Older docs may also refer to update limits as a standalone endpoint. In the reviewed public contract, those controls now live under card security settings.
  • The reviewed public gateway does not currently expose a dedicated terminate card endpoint.

Card Listing

GET /api/v1/cards supports tenant-scoped listing with optional:
  • customer_id
  • limit
  • offset
customerId is accepted as an alias for customer_id.

List Cards

Retrieve tenant-scoped card records

Fund Card

Add balance to an issued card

Security Settings

Manage lock state and card controls

Issuing Guide

See the broader card issuing flow