{"_id":"5bb57b8e54d2dc000398828d","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":"5bb55954478c1300031a44c2","project":"59f79e3c584eb200345ceafc","version":"5ba178b00a916500030c6a21","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-10-04T00:05:40.532Z","from_sync":false,"order":4,"slug":"wires","title":"Wires"},"user":"5a68eb6970ea610012bfb924","__v":12,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-04T02:31:42.370Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"http","code":"GET /v3.1/users/594e0fa2838454002ea317a0 HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json","name":"w/o full_dehydrate"},{"name":"with full_dehydrate","language":"http","code":"GET /v3.1/users/594e0fa2838454002ea317a0?full_dehydrate=yes HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"_id\": \"594e0fa2838454002ea317a0\",\n    \"_links\": {\n        \"self\": {\n            \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0\"\n        }\n    },\n    \"client\": {\n        \"id\": \"589acd9ecb3cd400fa75ac06\",\n        \"name\": \"SynapseFI\"\n    },\n    \"doc_status\": {\n        \"physical_doc\": \"SUBMITTED|VALID\",\n        \"virtual_doc\": \"SUBMITTED|VALID\"\n    },\n    \"documents\": [\n        {\n            \"id\": \"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\",\n            \"name\": \"Test User\",\n            \"permission_scope\": \"SEND|RECEIVE|1000|DAILY\",\n            \"physical_docs\": [\n                {\n                    \"document_type\": \"GOVT_ID\",\n                    \"id\": \"c486c2cb8c1bce695fcfae3197e14aa5b8ddec184c2779d00d581abee5d9a04c\",\n                    \"last_updated\": 1498288034877,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"social_docs\": [\n                {\n                    \"document_type\": \"FACEBOOK\",\n                    \"id\": \"8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7\",\n                    \"last_updated\": 1498288034880,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"PHONE_NUMBER\",\n                    \"id\": \"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\",\n                    \"last_updated\": 1498288034880,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"EMAIL\",\n                    \"id\": \"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\",\n                    \"last_updated\": 1498288034880,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"IP\",\n                    \"id\": \"28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a\",\n                    \"last_updated\": 1498288034880,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"virtual_docs\": [\n                {\n                    \"document_type\": \"SSN\",\n                    \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n                    \"last_updated\": 1498288034875,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ]\n        }\n    ],\n    \"emails\": [],\n    \"extra\": {\n        \"cip_tag\": 1,\n        \"date_joined\": 1498288029784,\n        \"extra_security\": false,\n        \"is_business\": false,\n        \"last_updated\": 1498288034864,\n        \"public_note\": null,\n        \"supp_id\": \"122eddfgbeafrfvbbb\"\n    },\n    \"is_hidden\": false,\n    \"legal_names\": [\n        \"Test User\"\n    ],\n    \"logins\": [\n        {\n            \"email\": \"test:::at:::synapsefi.com\",\n            \"scope\": \"READ_AND_WRITE\"\n        }\n    ],\n    \"permission\": \"SEND-AND-RECEIVE\",\n    \"phone_numbers\": [\n        \"[email protected]\",\n        \"901.111.1111\"\n    ],\n    \"photos\": [],\n    \"refresh_token\": \"refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq\"\n}","name":"w/o full_dehydrate"},{"code":"{\n    \"_id\": \"594e0fa2838454002ea317a0\",\n    \"_links\": {\n        \"self\": {\n            \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0\"\n        }\n    },\n    \"_v\": 2,\n    \"client\": {\n        \"id\": \"589acd9ecb3cd400fa75ac06\",\n        \"name\": \"SynapseFI\"\n    },\n    \"doc_status\": {\n        \"physical_doc\": \"SUBMITTED|VALID\",\n        \"virtual_doc\": \"SUBMITTED|VALID\"\n    },\n    \"documents\": [\n        {\n            \"address_city\": \"SF\",\n            \"address_country_code\": \"US\",\n            \"address_postal_code\": \"94114\",\n            \"address_street\": \"1 Market St.\",\n            \"address_subdivision\": \"CA\",\n            \"alias\": \"Test\",\n            \"day\": 2,\n            \"email\": \"[email protected]\",\n            \"entity_scope\": \"Arts & Entertainment\",\n            \"entity_type\": \"M\",\n            \"id\": \"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\",\n            \"ip\": \"::1\",\n            \"month\": 5,\n            \"name\": \"Test User\",\n            \"permission_scope\": \"SEND|RECEIVE|1000|DAILY\",\n            \"phone_number\": \"901.111.1111\",\n            \"physical_docs\": [\n                {\n                    \"document_type\": \"GOVT_ID\",\n                    \"document_value\": \"https://cdn.synapsepay.com/uploads/2017/06/24/DioeVvEbMOfxzpLGZNCPnJKYuHQ7t89s4FBmTk00rRgyc35WXU.gif\",\n                    \"id\": \"c486c2cb8c1bce695fcfae3197e14aa5b8ddec184c2779d00d581abee5d9a04c\",\n                    \"last_updated\": 1498288034877,\n                    \"meta\": {\n                        \"matches\": {\n                            \"address\": \"not_found\",\n                            \"dob\": \"not_found\",\n                            \"identification\": \"not_found\"\n                        }\n                    },\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"screening_results\": {\n                \"561\": \"NO_MATCH\",\n                \"aucl\": \"NO_MATCH\",\n                \"concern_location\": \"NO_MATCH\",\n                \"dpl\": \"NO_MATCH\",\n                \"dtc\": \"NO_MATCH\",\n                \"el\": \"NO_MATCH\",\n                \"eucl\": \"NO_MATCH\",\n                \"fatf_non_cooperative_jurisdiction\": \"NO_MATCH\",\n                \"fbi_bank_robbers\": \"NO_MATCH\",\n                \"fbi_counter_intelligence\": \"NO_MATCH\",\n                \"fbi_crimes_against_children\": \"NO_MATCH\",\n                \"fbi_criminal_enterprise_investigations\": \"NO_MATCH\",\n                \"fbi_cyber\": \"NO_MATCH\",\n                \"fbi_domestic_terrorism\": \"NO_MATCH\",\n                \"fbi_human_trafficking\": \"NO_MATCH\",\n                \"fbi_murders\": \"NO_MATCH\",\n                \"fbi_violent_crimes\": \"NO_MATCH\",\n                \"fbi_wanted_terrorists\": \"NO_MATCH\",\n                \"fbi_white_collar\": \"NO_MATCH\",\n                \"fincen_red_list\": \"NO_MATCH\",\n                \"fse\": \"NO_MATCH\",\n                \"fto_sanctions\": \"NO_MATCH\",\n                \"futures_sanctions\": \"NO_MATCH\",\n                \"hkma_sanctions\": \"NO_MATCH\",\n                \"hm_treasury_sanctions\": \"NO_MATCH\",\n                \"isn\": \"NO_MATCH\",\n                \"mas_sanctions\": \"NO_MATCH\",\n                \"monitored_location\": \"NO_MATCH\",\n                \"ns-isa\": \"NO_MATCH\",\n                \"ofac_561_list\": \"NO_MATCH\",\n                \"ofac_eo13645\": \"NO_MATCH\",\n                \"ofac_fse\": \"NO_MATCH\",\n                \"ofac_fse_ir\": \"NO_MATCH\",\n                \"ofac_fse_sy\": \"NO_MATCH\",\n                \"ofac_isa\": \"NO_MATCH\",\n                \"ofac_ns_isa\": \"NO_MATCH\",\n                \"ofac_plc\": \"NO_MATCH\",\n                \"ofac_sdn\": \"NO_MATCH\",\n                \"ofac_ssi\": \"NO_MATCH\",\n                \"ofac_syria\": \"NO_MATCH\",\n                \"ofac_ukraine_eo13662\": \"NO_MATCH\",\n                \"osfi\": \"NO_MATCH\",\n                \"pep\": \"NO_MATCH\",\n                \"plc\": \"NO_MATCH\",\n                \"primary_concern\": \"NO_MATCH\",\n                \"sdn\": \"NO_MATCH\",\n                \"ssi\": \"NO_MATCH\",\n                \"tel_sanctions\": \"NO_MATCH\",\n                \"ukcl\": \"NO_MATCH\",\n                \"uvl\": \"NO_MATCH\"\n            },\n            \"social_docs\": [\n                {\n                    \"document_type\": \"FACEBOOK\",\n                    \"document_value\": \"https://www.facebook.com/valid\",\n                    \"id\": \"8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7\",\n                    \"last_updated\": 1498288034880,\n                    \"meta\": {\n                        \"matches\": {\n                            \"address\": \"not_found\",\n                            \"dob\": \"not_found\",\n                            \"identification\": \"not_found\"\n                        }\n                    },\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"PHONE_NUMBER\",\n                    \"document_value\": \"901.111.1111\",\n                    \"id\": \"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\",\n                    \"last_updated\": 1498288034880,\n                    \"meta\": {\n                        \"matches\": {\n                            \"address\": \"not_found\",\n                            \"dob\": \"not_found\",\n                            \"identification\": \"not_found\"\n                        }\n                    },\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"EMAIL\",\n                    \"document_value\": \"[email protected]\",\n                    \"id\": \"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\",\n                    \"last_updated\": 1498288034880,\n                    \"meta\": {\n                        \"matches\": {\n                            \"address\": \"not_found\",\n                            \"dob\": \"not_found\",\n                            \"identification\": \"not_found\"\n                        }\n                    },\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"IP\",\n                    \"document_value\": \"::1\",\n                    \"id\": \"28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a\",\n                    \"last_updated\": 1498288034880,\n                    \"meta\": {\n                        \"matches\": {\n                            \"address\": \"not_found\",\n                            \"dob\": \"not_found\",\n                            \"identification\": \"not_found\"\n                        }\n                    },\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"virtual_docs\": [\n                {\n                    \"document_type\": \"SSN\",\n                    \"document_value\": \"2222\",\n                    \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n                    \"last_updated\": 1498288034875,\n                    \"meta\": {\n                        \"matches\": {\n                            \"address\": \"not_found\",\n                            \"dob\": \"not_found\",\n                            \"identification\": \"not_found\"\n                        }\n                    },\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"year\": 1989\n        }\n    ],\n    \"emails\": [],\n    \"extra\": {\n        \"cip_tag\": 1,\n        \"date_joined\": 1498288029784,\n        \"extra_security\": false,\n        \"is_business\": false,\n        \"last_updated\": 1498288034864,\n        \"note\": null,\n        \"public_note\": null,\n        \"supp_id\": \"122eddfgbeafrfvbbb\"\n    },\n    \"flag\": \"NOT-FLAGGED\",\n    \"ips\": [\n        \"127.0.0.1\"\n    ],\n    \"is_hidden\": false,\n    \"legal_names\": [\n        \"Test User\"\n    ],\n    \"logins\": [\n        {\n            \"email\": \"[email protected]\",\n            \"scope\": \"READ_AND_WRITE\"\n        }\n    ],\n    \"permission\": \"SEND-AND-RECEIVE\",\n    \"phone_numbers\": [\n        \"[email protected]\",\n        \"901.111.1111\"\n    ],\n    \"photos\": [],\n    \"refresh_token\": \"refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq\"\n}","language":"json","name":"with full_dehydrate","status":200}]},"settings":"","auth":"required","params":[{"_id":"58acf7f3e570c62500512a63","ref":"","in":"query","required":false,"desc":"[yes/no] Full Dehydrate yes will return back user's KYC info.","default":"no","type":"string","name":"full_dehydrate"},{"_id":"590ca984ae0df70f0044026c","ref":"","in":"path","required":true,"desc":"The user ID of the user you wish to retrieve","default":"","type":"string","name":"user_id"}],"url":"/v3.1/users/:user_id"},"isReference":false,"order":3,"body":"To send an international wire, you will create a transaction from a Deposit Account (DEPOSIT-US) to a Wire Account (WIRE-INT node).\n\n*Reminder: Please remember to [Create Users](https://docs.synapsefi.com/v3.2/docs/create-a-user-1), [Oauth Users](https://docs.synapsefi.com/v3.2/docs/oauth-the-user) and Link Accounts (including a [DEPOSIT-US](https://docs.synapsefi.com/v3.2/docs/opening-direct-deposit-accounts) node for the sender and a [WIRE-INT](https://docs.synapsefi.com/v3.2/docs/opening-a-wire-account) node for the recipient).*\n\n##API ENDPOINT\nhttps://uat-api.synapsefi.com/v3.1/users/:user_id/nodes\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 you wish to add the WIRE-US node under</p></div></div></div></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>type <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>Type of node you wish to add</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>nickname <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>Nickname for the node</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>name_on_account <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>Name of the account holder</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>account_num <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>Account number associated with the bank</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>bank_name <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>Name of bank</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>address <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>Address of bank</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>swift <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>SWIFT Code of the bank</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.correspondent_info.</span>routing_num <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Routing number of correspondent bank</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.correspondent_info.</span>bank_name <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Name of correspondent bank</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.correspondent_info.</span>address <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Address of correspondent bank</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.correspondent_info.</span>swift <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>SWIFT Code of the correspondent bank</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">extra.</span>supp_id <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Any ID you wish to register to the node</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>is_active <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">boolean</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>If the node is indexed or marked deleted</p></div></div></div></div></div></div>\"\n}\n[/block]\n##EXAMPLE REQUEST\n[block:code]\n{\n  \"codes\": [\n    {\n      \"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\\\": \\\"WIRE-INT\\\",\\n  \\\"info\\\":{\\n      \\\"nickname\\\":\\\"Some Account\\\",\\n      \\\"account_num\\\":\\\"123567443\\\",\\n      \\\"swift\\\":\\\"TSIGFR22\\\"\\n    }\\n}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"We strongly encourage requiring 2FA on the sender before you allow them to send a wire from their deposit account. This is an extra step of verification, since you cannot pull a wire back after it is sent.\",\n  \"title\": \"2FA For Outgoing Wires\"\n}\n[/block]\n##EXAMPLE RESPONSE\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"error_code\\\": \\\"0\\\",\\n    \\\"http_code\\\": \\\"200\\\",\\n    \\\"limit\\\": 20,\\n    \\\"node_count\\\": 1,\\n    \\\"nodes\\\": [\\n        {\\n            \\\"_id\\\": \\\"594e67f1603964002f5561e7\\\",\\n            \\\"_links\\\": {\\n                \\\"self\\\": {\\n                    \\\"href\\\": \\\"https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0/nodes/594e67f1603964002f5561e7\\\"\\n                }\\n            },\\n            \\\"allowed\\\": \\\"CREDIT-AND-DEBIT\\\",\\n            \\\"client\\\": {\\n                \\\"id\\\": \\\"589acd9ecb3cd400fa75ac06\\\",\\n                \\\"name\\\": \\\"SynapseFI\\\"\\n            },\\n            \\\"extra\\\": {\\n                \\\"other\\\": {},\\n                \\\"supp_id\\\": \\\"\\\"\\n            },\\n            \\\"info\\\": {\\n                \\\"account_num\\\": \\\"7443\\\",\\n                \\\"address\\\": \\\"PLACE DE LA REPUBLIQUE 4 CROIX 59170 FR\\\",\\n                \\\"balance\\\": {\\n                    \\\"amount\\\": \\\"0.00\\\",\\n                    \\\"currency\\\": \\\"USD\\\"\\n                },\\n                \\\"bank_long_name\\\": \\\"3 SUISSES INTERNATIONAL\\\",\\n                \\\"bank_name\\\": \\\"3 SUISSES INTERNATIONAL\\\",\\n                \\\"name_on_account\\\": \\\" \\\",\\n                \\\"nickname\\\": \\\"Some Account\\\"\\n            },\\n            \\\"is_active\\\": true,\\n            \\\"timeline\\\": [\\n                {\\n                    \\\"date\\\": 1498310639513,\\n                    \\\"note\\\": \\\"Node created.\\\"\\n                }\\n            ],\\n            \\\"type\\\": \\\"WIRE-INT\\\",\\n            \\\"user_id\\\": \\\"594e0fa2838454002ea317a0\\\"\\n        }\\n    ],\\n    \\\"page_count\\\": 1,\\n    \\\"success\\\": true\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n##Wire Cutoff Times\nInternational wires will be sent out same day if created before 9AM PST.\n\n##Example Timeline\nHere is an example timeline for an outgoing wire. Not all transactions will follow this exact timeline, so please do not build your logic off these times. Instead, monitor transaction status and account balance.\n\nNote: Different banks post transactions at different times, so a user may not see their transaction marked as settled at the exact time that we mark a transaction as settled.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Description\",\n    \"h-1\": \"Time\",\n    \"h-2\": \"Transaction Status\",\n    \"h-3\": \"status_id\",\n    \"0-0\": \"User creates a transaction\",\n    \"1-0\": \"Transaction is submitted to our partner bank (\\\"ODFI\\\") at the appropriate cutoff time, assuming the transaction was not queued or canceled.\",\n    \"2-0\": \"User's bank picks up the Wire.\",\n    \"3-0\": \"We mark the Transaction as Settled\",\n    \"0-1\": \"Day 1, 8AM PT\",\n    \"1-1\": \"Day 1, 9AM PT\",\n    \"2-1\": \"Day 1, 6PM PT\",\n    \"3-1\": \"Day 1, 6:05PM PT\",\n    \"0-2\": \"CREATED\",\n    \"1-2\": \"PROCESSING-DEBIT\",\n    \"2-2\": \"PROCESSING-CREDIT\",\n    \"3-2\": \"SETTLED\",\n    \"0-3\": \"1\",\n    \"1-3\": \"2\",\n    \"2-3\": \"3\",\n    \"3-3\": \"4\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n##Transaction Status\nThe following are different types of transaction statuses for Wires.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Status\",\n    \"h-1\": \"status_id\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"QUEUED-BY-SYNAPSE\",\n    \"1-0\": \"QUEUED-BY-RECEIVER\",\n    \"2-0\": \"CREATED\",\n    \"3-0\": \"PROCESSING-DEBIT\",\n    \"4-0\": \"PROCESSING-CREDIT\",\n    \"5-0\": \"SETTLED\",\n    \"6-0\": \"CANCELED\",\n    \"7-0\": \"RETURNED\",\n    \"0-1\": \"-1\",\n    \"1-1\": \"0\",\n    \"2-1\": \"1\",\n    \"3-1\": \"2\",\n    \"4-1\": \"3\",\n    \"5-1\": \"4\",\n    \"6-1\": \"5\",\n    \"7-1\": \"6\",\n    \"0-2\": \"Transaction queued by Synapse\",\n    \"1-2\": \"Transaction queued by Client\",\n    \"2-2\": \"Transaction Created\",\n    \"3-2\": \"Processing Debit\",\n    \"4-2\": \"Processing Credit\",\n    \"5-2\": \"Transaction Settled\",\n    \"6-2\": \"Transaction Canceled\",\n    \"7-2\": \"Transaction Returned\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n##QUEUED AND CANCELED TRANSACTIONS\nVisit our [Transaction Codes resource](https://docs.synapsefi.com/v3.2/docs/transaction-codes) for the full list of reasons a transaction can be queued or canceled.\n\nTo cancel a transaction yourself, DELETE transaction. Only transactions with a `CREATED` or `QUEUED` status can be canceled. Once a transaction is processing or settled you are unable to cancel it.\n\n##Returned Transactions\nReturned Transactions will be marked as returned. When possible, we will propagate the reason along with the return.\n\n##Viewing the Transaction Timeline\nIf you need to track a wire, the transaction timeline will have the OMAD # available.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"        timeline: [\\n                date: {\\n                        $date : 1515433760022,\\n                },\\n                note : \\\"Transaction Created.\\\",\\n                status : \\\"CREATED\\\",\\n                status_id : \\\"1\\\",\\n                date: {\\n                        $date : 1515433764803,\\n                },\\n                note : \\\"Q10-K Further investigation needed from Synapse.\\\",\\n                status : \\\"QUEUED-BY-SYNAPSE\\\",\\n                status_id : \\\"-1\\\",\\n                date: {\\n                        $date : 1515618615016,\\n                },\\n                note : \\\"Transaction dequeued.\\\",\\n                status : \\\"CREATED\\\",\\n                status_id : \\\"1\\\",\\n                date: {\\n                        $date : 1515618619079,\\n                },\\n                note : \\\"\\\",\\n                status : \\\"PROCESSING-DEBIT\\\",\\n                status_id : \\\"2\\\",\\n                date: {\\n                        $date : 1515618619258,\\n                },\\n                note : \\\"\\\",\\n                status : \\\"PROCESSING-CREDIT\\\",\\n                status_id : \\\"3\\\",\\n                date: {\\n                        $date : 1515618619303,\\n                },\\n                note : \\\"\\\",\\n                status : \\\"SETTLED\\\",\\n                status_id : \\\"4\\\",        ]\",\n      \"language\": \"json\",\n      \"name\": \"Timeline\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Subscribe to Webhooks\",\n  \"body\": \"We recommend that you [subscribe to webhooks](https://docs.synapsefi.com/v3.2/docs/subscribe-to-webhooks) to stay updated on the status of transactions.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Transaction Fees\",\n  \"body\": \"By default, we deduct transaction fees from the transaction. To send the recipient 100% of the funds, [designate the account you want to debit fees from](https://docs.synapsefi.com/v3.2/docs/facilitator-fees-for-transactions).\\n\\nOr take an additional `fee` for yourself and designate the DEPOSIT-US node you want to send fees to.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Idempotent Requests\",\n  \"body\": \"POST calls support idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a transaction fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single charge is created.\\n\\nTo perform an idempotent request, attach a unique key to any POST request made to the API via the X-SP-IDEMPOTENCY-KEY: <key> header.\\n\\nIdempotency keys expire after 24 hours.\"\n}\n[/block]","excerpt":"POST Transaction to send an international wire","slug":"sending-an-international-wire","type":"basic","title":"Send a Wire (International)"}

Send a Wire (International)

POST Transaction to send an international wire

To send an international wire, you will create a transaction from a Deposit Account (DEPOSIT-US) to a Wire Account (WIRE-INT node). *Reminder: Please remember to [Create Users](https://docs.synapsefi.com/v3.2/docs/create-a-user-1), [Oauth Users](https://docs.synapsefi.com/v3.2/docs/oauth-the-user) and Link Accounts (including a [DEPOSIT-US](https://docs.synapsefi.com/v3.2/docs/opening-direct-deposit-accounts) node for the sender and a [WIRE-INT](https://docs.synapsefi.com/v3.2/docs/opening-a-wire-account) node for the recipient).* ##API ENDPOINT https://uat-api.synapsefi.com/v3.1/users/:user_id/nodes ##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 you wish to add the WIRE-US node under</p></div></div></div></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>type <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>Type of node you wish to add</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>nickname <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>Nickname for the node</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>name_on_account <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>Name of the account holder</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>account_num <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>Account number associated with the bank</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>bank_name <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>Name of bank</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>address <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>Address of bank</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>swift <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>SWIFT Code of the bank</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.correspondent_info.</span>routing_num <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Routing number of correspondent bank</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.correspondent_info.</span>bank_name <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Name of correspondent bank</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.correspondent_info.</span>address <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Address of correspondent bank</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.correspondent_info.</span>swift <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>SWIFT Code of the correspondent bank</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">extra.</span>supp_id <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Any ID you wish to register to the node</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong>is_active <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">boolean</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>If the node is indexed or marked deleted</p></div></div></div></div></div></div>" } [/block] ##EXAMPLE REQUEST [block:code] { "codes": [ { "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\": \"WIRE-INT\",\n \"info\":{\n \"nickname\":\"Some Account\",\n \"account_num\":\"123567443\",\n \"swift\":\"TSIGFR22\"\n }\n}", "language": "http" } ] } [/block] [block:callout] { "type": "info", "body": "We strongly encourage requiring 2FA on the sender before you allow them to send a wire from their deposit account. This is an extra step of verification, since you cannot pull a wire back after it is sent.", "title": "2FA For Outgoing Wires" } [/block] ##EXAMPLE RESPONSE [block:code] { "codes": [ { "code": "{\n \"error_code\": \"0\",\n \"http_code\": \"200\",\n \"limit\": 20,\n \"node_count\": 1,\n \"nodes\": [\n {\n \"_id\": \"594e67f1603964002f5561e7\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0/nodes/594e67f1603964002f5561e7\"\n }\n },\n \"allowed\": \"CREDIT-AND-DEBIT\",\n \"client\": {\n \"id\": \"589acd9ecb3cd400fa75ac06\",\n \"name\": \"SynapseFI\"\n },\n \"extra\": {\n \"other\": {},\n \"supp_id\": \"\"\n },\n \"info\": {\n \"account_num\": \"7443\",\n \"address\": \"PLACE DE LA REPUBLIQUE 4 CROIX 59170 FR\",\n \"balance\": {\n \"amount\": \"0.00\",\n \"currency\": \"USD\"\n },\n \"bank_long_name\": \"3 SUISSES INTERNATIONAL\",\n \"bank_name\": \"3 SUISSES INTERNATIONAL\",\n \"name_on_account\": \" \",\n \"nickname\": \"Some Account\"\n },\n \"is_active\": true,\n \"timeline\": [\n {\n \"date\": 1498310639513,\n \"note\": \"Node created.\"\n }\n ],\n \"type\": \"WIRE-INT\",\n \"user_id\": \"594e0fa2838454002ea317a0\"\n }\n ],\n \"page_count\": 1,\n \"success\": true\n}", "language": "json" } ] } [/block] ##Wire Cutoff Times International wires will be sent out same day if created before 9AM PST. ##Example Timeline Here is an example timeline for an outgoing wire. Not all transactions will follow this exact timeline, so please do not build your logic off these times. Instead, monitor transaction status and account balance. Note: Different banks post transactions at different times, so a user may not see their transaction marked as settled at the exact time that we mark a transaction as settled. [block:parameters] { "data": { "h-0": "Description", "h-1": "Time", "h-2": "Transaction Status", "h-3": "status_id", "0-0": "User creates a transaction", "1-0": "Transaction is submitted to our partner bank (\"ODFI\") at the appropriate cutoff time, assuming the transaction was not queued or canceled.", "2-0": "User's bank picks up the Wire.", "3-0": "We mark the Transaction as Settled", "0-1": "Day 1, 8AM PT", "1-1": "Day 1, 9AM PT", "2-1": "Day 1, 6PM PT", "3-1": "Day 1, 6:05PM PT", "0-2": "CREATED", "1-2": "PROCESSING-DEBIT", "2-2": "PROCESSING-CREDIT", "3-2": "SETTLED", "0-3": "1", "1-3": "2", "2-3": "3", "3-3": "4" }, "cols": 4, "rows": 4 } [/block] ##Transaction Status The following are different types of transaction statuses for Wires. [block:parameters] { "data": { "h-0": "Status", "h-1": "status_id", "h-2": "Description", "0-0": "QUEUED-BY-SYNAPSE", "1-0": "QUEUED-BY-RECEIVER", "2-0": "CREATED", "3-0": "PROCESSING-DEBIT", "4-0": "PROCESSING-CREDIT", "5-0": "SETTLED", "6-0": "CANCELED", "7-0": "RETURNED", "0-1": "-1", "1-1": "0", "2-1": "1", "3-1": "2", "4-1": "3", "5-1": "4", "6-1": "5", "7-1": "6", "0-2": "Transaction queued by Synapse", "1-2": "Transaction queued by Client", "2-2": "Transaction Created", "3-2": "Processing Debit", "4-2": "Processing Credit", "5-2": "Transaction Settled", "6-2": "Transaction Canceled", "7-2": "Transaction Returned" }, "cols": 3, "rows": 8 } [/block] ##QUEUED AND CANCELED TRANSACTIONS Visit our [Transaction Codes resource](https://docs.synapsefi.com/v3.2/docs/transaction-codes) for the full list of reasons a transaction can be queued or canceled. To cancel a transaction yourself, DELETE transaction. Only transactions with a `CREATED` or `QUEUED` status can be canceled. Once a transaction is processing or settled you are unable to cancel it. ##Returned Transactions Returned Transactions will be marked as returned. When possible, we will propagate the reason along with the return. ##Viewing the Transaction Timeline If you need to track a wire, the transaction timeline will have the OMAD # available. [block:code] { "codes": [ { "code": " timeline: [\n date: {\n $date : 1515433760022,\n },\n note : \"Transaction Created.\",\n status : \"CREATED\",\n status_id : \"1\",\n date: {\n $date : 1515433764803,\n },\n note : \"Q10-K Further investigation needed from Synapse.\",\n status : \"QUEUED-BY-SYNAPSE\",\n status_id : \"-1\",\n date: {\n $date : 1515618615016,\n },\n note : \"Transaction dequeued.\",\n status : \"CREATED\",\n status_id : \"1\",\n date: {\n $date : 1515618619079,\n },\n note : \"\",\n status : \"PROCESSING-DEBIT\",\n status_id : \"2\",\n date: {\n $date : 1515618619258,\n },\n note : \"\",\n status : \"PROCESSING-CREDIT\",\n status_id : \"3\",\n date: {\n $date : 1515618619303,\n },\n note : \"\",\n status : \"SETTLED\",\n status_id : \"4\", ]", "language": "json", "name": "Timeline" } ] } [/block] [block:callout] { "type": "info", "title": "Subscribe to Webhooks", "body": "We recommend that you [subscribe to webhooks](https://docs.synapsefi.com/v3.2/docs/subscribe-to-webhooks) to stay updated on the status of transactions." } [/block] [block:callout] { "type": "info", "title": "Transaction Fees", "body": "By default, we deduct transaction fees from the transaction. To send the recipient 100% of the funds, [designate the account you want to debit fees from](https://docs.synapsefi.com/v3.2/docs/facilitator-fees-for-transactions).\n\nOr take an additional `fee` for yourself and designate the DEPOSIT-US node you want to send fees to." } [/block] [block:callout] { "type": "info", "title": "Idempotent Requests", "body": "POST calls support idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a transaction fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single charge is created.\n\nTo perform an idempotent request, attach a unique key to any POST request made to the API via the X-SP-IDEMPOTENCY-KEY: <key> header.\n\nIdempotency keys expire after 24 hours." } [/block]