v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Card

Create a Card

post/card

Request body

account_idstring required

The ID of the account that the card should be issued against. Filterable.

card_product_idstring required

The ID of the card product that this card should be issued from. Filterable.

new_pan_from_card_idstring

The ID of a card to reissue. If this field is entered a new card will be created without pin, a new PAN, CVV and expiration

person_idstring required

The ID of the person representing the cardholder that this card will be issued to. Filterable.

reissue_pan_from_card_idstring

The ID of a card to reissue. If this field is entered a new card will be created with the same PAN and pin, but new CVV and expiration.

show_cvv'true' | 'false'

When true, the cvv field will be returned with non-null data. False by default. Requires PCI compliance.

show_pan'true' | 'false'

When true, the pan field will be returned with non-null data. False by default. Requires PCI compliance.

statusstring

One of: unactivated, active, suspended, terminated. Filterable.

userdataobject

Optional arbitrary user data

Response

The card created

account_idstring

The ID of the account that the card should be issued against. Filterable.

card_product_idstring

The ID of the card product that this card should be issued from. Filterable.

cvvstring

The 3-digit card verification code. Note this field will return null unless the show_cvv query parameter is set

expirationstring

The card expiration year and month, in MMYY format

idstring

Unique identifier for object

last4string

Last 4 digits of the card number. Filterable.

new_pan_from_card_idstring

The ID of a card to reissue. If this field is entered a new card will be created without pin, a new PAN, CVV and expiration

panstring

The primary 16-digit card number. Note this field will return null unless the show_pan parameter is set

person_idstring

The ID of the person representing the cardholder that this card will be issued to. Filterable.

pin_is_setboolean

Reflects whether the user has set a PIN on the card; initially false

reissue_pan_from_card_idstring

The ID of a card to reissue. If this field is entered a new card will be created with the same PAN and pin, but new CVV and expiration.

show_cvv'true' | 'false'

When true, the cvv field will be returned with non-null data. False by default. Requires PCI compliance.

show_pan'true' | 'false'

When true, the pan field will be returned with non-null data. False by default. Requires PCI compliance.

statusstring

One of: unactivated, active, suspended, terminated. Filterable.

userdataobject

Optional arbitrary user data