GEgetpliant
Cards

Issue Card with Cardholder (Instant as PCI-DSS)

Changed on

This endpoint offers similar card issuing functionality as the main card issuing and cardholder creation endpoint, but specifically allows for a synchronous and instant card issuing and cardholder creation, including PCI-DSS compliant sensitive card data retrieval, which can be then found in the response as object sensitiveCardData. This endpoint issues cards instantly in a synchronous fashion and returns the sensitive card data like the cards PAN and CVV directly. Meaning the card is active and usable when this endpoint returns a 200 Ok response and you can directly use the card data to do a purchase of any kind. The use case being here a fully automated card issuing flow, followed by an immediate card usage on API level.

This endpoint can only be used after a separate configuration done by Pliant and the partner using this endpoint needs to be PCI-DSS certified!

A dedicated host URL pci-api.getpliant.com is used for this endpoint! Please refer to the documentation for more information.

post/cards/instant-pci

Request

Request body

0 required(unresolved $ref)

Response

Ok. The card can be directly used now.

cardIdstring uuid

The Pliant card id (UUIDv4) of the card.

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

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

cardDesignIdstring uuid nullable

The unique identifier of the card design used for this card. Present only for virtual cards.

cardholderIdstring uuid

The ID of the cardholder this card is issued for.

organizationIdstring uuid

The ID of the organization this card is issued for.

cardAccountIdstring uuid

The ID of the card account this card is issued for.

limitRenewFrequency'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'TOTAL'
  • 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.
expiryDatestring date-time
labelstring nullable

Available only for virtual cards with a cardConfig containing VIRTUAL or TRAVEL. The maximum length is 40 characters.

purposestring nullable

Available only for cards with type SINGLE_USE

customFirstNamestring nullable

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.

customLastNamestring nullable

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.

cardControls0 (unresolved $ref)
validFromstring date nullable

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.

validTostring date nullable

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 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.

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.

maxTransactionCountnumber

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.

clickToPayInfoClickToPayInfo (unresolved $ref)
customFieldsItems[] (unresolved $ref)

The custom fields set on this card. These custom fields are used as default values for every transaction made with this card. If no custom fields are assigned to the card, we return an empty list.

teamIdstring uuid nullable

The ID of the team the card is issued for.

teamNamestring nullable

Name of the team the card is issued for.

projectIdstring uuid nullable

The ID of the project the card is issued for.

projectNamestring nullable

Name of the project the card is issued for.

Changes