Sign in

7be21448a2b3

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Cards

Search Cards

Endpoint to find Cards using filtering parameters.

get/business/v2/cards

Query parameters

type'wallet' | 'company' | 'employee' | 'onlineAd' | 'subscription' | 'purchase'

The type of a resource the Card is attached to.

Example:wallet

The type of a resource the Card is attached to.

idstring

The ID of the type resource (it's not applicable for company resource; it's not required for employees).

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7

The ID of the type resource (it's not applicable for company resource; it's not required for employees).

customreferenceIdstring

The custom reference ID of the type resource.

Example:123456-user-1

The custom reference ID of the type resource.

status'Normal' | 'Do not honor' | 'Lost card' | 'Stolen card' | 'Expired card' | 'Restricted card' | 'Security Violation' | 'Cardholder to contact the issuer' | 'Card Destroyed'

One among the available Card statuses of a Card.

groupIdstring

The ID of the Group the Card is related to.

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7

The ID of the Group the Card is related to.

namestring

The name of the Card.

Example:CardName

The name of the Card.

labelstring

The label of the Card.

Example:CardLabel

The label of the Card.

pinteger

It indicates the specific page to display (the counter starts from zero).

Example:3

It indicates the specific page to display (the counter starts from zero).

sinteger

It indicates the number of items per page.

Example:25

It indicates the number of items per page.

d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC

It indicates how the pages are ordered.

propsstring[]

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

[
  "creationTime"
]

Response

The result is an array containing Cards.

totalinteger

It represents the total number of available items in the list.

pagesinteger

It represents the total number of available pages.

page_sizeinteger

It represents the number of items per page.

current_pageinteger

It indicates the current page (the counter starts from zero).

results_sizeinteger

It indicates the size of the array results.

Example response

{
  "total": 168,
  "pages": 7,
  "page_size": 25,
  "results_size": 25,
  "results": [
    {
      "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "name": "CardName",
      "label": "CardLabel",
      "masked_pan": "123456******1234",
      "card_holder": "John Doe",
      "expiration_date": "2026-05-07T23:59:59Z",
      "creation_time": "2017-06-01T12:48:40Z",
      "last_update": "2017-06-01T12:48:40Z",
      "owner_public_id": "XMPL1234-000001",
      "custom_reference_id": "123456-user-1",
      "wallet_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "emboss_line4": "Example Inc.",
      "active": true,
      "group_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "groups": [
        "7bf79328-a7ae-4222-aa54-091ff7f429a7",
        "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
      ],
      "vehicle_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "assignees": [
        "XMPL1234-000001",
        "XMPL1234-000002",
        "XMPL1234-000003"
      ],
      "payment_method_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "preset_id": "c861cc24-6663-410f-8c78-73f886fff4ef",
      "shipping_address_id": "c861cc24-6663-410f-8c78-73f886fff4ef",
      "renewal_info": {
        "expiring_soon": true,
        "renewed_card_ready_for_activation": true
      }
    }
  ]
}