Preview a Revolving Credit Loan

Previewing a loan is a POST API call for the Node Resources.

This API call is just like Apply for a revolving credit loan but the the loan is created. This API call should be used to generate a loan preview for the end user before the final loan is created.

Request

POST /v3.1/users/5be92ff1321f48008fac90b3/nodes HTTP/1.1
Host: https://uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_9QacXjr56hOldHp8tN|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
{
  "type": "LOAN-US",
  "is_preview":true,
  "info": {
    "loan_type":"REVOLVING",
    "nickname":"My Loan",
    "credit_limit":{
      "amount":500.2,
      "currency":"USD"
    },
    "document_id":"2a4a5957a3a62aaac1a0dd0edcae9",
    "schedule":"MONTHLY"
  },
  "extra":{
    "supp_id":"xx123c"
  }
}
curl -X POST \
  https://uat-api.synapsefi.com/v3.1/users/5be92ff1321f48008fac90b3/nodes \
  -H 'Content-Type: application/json' \
  -H 'X-SP-USER: oauth_9QacXjr56hOldHp|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
  -H 'X-SP-USER-IP: 255.127.79.76' \
  -d '{
  "type": "LOAN-US",
  "is_preview":true,
  "info": {
    "loan_type":"REVOLVING",
    "nickname":"My Loan",
    "credit_limit":{
      "amount":500.2,
      "currency":"USD"
    },
    "document_id":"2a4a5957a3a62aaac1a0dd0edcae96ea",
    "schedule":"MONTHLY",
  },
  "extra":{
    "supp_id":"xx123c"
  }
}'
body= {
  "type": "LOAN-US",
  "is_preview":true,
  "info": {
    "loan_type":"REVOLVING",
    "nickname":"My Loan",
    "credit_limit":{
      "amount":500.2,
      "currency":"USD"
    },
    "document_id":"2a4a5957a3a62aaac1a0dd0edcae9",
    "schedule":"MONTHLY"
  },
  "extra":{
    "supp_id":"xx123c"
  }
}
user.create_node(body)
const body = {
  "type": "LOAN-US",
  "is_preview":true,
  "info": {
    "loan_type":"REVOLVING",
    "nickname":"My Loan",
    "credit_limit":{
      "amount":500.2,
      "currency":"USD"
    },
    "document_id":"2a4a5957a3a62aaac1a0dd0edcae9",
    "schedule":"MONTHLY"
  },
  "extra":{
    "supp_id":"xx123c"
  }
};

user.createNode(body);
body= {
  "type": "LOAN-US",
  "is_preview":true,
  "info": {
    "loan_type":"REVOLVING",
    "nickname":"My Loan",
    "credit_limit":{
      "amount":500.2,
      "currency":"USD"
    },
    "document_id":"2a4a5957a3a62aaac1a0dd0edcae9",
    "schedule":"MONTHLY"
  },
  "extra":{
    "supp_id":"xx123c"
  }
}
user.create_node(payload: body)
$extra = (object)[
  "supp_id" => "xx123c"
];
$credit_limit = (object)[
 "amount" => 40.10,
 "currency" => "USD"
];

$info = (object)[
 "loan_type" => "REVOLVING",
 "nickname" => "My Loan",
 "credit_limit" => $credit_limit, 
"document_id" =>"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
 "schedule"=>"MONTHLY"
];

$body = (object) [
 "type" => "LOAN-US",
 "is_preview" => true,
 "info" => $info,
 "extra" => $extra,
];

$user->create_node($body);
body := `{
  "type": "LOAN-US",
  "is_preview":true,
  "info": {
    "loan_type":"REVOLVING",
    "nickname":"My Loan",
    "credit_limit":{
      "amount":500.2,
      "currency":"USD"
    },
    "document_id":"2a4a5957a3a62aaac1a0dd0edcae9",
    "schedule":"MONTHLY"
  },
  "extra":{
    "supp_id":"xx123c"
  }
}`

data, err := user.CreateNode(body)

Response

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "node_count": 1,
    "nodes": [
        {
            "_id": "PREVIEW",
            "_links": {
                "self": {
                    "href": "https://uat-api.synapsefi.com/v3.1/users/5be92ff1321f48008fac90b3/nodes/PREVIEW"
                }
            },
            "allowed": "CREDIT-AND-DEBIT",
            "client": {
                "id": "589acd9ecb3cd400fa75ac06",
                "name": "SynapseFI"
            },
            "extra": {
                "note": null,
                "other": {},
                "supp_id": "xx123c"
            },
            "info": {
                "agreements": [
                    {
                        "type": "LOAN_AGREEMENT",
                        "url": "https://cdn.synapsepay.com/uploads/2018/11/12/ky23utZXqds9f4GonVLbvxIjRU7EW6r8SJMBATzO1N5FiDaYlC.pdf"
                    }
                ],
                "balance": {
                    "amount": 0,
                    "currency": "USD"
                },
                "credit_limit": {
                    "amount": 500.2,
                    "currency": "USD"
                },
                "document_id": "2a4a5957a3a62aaac1a0dd0edcae96",
                "interest": {
                    "accrued": 0,
                    "apr": 10,
                    "cap": 0.05
                },
                "loan_type": "REVOLVING",
                "name_on_account": " ",
                "nickname": "My Loan",
                "schedule": "MONTHLY"
            },
            "is_active": true,
            "timeline": [
            ],
            "type": "LOAN-US",
            "user_id": "5be92ff1321f48008fac90b3"
        }
    ],
    "page_count": 1,
    "success": true
}
{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "node_count": 1,
    "nodes": [
        {
            "_id": "5be9306bf8733300bb5fbf84",
            "_links": {
                "self": {
                    "href": "https://uat-api.synapsefi.com/v3.1/users/5be92ff1321f48008fac90b3/nodes/5be9306bf8733300bb5fbf84"
                }
            },
            "allowed": "REJECTED",
            "client": {
                "id": "589acd9ecb3cd400fa75ac06",
                "name": "SynapseFI"
            },
            "extra": {
                "note": "The LOANTYPE amount requested is higher than what we can offer you. Your limit is 1000.",
                "other": {},
                "supp_id": "xx123c"
            },
            "info": {
                "agreements": [
                    {
                        "type": "ADVERSE_ACTION",
                        "url": "https://cdn.synapsepay.com/uploads/2018/11/12/CU6qZT01svIEDGrnO0Fbh4tfdLglAcojNXmHYu9kwep28WMSP3.pdf"
                    }
                ],
                "balance": {
                    "amount": 0,
                    "currency": "USD"
                },
                "credit_limit": {
                    "amount": 0,
                    "currency": "USD"
                },
                "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
                "interest": {
                    "accrued": 0,
                    "apr": 10,
                    "cap": 0.05
                },
                "loan_type": "REVOLVING",
                "name_on_account": " ",
                "nickname": "My Loan",
                "schedule": "MONTHLY"
            },
            "is_active": true,
            "timeline": [
                {
                    "date": 1542008937322,
                    "note": "Node created."
                }
            ],
            "type": "LOAN-US",
            "user_id": "5be92ff1321f48008fac90b3"
        }
    ],
    "page_count": 1,
    "success": true
}

Preview a Revolving Credit Loan


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.