Create a bulk order configuration
curl --request POST \
--url https://api.synctera.com/v2/cards/bulk_issuance \
--header 'Authorization: Bearer <token>' \
--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.",
"country_code": "US",
"address_line_2": "Suite 99",
"city": "New York",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"method": "TWO_DAY",
"recipient_name": {
"first_name": "Jane",
"last_name": "Smith",
"middle_name": "Anne"
},
"business_name": "<string>",
"is_expedited_fulfillment": true,
"phone_number": "+14374570680"
}
}
'import requests
url = "https://api.synctera.com/v2/cards/bulk_issuance"
payload = {
"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.",
"country_code": "US",
"address_line_2": "Suite 99",
"city": "New York",
"is_registered_agent": True,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"method": "TWO_DAY",
"recipient_name": {
"first_name": "Jane",
"last_name": "Smith",
"middle_name": "Anne"
},
"business_name": "<string>",
"is_expedited_fulfillment": True,
"phone_number": "+14374570680"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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.',
country_code: 'US',
address_line_2: 'Suite 99',
city: 'New York',
is_registered_agent: true,
nickname: 'Home',
postal_code: '28620',
state: 'NY'
},
method: 'TWO_DAY',
recipient_name: {first_name: 'Jane', last_name: 'Smith', middle_name: 'Anne'},
business_name: '<string>',
is_expedited_fulfillment: true,
phone_number: '+14374570680'
}
})
};
fetch('https://api.synctera.com/v2/cards/bulk_issuance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.synctera.com/v2/cards/bulk_issuance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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.',
'country_code' => 'US',
'address_line_2' => 'Suite 99',
'city' => 'New York',
'is_registered_agent' => true,
'nickname' => 'Home',
'postal_code' => '28620',
'state' => 'NY'
],
'method' => 'TWO_DAY',
'recipient_name' => [
'first_name' => 'Jane',
'last_name' => 'Smith',
'middle_name' => 'Anne'
],
'business_name' => '<string>',
'is_expedited_fulfillment' => true,
'phone_number' => '+14374570680'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.synctera.com/v2/cards/bulk_issuance"
payload := strings.NewReader("{\n \"bulk_issuance_policy\": \"AUTO\",\n \"card_product_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"name\": \"Bulk Shipping to US Office\",\n \"shipping\": {\n \"address\": {\n \"address_line_1\": \"100 Main St.\",\n \"country_code\": \"US\",\n \"address_line_2\": \"Suite 99\",\n \"city\": \"New York\",\n \"is_registered_agent\": true,\n \"nickname\": \"Home\",\n \"postal_code\": \"28620\",\n \"state\": \"NY\"\n },\n \"method\": \"TWO_DAY\",\n \"recipient_name\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Anne\"\n },\n \"business_name\": \"<string>\",\n \"is_expedited_fulfillment\": true,\n \"phone_number\": \"+14374570680\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.synctera.com/v2/cards/bulk_issuance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"bulk_issuance_policy\": \"AUTO\",\n \"card_product_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"name\": \"Bulk Shipping to US Office\",\n \"shipping\": {\n \"address\": {\n \"address_line_1\": \"100 Main St.\",\n \"country_code\": \"US\",\n \"address_line_2\": \"Suite 99\",\n \"city\": \"New York\",\n \"is_registered_agent\": true,\n \"nickname\": \"Home\",\n \"postal_code\": \"28620\",\n \"state\": \"NY\"\n },\n \"method\": \"TWO_DAY\",\n \"recipient_name\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Anne\"\n },\n \"business_name\": \"<string>\",\n \"is_expedited_fulfillment\": true,\n \"phone_number\": \"+14374570680\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v2/cards/bulk_issuance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bulk_issuance_policy\": \"AUTO\",\n \"card_product_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"name\": \"Bulk Shipping to US Office\",\n \"shipping\": {\n \"address\": {\n \"address_line_1\": \"100 Main St.\",\n \"country_code\": \"US\",\n \"address_line_2\": \"Suite 99\",\n \"city\": \"New York\",\n \"is_registered_agent\": true,\n \"nickname\": \"Home\",\n \"postal_code\": \"28620\",\n \"state\": \"NY\"\n },\n \"method\": \"TWO_DAY\",\n \"recipient_name\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Anne\"\n },\n \"business_name\": \"<string>\",\n \"is_expedited_fulfillment\": true,\n \"phone_number\": \"+14374570680\"\n }\n}"
response = http.request(request)
puts response.read_body{
"bulk_issuance_policy": "AUTO",
"card_product_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"name": "Bulk Shipping to US Office",
"shipping": {
"address": {
"address_line_1": "100 Main St.",
"country_code": "US",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"method": "TWO_DAY",
"recipient_name": {
"first_name": "Jane",
"last_name": "Smith",
"middle_name": "Anne"
},
"business_name": "<string>",
"is_expedited_fulfillment": true,
"phone_number": "+14374570680"
},
"tenant": "abcdef_ghijkl",
"creation_time": "2010-05-06T12:23:34.321Z"
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}Bulk Issuance
Create a bulk order configuration
Bulk card orders can be configured to ship cards in bulk.
In order to create a bulk order the associated card product needs to be configured for bulk issuance (Refer to Card Product bulk_shipping_enabled).
Once a Card Product is configured a bulk order can be created.
Cards are dynamically added to the bulk order using the bulk_order_config_id (Refer to Issue Card bulk_order_config_id)
and will be shipped based on the bulk_issuance_policy.
Bulk orders configured with AUTO will be fulfilled daily at 9:30PM PST, all cards that have been added to the bulk order prior to the cutoff
will be shipped in the next bulk order, any subsequent cards will be added to the next days order. Bulk orders configured with MANUAL
will be shipped when an integrator sends a fulfillment request (Refer to Bulk Issuance Fulfill).
POST
/
cards
/
bulk_issuance
Create a bulk order configuration
curl --request POST \
--url https://api.synctera.com/v2/cards/bulk_issuance \
--header 'Authorization: Bearer <token>' \
--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.",
"country_code": "US",
"address_line_2": "Suite 99",
"city": "New York",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"method": "TWO_DAY",
"recipient_name": {
"first_name": "Jane",
"last_name": "Smith",
"middle_name": "Anne"
},
"business_name": "<string>",
"is_expedited_fulfillment": true,
"phone_number": "+14374570680"
}
}
'import requests
url = "https://api.synctera.com/v2/cards/bulk_issuance"
payload = {
"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.",
"country_code": "US",
"address_line_2": "Suite 99",
"city": "New York",
"is_registered_agent": True,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"method": "TWO_DAY",
"recipient_name": {
"first_name": "Jane",
"last_name": "Smith",
"middle_name": "Anne"
},
"business_name": "<string>",
"is_expedited_fulfillment": True,
"phone_number": "+14374570680"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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.',
country_code: 'US',
address_line_2: 'Suite 99',
city: 'New York',
is_registered_agent: true,
nickname: 'Home',
postal_code: '28620',
state: 'NY'
},
method: 'TWO_DAY',
recipient_name: {first_name: 'Jane', last_name: 'Smith', middle_name: 'Anne'},
business_name: '<string>',
is_expedited_fulfillment: true,
phone_number: '+14374570680'
}
})
};
fetch('https://api.synctera.com/v2/cards/bulk_issuance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.synctera.com/v2/cards/bulk_issuance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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.',
'country_code' => 'US',
'address_line_2' => 'Suite 99',
'city' => 'New York',
'is_registered_agent' => true,
'nickname' => 'Home',
'postal_code' => '28620',
'state' => 'NY'
],
'method' => 'TWO_DAY',
'recipient_name' => [
'first_name' => 'Jane',
'last_name' => 'Smith',
'middle_name' => 'Anne'
],
'business_name' => '<string>',
'is_expedited_fulfillment' => true,
'phone_number' => '+14374570680'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.synctera.com/v2/cards/bulk_issuance"
payload := strings.NewReader("{\n \"bulk_issuance_policy\": \"AUTO\",\n \"card_product_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"name\": \"Bulk Shipping to US Office\",\n \"shipping\": {\n \"address\": {\n \"address_line_1\": \"100 Main St.\",\n \"country_code\": \"US\",\n \"address_line_2\": \"Suite 99\",\n \"city\": \"New York\",\n \"is_registered_agent\": true,\n \"nickname\": \"Home\",\n \"postal_code\": \"28620\",\n \"state\": \"NY\"\n },\n \"method\": \"TWO_DAY\",\n \"recipient_name\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Anne\"\n },\n \"business_name\": \"<string>\",\n \"is_expedited_fulfillment\": true,\n \"phone_number\": \"+14374570680\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.synctera.com/v2/cards/bulk_issuance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"bulk_issuance_policy\": \"AUTO\",\n \"card_product_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"name\": \"Bulk Shipping to US Office\",\n \"shipping\": {\n \"address\": {\n \"address_line_1\": \"100 Main St.\",\n \"country_code\": \"US\",\n \"address_line_2\": \"Suite 99\",\n \"city\": \"New York\",\n \"is_registered_agent\": true,\n \"nickname\": \"Home\",\n \"postal_code\": \"28620\",\n \"state\": \"NY\"\n },\n \"method\": \"TWO_DAY\",\n \"recipient_name\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Anne\"\n },\n \"business_name\": \"<string>\",\n \"is_expedited_fulfillment\": true,\n \"phone_number\": \"+14374570680\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v2/cards/bulk_issuance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bulk_issuance_policy\": \"AUTO\",\n \"card_product_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"name\": \"Bulk Shipping to US Office\",\n \"shipping\": {\n \"address\": {\n \"address_line_1\": \"100 Main St.\",\n \"country_code\": \"US\",\n \"address_line_2\": \"Suite 99\",\n \"city\": \"New York\",\n \"is_registered_agent\": true,\n \"nickname\": \"Home\",\n \"postal_code\": \"28620\",\n \"state\": \"NY\"\n },\n \"method\": \"TWO_DAY\",\n \"recipient_name\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Anne\"\n },\n \"business_name\": \"<string>\",\n \"is_expedited_fulfillment\": true,\n \"phone_number\": \"+14374570680\"\n }\n}"
response = http.request(request)
puts response.read_body{
"bulk_issuance_policy": "AUTO",
"card_product_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"name": "Bulk Shipping to US Office",
"shipping": {
"address": {
"address_line_1": "100 Main St.",
"country_code": "US",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"method": "TWO_DAY",
"recipient_name": {
"first_name": "Jane",
"last_name": "Smith",
"middle_name": "Anne"
},
"business_name": "<string>",
"is_expedited_fulfillment": true,
"phone_number": "+14374570680"
},
"tenant": "abcdef_ghijkl",
"creation_time": "2010-05-06T12:23:34.321Z"
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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
Issuance for bulk orders with respect to when the order is shipped.
| Policy | Description |
|---|---|
| AUTO | Bulk orders will be fulfilled at the daily cutoff time 09:00 UTC (default). |
| MANUAL | Bulk orders will be shipped when requested. |
Available options:
AUTO, MANUAL The unique identifier of a cards product
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Name associated with the bulk order configuration.
Example:
"Bulk Shipping to US Office"
Details about the shipping method for bulk issuance.
Show child attributes
Show child attributes
Response
Bulk order configuration created
Issuance for bulk orders with respect to when the order is shipped.
| Policy | Description |
|---|---|
| AUTO | Bulk orders will be fulfilled at the daily cutoff time 09:00 UTC (default). |
| MANUAL | Bulk orders will be shipped when requested. |
Available options:
AUTO, MANUAL The unique identifier of a cards product
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
The unique identifier of a bulk order configuration
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Name associated with the bulk order configuration.
Example:
"Bulk Shipping to US Office"
Details about the shipping method for bulk issuance.
Show child attributes
Show child attributes
The id of the tenant containing the resource.
Example:
"abcdef_ghijkl"
The timestamp representing when the bulk order config was created
Example:
"2010-05-06T12:23:34.321Z"
Was this page helpful?
⌘I