Penny IssuingCardholdersIndividual

Create an individual cardholder

Create a new individual cardholder under an existing business entity.

Required permissions: cardholder:create.

Authentication

AuthorizationBearer

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

Query parameters

reveal_sensitivebooleanOptionalDefaults to false
Whether to include unmasked sensitive fields in the response. Defaults to false.

Request

This endpoint expects an object.
given_namestringRequired
The first name of the cardholder.
family_namestringRequired
The last name of the cardholder.
emailstringRequiredformat: "email"
The email address of the cardholder.
addressobjectRequired
The address of the cardholder.
phone_numberstring or nullOptional
The phone number of the cardholder.
spend_control_idstringOptional
The ID of the spend control associated with the cardholder.

Response

The newly created individual cardholder.
cardholder_idstring
Penny's unique identifier for this cardholder.
versioninteger
A number that increases each time this cardholder's details change. Use it to confirm you are looking at the latest information.
version_timedatetime
The date and time this cardholder's details were last changed.
business_idstring
The business this cardholder belongs to.
business_entity_idstring
The business entity this cardholder belongs to.
program_idstring
The program this cardholder is issued under.
statusenum

This cardholder’s current lifecycle status: ‘active’, ‘deactivated’ (cannot be issued new cards), ‘suspended’ (restricted, typically pending review), ‘deleting’ (removal has been requested and is in progress), or ‘deleted’.

Allowed values:
activeboolean
Whether this cardholder is currently active.
given_namestring

The cardholder’s given (first) name. Shown as a masked placeholder unless the request explicitly asks to reveal personal information.

family_namestring

The cardholder’s family (last) name. Shown as a masked placeholder unless the request explicitly asks to reveal personal information.

addressobject or nullOptional
The cardholder's registered physical address, if on file.
emailstring or nullOptional
The cardholder's contact email address, if on file. Shown as a masked placeholder unless the request explicitly asks to reveal personal information.
phonestring or nullOptional
The cardholder's contact phone number, if one is on file. Shown as a masked placeholder unless the request explicitly asks to reveal personal information.
spend_control_idstring or nullOptional
The spend control policy applied to this cardholder's cards, if one is set.
typeenumOptionalDefaults to individual

Distinguishes between natural-person and business cardholders.

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