{"_id":"5ba044c960ce91000309c08c","project":"59f79e3c584eb200345ceafc","version":{"_id":"59f79e3c584eb200345ceaff","project":"59f79e3c584eb200345ceafc","__v":8,"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","5bc8fa8063924c00186c5ded","5bc8fe9fa472190014a6b103"],"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":16,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-09-18T00:20:25.938Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"http","code":"POST /v3.1/users/5ba035f9f8db93006160cd3d/nodes 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{\n  \"type\": \"CARD-US\",\n  \"info\": {\n    \"nickname\":\"My Debit Card\",\n    \"document_id\":\"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\"\n  }\n}","name":""}]},"settings":"","results":{"codes":[{"code":"{\n    \"error_code\": \"0\",\n    \"http_code\": \"200\",\n    \"limit\": 20,\n    \"node_count\": 1,\n    \"nodes\": [\n        {\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            \"type\": \"CARD-US\",\n            \"user_id\": \"5ba035f9f8db93006160cd3d\"\n        }\n    ],\n    \"page_count\": 1,\n    \"success\": true\n}","name":"","status":200,"language":"json"}]},"method":"post","auth":"required","params":[{"_id":"58fe931a59079e190092fa48","ref":"","in":"path","required":true,"desc":"The user ID of the user you wish to add the CARD-US node under","default":"","type":"string","name":"user_id"},{"_id":"5573b11e91ce6e190023b76a","ref":"","in":"body","required":true,"desc":"Type of node you wish to add","default":"","type":"string","name":"type"},{"_id":"55fa4d6f764f5021009506c9","ref":"","in":"body","required":true,"desc":"Nickname associated with the node","default":"","type":"string","name":"info.nickname"},{"_id":"5a6ab53ced3ead001e3e99de","ref":"","in":"body","required":true,"desc":"Document ID of user's base document that the card is associated with","default":"","type":"string","name":"info.document_id"},{"_id":"55fa3f2a17b9d00d00969ea3","ref":"","in":"body","required":false,"desc":"Any ID you wish to register to the node","default":"","type":"string","name":"extra.supp_id"},{"_id":"594e65af283bee0035df6b56","ref":"","in":"body","required":false,"desc":"If the node is indexed or marked deleted.","default":"","type":"boolean","name":"is_active"}],"url":"/v3.1/users/:user_id/nodes"},"isReference":true,"order":12,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Viewing Card Number\",\n  \"body\": \"To be able to view the `card_number`, `cvc` and `exp` you need to do [GET Node](doc:node) with `full_dehydrate=yes`. We would not recommend doing this unless you are PCI compliant. Even if you are not storing card information, card information being transmitted during a [GET] User call. \\n\\nWe recommend using our [UI as a Service](doc:issuing-public-key) component for this use case, so that you can redirect users there for viewing card details.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Debit Card Testing\",\n  \"body\": \"How to test card:\\n1. Fund the card (https://docs.synapsefi.com/docs/create-transaction)\\n2. Attempt a transaction online with an international processor\\n3. Patch the card’s `preferences.allow_foreign_transactions` to `true`\\n4. Attempt an NSF transaction (transact at an amount higher than the available balance of the card)\\n5. Patch the card’s body parameter `allowed` to `INACTIVE` and attempt a transaction\\n6. Patch the card’s body parameter `allowed` back to `CREDIT-AND-DEBIT` and attempt a transaction\\n7. Un-fund the card (https://docs.synapsefi.com/docs/create-transaction)\\n\\nHow to test physical cards:\\n1. Fund the card (https://docs.synapsefi.com/docs/create-transaction)\\n2. Attempt a transaction online with an international processor\\n3. Patch the card’s `preferences.allow_foreign_transactions` to `true`\\n4. Attempt an ATM transaction with random PIN numbers\\n5. Patch the card’s `preferences.card_pin` to a card pin of your choice\\n6. Try an ATM transaction and a POS transaction (at a store and online, both pinless and with a pin)\\n7. Patch the card’s `preferences.max_pin_attempts` to 1 and try a terminal POS or ATM transaction using the pin twice\\n8. Un-fund the card (https://docs.synapsefi.com/docs/create-transaction)\\n\\n**Replicate any use cases that an end user might have. The goal is to prevent all possible error outcomes for a smooth user experience.**\"\n}\n[/block]","excerpt":"We are making some improvements to our debit card stack. Since the overall impact of the update is small, we thought we should just change the current version, rather than trying to version the stack itself. These updates will be available for Sandbox testing starting Sept. 17, 2018 7:00PM PST. Access to the current production documentation can be found here [Debit Cards](doc:debit-cards), [Reissue Debit Card](doc:reissue-debit-card), [Reorder Debit Card](doc:reorder-debit-card)","slug":"card-issuance","type":"endpoint","title":"Card Issuance"}

postCard Issuance

We are making some improvements to our debit card stack. Since the overall impact of the update is small, we thought we should just change the current version, rather than trying to version the stack itself. These updates will be available for Sandbox testing starting Sept. 17, 2018 7:00PM PST. Access to the current production documentation can be found here [Debit Cards](doc:debit-cards), [Reissue Debit Card](doc:reissue-debit-card), [Reorder Debit Card](doc:reorder-debit-card)

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

user_id:
required
string
The user ID of the user you wish to add the CARD-US node under

Body Params

type:
required
string
Type of node you wish to add
info.nickname:
required
string
Nickname associated with the node
info.document_id:
required
string
Document ID of user's base document that the card is associated with
extra.supp_id:
string
Any ID you wish to register to the node
is_active:
boolean
If the node is indexed or marked deleted.

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Viewing Card Number", "body": "To be able to view the `card_number`, `cvc` and `exp` you need to do [GET Node](doc:node) with `full_dehydrate=yes`. We would not recommend doing this unless you are PCI compliant. Even if you are not storing card information, card information being transmitted during a [GET] User call. \n\nWe recommend using our [UI as a Service](doc:issuing-public-key) component for this use case, so that you can redirect users there for viewing card details." } [/block] [block:callout] { "type": "info", "title": "Debit Card Testing", "body": "How to test card:\n1. Fund the card (https://docs.synapsefi.com/docs/create-transaction)\n2. Attempt a transaction online with an international processor\n3. Patch the card’s `preferences.allow_foreign_transactions` to `true`\n4. Attempt an NSF transaction (transact at an amount higher than the available balance of the card)\n5. Patch the card’s body parameter `allowed` to `INACTIVE` and attempt a transaction\n6. Patch the card’s body parameter `allowed` back to `CREDIT-AND-DEBIT` and attempt a transaction\n7. Un-fund the card (https://docs.synapsefi.com/docs/create-transaction)\n\nHow to test physical cards:\n1. Fund the card (https://docs.synapsefi.com/docs/create-transaction)\n2. Attempt a transaction online with an international processor\n3. Patch the card’s `preferences.allow_foreign_transactions` to `true`\n4. Attempt an ATM transaction with random PIN numbers\n5. Patch the card’s `preferences.card_pin` to a card pin of your choice\n6. Try an ATM transaction and a POS transaction (at a store and online, both pinless and with a pin)\n7. Patch the card’s `preferences.max_pin_attempts` to 1 and try a terminal POS or ATM transaction using the pin twice\n8. Un-fund the card (https://docs.synapsefi.com/docs/create-transaction)\n\n**Replicate any use cases that an end user might have. The goal is to prevent all possible error outcomes for a smooth user experience.**" } [/block]