Create a new finance request
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Create a Finance Request for account origination processes.
finance_request_id
string
This is the ID used to identify the finance request in your system. For most use-cases, we strongly recommend using the ID from the system the request was originally created in -- for most use-cases, this is created as part of the origination system that approves a borrower. This will be the id that is used to refer to the finance request and account that is created from the finance request. Note: both strings and integers are accepted.
customer_id
string
required
The ID of the existing customer this finance request is on behalf of.
product_id
string
required
The ID of the existing product for which this finance request will be created.
external_fields
object | null
A JSON object of External Fields. These should be used to provide any additional user inputted static data to Canopy to associate with the finance request.
notes
array of strings
length ≤ 100
Any notes to attach to the finance request.
requested_conversion_at
date-time
The Date-Time that the borrower requests the account become active.
partner_entity_id
integer
ID of the partner entity to be used for this finance request
create_account_details
object
Response Codes
| Code | Description |
|---|---|
200 |
Successful query of a finance request |
401 |
Unauthorized. |
403 |
Forbidden. |
422 |
Invalid input |
429 |
Too many requests. |
default |
Unexpected Error. |
{
"create_account_details": {
"summary": {
"origination_fee_cents": 0,
"origination_fee_percent": 0,
"is_origination_fee_lesser_value": false,
"is_origination_fee_amortized": false,
"annual_fee_cents": 0,
"monthly_fee_cents": 0,
"initial_principal_cents": 0
}
}
}
curl --request POST \
--url https://contact/%20sales%20to%20enable%20your%20sandbox/finance_requests \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '...'