Card Transitions
Use the /cardtransitions API to set the state of an existing card.
Create card transition
Copy section link
Action: POST
Endpoint: /cardtransitions
Creates a card state transition to set the state of an existing card.
If your system uses IVR, you can send a POST request to /cards/getbypan to retrieve a card token, which you can then use in your POST request to /cardtransitions.
It may not be possible to move a card from one user to another once the card has been activated.
Request body
Copy section link
| Fields | Description |
|---|---|
card_token
string
|
Identifies the card whose state will transition. Allowable Values: 1–36 chars Existing Send a |
channel
string
|
The mechanism by which the transition was initiated.
Allowable Values:
|
reason
string
|
Additional information about the state change. Allowable Values: 255 char max |
reason_code
string
|
A standard code describing the reason for the transition:
Allowable Values:
|
state
string
|
Specifies the new state. Allowable Values:
|
token
string
|
The unique identifier of the card transition. If you do not include a token, the system will generate one automatically. This token is referenced in other API calls, so we recommend that you define a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
validations
object
|
Contains information about the user. Allowable Values: Valid |
validations.user
object
|
Contains information about the user. Allowable Values: Valid |
validations.user.birth_date
datetime
|
The birth date of the user associated with this card. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
validations.user.phone
string
|
The telephone number of the user associated with this card. Allowable Values: 255 char max Format: 5105551212 or 510-555-1212 |
validations.user.random_name_line1_postfix
string
|
A random six-digit numeric postfix generated for some bulk card orders. See Bulk Card Orders for more information about numeric postfixes. Allowable Values: 6 chars |
validations.user.ssn
string
|
The Social Security number of the user associated with this card. Allowable Values: 255 char max |
Response body
Copy section link
| Fields | Description |
|---|---|
barcode
string
|
The barcode printed on the card, expressed as numerals. Allowable Values: 10-20 chars |
bulk_issuance_token
string
|
The unique identifier of the bulk card order. Allowable Values: 1-36 chars |
card
object
|
Associates customer-injected metadata with the card. Allowable Values: Existing |
card.metadata
object
|
Associates customer-injected metadata with the card. Allowable Values: You can define the names and values of up to 20 fields in the format |
card_product_token
string
|
The unique identifier of the card product. Allowable Values: 36 char max |
card_token
string
|
The unique identifier of the card. Allowable Values: 1–36 chars |
channel
string
|
The mechanism by which the transition was initiated.
Allowable Values:
|
created_time
datetime
|
The date and time when the resource was created, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
expedite
boolean
|
A value of Allowable Values:
|
expiration
string
|
The expiration date in Allowable Values: Format: MMyy |
expiration_time
string
|
The expiration date and time in UTC format. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
fulfillment
object
|
Specifies certain physical characteristics of a card, as well as shipment information. Allowable Values: Existing |
fulfillment.card_fulfillment_reason
string
|
The reason for card fulfillment. Allowable Values:
|
fulfillment.card_personalization
object
|
Allows personalized attributes to be added to the card. Allowable Values: Valid |
fulfillment.card_personalization.carrier
object
|
Specifies attributes of the card carrier. Allowable Values: Valid |
fulfillment.card_personalization.carrier.logo_file
string
|
Specifies an image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
fulfillment.card_personalization.carrier.logo_thumbnail_file
string
|
Specifies a thumbnail-sized rendering of the image specified in the Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
fulfillment.card_personalization.carrier.message_file
string
|
Specifies a text file containing a custom message to print on the card carrier. Allowable Values: Contains the name of the text file and must match the name of the file you send to your fulfillment provider. |
fulfillment.card_personalization.carrier.message_line
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
fulfillment.card_personalization.carrier.template_id
string
|
Specifies the card carrier template to use. Allowable Values: Card carrier template ID |
fulfillment.card_personalization.images
object
|
Specifies personalized images that appear on the card. Also specifies attributes of the card carrier, if your fulfillment provider is Perfect Plastic Printing or IDEMIA. Allowable Values: Valid |
fulfillment.card_personalization.images.card
object
|
Specifies personalized images that appear on the card. Allowable Values: Valid |
fulfillment.card_personalization.images.carrier
object
|
Specifies personalized images that appear on the card carrier. Allowable Values: Valid |
fulfillment.card_personalization.images.carrier_return_window
object
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values: Valid |
fulfillment.card_personalization.images.signature
object
|
Specifies a PNG image of the cardholder’s signature. Allowable Values: Valid |
fulfillment.card_personalization.perso_type
string
|
Specifies the type of card personalization. Allowable Values:
|
fulfillment.card_personalization.text
object
|
Specifies personalized text that appears on the card. Allowable Values: Valid |
fulfillment.card_personalization.text.name_line_1
object
|
First line of personalized text printed on the card. Allowable Values:
|
fulfillment.card_personalization.text.name_line_2
object
|
Second line of personalized text printed on the card. Allowable Values:
|
fulfillment.card_personalization.text.name_line_3
object
|
Third line of personalized text printed on the card. Allowable Values:
|
fulfillment.shipping
object
|
Specifies the shipping details for the card. Allowable Values: Valid |
fulfillment.shipping.care_of_line
string
|
Adds the specified value as a C/O (care of) line to the mailing carrier. NOTE: This field overrides the equivalent field on the associated card product. Allowable Values: 255 char max |
fulfillment.shipping.method
string
|
Specifies the shipping service. Allowable Values:
Shipping options vary by card provider. For details on the specific shipping companies and services offered by your card provider, contact your Marqeta representative. |
fulfillment.shipping.recipient_address
object
|
Address to which card will be shipped. For individual card orders:
If no Allowable Values: Valid |
fulfillment.shipping.recipient_address.address1
string
|
Number and street. Allowable Values: 255 char max Lower character limits may be imposed by providers. Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50. |
fulfillment.shipping.recipient_address.address2
string
|
Additional address information. Allowable Values: 255 char max Lower character limits may be imposed by providers. Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50. |
fulfillment.shipping.recipient_address.city
string
|
City. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.country
string
|
Country. Allowable Values: 40 char max The short English name. For example, "Spain". The ISO maintains the full list of country codes. This list includes the item "United States of America (the)," but "United States of America" is acceptable. |
fulfillment.shipping.recipient_address.first_name
string
|
First name. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.last_name
string
|
Last name. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.middle_name
string
|
Middle name. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.phone
string
|
Telephone number. Allowable Values: 20 char max |
fulfillment.shipping.recipient_address.postal_code
string
|
Postal code. Allowable Values: 10 char max |
fulfillment.shipping.recipient_address.state
string
|
State. Allowable Values: 32 char max |
fulfillment.shipping.recipient_address.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
fulfillment.shipping.return_address
object
|
Address to which cards will be returned if shipping fails. Allowable Values: Valid |
fulfillment.shipping.return_address.address1
string
|
Number and street. Allowable Values: 255 char max Lower character limits may be imposed by providers. Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50. |
fulfillment.shipping.return_address.address2
string
|
Additional address information. Allowable Values: 255 char max Lower character limits may be imposed by providers. Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50. |
fulfillment.shipping.return_address.city
string
|
City. Allowable Values: 40 char max |
fulfillment.shipping.return_address.country
string
|
Country. Allowable Values: 40 char max The short English name. For example, "Spain". The ISO maintains the full list of country codes. This list includes the item "United States of America (the)," but "United States of America" is acceptable. |
fulfillment.shipping.return_address.first_name
string
|
First name. Allowable Values: 40 char max |
fulfillment.shipping.return_address.last_name
string
|
Last name. Allowable Values: 40 char max |
fulfillment.shipping.return_address.middle_name
string
|
Middle name. Allowable Values: 40 char max |
fulfillment.shipping.return_address.phone
string
|
Telephone number. Allowable Values: 20 char max |
fulfillment.shipping.return_address.postal_code
string
|
Postal code. Allowable Values: 10 char max |
fulfillment.shipping.return_address.state
string
|
State. Allowable Values: 32 char max |
fulfillment.shipping.return_address.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
fulfillment_status
string
|
Provides status information about the card related to order and delivery. The possible fulfillment states are:
Allowable Values:
|
last_four
string
|
The last four digits of the card PAN. Allowable Values: 4 chars |
pan
string
|
The primary account number (PAN) of the card. Allowable Values: 16 char max |
pin_is_set
boolean
|
Specifies if the personal identification number (PIN) has been set for the card. Allowable Values: 4 chars |
reason
string
|
Additional information about the state change. Allowable Values: 255 char max |
reason_code
string
|
A standard code describing the reason for the transition:
Allowable Values:
|
reissue_pan_from_card_token
string
|
Reissues the specified card (known as the "source" card). Allowable Values: Existing card token |
state
string
|
Indicates the state of the card. Allowable Values:
|
token
string
|
The unique identifier of the card transition. Allowable Values: 1–36 chars |
type
string
|
This field cannot be set directly using the This field appears only when populated by the card fulfillment provider.
The
Allowable Values:
|
user
object
|
Associates customer-injected metadata with the cardholder. Allowable Values: Existing |
user.metadata
object
|
Associates customer-injected metadata with the cardholder. Allowable Values: You can define the names and values of up to 20 fields in the format |
user_token
string
|
The unique identifier of the cardholder. Allowable Values: 1–36 chars |
validations
object
|
Contains information about the user. Allowable Values: Existing |
validations.user
object
|
Contains information about the user. Allowable Values: Valid |
validations.user.birth_date
boolean
|
Indicates whether the Allowable Values:
|
validations.user.phone
boolean
|
Indicates whether the Allowable Values:
|
validations.user.random_name_line1_postfix
boolean
|
Indicates whether the Allowable Values:
|
validations.user.ssn
boolean
|
Indicates whether the Allowable Values:
|
List transitions for card
Copy section link
Action: GET
Endpoint: /cardtransitions/card/{token}
Retrieves a list of the transitions for a specific card.
This endpoint supports field filtering and pagination.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the card. Allowable Values: Existing card token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of card transitions to retrieve. Allowable Values: 1-10 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: Comma-delimited list of fields, or blank |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources to retrieve. Allowable Values: 1-10 |
data
array of objects
|
An array of card transitions. Allowable Values: Existing card transition array |
data[].barcode
string
|
The barcode printed on the card, expressed as numerals. Allowable Values: 10-20 chars |
data[].bulk_issuance_token
string
|
The unique identifier of the bulk card order. Allowable Values: 1-36 chars |
data[].card
object
|
Associates customer-injected metadata with the card. Allowable Values: Existing |
data[].card.metadata
object
|
Associates customer-injected metadata with the card. Allowable Values: You can define the names and values of up to 20 fields in the format |
data[].card_product_token
string
|
The unique identifier of the card product. Allowable Values: 36 char max |
data[].card_token
string
|
The unique identifier of the card. Allowable Values: 1–36 chars |
data[].channel
string
|
The mechanism by which the transition was initiated.
Allowable Values:
|
data[].created_time
datetime
|
The date and time when the resource was created, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].expedite
boolean
|
A value of Allowable Values:
|
data[].expiration
string
|
The expiration date in Allowable Values: Format: MMyy |
data[].expiration_time
string
|
The expiration date and time in UTC format. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].fulfillment
object
|
Specifies certain physical characteristics of a card, as well as shipment information. Allowable Values: Existing |
data[].fulfillment.card_fulfillment_reason
string
|
The reason for card fulfillment. Allowable Values:
|
data[].fulfillment.card_personalization
object
|
Allows personalized attributes to be added to the card. Allowable Values: Valid |
data[].fulfillment.card_personalization.carrier
object
|
Specifies attributes of the card carrier. Allowable Values: Valid |
data[].fulfillment.card_personalization.carrier.logo_file
string
|
Specifies an image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
data[].fulfillment.card_personalization.carrier.logo_thumbnail_file
string
|
Specifies a thumbnail-sized rendering of the image specified in the Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
data[].fulfillment.card_personalization.carrier.message_file
string
|
Specifies a text file containing a custom message to print on the card carrier. Allowable Values: Contains the name of the text file and must match the name of the file you send to your fulfillment provider. |
data[].fulfillment.card_personalization.carrier.message_line
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
data[].fulfillment.card_personalization.carrier.template_id
string
|
Specifies the card carrier template to use. Allowable Values: Card carrier template ID |
data[].fulfillment.card_personalization.images
object
|
Specifies personalized images that appear on the card. Also specifies attributes of the card carrier, if your fulfillment provider is Perfect Plastic Printing or IDEMIA. Allowable Values: Valid |
data[].fulfillment.card_personalization.images.card
object
|
Specifies personalized images that appear on the card. Allowable Values: Valid |
data[].fulfillment.card_personalization.images.carrier
object
|
Specifies personalized images that appear on the card carrier. Allowable Values: Valid |
data[].fulfillment.card_personalization.images.carrier_return_window
object
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values: Valid |
data[].fulfillment.card_personalization.images.signature
object
|
Specifies a PNG image of the cardholder’s signature. Allowable Values: Valid |
data[].fulfillment.card_personalization.perso_type
string
|
Specifies the type of card personalization. Allowable Values:
|
data[].fulfillment.card_personalization.text
object
|
Specifies personalized text that appears on the card. Allowable Values: Valid |
data[].fulfillment.card_personalization.text.name_line_1
object
|
First line of personalized text printed on the card. Allowable Values:
|
data[].fulfillment.card_personalization.text.name_line_2
object
|
Second line of personalized text printed on the card. Allowable Values:
|
data[].fulfillment.card_personalization.text.name_line_3
object
|
Third line of personalized text printed on the card. Allowable Values:
|
data[].fulfillment.shipping
object
|
Specifies the shipping details for the card. Allowable Values: Valid |
data[].fulfillment.shipping.care_of_line
string
|
Adds the specified value as a C/O (care of) line to the mailing carrier. NOTE: This field overrides the equivalent field on the associated card product. Allowable Values: 255 char max |
data[].fulfillment.shipping.method
string
|
Specifies the shipping service. Allowable Values:
Shipping options vary by card provider. For details on the specific shipping companies and services offered by your card provider, contact your Marqeta representative. |
data[].fulfillment.shipping.recipient_address
object
|
Address to which card will be shipped. For individual card orders:
If no Allowable Values: Valid |
data[].fulfillment.shipping.recipient_address.address1
string
|
Number and street. Allowable Values: 255 char max Lower character limits may be imposed by providers. Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50. |
data[].fulfillment.shipping.recipient_address.address2
string
|
Additional address information. Allowable Values: 255 char max Lower character limits may be imposed by providers. Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50. |
data[].fulfillment.shipping.recipient_address.city
string
|
City. Allowable Values: 40 char max |
data[].fulfillment.shipping.recipient_address.country
string
|
Country. Allowable Values: 40 char max The short English name. For example, "Spain". The ISO maintains the full list of country codes. This list includes the item "United States of America (the)," but "United States of America" is acceptable. |
data[].fulfillment.shipping.recipient_address.first_name
string
|
First name. Allowable Values: 40 char max |
data[].fulfillment.shipping.recipient_address.last_name
string
|
Last name. Allowable Values: 40 char max |
data[].fulfillment.shipping.recipient_address.middle_name
string
|
Middle name. Allowable Values: 40 char max |
data[].fulfillment.shipping.recipient_address.phone
string
|
Telephone number. Allowable Values: 20 char max |
data[].fulfillment.shipping.recipient_address.postal_code
string
|
Postal code. Allowable Values: 10 char max |
data[].fulfillment.shipping.recipient_address.state
string
|
State. Allowable Values: 32 char max |
data[].fulfillment.shipping.recipient_address.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
data[].fulfillment.shipping.return_address
object
|
Address to which cards will be returned if shipping fails. Allowable Values: Valid |
data[].fulfillment.shipping.return_address.address1
string
|
Number and street. Allowable Values: 255 char max Lower character limits may be imposed by providers. Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50. |
data[].fulfillment.shipping.return_address.address2
string
|
Additional address information. Allowable Values: 255 char max Lower character limits may be imposed by providers. Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50. |
data[].fulfillment.shipping.return_address.city
string
|
City. Allowable Values: 40 char max |
data[].fulfillment.shipping.return_address.country
string
|
Country. Allowable Values: 40 char max The short English name. For example, "Spain". The ISO maintains the full list of country codes. This list includes the item "United States of America (the)," but "United States of America" is acceptable. |
data[].fulfillment.shipping.return_address.first_name
string
|
First name. Allowable Values: 40 char max |
data[].fulfillment.shipping.return_address.last_name
string
|
Last name. Allowable Values: 40 char max |
data[].fulfillment.shipping.return_address.middle_name
string
|
Middle name. Allowable Values: 40 char max |
data[].fulfillment.shipping.return_address.phone
string
|
Telephone number. Allowable Values: 20 char max |
data[].fulfillment.shipping.return_address.postal_code
string
|
Postal code. Allowable Values: 10 char max |
data[].fulfillment.shipping.return_address.state
string
|
State. Allowable Values: 32 char max |
data[].fulfillment.shipping.return_address.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
data[].fulfillment_status
string
|
Provides status information about the card related to order and delivery. The possible fulfillment states are:
Allowable Values:
|
data[].last_four
string
|
The last four digits of the card PAN. Allowable Values: 4 chars |
data[].pan
string
|
The primary account number (PAN) of the card. Allowable Values: 16 char max |
data[].pin_is_set
boolean
|
Specifies if the personal identification number (PIN) has been set for the card. Allowable Values: 4 chars |
data[].reason
string
|
Additional information about the state change. Allowable Values: 255 char max |
data[].reason_code
string
|
A standard code describing the reason for the transition:
Allowable Values:
|
data[].reissue_pan_from_card_token
string
|
Reissues the specified card (known as the "source" card). Allowable Values: Existing card token |
data[].state
string
|
Indicates the state of the card. Allowable Values:
|
data[].token
string
|
The unique identifier of the card transition. Allowable Values: 1–36 chars |
data[].type
string
|
This field cannot be set directly using the This field appears only when populated by the card fulfillment provider.
The
Allowable Values:
|
data[].user
object
|
Associates customer-injected metadata with the cardholder. Allowable Values: Existing |
data[].user.metadata
object
|
Associates customer-injected metadata with the cardholder. Allowable Values: You can define the names and values of up to 20 fields in the format |
data[].user_token
string
|
The unique identifier of the cardholder. Allowable Values: 1–36 chars |
data[].validations
object
|
Contains information about the user. Allowable Values: Existing |
data[].validations.user
object
|
Contains information about the user. Allowable Values: Valid |
data[].validations.user.birth_date
boolean
|
Indicates whether the Allowable Values:
|
data[].validations.user.phone
boolean
|
Indicates whether the Allowable Values:
|
data[].validations.user.random_name_line1_postfix
boolean
|
Indicates whether the Allowable Values:
|
data[].validations.user.ssn
boolean
|
Indicates whether the Allowable Values:
|
end_index
integer
|
The sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
Retrieve card transition
Copy section link
Action: GET
Endpoint: /cardtransitions/{token}
Retrieves a specific card transition. This endpoint supports field filtering.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the card transition.
Send a Allowable Values: Existing card transition token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
fields
string
|
Comma-delimited list of fields to return ( Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
barcode
string
|
The barcode printed on the card, expressed as numerals. Allowable Values: 10-20 chars |
bulk_issuance_token
string
|
The unique identifier of the bulk card order. Allowable Values: 1-36 chars |
card
object
|
Associates customer-injected metadata with the card. Allowable Values: Existing |
card.metadata
object
|
Associates customer-injected metadata with the card. Allowable Values: You can define the names and values of up to 20 fields in the format |
card_product_token
string
|
The unique identifier of the card product. Allowable Values: 36 char max |
card_token
string
|
The unique identifier of the card. Allowable Values: 1–36 chars |
channel
string
|
The mechanism by which the transition was initiated.
Allowable Values:
|
created_time
datetime
|
The date and time when the resource was created, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
expedite
boolean
|
A value of Allowable Values:
|
expiration
string
|
The expiration date in Allowable Values: Format: MMyy |
expiration_time
string
|
The expiration date and time in UTC format. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
fulfillment
object
|
Specifies certain physical characteristics of a card, as well as shipment information. Allowable Values: Existing |
fulfillment.card_fulfillment_reason
string
|
The reason for card fulfillment. Allowable Values:
|
fulfillment.card_personalization
object
|
Allows personalized attributes to be added to the card. Allowable Values: Valid |
fulfillment.card_personalization.carrier
object
|
Specifies attributes of the card carrier. Allowable Values: Valid |
fulfillment.card_personalization.carrier.logo_file
string
|
Specifies an image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
fulfillment.card_personalization.carrier.logo_thumbnail_file
string
|
Specifies a thumbnail-sized rendering of the image specified in the Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
fulfillment.card_personalization.carrier.message_file
string
|
Specifies a text file containing a custom message to print on the card carrier. Allowable Values: Contains the name of the text file and must match the name of the file you send to your fulfillment provider. |
fulfillment.card_personalization.carrier.message_line
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
fulfillment.card_personalization.carrier.template_id
string
|
Specifies the card carrier template to use. Allowable Values: Card carrier template ID |
fulfillment.card_personalization.images
object
|
Specifies personalized images that appear on the card. Also specifies attributes of the card carrier, if your fulfillment provider is Perfect Plastic Printing or IDEMIA. Allowable Values: Valid |
fulfillment.card_personalization.images.card
object
|
Specifies personalized images that appear on the card. Allowable Values: Valid |
fulfillment.card_personalization.images.carrier
object
|
Specifies personalized images that appear on the card carrier. Allowable Values: Valid |
fulfillment.card_personalization.images.carrier_return_window
object
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values: Valid |
fulfillment.card_personalization.images.signature
object
|
Specifies a PNG image of the cardholder’s signature. Allowable Values: Valid |
fulfillment.card_personalization.perso_type
string
|
Specifies the type of card personalization. Allowable Values:
|
fulfillment.card_personalization.text
object
|
Specifies personalized text that appears on the card. Allowable Values: Valid |
fulfillment.card_personalization.text.name_line_1
object
|
First line of personalized text printed on the card. Allowable Values:
|
fulfillment.card_personalization.text.name_line_2
object
|
Second line of personalized text printed on the card. Allowable Values:
|
fulfillment.card_personalization.text.name_line_3
object
|
Third line of personalized text printed on the card. Allowable Values:
|
fulfillment.shipping
object
|
Specifies the shipping details for the card. Allowable Values: Valid |
fulfillment.shipping.care_of_line
string
|
Adds the specified value as a C/O (care of) line to the mailing carrier. NOTE: This field overrides the equivalent field on the associated card product. Allowable Values: 255 char max |
fulfillment.shipping.method
string
|
Specifies the shipping service. Allowable Values:
Shipping options vary by card provider. For details on the specific shipping companies and services offered by your card provider, contact your Marqeta representative. |
fulfillment.shipping.recipient_address
object
|
Address to which card will be shipped. For individual card orders:
If no Allowable Values: Valid |
fulfillment.shipping.recipient_address.address1
string
|
Number and street. Allowable Values: 255 char max Lower character limits may be imposed by providers. Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50. |
fulfillment.shipping.recipient_address.address2
string
|
Additional address information. Allowable Values: 255 char max Lower character limits may be imposed by providers. Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50. |
fulfillment.shipping.recipient_address.city
string
|
City. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.country
string
|
Country. Allowable Values: 40 char max The short English name. For example, "Spain". The ISO maintains the full list of country codes. This list includes the item "United States of America (the)," but "United States of America" is acceptable. |
fulfillment.shipping.recipient_address.first_name
string
|
First name. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.last_name
string
|
Last name. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.middle_name
string
|
Middle name. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.phone
string
|
Telephone number. Allowable Values: 20 char max |
fulfillment.shipping.recipient_address.postal_code
string
|
Postal code. Allowable Values: 10 char max |
fulfillment.shipping.recipient_address.state
string
|
State. Allowable Values: 32 char max |
fulfillment.shipping.recipient_address.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
fulfillment.shipping.return_address
object
|
Address to which cards will be returned if shipping fails. Allowable Values: Valid |
fulfillment.shipping.return_address.address1
string
|
Number and street. Allowable Values: 255 char max Lower character limits may be imposed by providers. Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50. |
fulfillment.shipping.return_address.address2
string
|
Additional address information. Allowable Values: 255 char max Lower character limits may be imposed by providers. Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50. |
fulfillment.shipping.return_address.city
string
|
City. Allowable Values: 40 char max |
fulfillment.shipping.return_address.country
string
|
Country. Allowable Values: 40 char max The short English name. For example, "Spain". The ISO maintains the full list of country codes. This list includes the item "United States of America (the)," but "United States of America" is acceptable. |
fulfillment.shipping.return_address.first_name
string
|
First name. Allowable Values: 40 char max |
fulfillment.shipping.return_address.last_name
string
|
Last name. Allowable Values: 40 char max |
fulfillment.shipping.return_address.middle_name
string
|
Middle name. Allowable Values: 40 char max |
fulfillment.shipping.return_address.phone
string
|
Telephone number. Allowable Values: 20 char max |
fulfillment.shipping.return_address.postal_code
string
|
Postal code. Allowable Values: 10 char max |
fulfillment.shipping.return_address.state
string
|
State. Allowable Values: 32 char max |
fulfillment.shipping.return_address.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
fulfillment_status
string
|
Provides status information about the card related to order and delivery. The possible fulfillment states are:
Allowable Values:
|
last_four
string
|
The last four digits of the card PAN. Allowable Values: 4 chars |
pan
string
|
The primary account number (PAN) of the card. Allowable Values: 16 char max |
pin_is_set
boolean
|
Specifies if the personal identification number (PIN) has been set for the card. Allowable Values: 4 chars |
reason
string
|
Additional information about the state change. Allowable Values: 255 char max |
reason_code
string
|
A standard code describing the reason for the transition:
Allowable Values:
|
reissue_pan_from_card_token
string
|
Reissues the specified card (known as the "source" card). Allowable Values: Existing card token |
state
string
|
Indicates the state of the card. Allowable Values:
|
token
string
|
The unique identifier of the card transition. Allowable Values: 1–36 chars |
type
string
|
This field cannot be set directly using the This field appears only when populated by the card fulfillment provider.
The
Allowable Values:
|
user
object
|
Associates customer-injected metadata with the cardholder. Allowable Values: Existing |
user.metadata
object
|
Associates customer-injected metadata with the cardholder. Allowable Values: You can define the names and values of up to 20 fields in the format |
user_token
string
|
The unique identifier of the cardholder. Allowable Values: 1–36 chars |
validations
object
|
Contains information about the user. Allowable Values: Existing |
validations.user
object
|
Contains information about the user. Allowable Values: Valid |
validations.user.birth_date
boolean
|
Indicates whether the Allowable Values:
|
validations.user.phone
boolean
|
Indicates whether the Allowable Values:
|
validations.user.random_name_line1_postfix
boolean
|
Indicates whether the Allowable Values:
|
validations.user.ssn
boolean
|
Indicates whether the Allowable Values:
|