Bulk Card Orders
Use the /bulkissuances endpoint to order physical payment cards in bulk.
For more information on cards, card products, and bulk card ordering, see About Cards.
Some attributes of the bulkissuance object can also be defined in an associated card or cardproduct object.
If you define one of these attributes in more than one object, the Marqeta platform applies an order of precedence to determine which attribute to use at fulfillment time.
The order of precedence is as follows:
-
card -
bulkissuance -
cardproduct
Defining an attribute in an object with higher precedence does not overwrite the same attribute in a lower-precedence object; the Marqeta platform ignores these lower-precedence attributes.
For more information on cards, see About Cards.
Create bulk card order
Copy section link
Action: POST
Endpoint: /bulkissuances
Use this endpoint to order physical cards in bulk. A new bulk card order creates new cards or users, generally within about a day.
Before creating a bulk card order, set the config.fulfillment.bulk_ship field of the associated card product to true.
To associate all cards with the same user:
-
Set
user_association.single_inventory_user=true -
Set
user_association.single_inventory_user_tokenequal to the token of an existing user.
The bulk card order automatically populates the database with the specified card objects.
Values for the card token fields are generated in the format card-numericPostfix, where numericPostfix is a randomly generated number that is added for each new card that is generated.
To associate each card with a unique user:
Set user_association.single_inventory_user=false.
Both the cards and their associated users are automatically generated.
Values for the user token fields are generated in the format user-numericPostfix.
The numericPostfix values for cards and their associated users match.
This value is also printed on the physical cards if the name_line_1_numeric_postfix field is set to true.
Request body
Copy section link
| Fields | Description |
|---|---|
card_allocation
integer
|
Number of cards in the order. Allowable Values: 50000 max The actual number of cards processed per day depends on your fulfillment provider. Contact your Marqeta representative for more information. |
card_product_token
string
|
Specifies the card product from which to create your cards. Allowable Values: 1–36 chars Send a |
expedite
boolean
|
Set to This expedited service is available for cards fulfilled by Perfect Plastic Printing, IDEMIA, and Arroweye Solutions. NOTE: Contact your Marqeta representative for information regarding the cost of expedited service. Allowable Values:
Default value: |
expiration_offset
object
|
Specifies the length of time after the date of issue for which the cards are valid. Allowable Values:
|
expiration_offset.unit
string
|
Specifies the units for the Allowable Values:
Default value: |
expiration_offset.value
integer
|
Specifies the number of time units (as defined by the This number is rounded as follows:
Allowable Values: Any positive integer Default value: |
fulfillment
object
|
Specifies certain physical characteristics of a card, as well as bulk shipment information. Allowable Values:
|
fulfillment.card_personalization
object
|
Specifies personalized attributes to be added to the card. Allowable Values:
|
fulfillment.card_personalization.carrier
object
|
Specifies attributes of the card carrier. Allowable Values:
|
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. Allowable Values:
|
fulfillment.card_personalization.images.card
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
fulfillment.card_personalization.images.card.name
string
|
Specifies a PNG image to display on the card. 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.images.card.thermal_color
string
|
Specifies the color of the image displayed on the card. Allowable Values: Contains the name of the color and must match one of the provider’s predefined colors. |
fulfillment.card_personalization.images.carrier
object
|
Specifies personalized images that appear on the card carrier. Allowable Values:
|
fulfillment.card_personalization.images.carrier.message_1
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
fulfillment.card_personalization.images.carrier.name
string
|
Specifies a PNG 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.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:
|
fulfillment.card_personalization.images.carrier_return_window.name
string
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. 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.images.signature
object
|
Specifies a PNG image of the cardholder’s signature. Allowable Values:
|
fulfillment.card_personalization.images.signature.name
string
|
Specifies a PNG image of the cardholder’s signature. 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.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:
|
fulfillment.card_personalization.text.name_line_1
object
|
Specifies the first line of personalized text that appears on the card. Allowable Values:
21 char max; if Strings longer than the character limit are truncated. |
fulfillment.card_personalization.text.name_line_1.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
fulfillment.card_personalization.text.name_line_2
object
|
Specifies the second line of personalized text that appears on the card. Allowable Values:
|
fulfillment.card_personalization.text.name_line_2.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
fulfillment.card_personalization.text.name_line_3
object
|
Specifies the third line of personalized text that appears on the card. Allowable Values:
|
fulfillment.card_personalization.text.name_line_3.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
fulfillment.shipping
object
|
Specifies shipping details for the order. Allowable Values:
|
fulfillment.shipping.care_of_line
string
|
Adds the specified value as a care of (C/O) line to the mailing carrier. NOTE: This field can be specified on cards, card products, and bulk card orders. If you specify this field at multiple levels, the order of precedence is: card, bulk card order, 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 the order will be shipped. In order to generate cards, a valid shipping address must be provided by one of these:
The order of precedence from highest to lowest is card, user, card product.
To be valid, an address must have the Allowable Values: Valid |
fulfillment.shipping.recipient_address.address1
string
|
Number and street of the address. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
fulfillment.shipping.recipient_address.address2
string
|
Additional address information. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
fulfillment.shipping.recipient_address.city
string
|
City of the address. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.country
string
|
Country of the address. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
fulfillment.shipping.recipient_address.first_name
string
|
First name of the addressee. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.last_name
string
|
Last name of the addressee. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.middle_name
string
|
Middle name of the addressee. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.phone
string
|
Telephone number of the addressee. Allowable Values: 20 char max |
fulfillment.shipping.recipient_address.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
fulfillment.shipping.recipient_address.state
string
|
State of the address. Allowable Values: 32 char max |
fulfillment.shipping.recipient_address.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
fulfillment.shipping.return_address
object
|
Address to which the order will be returned if shipping fails. Allowable Values:
|
fulfillment.shipping.return_address.address1
string
|
Number and street of the address. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
fulfillment.shipping.return_address.address2
string
|
Additional address information. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
fulfillment.shipping.return_address.city
string
|
City of the address. Allowable Values: 40 char max |
fulfillment.shipping.return_address.country
string
|
Country of the address. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
fulfillment.shipping.return_address.first_name
string
|
First name of the addressee. Allowable Values: 40 char max |
fulfillment.shipping.return_address.last_name
string
|
Last name of the addressee. Allowable Values: 40 char max |
fulfillment.shipping.return_address.middle_name
string
|
Middle name of the addressee. Allowable Values: 40 char max |
fulfillment.shipping.return_address.phone
string
|
Telephone number of the addressee. Allowable Values: 20 char max |
fulfillment.shipping.return_address.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
fulfillment.shipping.return_address.state
string
|
State of the address. Allowable Values: 32 char max |
fulfillment.shipping.return_address.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
name_line_1_numeric_postfix
boolean
|
If set to Allowable Values:
Default value: |
name_line_1_random_postfix
boolean
|
If set to Allowable Values:
Default value: |
token
string
|
If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
user_association
object
|
Associates each card with a user. Allowable Values:
|
user_association.single_inventory_user
boolean
|
Set to Allowable Values:
Default value: |
user_association.single_inventory_user_token
string
|
If Allowable Values: 1–36 chars |
Response body
Copy section link
| Fields | Description |
|---|---|
card_allocation
integer
|
Number of cards in the order. Allowable Values: 50000 max |
card_fulfillment_time
datetime
|
Date and time when the bulk card order was fulfilled, in UTC. This field is included if your bulk card order has been processed. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
card_product_token
string
|
Specifies the card product from which the cards are created. Allowable Values: 1–36 chars |
cards_processed
integer
|
Number of cards processed in the bulk card order. This field is returned if it exists in the resource. Allowable Values: Any positive integer |
created_time
datetime
|
Date and time when the resource was created, in UTC. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
expedite
boolean
|
Indicates if expedited processing of this bulk card order was requested. This field is returned if it exists in the resource. Allowable Values:
|
expiration_offset
object
|
Specifies the length of time after the date of issue for which the cards are valid. Allowable Values:
|
expiration_offset.unit
string
|
Specifies the units for the Allowable Values:
Default value: |
expiration_offset.value
integer
|
Specifies the number of time units (as defined by the This number is rounded as follows:
Allowable Values: Any positive integer Default value: |
fulfillment
object
|
Specifies certain physical characteristics of a card, as well as bulk shipment information. This object is returned if it exists in the resource. Allowable Values:
|
fulfillment.card_personalization
object
|
Specifies personalized attributes to be added to the card. Allowable Values:
|
fulfillment.card_personalization.carrier
object
|
Specifies attributes of the card carrier. Allowable Values:
|
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. Allowable Values:
|
fulfillment.card_personalization.images.card
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
fulfillment.card_personalization.images.card.name
string
|
Specifies a PNG image to display on the card. 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.images.card.thermal_color
string
|
Specifies the color of the image displayed on the card. Allowable Values: Contains the name of the color and must match one of the provider’s predefined colors. |
fulfillment.card_personalization.images.carrier
object
|
Specifies personalized images that appear on the card carrier. Allowable Values:
|
fulfillment.card_personalization.images.carrier.message_1
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
fulfillment.card_personalization.images.carrier.name
string
|
Specifies a PNG 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.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:
|
fulfillment.card_personalization.images.carrier_return_window.name
string
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. 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.images.signature
object
|
Specifies a PNG image of the cardholder’s signature. Allowable Values:
|
fulfillment.card_personalization.images.signature.name
string
|
Specifies a PNG image of the cardholder’s signature. 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.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:
|
fulfillment.card_personalization.text.name_line_1
object
|
Specifies the first line of personalized text that appears on the card. Allowable Values:
21 char max; if Strings longer than the character limit are truncated. |
fulfillment.card_personalization.text.name_line_1.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
fulfillment.card_personalization.text.name_line_2
object
|
Specifies the second line of personalized text that appears on the card. Allowable Values:
|
fulfillment.card_personalization.text.name_line_2.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
fulfillment.card_personalization.text.name_line_3
object
|
Specifies the third line of personalized text that appears on the card. Allowable Values:
|
fulfillment.card_personalization.text.name_line_3.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
fulfillment.shipping
object
|
Specifies shipping details for the order. This object is returned if it exists in the resource. Allowable Values:
|
fulfillment.shipping.care_of_line
string
|
Specifies the value of the care of (C/O) line on the mailing carrier. This field is returned if it exists in the resource. Allowable Values: 255 char max |
fulfillment.shipping.method
string
|
Specifies the shipping service. This field is returned if it exists in the resource. Allowable Values:
|
fulfillment.shipping.recipient_address
object
|
Address to which the order will be shipped. This field is returned if it exists in the resource. Allowable Values: Existing |
fulfillment.shipping.recipient_address.address1
string
|
Number and street of the address. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
fulfillment.shipping.recipient_address.address2
string
|
Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
fulfillment.shipping.recipient_address.city
string
|
City of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.country
string
|
Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
fulfillment.shipping.recipient_address.first_name
string
|
First name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.last_name
string
|
Last name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.middle_name
string
|
Middle name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.phone
string
|
Telephone number of the addressee. This field is returned if it exists in the resource. Allowable Values: 20 char max |
fulfillment.shipping.recipient_address.postal_code
string
|
Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
fulfillment.shipping.recipient_address.state
string
|
State or province of the address. This field is returned if it exists in the resource. Allowable Values: 32 char max |
fulfillment.shipping.recipient_address.zip
string
|
United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
fulfillment.shipping.return_address
object
|
Address to which the order will be returned if shipping fails. This object is returned if it exists in the resource. Allowable Values: Existing |
fulfillment.shipping.return_address.address1
string
|
Number and street of the address. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
fulfillment.shipping.return_address.address2
string
|
Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
fulfillment.shipping.return_address.city
string
|
City of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.return_address.country
string
|
Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
fulfillment.shipping.return_address.first_name
string
|
First name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.return_address.last_name
string
|
Last name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.return_address.middle_name
string
|
Middle name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.return_address.phone
string
|
Telephone number of the addressee. This field is returned if it exists in the resource. Allowable Values: 20 char max |
fulfillment.shipping.return_address.postal_code
string
|
Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
fulfillment.shipping.return_address.state
string
|
State or province of the address. This field is returned if it exists in the resource. Allowable Values: 32 char max |
fulfillment.shipping.return_address.zip
string
|
United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
name_line1_end_index
integer
|
This field is included if your bulk card order has been processed. You can use the See Create bulk card order for more information about the automatic generation and naming of cards and users. Allowable Values: Any positive integer |
name_line1_start_index
integer
|
This field is included if your bulk card order has been processed. You can use the See Create bulk card order for more information about the automatic generation and naming of cards and users. Allowable Values: Any positive integer |
name_line_1_numeric_postfix
boolean
|
If set to Allowable Values:
|
name_line_1_random_postfix
boolean
|
If set to This field is returned if it exists in the resource. Allowable Values:
|
provider_ship_date
datetime
|
Date and time when the card provider shipped the bulk card order, in UTC. This field is included if your bulk card order has shipped. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
provider_shipping_method
string
|
Shipping method used by the card provider.
This field is included if your bulk card order has shipped. Allowable Values: String |
provider_tracking_number
string
|
A tracking number is included only if your card provider is Arroweye Solutions. This field is included if your bulk card order has shipped. Allowable Values: String |
token
string
|
Unique identifier of the bulk card order. Allowable Values: 1–36 chars |
user_association
object
|
Associates each card with a user. Allowable Values:
|
user_association.single_inventory_user
boolean
|
Set to Allowable Values:
Default value: |
user_association.single_inventory_user_token
string
|
If Allowable Values: 1–36 chars |
List bulk card orders
Copy section link
Action: GET
Endpoint: /bulkissuances
Use this endpoint to list existing bulk card orders.
This endpoint supports pagination and sorting.
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of bulk card orders to retrieve. Allowable Values: 1-10 Default value: |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: Any integer Default value: |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
Default value: |
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of resources retrieved. This field is returned if there are resources in your returned array. Allowable Values: 1-10 |
data
array of objects
|
Array of bulk issuance objects. Objects are returned as appropriate to your query. Allowable Values: Valid array of one or more bulk issuance objects |
data[].card_allocation
integer
|
Number of cards in the order. Allowable Values: 50000 max |
data[].card_fulfillment_time
datetime
|
Date and time when the bulk card order was fulfilled, in UTC. This field is included if your bulk card order has been processed. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].card_product_token
string
|
Specifies the card product from which the cards are created. Allowable Values: 1–36 chars |
data[].cards_processed
integer
|
Number of cards processed in the bulk card order. This field is returned if it exists in the resource. Allowable Values: Any positive integer |
data[].created_time
datetime
|
Date and time when the resource was created, in UTC. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].expedite
boolean
|
Indicates if expedited processing of this bulk card order was requested. This field is returned if it exists in the resource. Allowable Values:
|
data[].expiration_offset
object
|
Specifies the length of time after the date of issue for which the cards are valid. Allowable Values:
|
data[].expiration_offset.unit
string
|
Specifies the units for the Allowable Values:
Default value: |
data[].expiration_offset.value
integer
|
Specifies the number of time units (as defined by the This number is rounded as follows:
Allowable Values: Any positive integer Default value: |
data[].fulfillment
object
|
Specifies certain physical characteristics of a card, as well as bulk shipment information. This object is returned if it exists in the resource. Allowable Values:
|
data[].fulfillment.card_personalization
object
|
Specifies personalized attributes to be added to the card. Allowable Values:
|
data[].fulfillment.card_personalization.carrier
object
|
Specifies attributes of the card carrier. Allowable Values:
|
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. Allowable Values:
|
data[].fulfillment.card_personalization.images.card
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
data[].fulfillment.card_personalization.images.card.name
string
|
Specifies a PNG image to display on the card. 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.images.card.thermal_color
string
|
Specifies the color of the image displayed on the card. Allowable Values: Contains the name of the color and must match one of the provider’s predefined colors. |
data[].fulfillment.card_personalization.images.carrier
object
|
Specifies personalized images that appear on the card carrier. Allowable Values:
|
data[].fulfillment.card_personalization.images.carrier.message_1
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
data[].fulfillment.card_personalization.images.carrier.name
string
|
Specifies a PNG 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.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:
|
data[].fulfillment.card_personalization.images.carrier_return_window.name
string
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. 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.images.signature
object
|
Specifies a PNG image of the cardholder’s signature. Allowable Values:
|
data[].fulfillment.card_personalization.images.signature.name
string
|
Specifies a PNG image of the cardholder’s signature. 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.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:
|
data[].fulfillment.card_personalization.text.name_line_1
object
|
Specifies the first line of personalized text that appears on the card. Allowable Values:
21 char max; if Strings longer than the character limit are truncated. |
data[].fulfillment.card_personalization.text.name_line_1.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
data[].fulfillment.card_personalization.text.name_line_2
object
|
Specifies the second line of personalized text that appears on the card. Allowable Values:
|
data[].fulfillment.card_personalization.text.name_line_2.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
data[].fulfillment.card_personalization.text.name_line_3
object
|
Specifies the third line of personalized text that appears on the card. Allowable Values:
|
data[].fulfillment.card_personalization.text.name_line_3.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
data[].fulfillment.shipping
object
|
Specifies shipping details for the order. This object is returned if it exists in the resource. Allowable Values:
|
data[].fulfillment.shipping.care_of_line
string
|
Specifies the value of the care of (C/O) line on the mailing carrier. This field is returned if it exists in the resource. Allowable Values: 255 char max |
data[].fulfillment.shipping.method
string
|
Specifies the shipping service. This field is returned if it exists in the resource. Allowable Values:
|
data[].fulfillment.shipping.recipient_address
object
|
Address to which the order will be shipped. This field is returned if it exists in the resource. Allowable Values: Existing |
data[].fulfillment.shipping.recipient_address.address1
string
|
Number and street of the address. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
data[].fulfillment.shipping.recipient_address.address2
string
|
Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
data[].fulfillment.shipping.recipient_address.city
string
|
City of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
data[].fulfillment.shipping.recipient_address.country
string
|
Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
data[].fulfillment.shipping.recipient_address.first_name
string
|
First name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
data[].fulfillment.shipping.recipient_address.last_name
string
|
Last name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
data[].fulfillment.shipping.recipient_address.middle_name
string
|
Middle name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
data[].fulfillment.shipping.recipient_address.phone
string
|
Telephone number of the addressee. This field is returned if it exists in the resource. Allowable Values: 20 char max |
data[].fulfillment.shipping.recipient_address.postal_code
string
|
Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
data[].fulfillment.shipping.recipient_address.state
string
|
State or province of the address. This field is returned if it exists in the resource. Allowable Values: 32 char max |
data[].fulfillment.shipping.recipient_address.zip
string
|
United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
data[].fulfillment.shipping.return_address
object
|
Address to which the order will be returned if shipping fails. This object is returned if it exists in the resource. Allowable Values: Existing |
data[].fulfillment.shipping.return_address.address1
string
|
Number and street of the address. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
data[].fulfillment.shipping.return_address.address2
string
|
Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
data[].fulfillment.shipping.return_address.city
string
|
City of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
data[].fulfillment.shipping.return_address.country
string
|
Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
data[].fulfillment.shipping.return_address.first_name
string
|
First name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
data[].fulfillment.shipping.return_address.last_name
string
|
Last name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
data[].fulfillment.shipping.return_address.middle_name
string
|
Middle name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
data[].fulfillment.shipping.return_address.phone
string
|
Telephone number of the addressee. This field is returned if it exists in the resource. Allowable Values: 20 char max |
data[].fulfillment.shipping.return_address.postal_code
string
|
Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
data[].fulfillment.shipping.return_address.state
string
|
State or province of the address. This field is returned if it exists in the resource. Allowable Values: 32 char max |
data[].fulfillment.shipping.return_address.zip
string
|
United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
data[].name_line1_end_index
integer
|
This field is included if your bulk card order has been processed. You can use the See Create bulk card order for more information about the automatic generation and naming of cards and users. Allowable Values: Any positive integer |
data[].name_line1_start_index
integer
|
This field is included if your bulk card order has been processed. You can use the See Create bulk card order for more information about the automatic generation and naming of cards and users. Allowable Values: Any positive integer |
data[].name_line_1_numeric_postfix
boolean
|
If set to Allowable Values:
|
data[].name_line_1_random_postfix
boolean
|
If set to This field is returned if it exists in the resource. Allowable Values:
|
data[].provider_ship_date
datetime
|
Date and time when the card provider shipped the bulk card order, in UTC. This field is included if your bulk card order has shipped. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].provider_shipping_method
string
|
Shipping method used by the card provider.
This field is included if your bulk card order has shipped. Allowable Values: String |
data[].provider_tracking_number
string
|
A tracking number is included only if your card provider is Arroweye Solutions. This field is included if your bulk card order has shipped. Allowable Values: String |
data[].token
string
|
Unique identifier of the bulk card order. Allowable Values: 1–36 chars |
data[].user_association
object
|
Associates each card with a user. Allowable Values:
|
data[].user_association.single_inventory_user
boolean
|
Set to Allowable Values:
Default value: |
data[].user_association.single_inventory_user_token
string
|
If Allowable Values: 1–36 chars |
end_index
integer
|
Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of This field is returned if there are resources in your returned array. Allowable Values:
|
start_index
integer
|
Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
Retrieve bulk card order
Copy section link
Action: GET
Endpoint: /bulkissuances/{token}
Use this endpoint to retrieve a specific bulk card order.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the bulk card order to retrieve. Allowable Values: Existing bulk card order token |
Response body
Copy section link
| Fields | Description |
|---|---|
card_allocation
integer
|
Number of cards in the order. Allowable Values: 50000 max |
card_fulfillment_time
datetime
|
Date and time when the bulk card order was fulfilled, in UTC. This field is included if your bulk card order has been processed. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
card_product_token
string
|
Specifies the card product from which the cards are created. Allowable Values: 1–36 chars |
cards_processed
integer
|
Number of cards processed in the bulk card order. This field is returned if it exists in the resource. Allowable Values: Any positive integer |
created_time
datetime
|
Date and time when the resource was created, in UTC. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
expedite
boolean
|
Indicates if expedited processing of this bulk card order was requested. This field is returned if it exists in the resource. Allowable Values:
|
expiration_offset
object
|
Specifies the length of time after the date of issue for which the cards are valid. Allowable Values:
|
expiration_offset.unit
string
|
Specifies the units for the Allowable Values:
Default value: |
expiration_offset.value
integer
|
Specifies the number of time units (as defined by the This number is rounded as follows:
Allowable Values: Any positive integer Default value: |
fulfillment
object
|
Specifies certain physical characteristics of a card, as well as bulk shipment information. This object is returned if it exists in the resource. Allowable Values:
|
fulfillment.card_personalization
object
|
Specifies personalized attributes to be added to the card. Allowable Values:
|
fulfillment.card_personalization.carrier
object
|
Specifies attributes of the card carrier. Allowable Values:
|
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. Allowable Values:
|
fulfillment.card_personalization.images.card
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
fulfillment.card_personalization.images.card.name
string
|
Specifies a PNG image to display on the card. 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.images.card.thermal_color
string
|
Specifies the color of the image displayed on the card. Allowable Values: Contains the name of the color and must match one of the provider’s predefined colors. |
fulfillment.card_personalization.images.carrier
object
|
Specifies personalized images that appear on the card carrier. Allowable Values:
|
fulfillment.card_personalization.images.carrier.message_1
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
fulfillment.card_personalization.images.carrier.name
string
|
Specifies a PNG 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.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:
|
fulfillment.card_personalization.images.carrier_return_window.name
string
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. 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.images.signature
object
|
Specifies a PNG image of the cardholder’s signature. Allowable Values:
|
fulfillment.card_personalization.images.signature.name
string
|
Specifies a PNG image of the cardholder’s signature. 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.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:
|
fulfillment.card_personalization.text.name_line_1
object
|
Specifies the first line of personalized text that appears on the card. Allowable Values:
21 char max; if Strings longer than the character limit are truncated. |
fulfillment.card_personalization.text.name_line_1.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
fulfillment.card_personalization.text.name_line_2
object
|
Specifies the second line of personalized text that appears on the card. Allowable Values:
|
fulfillment.card_personalization.text.name_line_2.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
fulfillment.card_personalization.text.name_line_3
object
|
Specifies the third line of personalized text that appears on the card. Allowable Values:
|
fulfillment.card_personalization.text.name_line_3.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
fulfillment.shipping
object
|
Specifies shipping details for the order. This object is returned if it exists in the resource. Allowable Values:
|
fulfillment.shipping.care_of_line
string
|
Specifies the value of the care of (C/O) line on the mailing carrier. This field is returned if it exists in the resource. Allowable Values: 255 char max |
fulfillment.shipping.method
string
|
Specifies the shipping service. This field is returned if it exists in the resource. Allowable Values:
|
fulfillment.shipping.recipient_address
object
|
Address to which the order will be shipped. This field is returned if it exists in the resource. Allowable Values: Existing |
fulfillment.shipping.recipient_address.address1
string
|
Number and street of the address. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
fulfillment.shipping.recipient_address.address2
string
|
Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
fulfillment.shipping.recipient_address.city
string
|
City of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.country
string
|
Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
fulfillment.shipping.recipient_address.first_name
string
|
First name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.last_name
string
|
Last name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.middle_name
string
|
Middle name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.recipient_address.phone
string
|
Telephone number of the addressee. This field is returned if it exists in the resource. Allowable Values: 20 char max |
fulfillment.shipping.recipient_address.postal_code
string
|
Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
fulfillment.shipping.recipient_address.state
string
|
State or province of the address. This field is returned if it exists in the resource. Allowable Values: 32 char max |
fulfillment.shipping.recipient_address.zip
string
|
United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
fulfillment.shipping.return_address
object
|
Address to which the order will be returned if shipping fails. This object is returned if it exists in the resource. Allowable Values: Existing |
fulfillment.shipping.return_address.address1
string
|
Number and street of the address. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
fulfillment.shipping.return_address.address2
string
|
Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
fulfillment.shipping.return_address.city
string
|
City of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.return_address.country
string
|
Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. |
fulfillment.shipping.return_address.first_name
string
|
First name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.return_address.last_name
string
|
Last name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.return_address.middle_name
string
|
Middle name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
fulfillment.shipping.return_address.phone
string
|
Telephone number of the addressee. This field is returned if it exists in the resource. Allowable Values: 20 char max |
fulfillment.shipping.return_address.postal_code
string
|
Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
fulfillment.shipping.return_address.state
string
|
State or province of the address. This field is returned if it exists in the resource. Allowable Values: 32 char max |
fulfillment.shipping.return_address.zip
string
|
United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
name_line1_end_index
integer
|
This field is included if your bulk card order has been processed. You can use the See Create bulk card order for more information about the automatic generation and naming of cards and users. Allowable Values: Any positive integer |
name_line1_start_index
integer
|
This field is included if your bulk card order has been processed. You can use the See Create bulk card order for more information about the automatic generation and naming of cards and users. Allowable Values: Any positive integer |
name_line_1_numeric_postfix
boolean
|
If set to Allowable Values:
|
name_line_1_random_postfix
boolean
|
If set to This field is returned if it exists in the resource. Allowable Values:
|
provider_ship_date
datetime
|
Date and time when the card provider shipped the bulk card order, in UTC. This field is included if your bulk card order has shipped. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
provider_shipping_method
string
|
Shipping method used by the card provider.
This field is included if your bulk card order has shipped. Allowable Values: String |
provider_tracking_number
string
|
A tracking number is included only if your card provider is Arroweye Solutions. This field is included if your bulk card order has shipped. Allowable Values: String |
token
string
|
Unique identifier of the bulk card order. Allowable Values: 1–36 chars |
user_association
object
|
Associates each card with a user. Allowable Values:
|
user_association.single_inventory_user
boolean
|
Set to Allowable Values:
Default value: |
user_association.single_inventory_user_token
string
|
If Allowable Values: 1–36 chars |