Skip to main content
The cards endpoints maintain the set of cards enrolled in OpenCard per customer organisation. Register cards before sending transaction states — {card_id} in the transaction path is your card id from the create payload. Base path:

Endpoints

The boilerplate documents the full card API. OpenCard enables only the operations your integration needs — confirm which methods are live for your {slug} before go-live. Minimal integration = create + delete + transaction states. Use that when you only register and close cards via API and manage changes by delete + re-create. Full boilerplate = all five operations above — update holder or company in place, query and inspect cards without posting again.
If an endpoint returns 404 or 405 on your slug, it is not enabled for your integration. The OpenAPI reference shows the full boilerplate surface; your credentials and scope list reflect what you can actually call.

Create card

*Required on integrations that expose funding (confirm with OpenCard for your {slug}). Responses: Create is idempotent on id. Re-posting the same card returns the existing record.

Update card

Boilerplate only — not all issuer slugs expose PUT. If you only have create + delete, close the old card and create a new one when details change.
Same body shape as create (except id comes from the path). Supports moving a card between identities/companies when holder or employer changes. Response 200 with updated: true.

Get card

Boilerplate only — optional on minimal integrations.

List cards

Boilerplate only — optional on minimal integrations.
Query parameters: last_four, buyer_party, seller_party, bin_number, id, active, per_page (1–100, default 15), page.

Delete card

Soft-deletes the card and marks it inactive. Response 204 with empty body.

Why the registry matters

OpenCard matches every transaction state to a registered card and identity. Without an up-to-date registry:
  • Transaction posts return card_not_found
  • EMS apps never see data for unknown cards
Keep cards in sync when issued, replaced, or closed at your end.