{"_id":"5a532ee6ae45ed001cb84054","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":"54e4044e8ef7552300409dcb","githubsync":"","__v":15,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-01-08T08:42:14.734Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"error_code\": \"0\",\n    \"http_code\": \"200\",\n    \"limit\": 20,\n    \"node_count\": 1,\n    \"nodes\": [\n        {\n            \"_id\": \"594e21fc4d1d62002f17e37d\",\n            \"_links\": {\n                \"self\": {\n                    \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0/nodes/594e21fc4d1d62002f17e37d\"\n                }\n            },\n            \"allowed\": \"CREDIT-AND-DEBIT\",\n            \"client\": {\n                \"id\": \"589acd9ecb3cd400fa75ac06\",\n                \"name\": \"SynapseFI\"\n            },\n            \"extra\": {\n                \"other\": {},\n                \"supp_id\": \"ABC124\"\n            },\n            \"info\": {\n                \"nickname\": \"Bank of America Debit Card\",\n              \t\"card_hash\": \"5d20f6c392348ed604241bee015af14519d47cc1cb61c31a256973a8d75cf939\",\n                \"document_id\": \"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\",\n              \t\"is_international\": false,\n                \"network\": \"VISA\",\n              \t\"type\":\"DEBIT\"\n            },\n            \"is_active\": true,\n            \"timeline\": [\n                {\n                    \"date\": 1498292731835,\n                    \"note\": \"Node created.\"\n                }\n            ],\n            \"type\": \"INTERCHANGE-US\",\n            \"user_id\": \"594e0fa2838454002ea317a0\"\n        }\n    ],\n    \"page_count\": 1,\n    \"success\": true\n}","name":""}]},"method":"post","examples":{"codes":[{"language":"http","code":"POST /v3.1/users/594e0fa2838454002ea317a0/nodes HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json\n\n{\n  \"type\": \"INTERCHANGE-US\",\n  \"info\": {\n    \"nickname\": \"My Debit Card\",\n    \"card_number\": \"Zoo8g2vBUjt7TwmEpRW8f6eQT3AOEEYePw2LkoxD+mO9lOT5OemHlGwgamgLGUbrmWu3DPwnEr2IqDy5YMFVgvQWP3w9nLOFzFFSW43auDgsVAqZScoRf8nI+6/B9KvOEV4XI8JeyXT+O+y3p3RtbiXGmYQNJ56Hy3hs2E5O+yn+3fpLfJQpVvNc38V+aE21VEsJuXFFNtS/8r4jJ6Dx/etTEaE/rtcEUEbwLLHFHjPiOWaHWZPuhXFLtyYrR9zG8FWSJVFwNTG/mEpv2O7We1iCB+9WoEKqdHyGwjjBcVgkUlU5huJIXv9xj53RGNvmHkDFTqgrlHpKkb0E/Ot0Zg==\",\n    \"exp_date\": \"ctA4Zj1CP0WCiMefPYsyewVbIHNilfwA09X9NSCyWxft4WGwFZmZkhsBJh51QL751/iFkUHbd09ZpDYjS86PqyNPZ5LkBueGHDIghLwWyzH1l99RiIs8urOW9c4g3L1USD+kzzRAqG1DBkW47FAX6AhPSi3YgQd94ery1H+asaqDrP79ayzoJ+nRXeEqe83FIgNUk/J5+EcAz3JYnoBmp1sfz7a4zHkvk0eKCxQWLETdqvONyCZyXdC/4CkaCxJ/87VsN3i4+ToULtSluRv8xr1NpRhzipKiEKTYW1nvNDAaJQezTVP/+GxmTmQfnfpVNDpJbXjNrOTej1HgMFpg4w==\",\n    \"document_id\": \"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\"\n  }\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"58fe92f443708d1900c36463","ref":"","in":"path","required":true,"desc":"The user ID of the user you wish to add the INTERCHANGE-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 for the node. It is very important to assign a nickname to the node for `INTERCHANGE-US`, because you can never retrieve the `card_number` back from the API","default":"","type":"string","name":"info.nickname"},{"_id":"55fa3f2a17b9d00d00969ea3","ref":"","in":"body","required":true,"desc":"Encrypted card number","default":"","type":"string","name":"info.card_number"},{"_id":"55ff577b5c67200d00fa2fc1","ref":"","in":"body","required":true,"desc":"Encrypted expiration date of the card `YYYYMM`","default":"","type":"string","name":"info.exp_date"},{"_id":"55ff5907748eb30d008a1ed9","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":"55ff5907748eb30d008a1ed7","ref":"","in":"body","required":false,"desc":"Any ID you wish to register to the node","default":"","type":"string","name":"extra.supp_id"},{"_id":"598a5a244390aa000f078fd8","ref":"","in":"body","required":false,"desc":"Memo tagged with the node","default":"","type":"string","name":"extra.note"},{"_id":"594e62ba57b2c60061f147ff","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":23,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Nicknames\",\n  \"body\": \"It is very important to assign a nickname to the node for `INTERCHANGE-US`, because you can never retrieve the `card_number` back from the API.\"\n}\n[/block]\n## Encrypting Data\n\nMake sure you encrypt the `card_number` and `exp_date` on the client's device using our public key provided below.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzxVLeRTf77kmG/42SdjjtRfaI/7GN4UoUBfxzN80gCyrjK+tHYJR7DKefC47fNyA2dGU7x3tu1wQRKOkjschbC3ZWF1mCqccUiHRPiGhH9VBsxLbAUCFAKOPZcBDCT7IhUdd6S23e99ewkb0c6pRk28u+kz+7ZB7d6Z/S+Em316zs0HqEnEaoUNFXtdTyW3EPuaqo0+p9daICRC44VbrTlzc+Y1A/CsiOcCCl4ske8scu/fWg0K3nybfn7IdO2smkzRwwGOc4uexBMnAkAyl0eQrqXZO4vis6ktmLFV4NpYsd0U2vvmuXFoA9XBcJHdbAww/TGwHq5RJ3505QSEK8QIDAQAB\\n-----END PUBLIC KEY-----\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n[JSencrypt](https://github.com/travist/jsencrypt) is an easy to use library to use for this purpose, the implementation would look something like this\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// Encrypt with the public key...\\nvar encrypt = new JSEncrypt();\\nencrypt.setPublicKey($('#pubkey').val());\\nvar encryptedCardNumber = encrypt.encrypt($('#card_number').val());\\nvar encryptedExpDate = encrypt.encrypt($('#exp_date').val());\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Padding\",\n  \"body\": \"Please make sure you are using PKCS1_v1_5 padding for encryption.\"\n}\n[/block]","excerpt":"Create an INTERCHANGE-US node","slug":"interchange-us","type":"endpoint","title":"INTERCHANGE-US"}

postINTERCHANGE-US

Create an INTERCHANGE-US node

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Body Params

type:
required
string
Type of node you wish to add
info.nickname:
required
string
Nickname for the node. It is very important to assign a nickname to the node for `INTERCHANGE-US`, because you can never retrieve the `card_number` back from the API
info.card_number:
required
string
Encrypted card number
info.exp_date:
required
string
Encrypted expiration date of the card `YYYYMM`
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
extra.note:
string
Memo tagged with the node
is_active:
boolean
If the node is indexed or marked deleted.

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Nicknames", "body": "It is very important to assign a nickname to the node for `INTERCHANGE-US`, because you can never retrieve the `card_number` back from the API." } [/block] ## Encrypting Data Make sure you encrypt the `card_number` and `exp_date` on the client's device using our public key provided below. [block:code] { "codes": [ { "code": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzxVLeRTf77kmG/42SdjjtRfaI/7GN4UoUBfxzN80gCyrjK+tHYJR7DKefC47fNyA2dGU7x3tu1wQRKOkjschbC3ZWF1mCqccUiHRPiGhH9VBsxLbAUCFAKOPZcBDCT7IhUdd6S23e99ewkb0c6pRk28u+kz+7ZB7d6Z/S+Em316zs0HqEnEaoUNFXtdTyW3EPuaqo0+p9daICRC44VbrTlzc+Y1A/CsiOcCCl4ske8scu/fWg0K3nybfn7IdO2smkzRwwGOc4uexBMnAkAyl0eQrqXZO4vis6ktmLFV4NpYsd0U2vvmuXFoA9XBcJHdbAww/TGwHq5RJ3505QSEK8QIDAQAB\n-----END PUBLIC KEY-----", "language": "text" } ] } [/block] [JSencrypt](https://github.com/travist/jsencrypt) is an easy to use library to use for this purpose, the implementation would look something like this [block:code] { "codes": [ { "code": "// Encrypt with the public key...\nvar encrypt = new JSEncrypt();\nencrypt.setPublicKey($('#pubkey').val());\nvar encryptedCardNumber = encrypt.encrypt($('#card_number').val());\nvar encryptedExpDate = encrypt.encrypt($('#exp_date').val());", "language": "javascript" } ] } [/block] [block:callout] { "type": "info", "title": "Padding", "body": "Please make sure you are using PKCS1_v1_5 padding for encryption." } [/block]