Overview
Internal API to retrieve a single card of a party using either its card ID or its card token. Exactly one of cardId or cardToken must be provided. The response includes both identifiers.
GET (/internal/v1/parties/{partyId}/cards)
Parameters
partyId (path) (required): The ID of the party that owns the cards. See PartyId model.
cardId (query): The card ID. Provide either this or cardToken.
cardToken (query): The card token. Provide either this or cardId.
includeStatusHistory (query): Set to
trueto include history of card transitions in the response.
Responses
200 OK
Internal representation of a card. Same non-sensitive data as BasicCard, plus the card token, so internal services can reference a card by either its card ID or its card token.
400 Bad Request
Bad request response
404 Not Found
Not found error response
500 Internal Server Error
Internal server error response
Architecture
Internal representation of a card. Same non-sensitive data as BasicCard, plus the card token, so internal services can reference a card by either its card ID or its card token.
Unique identifier for the card.
Name of the person who owns the card.
The Card Type. The current set of possible values includes: - VIRTUAL - PHYSICAL Please note that new possible values can be added in the future.
Unique identifier for the account the card is associated to.
Display-friendly, obfuscated version of the Primary Account Number (PAN).
Expiry date of the card
Card current status
ACTIVE INACTIVE FROZEN TERMINATED EXPIREDCard fulfillment status
ISSUED ORDERED SHIPPED DELIVEREDThe card alias.
Indicates whether ATM cash withdrawals are permitted for the card. By default at card creation this is true.
Indicates whether online (e-commerce) payments are permitted for the card. By default at card creation this is true.
Indicates whether contactless payments are permitted for the card. By default at card creation this is true.
Free-form map of non-standard attributes.
The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5877.78
[0-9]{1,14}(\.[0-9]{1,3})?The time window for which the limit applies.
DAILY WEEKLY MONTHLYThe type of transaction to which the limit applies. - `ATM_WITHDRAWAL`: The limit applies to cash withdrawals made at ATMs. - `PURCHASE`: The limit applies to purchase transactions.
ATM_WITHDRAWAL PURCHASEThe product id value associated with the card. If none is provided, then the default product id for virtual cards will be used.
The customisation to be applied on the card.
The colour of the card as supported by the fulfilment provider.
Custom text to be displayed on the card. Maximum of 21 characters allowed.
Unique identifier of the design to be applied on the card.
Wallet token id
Type of digital wallet (e.g., GOOGLE_PAY, APPLE_PAY)
Current state of the wallet token
The card token used as a card reference by internal services.
No properties match your search
Try a different search term or clear the search to see all properties
Bad request response
urn:plmr:cards:api:INVALID_CARD_LOOKUP_REQUEST urn:plmr:cards:api:BAD_REQUEST urn:plmr:cards:api:INVALID_PARAM urn:plmr:cards:api:WEB_APPLICATIONurn:plmr:cards:api:NOT_BLANK urn:plmr:cards:api:NOT_NULLNo properties match your search
Try a different search term or clear the search to see all properties
Not found error response
urn:plmr:cards:api:RESOURCE_UNKNOWN urn:plmr:cards:api:CARD_NOT_FOUNDNo properties match your search
Try a different search term or clear the search to see all properties
Internal server error response
urn:plmr:cards:api:INTERNAL_SERVER_ERRORurn:plmr:cards:api:NOT_BLANK urn:plmr:cards:api:NOT_NULLNo properties match your search
Try a different search term or clear the search to see all properties