Skip to main content
POST
/
cards
/
bulk_issuance
Create a bulk order configuration
curl --request POST \
  --url https://api.synctera.com/v2/cards/bulk_issuance \
  --header 'Content-Type: application/json' \
  --data '{
  "bulk_issuance_policy": "AUTO",
  "card_product_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "name": "Bulk Shipping to US Office",
  "shipping": {
    "address": {
      "address_line_1": "100 Main St.",
      "address_line_2": "Suite 99",
      "city": "New York",
      "country_code": "US",
      "is_registered_agent": true,
      "nickname": "Home",
      "postal_code": "28620",
      "state": "NY"
    },
    "business_name": "<string>",
    "is_expedited_fulfillment": true,
    "method": "TWO_DAY",
    "phone_number": "+14374570680",
    "recipient_name": {
      "first_name": "Jane",
      "last_name": "Smith",
      "middle_name": "Anne"
    }
  }
}'
{
  "bulk_issuance_policy": "AUTO",
  "card_product_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "name": "Bulk Shipping to US Office",
  "shipping": {
    "address": {
      "address_line_1": "100 Main St.",
      "address_line_2": "Suite 99",
      "address_type": "SHIPPING",
      "city": "New York",
      "country_code": "US",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "is_registered_agent": true,
      "nickname": "Home",
      "postal_code": "28620",
      "state": "NY"
    },
    "business_name": "<string>",
    "is_expedited_fulfillment": true,
    "method": "TWO_DAY",
    "phone_number": "+14374570680",
    "recipient_name": {
      "first_name": "Jane",
      "last_name": "Smith",
      "middle_name": "Anne"
    }
  },
  "tenant": "abcdef_ghijkl"
}

Headers

​
Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Bulk issuance configuration

​
bulk_issuance_policy
enum<string>
default:AUTO
required

Issuance for bulk orders with respect to when the order is shipped.

PolicyDescription
AUTOBulk orders will be fulfilled at the daily cutoff time 09:00 UTC (default).
MANUALBulk orders will be shipped when requested.
Available options:
AUTO,
MANUAL
​
card_product_id
string<uuid>
required

The unique identifier of a cards product

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
name
string
required

Name associated with the bulk order configuration.

Example:

"Bulk Shipping to US Office"

​
shipping
object
required

Details about the shipping method for bulk issuance.

Response

Bulk order configuration created

​
bulk_issuance_policy
enum<string>
default:AUTO
required

Issuance for bulk orders with respect to when the order is shipped.

PolicyDescription
AUTOBulk orders will be fulfilled at the daily cutoff time 09:00 UTC (default).
MANUALBulk orders will be shipped when requested.
Available options:
AUTO,
MANUAL
​
card_product_id
string<uuid>
required

The unique identifier of a cards product

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
id
string<uuid>
required

The unique identifier of a bulk order configuration

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
name
string
required

Name associated with the bulk order configuration.

Example:

"Bulk Shipping to US Office"

​
shipping
object
required

Details about the shipping method for bulk issuance.

​
tenant
string
required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

​
creation_time
string<date-time>

The timestamp representing when the bulk order config was created

Example:

"2010-05-06T12:23:34.321Z"