API Reference
Changelog UpdatesAPI StatusSupport

Create Card Request

post
https://partner-api.getpliant.com/api/cards/requests
šŸ”’

Required scope: cards:write

The API credential calling this endpoint must be granted the cards category with read & write access.
Scopes are assigned to the credential when it is created or edited in Pliant, not requested when obtaining the access token.
A credential without this scope receives 403 Forbidden with the error code INSUFFICIENT_PERMISSION.

Create a card request for a specific cardholder.

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

  • changed the HTTP response code to 202 Accepted and removed the response body, to reflect the asynchronous nature of this endpoint
  • deprecated type and replaced it with cardConfig
Body Params
uuid
required

The ID of the organization to create the card request for.

uuid
required

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

uuid

The ID of the card account to create the card request for. If not provided, the card will be created for the default card account of the organization. If the given card account has status SUPERSEDED, the request is transparently resolved to its successor (supersededBy) and the response carries the id of that successor card account.

cardControls
object
string | null
enum
deprecated

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.

Allowed:
string | null

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.

string
enum
required

Date when card expires in months; Mandatory for virtual cards. For cards with type PHYSICAL or BLACK this is set to 36 months automatically, for cards with type SINGLE_USE it is set to 12 months automatically.

string | null

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

string

Available only for virtual cards with type SINGLE_USE

requestedTransactionLimit
object
required
requestedMonthlyLimit
object
deprecated

Use requestedLimit instead

requestedLimit
object
required
string
enum
  • 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.
Allowed:
string
required
length between 0 and 200
additionalLimits
array of objects | null

Optional additional limits to request on the card. Forwarded to card management and applied when the request is approved.

additionalLimits
Responses

Updated 7 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoadingā€¦
Response
Choose an example:
application/json

Updated 7 months ago

Did this page help you?