Update an existing finance request

put

https://Contact sales to enable your sandbox/finance_requests/{finance_request_id}

Updates an existing finance request with data specified in the payload.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

finance_request_id

string

required

ID of the Finance Request

Body Params

Update an existing Finance Request for account origination processes.

external_fields

object | null

A JSON object of External Fields. These should be used to provide any additional static data to Canopy to associate with the finance request.

notes

array of strings

length ≤ 100

Any notes to attach to the finance request

notes

requested_conversion_at

date-time

The Date-Time that the borrower requests the account become active.

finance_request_status

string

enum

The status of the finance request. Note: REJECTED and VOID are final-state statuses and modifications to a finance request are disallowed once in these states. CONVERTED is a special final-state status which triggers the creation of the account and cannot be triggered from this endpoint.

Allowed:

partner_entity_id

integer

ID of the partner entity to be used for this finance request

create_account_details

object

Responses

401

Unauthorized.

403

Forbidden.

422

Invalid input

429

Too many requests.

default

Unexpected Error.

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful query of a finance request