Card Details (Single)
Returns details for a single card. For details of multiple cards, use our batch-style endpoint.
This endpoint has changed in comparison to the previous version of the API. The following changes were made:
- added cardControls to response body
- changed the enumeration for the status field in the response body
- deprecated type and replaced it with cardConfig
Path parameters
The unique identifier of the card.
Response
Ok
The unique identifier of the card.
If this card originated from a card request, this field contains the unique identifier of the card request.
The unique identifier of the organization, this card belongs to.
The unique identifier of the cardholder, this card belongs to.
The unique identifier of the card account, this card belongs to.
Deprecated, please use cardConfig instead. VIRTUAL - Virtual credit card SINGLE_USE - One-time virtual credit card (only one authorization allowed per card) PHYSICAL - Physical credit card BLACK - Physical black premium credit card TRAVEL - Virtual cards used specifically in travel industry related use cases
The Pliant card configuration of this card. This describes all feature of this card in one single configuration, e.g. the type of the card and also the design of the card etc. It replaces the deprecated card type. Please refer to the guide section to learn more about possible values.
The status of the card.
Deprecation Notice: The status values PENDING_ACTIVATION, PENDING_ISSUANCE, and PENDING_REGISTRATION are deprecated and will be mapped to PENDING with appropriate pendingDetails in the future. Use PENDING with the corresponding pendingDetails value instead.
The internal reason for a card's pending state. This field is only populated when status is PENDING or one of the deprecated PENDING_... statuses, and will be null for all non-pending statuses.
A short text describing the card. Available only for virtual cards with a cardConfig containing VIRTUAL or TRAVEL. The maximum length is 40 characters.
A short text describing the card. Available only for virtual cards with a cardConfig containing SINGLE_USE, the maximum length is 40 characters.
The last 4 digits of the PAN (payment card number), better known as the credit card number. It can be null e.g. for terminated cards.
Date-time of card issuing, e.g. 2023-08-23T14:28:53.600608Z. Can be null e.g. for cards which are requested by a cardholder but the request is declined.
Date-time (without nanoseconds) when card expires, e.g. 2026-07-31T23:59:59Z. For cards with type SINGLE_USE this is set to 12 months automatically and every value put here is ignored. Can be null e.g. for cards which are requested by a cardholder but the request is declined.
The network token of the card.
The card design of the card on Thredd (Pliant's credit card processor) side.
The product reference of the card on Thredd (Pliant's credit card processor) side. This field is deprecated and will be removed in the future. Use cardDesignId instead.
Whether the card is used for the internal Pliant platform fee or not.
Date-time (without nanoseconds) when the current limit period ends, e.g. 2023-09-30T23:59:59Z.
Date when the limit will be renewed, e.g. 2023-10-01.
Describes how often the limit of the card is renewed.
- DAILY - The card limit is renewed every day
- WEEKLY - The card limit is renewed every week
- MONTHLY - The card limit is renewed every calendar month
- QUARTERLY - The card limit is renewed every calendar quarter
- ANNUAL - The card limit is renewed every year
- TOTAL - The card limit is never going to be renewed. After the limit is spent the card cannot be used anymore.
Optional first name on TRAVEL cards which is used on the card, instead of the regular cardholder name. If empty, the regular cardholder name is used.
Optional last name on TRAVEL cards which is used on the card, instead of the regular cardholder name. If empty, the regular cardholder name is used.
Filled, if this card was replaced by another card.
Filled, if this card replaced another card.
Describes the reason for the card replacement, if any happened.
Date-time when the physical card was shipped, e.g. 2023-10-16T11:34:59.595Z. This field is empty for all other types of cards, or when the physical card is not shipped yet.
The PAN alias of the card. This is not the real credit card number (PAN) but a alias version of it.
Optional field to describe a fixed date range in which the card is usable for purchases. Outside of this date range, the card cannot be used for any purchases, only for zero-amount card-checks, and is shown with status PENDING. If not provided, the card is active immediately. Date needs to be provided as yyyy-mm-dd and is treated inclusive, meaning the provided date is already a valid day to use the card. If used, the parallel usage of card controls regarding dates and/or times is not allowed and the validityPeriod will be set to 36 months automatically. The earliest possible date is the current date. The validFrom date needs to be before the validTo date. The fields validFrom, validTo and validTimezone need to be used together, if used at all.
Optional field to describe a fixed date range in which the card is usable for purchases. After the specified date, the card is automatically terminated. If not provided, the card is active until the validityPeriod ends. Date needs to be provided as yyyy-mm-dd and is treated inclusive, meaning the card will be terminated one day after this date. If used, the parallel usage of card controls regarding dates and/or times is not allowed and the validityPeriod will be set to 36 months automatically. The earliest possible date is the current date. The latest possible date is the end date of the validityPeriod. The fields validFrom, validTo and validTimezone need to be used together, if used at all.
Optional field to describe the timezone for the validFrom and validTo fields. This field is mandatory if validFrom and validTo fields are used. A list of valid timezones can be found in our guide section.
Optional field to describe the maximum number of transactions within the range of 1..999999999 that can be performed with this card. If not provided, the card can be used for an unlimited number of transactions until the card expires.
- CHARGE - normal (non-benefit) credit card
- LOAD_BASED_ACCRUING - benefit card where money not spent is transferred to the next month
- LOAD_BASED_NON_ACCRUING - benefit card where money not spent is lost end of month
- BALANCE_BASED - benefit card with a standing balance that persists across months and is spent down until depleted (no monthly reset).
For cards that are loaded periodically, indicates the date when the card will be loaded the next time.
Additional limits on this card. Empty when none are configured. Re-fetch or subscribe to CARD_LIMITS_CHANGED to get the latest state after a limit change.