{"_id":"5ba032163c963c0003e7269f","project":"59f79e3c584eb200345ceafc","version":{"_id":"59f79e3c584eb200345ceaff","project":"59f79e3c584eb200345ceafc","__v":6,"createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["59f79e3c584eb200345ceb3a","59f79e3c584eb200345ceb3b","59f79e3c584eb200345ceb3c","59f79e3c584eb200345ceb3d","59f79e3c584eb200345ceb3e","59f79e3c584eb200345ceb3f","59f79e3c584eb200345ceb45","59f79e3c584eb200345ceb46","59f79e3c584eb200345ceb48","59f79e3c584eb200345ceb49","5aa21b60c0bda0002d1568b6","5afb6888212c690003ae3d3b","5b4bdcd3737d1800031d2293","5b9ed89212362100036b5a1c","5bb29bec77c22500034757ea","5bb29bfe77c22500034757ec"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.1.0","version":"3.1"},"category":{"_id":"59f79e3c584eb200345ceb3c","version":"59f79e3c584eb200345ceaff","project":"59f79e3c584eb200345ceafc","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-19T00:05:19.904Z","from_sync":false,"order":5,"slug":"nodes","title":"Nodes"},"user":"5a68eb6970ea610012bfb924","__v":15,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-09-17T23:00:38.180Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"PATCH /v3.1/users/5ba035f9f8db93006160cd3d/nodes/5ba05ed620b3aa005882c52a?ship=YES HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: oauth_j2NVvKDfSqQGsBk3aFZ8c4L6lxXOHt0yJRnP5C90|123456789\nContent-Type: application/json\n\n{\n  \"fee_node_id\":\"5ba05e7920b3aa006482c5ad\",\n  \"expedite\":true\n}","language":"http","name":""}]},"method":"patch","results":{"codes":[{"name":"","code":"{\n    \"_id\": \"5ba05ed620b3aa005882c52a\",\n    \"_links\": {\n        \"self\": {\n            \"href\": \"https://uat-api.synapsefi.com/v3.1/users/5ba035f9f8db93006160cd3d/nodes/5ba05ed620b3aa005882c52a\"\n        }\n    },\n    \"allowed\": \"INACTIVE\",\n    \"client\": {\n        \"id\": \"5ade26b4567a900029e2afd2\",\n        \"name\": \" YY Testing Acct\"\n    },\n    \"extra\": {\n        \"note\": null,\n        \"other\": {\n            \"access_token\": \"5ba05ed47466d8002208b517\"\n        },\n        \"supp_id\": \"\"\n    },\n    \"info\": {\n        \"balance\": {\n            \"amount\": 0,\n            \"currency\": \"USD\"\n        },\n        \"card_hash\": \"e82d9c5bde8e1fbbdba4a298ee905131fd36e3d803d0e3b235902bf18b079c1c\",\n        \"card_number\": \"3082\",\n        \"document_id\": \"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\",\n        \"monthly_withdrawals_remaining\": null,\n        \"name_on_account\": \" \",\n        \"nickname\": \"My Debit Card\"\n    },\n    \"is_active\": true,\n    \"timeline\": [\n        {\n            \"date\": 1537236676466,\n            \"note\": \"Node created.\"\n        },\n        {\n            \"date\": 1537237009042,\n            \"note\": \"Card sent for printing.\"\n        }\n    ],\n    \"type\": \"CARD-US\",\n    \"user_id\": \"5ba035f9f8db93006160cd3d\"\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"5948247a524b9a000fb7dcbe","ref":"","in":"query","required":true,"desc":"Set value to YES to wish to reissue debit card for supplied node","default":"YES/NO","type":"string","name":"ship"},{"_id":"594e64feb895b9004bbf1686","ref":"","in":"path","required":true,"desc":"The user ID of the user","default":"","type":"string","name":"user_id"},{"_id":"594e64feb895b9004bbf1685","ref":"","in":"path","required":true,"desc":"The node ID of the node","default":"","type":"string","name":"node_id"},{"_id":"5ba06044c53406000393bf7e","ref":"","in":"body","required":true,"desc":"Node ID that will be charged for the shipped debit card","default":"","type":"string","name":"fee_node_id"},{"_id":"5ba06044c53406000393bf7d","ref":"","in":"body","required":false,"desc":"Set to `true` to trigger overnight shipping for the card","default":"false","type":"boolean","name":"expedite"},{"_id":"5baeba1dcfaf8d000357997c","ref":"","in":"body","required":false,"desc":"If you have multiple card arts, this field can be used to specify which card art to use","default":"","type":"string","name":"card_style_id"}],"url":"/v3.1/users/:user_id/nodes/:node_id?ship=YES"},"isReference":true,"order":13,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Shipping a physical debit card\",\n  \"body\": \"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 account has been created and a physical card is requested. The physical card will be shipped to the user address found in the base document.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Shipping timeline\",\n  \"body\": \"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. Additionally, if you wish to expedite card shipping, `PATCH` `\\\"expedite\\\": true` to trigger overnight shipping for the debit card.\"\n}\n[/block]","excerpt":"Ship a physical debit card out to the user","slug":"ship-debit-card","type":"endpoint","title":"Ship Debit Card"}

patchShip Debit Card

Ship a physical debit card out to the user

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

user_id:
required
string
The user ID of the user
node_id:
required
string
The node ID of the node

Query Params

ship:
required
stringYES/NO
Set value to YES to wish to reissue debit card for supplied node

Body Params

fee_node_id:
required
string
Node ID that will be charged for the shipped debit card
expedite:
booleanfalse
Set to `true` to trigger overnight shipping for the card
card_style_id:
string
If you have multiple card arts, this field can be used to specify which card art to use

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Shipping a physical debit card", "body": "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 account has been created and a physical card is requested. The physical card will be shipped to the user address found in the base document." } [/block] [block:callout] { "type": "info", "title": "Shipping timeline", "body": "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. Additionally, if you wish to expedite card shipping, `PATCH` `\"expedite\": true` to trigger overnight shipping for the debit card." } [/block]