List cards | The Penny Inc

{
  "items": [
    {
      "card_id": "card_019375de-a2a0-7f31-884a-a2a0f3184abd",
      "version": 1,
      "version_time": "2024-01-15T10:30:00Z",
      "issued_time": "2024-01-15T10:30:00Z",
      "expiration_date": "2030-06-30",
      "bin_id": "bin_01937000-0592-7190-87e7-05921907e7c5",
      "bin_range_id": "bin_range_01937b28-f048-77de-8ef4-f0487deef42d",
      "card_product_id": "card_product_01937f5d-a015-7a55-818b-a015a5518b97",
      "business_id": "business_01937b95-484e-75af-8c68-484e5afc68d3",
      "business_entity_id": "business_entity_01937c9d-3a1e-72b0-8881-3a1e2b088159",
      "program_id": "program_019377de-7f88-7f02-894f-7f88f0294fcb",
      "capital_account_id": "account_019372e3-b8dc-7de2-80b6-b8dcde20b6c9",
      "cardholder_id": "cardholder_01937e19-4ebb-75bd-8250-4ebb5bd25085",
      "status": "pending",
      "active": true,
      "terminated": false,
      "currency": "USD",
      "country": "US",
      "usage_type": "single_use",
      "scheme_details": {
        "network": "visa",
        "funding_type": "debit",
        "product_type": "consumer"
      },
      "terminated_time": "2024-01-15T10:30:00Z",
      "bin": "424242",
      "last_four": "4242",
      "control_account_id": "account_019372e3-b8dc-7de2-80b6-b8dcde20b6c9",
      "usage_limits": {
        "authorizations_maximum": 1,
        "authorizations_used": 0,
        "amount_limit": "250.00",
        "amount_remaining": "180.00"
      },
      "alias": "Marketing Team Card",
      "description": "Card issued for the marketing team's advertising spend.",
      "spend_control_id": "spend_control_019379d9-a170-796b-867a-a17096b67a21",
      "client_reference": {
        "id": "order-482910",
        "data": {}
      },
      "form_factor": "virtual"
    }
  ],
  "count": 1,
  "next_page_token": "string"
}

List cards belonging to the caller’s business.

Required permissions: card:list.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

business_entity_idstring or nullOptional

Filter by business entity ID. Only needed if your business has multiple business entities.

program_idstring or nullOptional

Filter by program ID. Only needed if your business has multiple programs.

capital_account_idstring or nullOptional

Filter by capital account ID.

cardholder_idstring or nullOptional

Filter by cardholder ID.

control_account_idstring or nullOptional

Filter by control account ID.

terminatedboolean or nullOptional

Filter by termination state.

statusenum or nullOptional

Filter by card status.

Allowed values:

page_sizeintegerOptional1-3000Defaults to 100

Maximum number of results to return per page. Defaults to 100.

next_page_tokenstring or nullOptional

Pagination key used to retrieve the next page of results.

Response

The matching cards.

itemslist of objects

The list of items returned by the API.

countinteger

The total number of items returned in this response.

next_page_tokenstring or nullOptional

A token for retrieving the next page of results, if applicable.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error