Update account status and substatus

PUT /accounts/{account_id}/status

Update account status and substatus for the provided account.

Path parameters

Body

Update account status and substatus to specified values

  • account_status string Required

    Account status

    Values are ACTIVE, CLOSED, or SUSPENDED.

  • account_substatus string

    Account substatus

    Values are , ADMINISTRATIVE, INACTIVITY, INELIGIBLE, DELINQUENT, CHARGE_OFF, GRANTOR_REQUEST, BANKRUPTCY, PAID_OFF, CUSTOMER_REQUEST_PENDING_PAYOFF, GRANTOR_REQUEST_PENDING_PAYOFF, DECEASED, RISK_REVIEW, FRAUD, CUSTOMER_REQUEST, RISK, HARDSHIP/EXEMPTIONS, or SETTLEMENT. Default value is empty.

Responses

  • • 200 object

    Successful query of information for a specific account

    • account_id string Required

      This is the ID used to identify the account in your system. For most use-cases, we strongly recommend using the ID from the system the account 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 account that is used to refer to the borrower for all subsequent requests. Note: both strings and integers are accepted.

    • created_at string(date-time)

      The Date-Time which the account was created in the API.

    • updated_at string(date-time)

      The Date-Time which the account was updated in the API.

    • effective_at string(date-time)

      The Date-Time that this account became/becomes active.

    • account_overview object
      • account_status string Required

        The Status of the Account. Active upon account creation.

        Values are ACTIVE, SUSPENDED, or CLOSED. Default value is ACTIVE.

      • account_status_subtype string | null

        The subtype of the Status of the Account. Null upon account creation.

        Values are , ADMINISTRATIVE, INACTIVITY, INELIGIBLE, DELINQUENT, CHARGE_OFF, GRANTOR_REQUEST, BANKRUPTCY, PAID_OFF, SURPLUS_BALANCE, CUSTOMER_REQUEST_PENDING_PAYOFF, GRANTOR_REQUEST_PENDING_PAYOFF, DECEASED, RISK_REVIEW, FRAUD, CUSTOMER_REQUEST, RISK, HARDSHIP/EXEMPTIONS, or SETTLEMENT. Default value is empty.

      • is_active_scra boolean

        Denotes whether an account has active SCRA benefits

    • account_product object

      The product associated with the account.

      • product_id string Required

        The Canopy-generated ID for the product.

      • product_overview object
        • product_name string Required

          Name of Product, i.e. Express Card.

        • product_color string

          A color to be associated with the product for UI purposes.

          Default value is #4867FF.

        • product_short_description string | null

          Short description of the Product - max of 30 characters.

        • product_long_description string | null Required

          Description of the Product.

        • product_time_zone string

          Timezone denoted as an Olson-style timezone defining the timezone for the product. All times in any response data for accounts using this product will be denominated in this timezone. Shifts due to daylight savings will be accounted for where relevant, and all output timestamps will be denoted as UTC offsets normalized based on this value.

          Default value is America/New_York.

        • product_type string Required

          The Type of Product. If not included, defaults to REVOLVING

      • product_lifecycle object
        • late_fee_impl_cents integer Required

          The fee charged for late payments on the account.

          Default value is 0.

        • default_product_late_fee_cents integer

          Default late fee described by the account's product. This value will be overridden by 'late_fee_impl_cents` for determining fee amounts

        • payment_reversal_fee_impl_cents integer Required

          The fee charged for payment reversals on the account.

          Default value is 0.

        • default_product_payment_reversal_fee_cents integer

          Default payment reversal fee described by the account's product. This value will be overridden by payment_reversal_fee_impl_cents for determining fee amounts.

        • origination_fee_impl_cents integer

          The fee charged at the time of account origination.

          Default value is 0.

        • origination_fee_percent number

          The fee as a percent of initial_principal_cents charged at the time of account origination.

          Default value is 0.

        • is_origination_fee_lesser_value boolean

          If TRUE, the origination fee will be asessed as the lesser value of origination_fee_cents and origination_fee_percent, otherwise will default to greater of two.

          Default value is false.

        • is_origination_fee_amortized boolean

          Indicates whether the origination fee is amortized.

          Default value is false.

        • annual_fee_impl_cents integer Deprecated

          DEPRECATED - use recurring_fees instead.
          An annual fee to be charged yearly on December 31.

          Default value is 0.

        • monthly_fee_impl_cents integer Deprecated

          DEPRECATED - use recurring_fees instead.
          A monthly fee to be charged monthly from the date of account creation. It will reflect on the subsequent statement once incurred.

          Default value is 0.

        • recurring_fees array[object] | null

          Configuration for a fee to be charged recurrently from the date of account effective_at

          Not more than 1000 elements.

          • recurring_fee_interval string Required

            Frequency at which this fee will be charged to the account

          • recurring_fee_amount_cents integer Required

            Amount that will be charged from the account as a fee on a frequency defined by cycle_fee_interval (in cents)

            Default value is 0.

          • initial_delay_offset string

            Interval that defines the delay until the first recurring fee cycle starts from the moment the account was created

          • is_fee_interval_floored boolean

            Flag that when true, configures the scheduling of the fee line item at the end of the previous nearest interval unit.
            If recurring_fee_interval is 1 month, the first fee will be scheduled at the end of the current month. If recurring_fee_interval is 1 year, the fee line item will be scheduled at the end of this current year.
            Otherwise, no flooring will be applied to the interval and fees will be scheduled at the end of the day prior to account_creation_time + recurring_fee_interval + initial_delay_offset.
            Defaults to TRUE.

            Default value is true.

          • recurring_fee_label string

            Customer-configurable label to be displayed for this fee configuration

        • loan_end_date string(date-time) | null

          If applicable, the account's loan repayment date.

      • promo_overview object
        • promo_purchase_window_inclusive_start string(date-time) | null

          If applicable, the start date for a purchase window for the account

        • promo_purchase_window_exclusive_end string(date-time) | null

          If applicable, the end date for a purchase window for the account

        • promo_inclusive_start string(date-time) | null

          If applicable, the start date for a promotional period for the account.

        • promo_exclusive_end string(date-time) | null

          If applicable, the start date for a promotional period for the account.

        • promo_impl_interest_rate_percent number

          The percentage interest applied to the account during the promotional period (i.e. 6.2%)

          Default value is 0.

        • default_product_promo_interest_rate number

          Default interest rate described by the account's product (i.e. 6.2%). This value will be overridden by promo_impl_interest_rate_percent for determining interest rate.

        • promo_len integer

          Defaults to 0. The number of billing cycles from account origination during which accounts on this product are on a promotional period.

        • default_product_promo_len number

          Default promotional length described by the account's product. This will be overridden by promo_len for determining length of the promotional period.

      • post_promo_overview object
        • post_promo_inclusive_start string(date-time) | null

          If applicable, the start date for a promotional period for the account.

        • post_promo_exclusive_end string(date-time) | null

          If applicable, the start date for a promotional period for the account.

        • post_promo_impl_interest_rate_percent number

          The percentage interest applied to the account during the post-promotional period (i.e. 6.2%)

          Default value is 0.

        • default_product_post_promo_interest_rate number

          Default interest rate described by the account's product (i.e. 6.2%). This value will be overridden by post_promo_impl_interest_rate_percent for determining interest rate for the account.

          Default value is 0.

        • post_promo_len integer

          If applicable, post-promotional amortization length in cycles.

          Default value is 0.

        • default_product_post_promo_len integer

          Default post promotional amortization length in cycles described by this account's product. This value will be overridden by post_promo_len to determine the post promotional length for this account.

      • product_duration_information object
        • promo_len integer

          The number of billing cycles from account origination during which accounts on this product are on a promotional period.

          Default value is 0.

        • promo_purchase_window_len integer

          If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.

          Default value is 0.

    • external_fields array[object]

      An Array of External Fields. These should be used to connect accounts created in Canopy to Users in your system and any connected external systems.

      Not more than 1000 elements.

      • key string

        key: i.e. Name of the External Party

      • value string

        value: i.e. External Account ID

    • min_pay_due_cents object
      • statement_min_pay_cents integer Required

        Total amount due for the billing cycle, summing cycle principal, interest, deferred interest, and fees outstanding.

        Default value is 0.

      • min_pay_cents integer

        Real time total amount due including payments and payment reversals made since the start of the billing cycle, summing cycle principal, interest, deferred interest, and fees outstanding.

        Default value is 0.

      • min_pay_due_at string(date-time)

        The Date-Time the payment for this billing cycle is due.

    • additional_min_pay_details object
      • min_pay_fees_cents integer

        Total fees due for the billing cycle accounting for payments since the billing cycle start.

        Default value is 0.

      • current_min_pay_cents integer | null

        Portion of the real-time minimum payment that comes from current cycle balances.

      • unpaid_min_pay_cents integer

        Portion of the real-time minimum payment that comes from unpaid balances.

        Default value is 0.

    • additional_statement_min_pay_details object
    • payment_processor_config object
      • ach object

        ACH processing configuration.

      • debit_card object

        Debit processing configuration.

      • credit_card object

        Credit processing configuration.

        • payment_processor_name string Required

          Indicates the active payment processor whose configuration will be used for Credit card payments made from the account.

          Values are NONE or CHECKOUT. Default value is NONE.

        • checkout_config object | null
          • source_id string

            A Checkout.com payment source id or customer id.

          • card_token string

            The tokenized card number.

          • last_four string | null

            The last 4 digits of the card number.

          • expires_on string | null

            Expiration time for the card token.

      • autopay_enabled boolean

        Indicates whether autopay is enabled for this account. Currently, autopay is triggered 1 day prior to a payment due date. If default_payment_processor is set to NONE, autopay will not be triggered for account regardless of this field's value.

        Default value is false.

      • autopay_configs object

        Governs the autopay policies to be applied

        • autopay_method string

          Defines the calculation method for autopay.

          Values are MIN_PAY, TOTAL_BALANCE, FIXED_AMOUNT, or REMAINING_STATEMENT_BALANCE. Default value is MIN_PAY.

        • autopay_fixed_amount_cents integer

          If using FIXED_AMOUNT autopay method, autopay_fixed_amount_cents defines the fixed amount of each autopayment.

      • default_payment_processor_method string

        Configures the payment processor to be used for manual or autopay payments. This cannot be set to a value different from NONE if no valid ACH or Debit Card configs are provided.

        Values are ACH, DEBIT_CARD, CREDIT_CARD, or NONE. Default value is NONE.

    • disbursements_config object
      • disbursement_source_payout_entity_id string

        The payout_entity_id for this payout entity (typically a lender).

      • disbursement_split_percentages object

        Provide a disbursement breakdown if draw downs from a borrower are meant to be distributed across multiple payout entities (lenders, merchants). Borrower payout breakdown. These numbers must add up to 100%. Borrower payout breakdowns will get reflected in daily reconciliation reports.

        • principal array[object]
          • payout_entity_id string

            The payout_entity_id for this payout entity.

          • split_percent number

            The percentage of borrower payouts towards principal to be allocated to this payout entity. Sum of splits for a borrower must = 100%.

    • payouts_config object
      • payout_split_percentages object
        • principal array[object] Required
          • payout_entity_id string Required

            The payout_entity_id of the payout_entity.

          • split_percent number Required

            The percentage of borrower payouts/disbursements to be allocated to this associated entity. Sum of splits for a borrower must = 100%. No decimals allowed.

        • interest array[object] Required
          • payout_entity_id string Required

            The payout_entity_id of the payout_entity.

          • split_percent number Required

            The percentage of borrower payouts/disbursements to be allocated to this associated entity. Sum of splits for a borrower must = 100%. No decimals allowed.

        • fee array[object] Required
          • payout_entity_id string Required

            The payout_entity_id of the payout_entity.

          • split_percent number Required

            The percentage of borrower payouts/disbursements to be allocated to this associated entity. Sum of splits for a borrower must = 100%. No decimals allowed.

    • issuer_processor_details object | null
      • lithic object
        • account_token string(uuid)

          The external unique identifier of the Lithic account against which charges are made.

      • galileo object
        • account_token string

          External unique identifier (PRN) used to reconcile events related to this account from Galileo

    • cycle_type object
      • first_cycle_interval string

        Interval for a first cycle for this account.

      • late_fee_grace string

        The amount of time after a payment is late after which you would like for a late fee to be incurred. If not provided, defaults to product's fee policy's late fee grace value

    • discounts object
    • summary object
      • total_balance_cents integer

        The total balance (in cents) associated with the account. This balance is comprised of the sum of the following six balance items.

      • principal_cents integer

        The total principal balance (in cents) associated with the account.

      • interest_balance_cents integer

        The total interest balance (in cents) associated with the account.

      • am_interest_balance_cents integer

        The total AM interest balance (in cents) associated with the account.

        Default value is 0.

      • deferred_interest_balance_cents integer

        The total deferred interest balance (in cents) associated with the account.

        Default value is 0.

      • am_deferred_interest_balance_cents integer

        The total AM deferred interest balance (in cents) associated with the account.

        Default value is 0.

      • fees_balance_cents integer

        The total fees balance (in cents) associated with the account.

        Default value is 0.

      • initial_principal_cents integer

        The initial principal balance (in cents) associated with the account.

      • total_paid_to_date_cents integer

        The total sum of payments made to date (in cents) associated with the account.

      • total_interest_paid_to_date_cents integer

        The total sum of interest allocations for payments made to date (in cents) associated with the account.

      • credit_limit_cents integer Required

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

      • max_approved_credit_limit_cents integer

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

        Default value is 0.

      • interest_rate_percent number

        The percentage interest applied to the account (i.e. 6.2 means 6.2%)

      • interest_accrual_interval string

        The interval at which interest accrues on the account. Ex: '1 day', '1 week', '2 weeks', '1 month' .Defaults to the product interest_accrual_interval if not specified

      • interest_grace_method string

        The policy that defines how grace periods are mathematically applied to borrower accounts based on borrower repayment behavior.

        Values are NONE or PREVIOUS_STATEMENT_TOTAL_BALANCE_WITH_PENDING_PAYMENTS. Default value is NONE.

      • available_credit_cents integer

        The total available credit balance (in cents) for the account.

        Default value is 0.

      • open_to_buy_cents integer

        If applicable, the total amount of available funds for continued purchase following a purchase window pattern, where payments made do not replenish amount available for purchase.

        Default value is 0.

      • total_payoff_cents integer

        The total amount needed to pay off the loan at this exact moment.

        Default value is 0.

      • pending_am_interest_balance_cents integer

        If applicable, the pending AM interest balance (in cents) which will accrue on this account at the end of the cycle, otherwise 0. Only applicable when this account's product has an interest policy for installment_interest_applicable_balance configured as AVERAGE.

        Default value is 0.

      • late_fee_cap_percent 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.

      • payment_reversal_fee_cap_percent 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)

    • associated_entities object | null

      (to be depricated) -- use payout_entities instead to provide more granular detail.

    • plaid_config object

      Plaid configurations.

      • plaid_access_token object
        • valid_config boolean Required

          Indicates whether Canopy has a valid Plaid access token.

      • plaid_account_id object
        • valid_config boolean Required

          Indicates whether Canopy has a valid Plaid account ID.

      • check_balance_enabled boolean

        Indicates whether the balance check functionality is enabled with along side the payment processing. If set to true, the payment processing is enabled and the plaid access token and plaid account ID are valid, actions such as notifications etc. will be triggered.

        Default value is false.

    • payout_entities array[object] | null

      An array of payout entities assigned to the account

      Not more than 1000 elements.

      • payout_entity_id string Required

        The ID to be associated with the payout entity for future requests. If not provided on payout entity creation, Canopy will generate this field.

      • payout_entity_type string

        Type of associated entity

        Values are merchant, lender, sponsor, organization, or clearing.

      • payout_entity_name string

        Entity's name.

      • external_fields array[object]

        An Array of External Fields. These should be used to connect entities created in Canopy to data in your system and any connected external systems.

        Not more than 1000 elements.

        • key string

          key: i.e. Name of the External Party

        • value string

          value: i.e. External Account ID

      • parent_payout_entity_id string | null

        A Canopy-generated ID for the parent of this associated entity to establish a parent-child relationship.

      • bank_account_number string

        Account number of the bank account for payment distributions.

      • bank_routing_number string

        Routing number of the bank account for payment distributions.

      • bank_account_type string

        The type of bank account being stored for the payout entity.

        Values are CHECKING, SAVINGS, or GL.

      • company_identification string | null

        The Depository Financial Institution (DFI) ID of the entity.

      • irs_tin string | null

        The IRS tax identification number of the entity.

    • cards array[object] | null

      Card data. Field names match the ones in Lithic's card schema

      • spend_limit integer | null

        Spending limit of card (in cents). If not provided, spending is still subject to the spend limit set at the issuer processor account (if any).

        Minimum value is 1.

      • lithic object
        • token string(uuid)

          Unique external identifier for the card

        • card_program_token string(uuid)

          Token belonging to the card program under which to create the card.

        • last_four string

          Last four digits of the card

        • type string

          The type of card being returned

          Values are UNLOCKED, MERCHANT_LOCKED, or SINGLE_USE.

        • state string

          The current state of the card

          Values are OPEN, PAUSED, or CLOSED.

        • memo string

          Friendly name to identify the card

    • customers array[object | null] | null Required

      Passport information. required if country is not US

      Not more than 1000 elements.

      • address_line_one string Required

        Address line one.

      • address_line_two string

        Address line two.

      • address_city string Required

        Address city.

      • address_state string Required

        Address state.

      • address_zip string Required

        Five digit zipcode or nine digit 'ZIP+4'.

      • address_country_code string

        ISO 3166-1 alpha-2 country code for the customer.

        Values are US, GB, CA, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AN, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, or ZW.

      • name_prefix string

        Prefix to the customer's name.

      • name_first string

        Customer's first name.

      • name_middle string

        Customer's middle name.

      • name_last string

        Customer's last name.

      • name_suffix string

        Suffix to the customer's name.

      • passport object
        • number string Required

          Number on the passport

        • country string Required

          ISO 3166-1 Two letter code for the issuing country

      • customer_id string Required

        An ID for the customer.

      • created_at string(date-time)

        The Date-Time which the customer was created in the API.

      • updated_at string(date-time)

        The Date-Time which the customer was updated in the API.

      • is_borrower_portal_user boolean

        Indicates whether the customer has a borrower portal login or not

      • customer_type string

        The customer can be either a person or a business. This is used to explicitly set that and adjust behavior such as validation.

        Values are person or business.

      • is_active boolean

        Value manually maintained - defaults to true."False" generally indicates no additional credit should be granted to this customer

      • verification_status string

        The verification status of this customer. The default is 'unverified'. Depending on the system's configuration verification with third parties will happen and the status will be updated based on the result.

        Values are unverified, verified, retry, or document.

      • title string

        Title of the customer if a person OR title of the admin if a business

      • phone_number string

        Customer's phone number in E.164 format

      • ssn string

        Social security number of the customer.

      • international_customer_id string

        Any country-specific unique identifier for the customer.

      • email string(email)

        The email address of this Customer

      • date_of_birth string(date)

        Customer's date of birth in ISO 8601 format

      • customer_balances object
        • num_active_accounts integer

          The number of active accounts for this customer.

        • total_balance_cents integer

          The total outstanding balance (in cents) associated with all active accounts for this customer. This balance is comprised of the sum of the following six balance items.

        • principal_cents integer

          The total principal balance (in cents) associated with all active accounts for this customer.

        • interest_balance_cents integer

          The total interest balance (in cents) associated with all active accounts for this customer.

        • am_interest_balance_cents integer

          The total AM interest balance (in cents) associated with all active accounts for this customer.

          Default value is 0.

        • deferred_interest_balance_cents integer

          The total deferred interest balance (in cents) associated with all active accounts for this customer.

          Default value is 0.

        • am_deferred_interest_balance_cents integer

          The total AM deferred interest balance (in cents) associated with all active accounts for this customer.

          Default value is 0.

        • fees_balance_cents integer

          The total fees balance (in cents) associated with all active accounts for this customer.

          Default value is 0.

      • business_details object
        • business_legal_name string

          The legal name of the Business

        • doing_business_as string

          The DBA name of the Business

        • business_ein string

          EIN of the business, expected format in NN-NNNNNNN.

        • business_type string

          Type of business is used in determining the appropriate validation.

          Values are sole_proprietorship, llc, unincorporated_association, trust, corporation, corporation_public, non_profile, or partnership.

        • business_classification_id string

          UUID that references the business classification. This will eventually be supported by a reference api, however, for now refer to dwolla's specific UUID.

        • website string

          URL for the buesiness's website. This should be publicly resolvable

        • controller object | null

          Passport information. required if country is not US

          • address_line_one string Required

            Address line one.

          • address_line_two string

            Address line two.

          • address_city string Required

            Address city.

          • address_state string Required

            Address state.

          • address_zip string Required

            Five digit zipcode or nine digit 'ZIP+4'.

          • address_country_code string

            ISO 3166-1 alpha-2 country code for the customer.

            Values are US, GB, CA, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AN, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, or ZW.

          • name_prefix string

            Prefix to the customer's name.

          • name_first string

            Customer's first name.

          • name_middle string

            Customer's middle name.

          • name_last string

            Customer's last name.

          • name_suffix string

            Suffix to the customer's name.

          • passport object
            • number string Required

              Number on the passport

            • country string Required

              ISO 3166-1 Two letter code for the issuing country

          • title string

            Title of the customer if a person OR title of the admin if a business

          • phone_number string

            Customer's phone number in E.164 format.

          • ssn string

            Social security number of the customer.

      • metro2_config object

        Metro2 credit reporting configs

    • partner_entity object

      Information about additional third-parties related to the finance request.

    • metro2_config object

      Metro2 credit reporting configs

  • • 401

    Unauthorized.

  • • 403

    Forbidden.

  • • 422

    Invalid input

  • • 429

    Too many requests.

  • • default

    Unexpected Error.

PUT /accounts/{account_id}/status 
curl \
 -X PUT https://<your_environment_name>-uat-api.canopyservicing.com/accounts/can_52322/status \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"account_status":"SUSPENDED","account_substatus":"BANKRUPTCY"}'
Request example 
{
  "account_status": "SUSPENDED",
  "account_substatus": "BANKRUPTCY"
}
Response example (200) 
{
  "account_id": "31mNprzLd2bKl6koVna68ARM",
  "created_at": "2017-06-20T09:12:14+00:00",
  "updated_at": "2019-02-20T09:12:14+00:00",
  "effective_at": "2018-03-20T09:12:28+00:00",
  "account_overview": {
    "account_status": "SUSPENDED",
    "account_status_subtype": "BANKRUPTCY",
    "is_active_scra": "false"
  },
  "account_product": {
    "product_id": "prod_4p1sc",
    "product_overview": {
      "product_name": "Blue Cash Express",
      "product_color": "#0000FF",
      "product_short_description": "Consumer credit card",
      "product_long_description": "Student credit card.",
      "product_time_zone": "America/Chicago",
      "product_type": "REVOLVING"
    },
    "product_lifecycle": {
      "late_fee_impl_cents": 2900,
      "default_product_late_fee_cents": 2900,
      "payment_reversal_fee_impl_cents": 2900,
      "default_product_payment_reversal_fee_cents": 2900,
      "origination_fee_impl_cents": 2000,
      "origination_fee_percent": 12.34,
      "is_origination_fee_lesser_value": false,
      "is_origination_fee_amortized": false,
      "annual_fee_impl_cents": 1000,
      "monthly_fee_impl_cents": 500,
      "recurring_fees": [
        {
          "recurring_fee_interval": "1 month",
          "recurring_fee_amount_cents": 10000,
          "initial_delay_offset": "12 days",
          "is_fee_interval_floored": false,
          "recurring_fee_label": "Quarterly Fee"
        }
      ],
      "loan_end_date": "2013-01-13T05:25:13.813+00:00"
    },
    "promo_overview": {
      "promo_purchase_window_inclusive_start": "2013-01-13T05:25:13.813+00:00",
      "promo_purchase_window_exclusive_end": "2013-01-13T05:25:13.813+00:00",
      "promo_inclusive_start": "2013-01-13T05:25:13.813+00:00",
      "promo_exclusive_end": "2013-01-13T05:25:13.813+00:00",
      "promo_impl_interest_rate_percent": 6.2,
      "default_product_promo_interest_rate": 6.2,
      "promo_len": 6,
      "default_product_promo_len": 6
    },
    "post_promo_overview": {
      "post_promo_inclusive_start": "2013-01-13T05:25:13.813+00:00",
      "post_promo_exclusive_end": "2013-01-13T05:25:13.813+00:00",
      "post_promo_impl_interest_rate_percent": 6.2,
      "default_product_post_promo_interest_rate": 6.2,
      "post_promo_len": 48,
      "default_product_post_promo_len": 48
    },
    "product_duration_information": {
      "promo_len": 6,
      "promo_purchase_window_len": 5
    }
  },
  "external_fields": [
    {
      "key": "Umbrella Corporation",
      "value": "22445702-a389-431f-927d-07b8d0750787"
    }
  ],
  "min_pay_due_cents": {
    "statement_min_pay_cents": 160000,
    "min_pay_cents": 160000,
    "min_pay_due_at": "2019-10-18T23:04:48.321+00:00"
  },
  "additional_min_pay_details": {
    "min_pay_fees_cents": 20000,
    "current_min_pay_cents": 400000,
    "unpaid_min_pay_cents": 400000
  },
  "additional_statement_min_pay_details": {
    "statement_min_pay_charges_principal_cents": 100000,
    "statement_min_pay_interest_cents": 30000,
    "statement_min_pay_am_interest_cents": 200,
    "statement_min_pay_deferred_cents": 10000,
    "statement_min_pay_am_deferred_interest_cents": 200,
    "statement_min_pay_fees_cents": 20000,
    "statement_payments_cents": 20000,
    "previous_statement_min_pay_cents": 400000,
    "statement_current_min_pay_cents": 400000,
    "statement_unpaid_min_pay_cents": 400000
  },
  "payment_processor_config": {
    "ach": {
      "payment_processor_name": "REPAY",
      "repay_config": {
        "ach_token": "string",
        "last_four": "string"
      },
      "dwolla_config": {
        "ach_token": "string",
        "last_four": "string"
      },
      "modern_treasury_config": {
        "ach_token": "string",
        "last_four": "string"
      },
      "canopy_nacha_config": {
        "bank_routing_number": "999999992",
        "bank_account_number": "987654321",
        "bank_account_type": "CHECKING"
      },
      "stripe_config": {
        "customer_id": "cus_4QE4bx4C5BVSrC",
        "source_id": "string",
        "external_fields": {}
      },
      "galileo_config": {
        "plaid_processor_token": "processor-production-35cd43b-adfc-d8aa-b331-c9ba0fdha881"
      }
    },
    "debit_card": {
      "payment_processor_name": "REPAY",
      "repay_config": {
        "card_token": "string",
        "last_four": "string"
      },
      "authorize_net_config": {
        "customer_profile_id": "527262",
        "customer_payment_profile_ids": [
          "86"
        ]
      }
    },
    "credit_card": {
      "payment_processor_name": "CHECKOUT",
      "checkout_config": {
        "source_id": "cus_6artgoevd77u7ojah2wled32s",
        "card_token": "string",
        "last_four": "string",
        "expires_on": "string"
      }
    },
    "autopay_enabled": true,
    "autopay_configs": {
      "autopay_method": "TOTAL_BALANCE",
      "autopay_fixed_amount_cents": 2500
    },
    "default_payment_processor_method": "ACH"
  },
  "disbursements_config": {
    "disbursement_source_payout_entity_id": 1009,
    "disbursement_split_percentages": {
      "principal": [
        {
          "payout_entity_id": 1009,
          "split_percent": 25
        }
      ]
    }
  },
  "payouts_config": {
    "payout_split_percentages": {
      "principal": [
        {
          "payout_entity_id": 1009,
          "split_percent": 25
        }
      ],
      "interest": [
        {
          "payout_entity_id": 1009,
          "split_percent": 25
        }
      ],
      "fee": [
        {
          "payout_entity_id": 1009,
          "split_percent": 25
        }
      ]
    }
  },
  "issuer_processor_details": {
    "lithic": {
      "account_token": "349e2031-20de-40c6-87a3-214895077522"
    },
    "galileo": {
      "account_token": "406101000684"
    }
  },
  "cycle_type": {
    "first_cycle_interval": "11 days",
    "late_fee_grace": "2 days"
  },
  "discounts": {
    "prepayment_discount_config": {
      "loan_discount_cents": 800000,
      "loan_discount_at": "2018-03-20T09:12:28+00:00"
    }
  },
  "summary": {
    "total_balance_cents": 300000,
    "principal_cents": 200000,
    "interest_balance_cents": 60000,
    "am_interest_balance_cents": 0,
    "deferred_interest_balance_cents": 40000,
    "am_deferred_interest_balance_cents": 0,
    "fees_balance_cents": 0,
    "initial_principal_cents": 200000,
    "total_paid_to_date_cents": 40000,
    "total_interest_paid_to_date_cents": 10000,
    "credit_limit_cents": 400000,
    "max_approved_credit_limit_cents": 400000,
    "interest_rate_percent": 3,
    "interest_accrual_interval": "1 day",
    "interest_grace_method": "NONE",
    "available_credit_cents": 100000,
    "open_to_buy_cents": 5000,
    "total_payoff_cents": 900000,
    "pending_am_interest_balance_cents": 900000,
    "late_fee_cap_percent": 12.5,
    "payment_reversal_fee_cap_percent": 6.2
  },
  "associated_entities": {
    "merchant_name": "Acme Corporation",
    "lender_name": "Globex Lending Corp"
  },
  "plaid_config": {
    "plaid_access_token": {
      "valid_config": true
    },
    "plaid_account_id": {
      "valid_config": true
    },
    "check_balance_enabled": true
  },
  "payout_entities": [
    {
      "payout_entity_id": "0x1234",
      "payout_entity_type": "lender",
      "payout_entity_name": "Wonka Industries",
      "external_fields": [
        {
          "key": "Umbrella Corporation",
          "value": "22445702-a389-431f-927d-07b8d0750787"
        }
      ],
      "parent_payout_entity_id": "31mNprzLd2bKl6koVna68ARM",
      "bank_account_number": "1001001234",
      "bank_routing_number": "012345678",
      "bank_account_type": "CHECKING",
      "company_identification": "X000100393",
      "irs_tin": "203456789"
    }
  ],
  "cards": [
    {
      "spend_limit": 8000000,
      "lithic": {
        "token": "adccd28d-532e-480b-a063-a46a77a15570",
        "card_program_token": "a5e38341-cc95-4a9b-a21c-751aeca67e9c",
        "last_four": "0339",
        "type": "UNLOCKED",
        "state": "OPEN",
        "memo": "Conference Event Card"
      }
    }
  ],
  "customers": [
    {
      "address_line_one": "12 Strawberry Road",
      "address_line_two": "Suite 101",
      "address_city": "Atlanta",
      "address_state": "GA",
      "address_zip": "99999-1000",
      "address_country_code": "US",
      "name_prefix": "Dr.",
      "name_first": "Miriam",
      "name_middle": "Louise",
      "name_last": "Trevino",
      "name_suffix": "Jr",
      "passport": {
        "number": "string",
        "country": "JP"
      },
      "customer_id": "31mNprzLd2bKl6koVna68ARM",
      "created_at": "2017-06-20T09:12:14+00:00",
      "updated_at": "2019-02-20T09:12:14+00:00",
      "is_borrower_portal_user": true,
      "customer_type": "person",
      "is_active": true,
      "verification_status": "verified",
      "title": "CFO",
      "phone_number": "+14105556789",
      "ssn": "888888888",
      "international_customer_id": "9999999999",
      "email": "marissa@protonmail.com",
      "date_of_birth": "1985-06-20",
      "customer_balances": {
        "num_active_accounts": 2,
        "total_balance_cents": 300000,
        "principal_cents": 200000,
        "interest_balance_cents": 60000,
        "am_interest_balance_cents": 0,
        "deferred_interest_balance_cents": 40000,
        "am_deferred_interest_balance_cents": 0,
        "fees_balance_cents": 0
      },
      "business_details": {
        "business_legal_name": "Umbrella Corporation",
        "doing_business_as": "Umbrella",
        "business_ein": "888-888888",
        "business_type": "llc",
        "business_classification_id": "794D9D5E-B547-4B3B-8289-76484C1AFC5F",
        "website": "https://example.com",
        "controller": {
          "address_line_one": "12 Strawberry Road",
          "address_line_two": "Suite 101",
          "address_city": "Atlanta",
          "address_state": "GA",
          "address_zip": "99999-1000",
          "address_country_code": "US",
          "name_prefix": "Dr.",
          "name_first": "Miriam",
          "name_middle": "Louise",
          "name_last": "Trevino",
          "name_suffix": "Jr",
          "passport": {
            "number": "string",
            "country": "JP"
          },
          "title": "CFO",
          "phone_number": "+14105556789",
          "ssn": "888888888"
        }
      },
      "metro2_config": {
        "bloom_metadata": {
          "address_type": "CONFIRMED",
          "residence_type": "OWNS",
          "account_designations": [
            {
              "account_id": "string",
              "designation": "INDIVIDUAL"
            }
          ]
        }
      }
    }
  ],
  "partner_entity": {},
  "metro2_config": {
    "bloom_metadata": {
      "branch_identifier": "string",
      "customer_designations": [
        {
          "customer_id": "string",
          "designation": "INDIVIDUAL"
        }
      ]
    }
  }
}