Sign in
Cards

Issue Card

Issue a new credit card for a specific cardholder. A detailed explanation of different types and statuses can be found in our guides section. Hint: you can also replace an existing card instead. If the cardholder is in the invited state at the time of issuing the card, we will park the card issuing request and automatically issue the card once the cardholder is active. Please be aware that card issuing is (as many other processes in Pliant's API) an asynchronous process. This means you need to rely on the callback for the card being active, before you can start using it.

This endpoint has changed in comparison to the previous version of the API. The following changes were made:

  • added cardControls to request and response body
  • deprecated type and replaced it with cardConfig
post/cards/{cardholderId}

Path parameters

cardholderIdstring uuid required

The id of the cardholder to issue the card for. This cardholder needs to have a phone number, otherwise 3DS security mechanism during a purchase will not work.

Request body

organizationIdstring uuid required

The ID of the organization to issue the card for.

cardAccountIdstring uuid

The ID of the card account to issue the card for. If not provided, the card will be issued for the default card account of the organization.

type'VIRTUAL' | 'SINGLE_USE' | 'PHYSICAL' | 'BLACK' | 'TRAVEL' nullable

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 Either type or cardConfig has to be provided. Please prefer cardConfig.

cardConfigstring required

The Pliant card configuration of this card. This describes all features 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. Either type or cardConfig has to be provided. Please prefer cardConfig. Required for INSURANCE cards - the deprecated type field cannot be used.

cardDesignIdstring uuid nullable

The unique identifier of the card design used for this card. This field can only be set when creating virtual cards. Available designs for a card config can be retrieved via the available cards endpoint.

labelstring nullable

Mandatory only for virtual cards with a cardConfig containing VIRTUAL or TRAVEL, the maximum length is 40 characters.

purposestring

Mandatory only for virtual cards with cardConfig ending with SINGLE_USE

validityPeriod3 | 6 | 9 | 12 | 18 | 24 | 30 | 36

Number of months when card expires.

  • Mandatory for cardConfig containing VIRTUAL and TRAVEL
  • For cardConfig ending with PHYSICAL or BLACK: set to 36 months automatically
  • For cardConfig ending with SINGLE_USE: set to 12 months automatically
  • For cardConfig containing INSURANCE:
    • Physical insurance: set to 24 months automatically
    • Virtual insurance (excluding single-use): validated from enum, defaults to 36 months
    • Single-use insurance: set to 12 months automatically For cards with fixed validity periods, user input is ignored.
validFromstring date nullable

Optional field to describe a fixed date range in which the card is usable for purchases, replaces the validityPeriod if used. 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. This field can be updated later. This field must be null when issuing benefit cards.

validTostring date nullable

Optional field to describe a fixed date range in which the card is usable for purchases, replaces the validityPeriod if used. 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. This field can be updated later. This field must be null when issuing benefit cards.

validTimezonestring

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. This field can be updated later. This field must be null when issuing benefit cards.

maxTransactionCountnumber

:exclamation: IMPORTANT: if the cardConfig is TRAVEL and this field is not set, the default value will be 3. 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.

limitRenewFrequency'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'TOTAL'

The frequency of the card limit renewal.

  • 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, this is the default setting.
  • 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.
customFirstNamestring nullable

Optional first name on TRAVEL cards which will be used on the card. When used, this replaces the cardholder first name, which normally is used on the card. The maximum length of customFirstName is 50 characters. If used, both fields (customFirstName and customLastName) have to be provided with at least one character each. It is important to note, that only the following characters are allowed for issuing cards: A-Z, a-z, 0-9, äöüÄÖÜ.-

customLastNamestring nullable

Optional last name on TRAVEL cards which will be used on the card. When used, this replaces the cardholder last name, which normally is used on the card. The maximum length of customLastName is 50 characters. If used, both fields (customFirstName and customLastName) have to be provided with at least one character each. It is important to note, that only the following characters are allowed for issuing cards: A-Z, a-z, 0-9, äöüÄÖÜ.-

cardControls0 — unresolved $ref
customFieldsCustomFields — unresolved $ref
teamIdstring uuid nullable

The ID of the team to issue the card for.

projectIdstring uuid nullable

The ID of the project to issue the card for.

deliverTo'ORGANIZATION' | 'CARDHOLDER' nullable

Optionally, specifies where the physical card should be delivered.

  • ORGANIZATION - Ship to organization address (default)
  • CARDHOLDER - Ship to cardholder's personal delivery address

This field is only applicable for physical cards. If not provided, the card will be shipped to the organization address.

The request will fail if the cardholder's personal delivery address is not set and deliverTo is set to CARDHOLDER.

additionalLimitsItems[] nullable— unresolved $ref

Optional additional limits to set on the card at creation time.

Response

Ok. The card can be used after you received the callback for the card being active.

Schema required— unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.