{"_id":"5b9eea62607b190003a37681","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":"5b9ed89212362100036b5a1c","project":"59f79e3c584eb200345ceafc","version":"59f79e3c584eb200345ceaff","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-09-16T22:26:26.400Z","from_sync":false,"order":6,"slug":"loans","title":"Loans"},"user":"54e4044e8ef7552300409dcb","__v":33,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-09-16T23:42:26.242Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"5b9eea62607b190003a37683","ref":"","in":"body","required":false,"desc":"Supply `LOAN-US`","default":"","type":"string","name":"type"},{"_id":"5b9eea62607b190003a37682","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"info.nickname"}],"url":"/v3.1/users/:user_id/nodes"},"isReference":false,"order":2,"body":"Applying for a loan is a `POST` API call for the [Node Resources](doc:node-resources).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v3.1/users/5b9ee70e04707a0067a724d5/nodes HTTP/1.1\\nHost: uat-api.synapsefi.com\\nX-SP-USER-IP: 255.127.79.76\\nX-SP-USER: oauth_F0rsnYzBpfZkNh91aERc5d|e83cf6ddcf778e37bfe3d48fc78a6502062fc\\nContent-Type: application/json\\nCache-Control: no-cache\\n\\n{\\n  \\\"type\\\": \\\"LOAN-US\\\",\\n  \\\"info\\\": {\\n  \\t\\\"loan_type\\\":\\\"ONE-TIME\\\",\\n    \\\"nickname\\\":\\\"My Loan\\\",\\n    \\\"credit_limit\\\":{\\n    \\t\\\"amount\\\":500.2,\\n    \\t\\\"currency\\\":\\\"USD\\\"\\n    },\\n    \\\"payment_node_id\\\":\\\"5be9296c4408930090ac92d2\\\",\\n    \\\"disbursement_node_id\\\":\\\"5be9296c4408930090ac92d2\\\",\\n    \\\"document_id\\\":\\\"2a4a5957a3a62aaac1a0dd0edcae96ea2c\\\",\\n    \\\"schedule\\\":\\\"MONTHLY\\\",\\n    \\\"next_payment\\\":30,\\n    \\\"num_payments\\\":10\\n  },\\n  \\\"extra\\\":{\\n  \\t\\\"supp_id\\\":\\\"xx123c\\\"\\n  }\\n}\",\n      \"language\": \"http\"\n    },\n    {\n      \"code\": \"curl -X POST \\\\\\n  https://uat-api.synapsefi.com/v3.1/users/5be9295b92571b00a74dc9c9/nodes \\\\\\n  -H 'Content-Type: application/json' \\\\\\n  -H 'X-SP-USER: oauth_QAdymv3UWO04u2kEXPV|e83cf6ddcf778e37' \\\\\\n  -H 'X-SP-USER-IP: 255.127.79.76' \\\\\\n  -d '{\\n  \\\"type\\\": \\\"LOAN-US\\\",\\n  \\\"info\\\": {\\n  \\t\\\"loan_type\\\":\\\"ONE-TIME\\\",\\n    \\\"nickname\\\":\\\"My Loan\\\",\\n    \\\"credit_limit\\\":{\\n    \\t\\\"amount\\\":500.2,\\n    \\t\\\"currency\\\":\\\"USD\\\"\\n    },\\n    \\\"payment_node_id\\\":\\\"5be9296c4408930090ac92d2\\\",\\n    \\\"disbursement_node_id\\\":\\\"5be9296c4408930090ac92d2\\\",\\n    \\\"document_id\\\":\\\"2a4a5957a3a62aaac1a0dd0edcae\\\",\\n    \\\"schedule\\\":\\\"MONTHLY\\\",\\n    \\\"next_payment\\\":30,\\n    \\\"num_payments\\\":10\\n  },\\n  \\\"extra\\\":{\\n  \\t\\\"supp_id\\\":\\\"xx123c\\\"\\n  }\\n}'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nResponses:\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\\\": \\\"5be9291d440893008eac92c4\\\",\\n            \\\"_links\\\": {\\n                \\\"self\\\": {\\n                    \\\"href\\\": \\\"https://uat-api.synapsefi.com/v3.1/users/5be921d3321f48008eac7810/nodes/5be9291d440893008eac92c4\\\"\\n                }\\n            },\\n            \\\"allowed\\\": \\\"CREDIT\\\",\\n            \\\"client\\\": {\\n                \\\"id\\\": \\\"589acd9ecb3cd400fa75ac06\\\",\\n                \\\"name\\\": \\\"SynapseFI\\\"\\n            },\\n            \\\"extra\\\": {\\n                \\\"note\\\": null,\\n                \\\"other\\\": {},\\n                \\\"supp_id\\\": \\\"xx123c\\\"\\n            },\\n            \\\"info\\\": {\\n                \\\"agreements\\\": [\\n                    {\\n                        \\\"type\\\": \\\"LOAN_AGREEMENT\\\",\\n                        \\\"url\\\": \\\"https://cdn.synapsepay.com/uploads/2018/11/12/W1jc2N4YGRhtI7uHMdX8AyvOmpPFgKeoqrD3VL0xBsE0UlTzfb.pdf\\\"\\n                    }\\n                ],\\n                \\\"balance\\\": {\\n                    \\\"amount\\\": 0,\\n                    \\\"currency\\\": \\\"USD\\\"\\n                },\\n                \\\"credit_limit\\\": {\\n                    \\\"amount\\\": 500.2,\\n                    \\\"currency\\\": \\\"cUSD\\\"\\n                },\\n                \\\"disbursement_node_id\\\": \\\"5be921e1fc0a9800b696eae2\\\",\\n                \\\"document_id\\\": \\\"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\\\",\\n                \\\"installment_amount\\\": 52.53,\\n                \\\"interest\\\": {\\n                    \\\"accrued\\\": 0,\\n                    \\\"apr\\\": 10,\\n                    \\\"cap\\\": 25.01\\n                },\\n                \\\"loan_type\\\": \\\"ONE-TIME\\\",\\n                \\\"name_on_account\\\": \\\" \\\",\\n                \\\"next_payment\\\": 1544599063691,\\n                \\\"nickname\\\": \\\"My Loan\\\",\\n                \\\"num_payments\\\": 10,\\n                \\\"payment_node_id\\\": \\\"5be921e1fc0a9800b696eae2\\\",\\n                \\\"schedule\\\": \\\"MONTHLY\\\"\\n            },\\n            \\\"is_active\\\": true,\\n            \\\"timeline\\\": [\\n                {\\n                    \\\"date\\\": 1542007063691,\\n                    \\\"note\\\": \\\"Node created.\\\"\\n                }\\n            ],\\n            \\\"type\\\": \\\"LOAN-US\\\",\\n            \\\"user_id\\\": \\\"5be921d3321f48008eac7810\\\"\\n        }\\n    ],\\n    \\\"page_count\\\": 1,\\n    \\\"success\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Approved\"\n    },\n    {\n      \"code\": \"{\\n    \\\"error_code\\\": \\\"0\\\",\\n    \\\"http_code\\\": \\\"200\\\",\\n    \\\"limit\\\": 20,\\n    \\\"node_count\\\": 1,\\n    \\\"nodes\\\": [\\n        {\\n            \\\"_id\\\": \\\"5be92f92f8733300bb5fbf6d\\\",\\n            \\\"_links\\\": {\\n                \\\"self\\\": {\\n                    \\\"href\\\": \\\"https://uat-api.synapsefi.com/v3.1/users/5be92f2292571b00a74dcbdf/nodes/5be92f92f8733300bb5fbf6d\\\"\\n                }\\n            },\\n            \\\"allowed\\\": \\\"REJECTED\\\",\\n            \\\"client\\\": {\\n                \\\"id\\\": \\\"589acd9ecb3cd400fa75ac06\\\",\\n                \\\"name\\\": \\\"SynapseFI\\\"\\n            },\\n            \\\"extra\\\": {\\n                \\\"note\\\": \\\"The LOANTYPE amount requested is higher than what we can offer you. Your limit is 1000.\\\",\\n                \\\"other\\\": {},\\n                \\\"supp_id\\\": \\\"xx123c\\\"\\n            },\\n            \\\"info\\\": {\\n                \\\"agreements\\\": [\\n                    {\\n                        \\\"type\\\": \\\"ADVERSE_ACTION\\\",\\n                        \\\"url\\\": \\\"https://cdn.synapsepay.com/uploads/2018/11/12/U007pH16AvzLqMDSoGsJ8QTnk4FWetbXd9rEYgVyh3maNBxc2i.pdf\\\"\\n                    }\\n                ],\\n                \\\"balance\\\": {\\n                    \\\"amount\\\": 0,\\n                    \\\"currency\\\": \\\"USD\\\"\\n                },\\n                \\\"credit_limit\\\": {\\n                    \\\"amount\\\": 0,\\n                    \\\"currency\\\": \\\"USD\\\"\\n                },\\n                \\\"disbursement_node_id\\\": \\\"5be92f6efc0a9800b287029f\\\",\\n                \\\"document_id\\\": \\\"2a4a5957a3a62aaac1a0dd0edcae9\\\",\\n                \\\"installment_amount\\\": 0,\\n                \\\"interest\\\": {\\n                    \\\"accrued\\\": 0,\\n                    \\\"apr\\\": 10,\\n                    \\\"cap\\\": 0.05\\n                },\\n                \\\"loan_type\\\": \\\"ONE-TIME\\\",\\n                \\\"name_on_account\\\": \\\" \\\",\\n                \\\"next_payment\\\": null,\\n                \\\"nickname\\\": \\\"My Loan\\\",\\n                \\\"num_payments\\\": 0,\\n                \\\"payment_node_id\\\": \\\"5be92f6efc0a9800b287029f\\\",\\n                \\\"schedule\\\": \\\"MONTHLY\\\"\\n            },\\n            \\\"is_active\\\": true,\\n            \\\"timeline\\\": [\\n                {\\n                    \\\"date\\\": 1542008719334,\\n                    \\\"note\\\": \\\"Node created.\\\"\\n                }\\n            ],\\n            \\\"type\\\": \\\"LOAN-US\\\",\\n            \\\"user_id\\\": \\\"5be92f2292571b00a74dcbdf\\\"\\n        }\\n    ],\\n    \\\"page_count\\\": 1,\\n    \\\"success\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Rejected\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Variable APRs\"\n}\n[/block]\nYou can also specify the APR when you create a loan object. Any APR below what has been approved by us will work as a valid input. All you would need to do is add `info.interest.apr` in %.\n\nExample:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v3.1/users/5b9ee70e04707a0067a724d5/nodes HTTP/1.1\\nHost: uat-api.synapsefi.com\\nX-SP-USER-IP: 255.127.79.76\\nX-SP-USER: oauth_F0rsnYzBpfZkNh91aERc5d|e83cf6ddcf778e37bfe3d48fc78a6502062fc\\nContent-Type: application/json\\nCache-Control: no-cache\\n\\n{\\n  \\\"type\\\": \\\"LOAN-US\\\",\\n  \\\"info\\\": {\\n  \\t\\\"loan_type\\\":\\\"ONE-TIME\\\",\\n    \\\"nickname\\\":\\\"For a Tesla Model X\\\",\\n    \\\"credit_limit\\\":{\\n    \\t\\\"amount\\\":500.2,\\n    \\t\\\"currency\\\":\\\"USD\\\"\\n    },\\n    \\\"interest\\\": {\\n    \\t\\\"apr\\\": 10\\n    },\\n    \\\"payment_node_id\\\":\\\"5bb4ea879a835600b57fb1c2\\\",\\n    \\\"disbursement_node_id\\\":\\\"5bb4ea879a835600b57fb1c2\\\",\\n    \\\"document_id\\\":\\\"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee68\\\",\\n    \\\"schedule\\\":\\\"MONTHLY\\\",\\n    \\\"next_payment\\\":30,\\n    \\\"num_payments\\\":10\\n  },\\n  \\\"extra\\\":{\\n  \\t\\\"supp_id\\\":\\\"xx123c\\\"\\n  }\\n}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"apply-for-a-loan","type":"basic","title":"Apply for a one-time loan"}

Apply for a one-time loan


Applying for a loan is a `POST` API call for the [Node Resources](doc:node-resources). [block:code] { "codes": [ { "code": "POST /v3.1/users/5b9ee70e04707a0067a724d5/nodes HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-USER-IP: 255.127.79.76\nX-SP-USER: oauth_F0rsnYzBpfZkNh91aERc5d|e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json\nCache-Control: no-cache\n\n{\n \"type\": \"LOAN-US\",\n \"info\": {\n \t\"loan_type\":\"ONE-TIME\",\n \"nickname\":\"My Loan\",\n \"credit_limit\":{\n \t\"amount\":500.2,\n \t\"currency\":\"USD\"\n },\n \"payment_node_id\":\"5be9296c4408930090ac92d2\",\n \"disbursement_node_id\":\"5be9296c4408930090ac92d2\",\n \"document_id\":\"2a4a5957a3a62aaac1a0dd0edcae96ea2c\",\n \"schedule\":\"MONTHLY\",\n \"next_payment\":30,\n \"num_payments\":10\n },\n \"extra\":{\n \t\"supp_id\":\"xx123c\"\n }\n}", "language": "http" }, { "code": "curl -X POST \\\n https://uat-api.synapsefi.com/v3.1/users/5be9295b92571b00a74dc9c9/nodes \\\n -H 'Content-Type: application/json' \\\n -H 'X-SP-USER: oauth_QAdymv3UWO04u2kEXPV|e83cf6ddcf778e37' \\\n -H 'X-SP-USER-IP: 255.127.79.76' \\\n -d '{\n \"type\": \"LOAN-US\",\n \"info\": {\n \t\"loan_type\":\"ONE-TIME\",\n \"nickname\":\"My Loan\",\n \"credit_limit\":{\n \t\"amount\":500.2,\n \t\"currency\":\"USD\"\n },\n \"payment_node_id\":\"5be9296c4408930090ac92d2\",\n \"disbursement_node_id\":\"5be9296c4408930090ac92d2\",\n \"document_id\":\"2a4a5957a3a62aaac1a0dd0edcae\",\n \"schedule\":\"MONTHLY\",\n \"next_payment\":30,\n \"num_payments\":10\n },\n \"extra\":{\n \t\"supp_id\":\"xx123c\"\n }\n}'", "language": "curl" } ] } [/block] Responses: [block:code] { "codes": [ { "code": "{\n \"error_code\": \"0\",\n \"http_code\": \"200\",\n \"limit\": 20,\n \"node_count\": 1,\n \"nodes\": [\n {\n \"_id\": \"5be9291d440893008eac92c4\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://uat-api.synapsefi.com/v3.1/users/5be921d3321f48008eac7810/nodes/5be9291d440893008eac92c4\"\n }\n },\n \"allowed\": \"CREDIT\",\n \"client\": {\n \"id\": \"589acd9ecb3cd400fa75ac06\",\n \"name\": \"SynapseFI\"\n },\n \"extra\": {\n \"note\": null,\n \"other\": {},\n \"supp_id\": \"xx123c\"\n },\n \"info\": {\n \"agreements\": [\n {\n \"type\": \"LOAN_AGREEMENT\",\n \"url\": \"https://cdn.synapsepay.com/uploads/2018/11/12/W1jc2N4YGRhtI7uHMdX8AyvOmpPFgKeoqrD3VL0xBsE0UlTzfb.pdf\"\n }\n ],\n \"balance\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"credit_limit\": {\n \"amount\": 500.2,\n \"currency\": \"cUSD\"\n },\n \"disbursement_node_id\": \"5be921e1fc0a9800b696eae2\",\n \"document_id\": \"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\",\n \"installment_amount\": 52.53,\n \"interest\": {\n \"accrued\": 0,\n \"apr\": 10,\n \"cap\": 25.01\n },\n \"loan_type\": \"ONE-TIME\",\n \"name_on_account\": \" \",\n \"next_payment\": 1544599063691,\n \"nickname\": \"My Loan\",\n \"num_payments\": 10,\n \"payment_node_id\": \"5be921e1fc0a9800b696eae2\",\n \"schedule\": \"MONTHLY\"\n },\n \"is_active\": true,\n \"timeline\": [\n {\n \"date\": 1542007063691,\n \"note\": \"Node created.\"\n }\n ],\n \"type\": \"LOAN-US\",\n \"user_id\": \"5be921d3321f48008eac7810\"\n }\n ],\n \"page_count\": 1,\n \"success\": true\n}", "language": "json", "name": "Approved" }, { "code": "{\n \"error_code\": \"0\",\n \"http_code\": \"200\",\n \"limit\": 20,\n \"node_count\": 1,\n \"nodes\": [\n {\n \"_id\": \"5be92f92f8733300bb5fbf6d\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://uat-api.synapsefi.com/v3.1/users/5be92f2292571b00a74dcbdf/nodes/5be92f92f8733300bb5fbf6d\"\n }\n },\n \"allowed\": \"REJECTED\",\n \"client\": {\n \"id\": \"589acd9ecb3cd400fa75ac06\",\n \"name\": \"SynapseFI\"\n },\n \"extra\": {\n \"note\": \"The LOANTYPE amount requested is higher than what we can offer you. Your limit is 1000.\",\n \"other\": {},\n \"supp_id\": \"xx123c\"\n },\n \"info\": {\n \"agreements\": [\n {\n \"type\": \"ADVERSE_ACTION\",\n \"url\": \"https://cdn.synapsepay.com/uploads/2018/11/12/U007pH16AvzLqMDSoGsJ8QTnk4FWetbXd9rEYgVyh3maNBxc2i.pdf\"\n }\n ],\n \"balance\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"credit_limit\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"disbursement_node_id\": \"5be92f6efc0a9800b287029f\",\n \"document_id\": \"2a4a5957a3a62aaac1a0dd0edcae9\",\n \"installment_amount\": 0,\n \"interest\": {\n \"accrued\": 0,\n \"apr\": 10,\n \"cap\": 0.05\n },\n \"loan_type\": \"ONE-TIME\",\n \"name_on_account\": \" \",\n \"next_payment\": null,\n \"nickname\": \"My Loan\",\n \"num_payments\": 0,\n \"payment_node_id\": \"5be92f6efc0a9800b287029f\",\n \"schedule\": \"MONTHLY\"\n },\n \"is_active\": true,\n \"timeline\": [\n {\n \"date\": 1542008719334,\n \"note\": \"Node created.\"\n }\n ],\n \"type\": \"LOAN-US\",\n \"user_id\": \"5be92f2292571b00a74dcbdf\"\n }\n ],\n \"page_count\": 1,\n \"success\": true\n}", "language": "json", "name": "Rejected" } ] } [/block] [block:api-header] { "title": "Variable APRs" } [/block] You can also specify the APR when you create a loan object. Any APR below what has been approved by us will work as a valid input. All you would need to do is add `info.interest.apr` in %. Example: [block:code] { "codes": [ { "code": "POST /v3.1/users/5b9ee70e04707a0067a724d5/nodes HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-USER-IP: 255.127.79.76\nX-SP-USER: oauth_F0rsnYzBpfZkNh91aERc5d|e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json\nCache-Control: no-cache\n\n{\n \"type\": \"LOAN-US\",\n \"info\": {\n \t\"loan_type\":\"ONE-TIME\",\n \"nickname\":\"For a Tesla Model X\",\n \"credit_limit\":{\n \t\"amount\":500.2,\n \t\"currency\":\"USD\"\n },\n \"interest\": {\n \t\"apr\": 10\n },\n \"payment_node_id\":\"5bb4ea879a835600b57fb1c2\",\n \"disbursement_node_id\":\"5bb4ea879a835600b57fb1c2\",\n \"document_id\":\"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee68\",\n \"schedule\":\"MONTHLY\",\n \"next_payment\":30,\n \"num_payments\":10\n },\n \"extra\":{\n \t\"supp_id\":\"xx123c\"\n }\n}", "language": "http" } ] } [/block]