In order to create bulk orders your card product needs to be configured for bulk issuance.
Bulk Order Creation Steps
1
Create a Bulk Order Configuration
A bulk order configuration provides the shipping instructions for individual bulk orders. Once a bulk order configuration has been set up in the Synctera system, cards can be issued in bulk and will be shipped to the destination specified in the configuration. Fulfillment of the bulk order configuration is based on the bulk issuance policy specified in the configuration.
Call POST /v1/cards/bulk_issuance to create a bulk order config.This will return a response with the created bulk order configuration:Note the returned
Bulk Issuance Policy
Bulk Issuance Policy | Description |
---|---|
AUTO | Bulk orders configured with an AUTO fulfillment policy will be fulfilled nightly at 9:30pm PST (UTC -8:00). All cards that have been issued with the corresponding bulk order config id prior to the cut-off time will be included in the daily bulk order. |
MANUAL | Bulk orders configured with a MANUAL fulfillment policy will be fulfilled at the request of the integrator. All cards that have been issued with the corresponding bulk order config id prior to the requested fulfillment will be included in the bulk order. |
id
attribute. This is used in future card issuance requests in order to include the card as part of a bulk shipment and in order to fulfill bulk orders configured for MANUAL
fulfillment.2
Issue Cards
Cards are dynamically added to a bulk order by providing the bulk order configuration
id
in the card issuance request.Call POST /v1/cards to issue a card.3
Fulfill Bulk Order
bulk order configurations with an auto policy are automatically fulfilled nightly at 9:30pm PST (UTC -8:00
Manual Order Fulfillment
Call POST /v1/cards/bulk_issuance to fulfill the bulk order.202 Accepted
response. All cards issued with the corresponding bulk order config id since the last fulfillment request will be included in the bulk order.Card Fulfillment
Once a card has been shipped a webhook will be triggered with the updated shipping details. Including a tracking number if available. To subscribe to theCARD.UPDATED
webhook refer to the Webhooks Guide.