Ship Card

Ship out a physical card to the end user

Use this call if you want a physical card shipped to your end user. This is meant to be used in instances after the debit card number has been created and a physical card is requested. The physical card will be shipped to the user address found in the base document.

For normal wear and tear, you can use this same call to ship the physical card again. To get a new card number, you will need to terminate the previous card and issue a new card number.

API ENDPOINT

https://uat-api.synapsefi.com/v3.1/users/:user_id/nodes/:node_id/subnets/:subnet_id/ship

PATH PARAMETER

user_id :
required
string

The user ID of the user

node_id :
required
string

The ID of the node the card number was issued to

subnet_id:
required
string

The ID of the subnet (card number)

BODY PARAMETER

fee_node_id :
required
string

Node ID that will be charged for the shipped debit card

expedite:
boolean false

Set to true to trigger overnight shipping for the card

card_style_id:
string
Card style ID of the card being issued

cardholder_name:
string
Name on card

Paying for the Card

The card fee is covered by either you or your end user. To specify who will pay the fee, simply designate a DEPOSIT-US node. If this node belongs to the user, their node is allowed to go negative. If this node belongs to your platform, please keep it well funded and segregated from the reserve account that covers your transactional risk.

Card Style ID

The card style ID provided in body of the API call can be retrieved via your spec sheet that is created with your Platform Architect. Each card style ID designates a unique branded card that has been approved by the card network. If no value is supplied in the body, the first listed card style id will be used to print and ship the card.

Confirm the Address

The physical card is shipped to the address found in the user’s base document. We recommend confirming the address prior to shipping, as addresses may change. The address should include apartment numbers and other necessary details.

Shipping Timeline

Cards are shipped via First Class Mail within the next business day of API request if submitted before 7 AM CT. If the ship card request was made after 7 AM CT, the debit card will be shipped out the following morning. The user should receive the card in 8-10 business days. If you wish to expedite card shipping, PATCH "expedite": true to trigger overnight shipping for the debit card.

EXAMPLE REQUEST

PATCH /v3.1/users/5bb6ab05472e2500adffad5a/nodes/5bc920e27eb7c500972c7e33/subnets/5bc920f9a5061e002681c89f/ship HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_46jGbL5oIhAHtTuQVfYDpcqmedZBP9Xa0Owrnv7F|n38dj3h8NE393bv24ovoRY34kd62
Content-Type: application/json

{
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":false,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}
node_id = '594e606212e17a002f2e3251'
subn_id = '59c9f77cd412960028b99d2b'
body = {
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":False,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}

user.ship_card(node_id, subn_id, body)
const nodeID = '594e606212e17a002f2e3251'
const subnetID = '59c9f77cd412960028b99d2b'
const body = {
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":false,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}

user.shipCard(nodeID, subnetID, body);
node_id = "5bbadc6f7b11c3008d045add"
subnet_id = “5bc920f2fff373002bf0d51b”
body= {
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":false,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}

user.ship_card(node_id: node_id, payload: body)
$body = (object) [
   "fee_node_id" => "5ba05e7920b3aa006482c5ad",
   "expedite" => false,
   "card_style_id" => "555",
   "cardholder_name" => "Cardholder Name"
];
$nodeid = '5bbadc6f7b11c3008d045add'
$subnetid = '5bc920f2fff373002bf0d51b'

$user->ship_card_subnet($nodeid , $subnetid , $body);
nodeID := "594e606212e17a002f2e3251"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "fee_node_id":"5bba781485411800991b606b",
  "expedite":false,
  "card_style_id": "555",
  "cardholder_name": "Cardholder Name"
}`

data, err := user.ShipCard(nodeID, subnetID, body)

EXAMPLE RESPONSE

{
    "node_id": "5bc920e27eb7c500972c7e33",
    "subnet_id": "5bc920f9a5061e002681c89f",
    "transaction_id": "5bcf7c59c39fa85af5729653"
}

Ship Card


Ship out a physical card to the end user

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.