{"_id":"559496bc0c33bd0d000596ec","project":"543de77431ca981a00a700ec","version":{"_id":"55819c76a5474a0d00d945db","__v":6,"project":"543de77431ca981a00a700ec","forked_from":"543de77431ca981a00a700ef","createdAt":"2015-06-17T16:12:38.031Z","releaseDate":"2015-06-17T16:12:38.031Z","categories":["55819c76a5474a0d00d945dc","55883498b3bcf52b00513212","5591ad23c671980d00543dd7","5591adfa342e980d006db03b","5591ae005781ae0d00236737","5595b4c4f4437019002888fb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"user":"557b54fb9670ce0d0071b7bd","__v":15,"category":{"_id":"5591ae005781ae0d00236737","__v":9,"pages":["5593165847f40b1700360786","55946c610c33bd0d0005968c","5594749535f5671700942e6b","55947b960c33bd0d000596b7","55947b9d35f5671700942e7f","55947ba90c33bd0d000596b9","559484b70c33bd0d000596d0","559496bc0c33bd0d000596ec","559d7a7979e08b350041b8f3"],"version":"55819c76a5474a0d00d945db","project":"543de77431ca981a00a700ec","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-29T20:43:44.229Z","from_sync":false,"order":2,"slug":"methods","title":"Methods"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-02T01:41:16.604Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"This endpoint will allow you to make purchases using the API. The endpoint will work for both whole loans and fractional, however for fractional you will need to use the parameter amount_cents. \n\nThe normal maximum order restrictions will apply to fractional loans and all POSTs are rate limited to 40 per second (spread across that second) to ensure fairness amongst our investors. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Purchasing Whole Loans\"\n}\n[/block]\nYou can purchase whole loans through the API either by placing the loan ID in form data, or, as a query parameter as shown below.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST https://investor-api.fundingcircle.us/api/v2/orders?listing_id=9f8c36b9-31e9-461e-bc57-cbb69fe8450\\n\\n\\n{\\n  \\\"transaction_id\\\": 238699,\\n  \\\"purchased_amount_cents\\\": 1000000,\\n  \\\"cashback_rate\\\": 0,\\n  \\\"fund_managed\\\": false,\\n  \\\"updated_at\\\": \\\"2015-07-02T12:16:00-07:00\\\",\\n  \\\"interest_rate\\\": 0.08990000000000001,\\n  \\\"status\\\": \\\"pending\\\",\\n  \\\"id\\\": \\\"dde0l929-842a-64e9-a618-03feo4a4alca\\\",\\n  \\\"truncated\\\": false,\\n  \\\"listing_id\\\": \\\"dde0l929-842a-64e9-a618-03feo4a4alca\\\",\\n  \\\"investor_postfunded\\\": false,\\n  \\\"investor_id\\\": \\\"1feb837e-c38f-4f19-b349-04a85af2e3ca\\\",\\n  \\\"investor_servicer_code\\\": \\\"orion\\\",\\n  \\\"accrued_interest_cents\\\": 0,\\n  \\\"original_purchase_amount_cents\\\": 100000,\\n  \\\"created_at\\\": \\\"2015-07-02T12:16:00-07:00\\\",\\n  \\\"payment_due_at\\\": null\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Purchasing Fractional Loans\"\n}\n[/block]\n\nIntroduced in version 2, you can now purchase a fractional loans via the API. In order to do this, you will need to specify the 'amount_cents' either in form data, or as a parameter shown below.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST https://investor-api.fundingcircle.us/api/v2/orders?listing_id=9f8c36b9-31e9-461e-bc57-cbb69fe8450&amount_cents=150000\\n\\n\\n{\\n  \\\"transaction_id\\\": 238699,\\n  \\\"purchased_amount_cents\\\": 150000,\\n  \\\"cashback_rate\\\": 0,\\n  \\\"fund_managed\\\": false,\\n  \\\"updated_at\\\": \\\"2015-07-02T12:16:00-07:00\\\",\\n  \\\"interest_rate\\\": 0.08990000000000001,\\n  \\\"status\\\": \\\"pending\\\",\\n  \\\"id\\\": \\\"dde0l929-842a-64e9-a618-03feo4a4alca\\\",\\n  \\\"truncated\\\": false,\\n  \\\"listing_id\\\": \\\"dde0l929-842a-64e9-a618-03feo4a4alca\\\",\\n  \\\"investor_postfunded\\\": false,\\n  \\\"investor_id\\\": \\\"1fob897e-c380-4fl9-b379-04a85af5e3ca\\\",\\n  \\\"investor_servicer_code\\\": \\\"orion\\\",\\n  \\\"accrued_interest_cents\\\": 0,\\n  \\\"original_purchase_amount_cents\\\": 100000,\\n  \\\"created_at\\\": \\\"2015-07-02T12:16:00-07:00\\\",\\n  \\\"payment_due_at\\\": null\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Responses\"\n}\n[/block]\nThe keys returned by both the Whole and Fractional purchases are the same\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data Type\",\n    \"h-2\": \"Discription\",\n    \"0-0\": \"accrued_interest_cents\",\n    \"1-0\": \"cashback_rate\",\n    \"2-0\": \"created_at\",\n    \"3-0\": \"fund_managed\",\n    \"4-0\": \"id\",\n    \"5-0\": \"interest_rate\",\n    \"6-0\": \"investor_id\",\n    \"7-0\": \"investor_postfunded\",\n    \"8-0\": \"investor_servicer_code\",\n    \"9-0\": \"listing_id\",\n    \"10-0\": \"original_purchase_amount_cents\",\n    \"11-0\": \"payment_due_at\",\n    \"12-0\": \"purchased_amount_cents\",\n    \"13-0\": \"status\",\n    \"14-0\": \"transaction_id\",\n    \"15-0\": \"truncated\",\n    \"16-0\": \"updated_at\",\n    \"0-1\": \"INTEGER\",\n    \"3-1\": \"BOOLEAN\",\n    \"4-1\": \"STRING\",\n    \"2-1\": \"STRING\",\n    \"1-1\": \"DECIMAL\",\n    \"5-1\": \"DECIMAL\",\n    \"6-1\": \"STRING\",\n    \"7-1\": \"BOOLEAN\",\n    \"9-1\": \"STRING\",\n    \"11-1\": \"STRING\",\n    \"12-1\": \"INTEGER\",\n    \"13-1\": \"STRING\",\n    \"10-1\": \"INTEGER\",\n    \"14-1\": \"STRING\",\n    \"15-1\": \"BOOLEAN\",\n    \"16-1\": \"STRING\",\n    \"0-2\": \"The amount of interest that the loan has generated before becoming an holding\",\n    \"2-2\": \"When the order was created\",\n    \"3-2\": \"Indicates if the loan is  managed by a Funding Circle fund\",\n    \"4-2\": \"The unique identifier of the order\",\n    \"6-2\": \"The unique ID of the investor who placed the order\",\n    \"7-2\": \"Indicates whether or not that investor is a post funded investor\",\n    \"9-2\": \"The unique ID of the listing\",\n    \"5-2\": \"How much interest is being charged on the loan\",\n    \"10-2\": \"The amount that the loan was purchased for\",\n    \"11-2\": \"When payment for the order is due\",\n    \"12-2\": \"The amount that was ultimately paid for the order\",\n    \"13-2\": \"The current state of the order\",\n    \"14-2\": \"A unique identifier for the transaction (actual cash transfer)\",\n    \"15-2\": \"\",\n    \"16-2\": \"When the loan was last modified\"\n  },\n  \"cols\": 3,\n  \"rows\": 17\n}\n[/block]","excerpt":"","slug":"post-orders","type":"basic","title":"POST Orders"}
This endpoint will allow you to make purchases using the API. The endpoint will work for both whole loans and fractional, however for fractional you will need to use the parameter amount_cents. The normal maximum order restrictions will apply to fractional loans and all POSTs are rate limited to 40 per second (spread across that second) to ensure fairness amongst our investors. [block:api-header] { "type": "basic", "title": "Purchasing Whole Loans" } [/block] You can purchase whole loans through the API either by placing the loan ID in form data, or, as a query parameter as shown below. [block:code] { "codes": [ { "code": "POST https://investor-api.fundingcircle.us/api/v2/orders?listing_id=9f8c36b9-31e9-461e-bc57-cbb69fe8450\n\n\n{\n \"transaction_id\": 238699,\n \"purchased_amount_cents\": 1000000,\n \"cashback_rate\": 0,\n \"fund_managed\": false,\n \"updated_at\": \"2015-07-02T12:16:00-07:00\",\n \"interest_rate\": 0.08990000000000001,\n \"status\": \"pending\",\n \"id\": \"dde0l929-842a-64e9-a618-03feo4a4alca\",\n \"truncated\": false,\n \"listing_id\": \"dde0l929-842a-64e9-a618-03feo4a4alca\",\n \"investor_postfunded\": false,\n \"investor_id\": \"1feb837e-c38f-4f19-b349-04a85af2e3ca\",\n \"investor_servicer_code\": \"orion\",\n \"accrued_interest_cents\": 0,\n \"original_purchase_amount_cents\": 100000,\n \"created_at\": \"2015-07-02T12:16:00-07:00\",\n \"payment_due_at\": null\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Purchasing Fractional Loans" } [/block] Introduced in version 2, you can now purchase a fractional loans via the API. In order to do this, you will need to specify the 'amount_cents' either in form data, or as a parameter shown below. [block:code] { "codes": [ { "code": "POST https://investor-api.fundingcircle.us/api/v2/orders?listing_id=9f8c36b9-31e9-461e-bc57-cbb69fe8450&amount_cents=150000\n\n\n{\n \"transaction_id\": 238699,\n \"purchased_amount_cents\": 150000,\n \"cashback_rate\": 0,\n \"fund_managed\": false,\n \"updated_at\": \"2015-07-02T12:16:00-07:00\",\n \"interest_rate\": 0.08990000000000001,\n \"status\": \"pending\",\n \"id\": \"dde0l929-842a-64e9-a618-03feo4a4alca\",\n \"truncated\": false,\n \"listing_id\": \"dde0l929-842a-64e9-a618-03feo4a4alca\",\n \"investor_postfunded\": false,\n \"investor_id\": \"1fob897e-c380-4fl9-b379-04a85af5e3ca\",\n \"investor_servicer_code\": \"orion\",\n \"accrued_interest_cents\": 0,\n \"original_purchase_amount_cents\": 100000,\n \"created_at\": \"2015-07-02T12:16:00-07:00\",\n \"payment_due_at\": null\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Responses" } [/block] The keys returned by both the Whole and Fractional purchases are the same [block:parameters] { "data": { "h-0": "Key", "h-1": "Data Type", "h-2": "Discription", "0-0": "accrued_interest_cents", "1-0": "cashback_rate", "2-0": "created_at", "3-0": "fund_managed", "4-0": "id", "5-0": "interest_rate", "6-0": "investor_id", "7-0": "investor_postfunded", "8-0": "investor_servicer_code", "9-0": "listing_id", "10-0": "original_purchase_amount_cents", "11-0": "payment_due_at", "12-0": "purchased_amount_cents", "13-0": "status", "14-0": "transaction_id", "15-0": "truncated", "16-0": "updated_at", "0-1": "INTEGER", "3-1": "BOOLEAN", "4-1": "STRING", "2-1": "STRING", "1-1": "DECIMAL", "5-1": "DECIMAL", "6-1": "STRING", "7-1": "BOOLEAN", "9-1": "STRING", "11-1": "STRING", "12-1": "INTEGER", "13-1": "STRING", "10-1": "INTEGER", "14-1": "STRING", "15-1": "BOOLEAN", "16-1": "STRING", "0-2": "The amount of interest that the loan has generated before becoming an holding", "2-2": "When the order was created", "3-2": "Indicates if the loan is managed by a Funding Circle fund", "4-2": "The unique identifier of the order", "6-2": "The unique ID of the investor who placed the order", "7-2": "Indicates whether or not that investor is a post funded investor", "9-2": "The unique ID of the listing", "5-2": "How much interest is being charged on the loan", "10-2": "The amount that the loan was purchased for", "11-2": "When payment for the order is due", "12-2": "The amount that was ultimately paid for the order", "13-2": "The current state of the order", "14-2": "A unique identifier for the transaction (actual cash transfer)", "15-2": "", "16-2": "When the loan was last modified" }, "cols": 3, "rows": 17 } [/block]