{"_id":"5bce6cfb28aa2c00160aad4c","project":"59f79e3c584eb200345ceafc","version":{"_id":"5ba178b00a916500030c6a21","project":"59f79e3c584eb200345ceafc","__v":24,"forked_from":"59f79e3c584eb200345ceaff","createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["5ba178b00a916500030c69a2","5ba178b00a916500030c69a3","5ba178b00a916500030c69a4","5ba178b00a916500030c69a5","5ba178b00a916500030c69a6","5ba178b00a916500030c69a7","5ba178b00a916500030c69a8","5ba178b00a916500030c69a9","5ba178b00a916500030c69aa","5ba178b00a916500030c69ab","5ba178b00a916500030c69ac","5afb6888212c690003ae3d3b","5ba178b00a916500030c69ad","5ba178b00a916500030c69ae","5ba2dcbc99f53f0003b97e2c","5babd73fa0ab3e0003ead030","5bb4038be7222e000334dd97","5bb55954478c1300031a44c2","5bb665a1607307000327c81e","5bb6f90229a7fb0003a0650d","5bb7f9bc29a7fb0003a07ac1","5bba58bd7ba7710003bd901d","5bba6dac7ba7710003bd908d","5bba6e257ba7710003bd9090","5bbac87810189c0003e619ea","5bbb9d02b5862c00036266b2","5bbbadb6219c3e000376c2de","5bc417751d1b0000182bf7f6","5bc59e3b2a5b4f0044db5b97","5bc7bbce2262cc0041f6eff2","5bce6a3580a7250031199f34","5bcfac2c4082510019f2d91b","5bcfac3757bed90030e45d68","5bcfac45d305bc0049941539","5bd2a43548bb6f00289c8fad","5bd3a42a026ebe001f66259e","5bd9d5afffe003005b02f97b","5becb7ee85c6b300557662b6"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":false,"codename":"","version_clean":"3.2.0","version":"3.2"},"category":{"_id":"5bce6a3580a7250031199f34","project":"59f79e3c584eb200345ceafc","version":"5ba178b00a916500030c6a21","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-10-23T00:24:21.671Z","from_sync":false,"order":18,"slug":"card-number-issuance","title":"Issue Debit Card"},"user":"5bbfef1d7d1cb0000384bec5","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-23T00:36:11.202Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"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 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.\n\nFor 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.\n\n##API ENDPOINT\nhttps://uat-api.synapsefi.com/v3.1/users/:user_id/nodes/:node_id/subnets/:subnet_id/ship\n\n##PATH PARAMETER\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"> <div class=\\\"param-table\\\"> <div class=\\\"table\\\"> <div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>user_id <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>The user ID of the user</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>node_id <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>The ID of the node the card number was issued to</p></div></div></div>\\n  <div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>subnet_id<span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>The ID of the subnet (card number)</p></div></div></div>\\n  \\n  </div></div></div>\"\n}\n[/block]\n##BODY PARAMETER\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"> <div class=\\\"param-table\\\"> <div class=\\\"table\\\"> <div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>fee_node_id <span class=\\\"colon\\\">:</span> </strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Node ID that will be charged for the shipped debit card</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>expedite<span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">boolean</strong> <span class=\\\"param-default text-muted\\\">false</span> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Set to <code>true</code> to trigger overnight shipping for the card</p></div></div></div>\\n  <div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>card_style_id<span class=\\\"colon\\\">:</span> </strong></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\">Card style ID of the card being issued</p></div></div></div>\\n  </div></div></div>\"\n}\n[/block]\n##Paying for the Card\nThe 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.\n\n##Card Style ID\nThe 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.\n\n##Confirm the Address\nThe 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.\n\n##Shipping Timeline\nCards 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##EXAMPLE REQUEST\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PATCH /v3.1/users/5bb6ab05472e2500adffad5a/nodes/5bbadc6f7b11c3008d045add?ship=YES HTTP/1.1\\nHost: uat-api.synapsefi.com\\nX-SP-USER-IP: 127.0.0.1\\nX-SP-USER: oauth_46jGbL5oIhAHtTuQVfYDpcqmedZBP9Xa0Owrnv7F|n38dj3h8NE393bv24ovoRY34kd62\\nContent-Type: application/json\\n\\n\\n{\\n\\t\\\"fee_node_id\\\":\\\"5bba781485411800991b606b\\\",\\n\\t\\\"expedite\\\":false,\\n  \\\"card_style_id\\\":\\\"555\\\"\\n}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n##EXAMPLE RESPONSE\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"node_id\\\": \\\"5bc920e27eb7c500972c7e33\\\",\\n    \\\"subnet_id\\\": \\\"5bc920f9a5061e002681c89f\\\",\\n    \\\"transaction_id\\\": \\\"5bcf7c59c39fa85af5729653\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Ship out a physical card to the end user","slug":"ship-card","type":"basic","title":"Ship Card"}

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 [block:html] { "html": "<div class=\"api-manager\"> <div class=\"param-table\"> <div class=\"table\"> <div class=\"tr\"> <div class=\"td param\"> <strong>user_id <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>The user ID of the user</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong>node_id <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>The ID of the node the card number was issued to</p></div></div></div>\n <div class=\"tr\"> <div class=\"td param\"> <strong>subnet_id<span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>The ID of the subnet (card number)</p></div></div></div>\n \n </div></div></div>" } [/block] ##BODY PARAMETER [block:html] { "html": "<div class=\"api-manager\"> <div class=\"param-table\"> <div class=\"table\"> <div class=\"tr\"> <div class=\"td param\"> <strong>fee_node_id <span class=\"colon\">:</span> </strong><div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Node ID that will be charged for the shipped debit card</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong>expedite<span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">boolean</strong> <span class=\"param-default text-muted\">false</span> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Set to <code>true</code> to trigger overnight shipping for the card</p></div></div></div>\n <div class=\"tr\"> <div class=\"td param\"> <strong>card_style_id<span class=\"colon\">:</span> </strong></div><div class=\"td\"> <strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\">Card style ID of the card being issued</p></div></div></div>\n </div></div></div>" } [/block] ##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. Additionally, if you wish to expedite card shipping, `PATCH` `"expedite": true` to trigger overnight shipping for the debit card. ##EXAMPLE REQUEST [block:code] { "codes": [ { "code": "PATCH /v3.1/users/5bb6ab05472e2500adffad5a/nodes/5bbadc6f7b11c3008d045add?ship=YES HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: oauth_46jGbL5oIhAHtTuQVfYDpcqmedZBP9Xa0Owrnv7F|n38dj3h8NE393bv24ovoRY34kd62\nContent-Type: application/json\n\n\n{\n\t\"fee_node_id\":\"5bba781485411800991b606b\",\n\t\"expedite\":false,\n \"card_style_id\":\"555\"\n}", "language": "http" } ] } [/block] ##EXAMPLE RESPONSE [block:code] { "codes": [ { "code": "{\n \"node_id\": \"5bc920e27eb7c500972c7e33\",\n \"subnet_id\": \"5bc920f9a5061e002681c89f\",\n \"transaction_id\": \"5bcf7c59c39fa85af5729653\"\n}", "language": "json" } ] } [/block]