Update account policies

Update account level policies for the provided account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the Account

Body Params

Update account level policies to specified values.

string

Identifier for external card processor service.

number

Total Amount (in cents) that this account can borrow.

string

The payout_entity_id for this payout entity (typically a lender). The ID provided must also be linked to the account.

number

Any number as a percentage (e.g. 5=> 5%). This is the maximum late fee that can be charged in this account: as determined by late_fee_cap_percent * minimum payment. Note: The minimum payment, in this case is the due payment obligation for the date of the late fee that was not paid on time; this may differ from the minimum payment on the most recent statement. For example - if the borrower made a payment that reduced the minimum payment from the statement, but a reversal of that payment resulted in an increase to the borrower's payment obligation, the increases in min pay due to the reversal are included in the balance over which the cap is calculated.

number

The fee charged for late payments on the account.

number

Informational. Pre-approved maximum amount a CSR can increase the account's credit_limit_cents to.

number

Defaults to 100. The percent of outstanding balances in the cycle used to determine the minimum payment. Used alongside PERCENT_INTEREST, PERCENT_PRINCIPAL, and PERCENT_PRINCIPAL_INTEREST min_pay_types.

number

Any number as a percentage (e.g. 5=> 5%). This is the maximum reversal fee that can be charged in this account, as determined by payment_reversal_fee_cap_percent * account principal as if the payment never occurred (as opposed to after the payment but before it's reversed)

number

The fee charged for payment reversals on the account.

boolean

Indicates whether pending payments affect available credit.

number

If provided, the min_pay in the promo period will be set to this value whenever this value exceeds the calculated min_pay using promo_min_pay_type. *Note: if the account's total balance is less than promo_min_pay_floor, only the total balance will be due.

external_fields
object

A JSON object used to connect entities created in Canopy to data in your system and any connected external systems.

string
enum

Current due calculation method

Responses

401

Unauthorized.

403

Forbidden.

422

Invalid input

429

Too many requests.

default

Unexpected Error.

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json