API ReferenceProducts & BINs

Get a card product

Retrieve a card product, including its usage type, expiration rules and BIN selection settings.

Required permissions: card_product:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

card_product_idstringRequired

Query parameters

versionintegerOptional>=0Defaults to 0
Card product version. Zero selects latest.

Response

The card product.
card_product_idstring
Penny's unique identifier for this card product.
versioninteger
A number that increases each time this product's details change. Use it to confirm you are looking at the latest information.
version_timedatetime
The date and time this product's details were last changed.
business_idstring
The business this product belongs to.
program_idstring
The program this product is offered under.
usage_typeenum
The usage type permitted for cards issued under this product.
Allowed values:
expiration_date_configobject
The rules used to compute the expiration date of cards issued under this product.
statusenum
This product's current lifecycle status.
Allowed values:
aliasstring

A human-readable name for this product.

descriptionstring or nullOptional
An extended description of this product.
form_factorenumOptionalDefaults to virtual
The form of cards issued under this product.
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error