Create a Card
Beta: This endpoint is in beta and may change before general availability.
Creates a new card.
Business Rules
- A new card is created in the
activestate.statusis system-managed and cannot be set on create; status changes go through the status-transition endpoints. details.replacement_forreferences an existing card that this card replaces. When provided, the referenced card must be inclosedstatus at the time of the write and must not already be referenced by another card.
Idempotency
The Idempotency-Key header is required. Reusing a key with a different request body will return a 422 error.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Unique key to ensure idempotent requests
255Body
Request body for creating a new card.
The ID of the Account object.
^account_\w+$"account_xyz123"
The ID of your entity.
^entity_[^\s]{1,33}$"entity_xyz123"
Card details for a create request. Extends CardDetails, additionally requiring last_four (the API only creates cards that carry a PAN; the optional last_four on CardDetails is for responses, where file-ingested cards may have none).
A set of key-value pairs that can be used to store additional information related to this object.
Response
Card created successfully.
A card object
The server-generated ID of the Card object.
^card_\w+$"card_xyz123"
Client-provided identifier for the card. Optional: present only for cards created via file upload, and omitted for cards created through the API, which are identified solely by their server-generated ID.
The ID of the Account object.
^account_\w+$"account_xyz123"
The ID of your entity.
^entity_[^\s]{1,33}$"entity_xyz123"
Status is system-managed and cannot be set on create; status changes go through the status-transition endpoints.
active, inactive, closed The reason for the card's current status. Empty when the card is active; otherwise
populated. Set via the status-transition endpoints.
Creation timestamp.
Last update timestamp.
Physical and product attributes of the card.
A set of key-value pairs that can be used to store additional information related to this object.