POST /cra/loans/update

/cra/loans/update updates loan information such as the status and payment history.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`client_id`	String	No	Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
`loans[]`	Array	Yes	A list of loans to update.
`loans[].status_history[]`	Array	No	A list of status update history of the loan.
`loans[].status_history[].status`	String	Yes	The status of the loan. Possible values: `"DEFAULT"` `"OTHER"` `"TRANSFERRED"` `"CURRENT"` `"PAID_OFF"` `"BOOKED"` `"CHARGED_OFF"` `"DECLINED"` `"APPROVED"` `"DELINQUENT"`
`loans[].status_history[].date`	String	Yes	The effective date for the status of the loan. The date should be in ISO 8601 format (YYYY-MM-DD).
`loans[].payment_history[]`	Array	No	The updates to the payment history for the loan.
`loans[].payment_history[].days_past_due`	Integer	Yes	The number of days the loan was delinquent at the end of the pay period. If specified, should be greater of equal to 0.
`loans[].payment_history[].balance_remaining`	Number	No	The balance remaining on the loan at the end of the payment period.
`loans[].payment_history[].amount_past_due`	Number	No	The amount past due or the charge-off amount of the loan at the end of the payment period.
`loans[].payment_history[].period`	Integer	Yes	The index to identify the loan's payment period, starting from 1. For example: 1 means the period between the loan's opening date and the 1st payment due date. 2 means the period between the loan's 1st payment due date and 2nd payment due date.
`loans[].payment_history[].due_date`	String	Yes	The payment due date or end date of the payment period. The date should be in ISO 8601 format (YYYY-MM-DD).
`loans[].loan_id`	String	No	A unique identifier for the loan. Personally identifiable information, such as an email address or phone number, should not be used in the `loan_id`.
`secret`	String	No	Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.