v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB
Card

List Cards

Fetch detailed information for cards. This includes card status, person card status, limits, and any other relevant data. But nothing sensitive.

get/open-api/v3/card-list

Query parameters

accountIdstring uuid required

The UUID of the Account.

The UUID of the Account.

cardIdstring uuid

The UUID of the Card.

The UUID of the Card.

budgetIdstring uuid

The UUID of the budget.

The UUID of the budget.

cardholderIdstring

The ID of the cardholder.

The ID of the cardholder.

labelstring

Custom card label or tag

Custom card label or tag

statusstring

Card status: INACTIVE,CONTROL,ACTIVE,PENDING,FROZEN

Card status: INACTIVE,CONTROL,ACTIVE,PENDING,FROZEN

referenceIdstring

Optional filter parameter. When provided, only the card with the matching referenceId will be returned. This value corresponds to the unique identifier you assigned when creating the card.

Optional filter parameter. When provided, only the card with the matching referenceId will be returned. This value corresponds to the unique identifier you assigned when creating the card.

limitstring number

Limits the number of items to be returned.

Limits the number of items to be returned.

pagestring number

The page to be returned, counting from 1 as the first page.

The page to be returned, counting from 1 as the first page.

Response

OK

codestring

Return code

messagestring

Error message