Canopy API - Latest

Create a new finance request

POST /finance_requests

Creates a finance request which will get converted to an account upon outlay.

Body

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.
- Additional properties are allowed
notes array[string]

Any notes to attach to the finance request.

Not more than 100 elements.
requested_conversion_at string(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
- summary object
  credit_limit_cents integer
  
  Total amount (in cents) that this account can borrow.
  
  max_approved_credit_limit_cents integer
  
  Total amount (in cents) that this account can borrow.
  
  late_fee_cents integer
  
  The fee charged for late payments on the account.
  
  payment_reversal_fee_cents integer
  
  The fee charged for payment reversals on the account.
  
  origination_fee_cents integer
  
  The fee charged at the time of loan origination
  
  Default value is 0.
  
  origination_fee_percent number
  
  The fee as a percent of initial_principal_cents charged at the time of loan origination
  
  Default value is 0.
  
  is_origination_fee_lesser_value boolean
  
  If this flag is false, the default, the origination fee will be assessed as the greater value of origination_fee_cents and origination_fee_percent / 100 * initial_principal_cents. If this flag is true, not the default, the origination fee will be assessed as the lesser value of origination_fee_cents and origination_fee_percent / 100 * initial_principal_cents.
  
  Default value is false.
  
  is_origination_fee_amortized boolean
  
  If this flag is false, the default, then the origination fee will come due with the first statement. If the flag is true, not the default, the origination fee will amortize as a part of the loan creation process and the fee will be split into equal payments across the life of the loan.
  
  Default value is false.
  
  annual_fee_cents integer Deprecated
  
  DEPRECATED - use recurring_fees instead.
  An annual fee to be charged yearly on December 31.
  
  Default value is 0.
  
  monthly_fee_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
  
  initial_principal_cents integer | null
  
  The initial principal balance (in cents) for the account.
  
  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)
- post_promo_overview object
  post_promo_impl_interest_rate_percent number
  
  The percentage interest applied to the account during the post-promotional period (e.g. 6.2). If not provide, will default to associated product's post_promo_default_interest_rate_percent value.
  
  post_promo_len integer
  
  If applicable, post-promotional amortization length in cycles.
Additional properties are NOT allowed

Responses

• 200 object

Successful query of a finance request
- 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
  
  The ID of the existing customer this finance request is on behalf of.
- product_id string
  
  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 static data to Canopy to associate with the finance request.
  Additional properties are allowed
- notes array[string]
  
  Any notes to attach to the finance request
  
  Not more than 100 elements.
- requested_conversion_at string(date-time)
  
  The Date-Time that the borrower requests the account become active.
- created_at string(date-time)
  
  The Date-Time that this finance request was created.
- updated_at string(date-time)
  
  The Date-Time that this finance request was last updated.
- conversion_at string(date-time)
  
  The Date-Time at which this finance request is converted into an account.
- finance_request_status string
  
  The status of the finance request. Note: CONVERTED is a special final-state status which triggers the creation of the account. REJECTED and VOID are also final-state statuses.
  
  Values are PENDING, IN_REVIEW, APPROVED, CONVERTED, REJECTED, or VOID. Default value is PENDING.
- account_id string
  
  The ID of the account that has been created using this finance request. This will only be populated when the finance request has reached the terminal status of OUTLAYED.
- partner_entity object
  
  Information about additional third-parties related to the finance request.
  Additional properties are allowed
- create_account_details object
  summary object
  
  credit_limit_cents integer
  
  Total amount (in cents) that this account can borrow.
  
  max_approved_credit_limit_cents integer
  
  Total amount (in cents) that this account can borrow.
  
  late_fee_cents integer
  
  The fee charged for late payments on the account.
  
  payment_reversal_fee_cents integer
  
  The fee charged for payment reversals on the account.
  
  origination_fee_cents integer
  
  The fee charged at the time of loan origination
  
  Default value is 0.
  
  origination_fee_percent number
  
  The fee as a percent of initial_principal_cents charged at the time of loan origination
  
  Default value is 0.
  
  is_origination_fee_lesser_value boolean
  
  If this flag is false, the default, the origination fee will be assessed as the greater value of origination_fee_cents and origination_fee_percent / 100 * initial_principal_cents. If this flag is true, not the default, the origination fee will be assessed as the lesser value of origination_fee_cents and origination_fee_percent / 100 * initial_principal_cents.
  
  Default value is false.
  
  is_origination_fee_amortized boolean
  
  If this flag is false, the default, then the origination fee will come due with the first statement. If the flag is true, not the default, the origination fee will amortize as a part of the loan creation process and the fee will be split into equal payments across the life of the loan.
  
  Default value is false.
  
  annual_fee_cents integer Deprecated
  
  DEPRECATED - use recurring_fees instead.
  An annual fee to be charged yearly on December 31.
  
  Default value is 0.
  
  monthly_fee_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
  
  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
  
  initial_principal_cents integer | null
  
  The initial principal balance (in cents) for the account.
  
  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)
  
  post_promo_overview object
  
  post_promo_impl_interest_rate_percent number
  
  The percentage interest applied to the account during the post-promotional period (e.g. 6.2). If not provide, will default to associated product's post_promo_default_interest_rate_percent value.
  
  post_promo_len integer
  
  If applicable, post-promotional amortization length in cycles.
- product object
  product_id string Required
  
  A unique ID to identify the product with for future requests. If not provided at the time of product creation, Canopy will generate one.
  
  created_at string(date-time)
  
  The Date-Time that this product was created on the server.
  
  updated_at string(date-time)
  
  The Date-Time that this product was updated on the server.
  
  effective_at string(date-time)
  
  The Date-Time as of which this product is effective on the server.
  
  is_active boolean
  
  Indicates whether the product is active or inactive
  
  product_overview object Required
  
  A series of static fields about the product.
  
  product_name string Required
  
  Name of Product, i.e. Express Card.
  
  product_type string Required
  
  The Type of Product
  
  product_short_description string | null
  
  A short description of the product ranging from 0 - 60 characters.
  
  product_long_description string | null Required
  
  Description of the Product ranging from 0 - 1000.
  
  product_color string
  
  A color to be associated with the product for UI purposes.
  
  Default value is #4867FF.
  
  external_fields array[object] | null
  
  Not more than 1000 elements.
  
  key string
  
  value string
  
  product_lifecycle_policies object Required
  
  payment_due_policies object
  
  The set of policies governing payment due information for the product.
  
  delinquent_on_n_consecutive_late_fees integer
  
  After this number of consecutive late events, the account status shifts to suspended with a status subtype of delinquent
  
  Default value is 1.
  
  charge_off_on_n_consecutive_late_fees integer
  
  After this number of consecutive late events, the account status shifts to suspended with a status subtype of charged_off
  
  Default value is 2.
  
  pre_statement_payments_reduce_min_pay boolean
  
  If false, the default, payments mid-cycle (after the previous cycle's due date, but before the active cycle's statement date) on an installment product will not reduce the minimum payment as assessed on the accounts' upcoming statements, i.e. the full minimum payment for the cycle is still due after a statement.
  If true, not the default, payments mid-cycle on an installment product will reduce the minimum payment as assessed on the accounts' upcoming statements, i.e. making the full upcoming payment mid-cycle will output a minimum payment of $0 on the upcoming statement.
  Note that this only affects behavior of installment items, as payments towards revolving balances will always reduce the minimum payment due.
  
  Default value is false.
  
  payment_pouring_policies object
  
  The set of policies governing payment pouring information for the product.
  
  pending_pmt_affects_avail_credit boolean
  
  Indicates whether pending payments affect available credit.
  
  Default value is false.
  
  fee_policies object
  
  The set of policies governing fees for the product.
  
  late_fee_grace string
  
  Amount of time between when a payment is due and when a late fee is assessed if no payments have been made.
  
  Default value is 5 days.
  
  billing_cycle_policies object
  
  The set of policies governing the billing cycle for the product.
  
  cycle_interval string Required
  
  The length of the billing cycle. after which a statement is generated, and a due date assigned. IE '1 month' '3 months' or '7 days' (most common is monthly)
  
  cycle_due_interval string
  
  The amount of time before statement cut that the payment should be due for the billing cycle. If positive, it will count days from the start of the cycle. Note, this field has a signage convention: if negative, it will count days back from the end of the cycle. IE '25 days' indicates that payments are due 25 days after the statement is cut. -5 days indicates that payments will be due five days prior to the cut of the next cycle. Cannot exceed the duration of the billing cycle.
  
  Default value is -5 days.
  
  first_cycle_interval string
  
  Defaults to value of cycle_interval. If applicable, the amount of time you would like between origination and the first statement cut. IE '10 days'. If you would like the first billing cycle to be the same length as all other billing cycles, either do not include this field in the request, or set its value to the same as cycle_interval
  
  close_of_business_time string(time)
  
  Defaults to EST Midnight. Time of the close of business. Note* this value will be converted into the product_time_zone This is used for statement cuts and partner-level and issuing bank-level reconciliation
  
  Default value is 23:59:59-05:00.
  
  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. Defaults to America/New_York if not provided.
  
  Default value is America/New_York.
  
  interest_policies object
  
  The Interest Policy Object
  
  interest_calc_time string(time)
  
  Being deprecated under our backwards compatibility policy in favor of close_of_business time and timezone variables. Defaults to statement cut time Interest for this policy is calculated at this time every X interval.
  
  Default value is 01:00:00-05:00.
  
  interest_calc_method string
  
  Speaks to how interest is calculated for accounts under this product.
  monthly_ending_bal_360: interest amount = [principal] * (r / (360 / 30)) :: calculated once at the end of each one month cycle
  cycle_end_12 : DEPRECATED. Use monthly_ending_bal_360 instead.
  monthly_ending_bal_365: interest amount = [principal] * (r / (365 / 30)) :: calculated once at the end of each one month cycle
  daily_ending_bal_365: interest amount = [principal] * (r / 365) :: calculated at the end of each day
  daily_end_365: DEPRECATED. Use daily_ending_bal_365 instead.
  daily_ending_bal_360: interest amount = [principal] * (r / 360) :: interest accrues at the end of each day
  daily_end_360: DEPRECATED. Use daily_ending_bal_360 instead.
  monthly_avg_bal_365: interest amount = [avg_daily_principal] * (r / 12) :: interest accrues once at the end of each one month cycle.
  avg_daily_12: DEPRECATED. Use monthly_avg_bal_365 instead.
  cycle_start_360 : interest amount = [principal] * (r / (360 / 30)) :: calculated once at the beginning of each one month cycle. Applicable to installment balances.
  cycle_start_365 : interest amount = [principal] * (r / (365 / 30)) :: calculated once at the beginning of each one month cycle. Applicable to installment balances.
  
  Values are cycle_end_12, avg_daily_12, daily_end_365, daily_end_360, monthly_avg_bal_365, monthly_ending_bal_360, monthly_ending_bal_365, daily_ending_bal_360, daily_ending_bal_365, cycle_start_360, or cycle_start_365. Default value is monthly_ending_bal_360.
  
  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.
  
  installment_interest_accrual_moment string
  
  When should the interest of an installment be accrued.
  BEGINNING: At the beginning of a cycle
  END: At the end of a cycle
  
  Values are BEGINNING or END. Default value is END.
  
  revolving_interest_applicable_balance string
  
  The policy which defines which revolving balance under an account will accrue interest during the interest accrual calculation. PRINCIPAL accrues interest on principal balances of revolving transactions (i.e. non-installment charges), TOTAL_ACCOUNT_BALANCE accrues interest on the account's total revolving balance (inclusive of interest, fees).
  
  Values are PRINCIPAL or TOTAL_ACCOUNT_BALANCE. Default value is PRINCIPAL.
  
  installment_interest_applicable_balance string
  
  The policy which defines which principal balance to accrue interest on during the installment interest accrual calculation. ACTUAL accrues interest on the actual outstanding principal balance of loans (e.g. after a missed payment, interest would be higher than originally anticipated in the amortization schedule), EXPECTED accrues interest on the loan's expected balance (e.g. interest would be accrued at the same rate as quoted in the original amortization schedule). ORIGINAL accrues interest based on the original principal balance of the loan (i.e. a fixed amount of interest each cycle). AVERAGE accrues interest using the calculated average daily ending balance of the loan during the given cycle.
  
  Values are EXPECTED, ACTUAL, ORIGINAL, or AVERAGE. Default value is EXPECTED.
  
  is_limited_to_loan_duration boolean
  
  Applies only to loans. If true, loan interest will only accrue for the expected duration of the loan. Otherwise, interest will accrue as long as there is an outstanding balance. This serves as the default, including loans rolled over at the end of the promotional period, but can be overridden on a per-loan basis in the loan creation payload.
  
  Default value is false.
  
  Additional properties are NOT allowed
  
  default_attributes object
  
  default_credit_limit_cents integer Required
  
  The default maximum principal credit (in cents) available for a customer account. This default limit can be overridden on a per-account basis if a credit_limit is selected at the time of assigning an account to a product. Credit limits for an account can also be updated post-account creation.
  
  Default value is 0.
  
  default_late_fee_cents integer
  
  The default maximum principal credit (in cents) available for a customer account. This default limit can be overridden on a per-account basis if a credit_limit is selected at the time of assigning an account to a product. Credit limits for an account can also be updated post-account creation.
  
  Default value is 0.
  
  default_payment_reversal_fee_cents integer
  
  The default maximum principal credit (in cents) available for a customer account. This default limit can be overridden on a per-account basis if a credit_limit is selected at the time of assigning an account to a product. Credit limits for an account can also be updated post-account creation.
  
  Default value is 0.
  
  promotional_policies object Required
  
  If applicable, a promotional configuration for the product.
  
  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_min_pay_type string
  
  Current due calculation method for the promotional period.
  
  Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, PERCENT_PRINCIPAL_INTEREST, INTEREST_AND_PERCENT_PRINCIPAL, or NONE. Default value is NONE.
  
  promo_min_pay_floor_cents integer
  
  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.
  
  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.
  
  promo_min_pay_percent number
  
  Defaults to 100. The percent of new interest in the cycle used to determine the minimum payment.
  
  Default value is 100.
  
  promo_interest_deferred boolean
  
  Indicates whether interest accrued during the promotional period is deferred interest.
  
  Default value is false.
  
  promo_reset_on_first_charge boolean
  
  If set to true, the promo end date will be reset to end of current cycle + promo_len when the account draws its first charge during the promo period. If no charges occur during the promo period, the promo period will still end on the date set at account creation.
  
  Default value is false.
  
  promo_default_interest_rate_percent number
  
  The rate that serves as the active interest rate for accounts during the promotional period.
  
  Default value is 0.
  
  promo_apr_range_inclusive_lower number
  
  Optional lower bound for APR Range for the product (i.e. 2 = 2%).
  
  Default value is 0.
  
  promo_apr_range_inclusive_upper number
  
  Optional upper bound for APR Range for the product (i.e. 5 = 5%).
  
  Default value is 0.
  
  post_promotional_policies object
  
  post_promo_len integer | null
  
  Default duration for the amortization period during post-promotion
  
  post_promo_am_len_range_inclusive_lower integer | null
  
  Optional lower bound for amortization length in billing cycles for the product.
  
  post_promo_am_len_range_inclusive_upper integer | null
  
  Optional upper bound for amortization length in billing cycles for the product.
  
  post_promo_min_pay_type string
  
  Current due calculation method for the post-promotional period.
  
  Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, or NONE. Default value is AM.
  
  post_promo_default_interest_rate_percent number | null
  
  The rate that serves as the active interest rate for accounts during the post-promotional period.
  
  post_promo_apr_range_inclusive_lower number | null
  
  Optional lower bound for APR Range for the product (i.e. 2 = 2%).
  
  post_promo_apr_range_inclusive_upper number | null
  
  Optional upper bound for APR Range for the product (i.e. 5 = 5%).
  
  product_summary object
  
  Summary of product information
  
  accounts_overview object
  
  account_count_total integer Required
  
  Total number of accounts under the product.
  
  product_status string
  
  Status associated with this product
  
  Values are ACTIVE or DEACTIVATED.
  
  admin object
  
  migration_mode boolean
  
  If migration mode is on, Canopy will stop auto-generating statements for this account.
  
  Default value is false.
  
  metro2_config object
  
  Metro2 credit reporting configs
  
  bloom_metadata object
  
  Bloom API fields for products: https://docs.bloom.dev/docs/furnishment-api/b3A6MTMyOTc3NDQ-create-a-credit-product
  
  industry string
  
  Bloom Industry field
  
  Values are CREDIT_CARD_ISSUER or LOAN_FINANCE.
  
  portfolio_type string
  
  Metro2 'Portfolio Type' segment
  
  Values are INSTALLMENT, MORTGAGE, OPEN, or REVOLVING.
  
  account_type string
  
  Metro2 'Account Type' segment
  
  Values are UNSECURED or CREDIT_CARD.
  
  interest_type string
  
  Metro2 'Interest Type' segment
  
  Values are FIXED or VARIABLE.
  
  terms_frequency string
  
  Bloom API supports only monthly terms frequencies for now.
  
  Value is MONTHLY.
  
  Additional properties are allowed
- customer 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
  
  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
  
  bloom_metadata object
  
  Bloom API fields for customers: https://docs.bloom.dev/docs/furnishment-api/b3A6MjA1NTM1MQ-create-consumer
  
  address_type string
  
  Status of the reported address.
  
  Values are CONFIRMED, KNOWN, NOT_CONFIRMED, MILITARY, SECONDARY, BUSINESS, UNDELIVERABLE, DEFAULT, or BILL_PAYER_SERVICE.
  
  residence_type string
  
  Optional, if not available or unknown, do not report.
  
  Values are OWNS or RENTS.
  
  account_designations array[object] | null
  
  A list of accounts associated with the customer.
  
  account_id string
  
  the ID of the account associated with the customer
  
  designation string
  
  The designation of the customer for the account.
  
  Values are INDIVIDUAL, JOINT_CONTRACTUAL_LIABILITY, AUTHORIZED_USER, COMAKER_OR_GUARANTOR, MAKER, BUSINESS_COMMERCIAL, or DECEASED.
- Additional properties are NOT allowed
• 401

Unauthorized.
• 403

Forbidden.
• 422

Invalid input
• 429

Too many requests.
• default

Unexpected Error.

POST /finance_requests

curl \
 -X POST https://<your_environment_name>-uat-api.canopyservicing.com/finance_requests \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"finance_request_id":"31mNprzLd2bKl6koVna68ARM","customer_id":"31mNprzLd2bKl6koVna68ARM","product_id":"95fea111-d121-40f8-9e8e-a6c335e48a45","external_fields":{},"notes":["string"],"requested_conversion_at":"2018-03-20T09:12:28+00:00","partner_entity_id":42,"create_account_details":{"summary":{"credit_limit_cents":400000,"max_approved_credit_limit_cents":400000,"late_fee_cents":2900,"payment_reversal_fee_cents":2900,"origination_fee_cents":2000,"origination_fee_percent":2.34,"is_origination_fee_lesser_value":false,"is_origination_fee_amortized":false,"annual_fee_cents":1000,"monthly_fee_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"}],"initial_principal_cents":400000,"late_fee_cap_percent":12.5,"payment_reversal_fee_cap_percent":6.2},"post_promo_overview":{"post_promo_impl_interest_rate_percent":6.2,"post_promo_len":48}}}'

Request example

{
  "finance_request_id": "31mNprzLd2bKl6koVna68ARM",
  "customer_id": "31mNprzLd2bKl6koVna68ARM",
  "product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45",
  "external_fields": {},
  "notes": [
    "string"
  ],
  "requested_conversion_at": "2018-03-20T09:12:28+00:00",
  "partner_entity_id": 42,
  "create_account_details": {
    "summary": {
      "credit_limit_cents": 400000,
      "max_approved_credit_limit_cents": 400000,
      "late_fee_cents": 2900,
      "payment_reversal_fee_cents": 2900,
      "origination_fee_cents": 2000,
      "origination_fee_percent": 2.34,
      "is_origination_fee_lesser_value": false,
      "is_origination_fee_amortized": false,
      "annual_fee_cents": 1000,
      "monthly_fee_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"
        }
      ],
      "initial_principal_cents": 400000,
      "late_fee_cap_percent": 12.5,
      "payment_reversal_fee_cap_percent": 6.2
    },
    "post_promo_overview": {
      "post_promo_impl_interest_rate_percent": 6.2,
      "post_promo_len": 48
    }
  }
}

Response example (200)

{
  "finance_request_id": "31mNprzLd2bKl6koVna68ARM",
  "customer_id": "31mNprzLd2bKl6koVna68ARM",
  "product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45",
  "external_fields": {},
  "notes": [
    "string"
  ],
  "requested_conversion_at": "2018-03-20T09:12:28+00:00",
  "created_at": "2018-03-20T09:12:28+00:00",
  "updated_at": "2018-03-20T09:12:28+00:00",
  "conversion_at": "2018-04-20T09:12:28+00:00",
  "finance_request_status": "IN_REVIEW",
  "account_id": "31mNprzLd2bKl6koVna68ARM",
  "partner_entity": {},
  "create_account_details": {
    "summary": {
      "credit_limit_cents": 400000,
      "max_approved_credit_limit_cents": 400000,
      "late_fee_cents": 2900,
      "payment_reversal_fee_cents": 2900,
      "origination_fee_cents": 2000,
      "origination_fee_percent": 2.34,
      "is_origination_fee_lesser_value": false,
      "is_origination_fee_amortized": false,
      "annual_fee_cents": 1000,
      "monthly_fee_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"
        }
      ],
      "initial_principal_cents": 400000,
      "late_fee_cap_percent": 12.5,
      "payment_reversal_fee_cap_percent": 6.2
    },
    "post_promo_overview": {
      "post_promo_impl_interest_rate_percent": 6.2,
      "post_promo_len": 48
    }
  },
  "product": {
    "product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45",
    "created_at": "2019-03-20T09:12:28+00:00",
    "updated_at": "2020-01-20T09:12:28+00:00",
    "effective_at": "2016-11-27T13:19:56+00:00",
    "is_active": true,
    "product_overview": {
      "product_name": "Blue Cash Express",
      "product_type": "REVOLVING",
      "product_short_description": "12mm3apr.",
      "product_long_description": "Student credit card.",
      "product_color": "#0000FF",
      "external_fields": [
        {
          "key": "client_product_id",
          "value": "3e93a899-d267-4193-8509-6dba53c13b7b"
        }
      ]
    },
    "product_lifecycle_policies": {
      "payment_due_policies": {
        "delinquent_on_n_consecutive_late_fees": 2,
        "charge_off_on_n_consecutive_late_fees": 5,
        "pre_statement_payments_reduce_min_pay": false
      },
      "payment_pouring_policies": {
        "pending_pmt_affects_avail_credit": true
      },
      "fee_policies": {
        "late_fee_grace": "5 days"
      },
      "billing_cycle_policies": {
        "cycle_interval": "1 month",
        "cycle_due_interval": "-5 days",
        "first_cycle_interval": "25 days",
        "close_of_business_time": "17:00:00-05:00",
        "product_time_zone": "America/Chicago"
      },
      "interest_policies": {
        "interest_calc_time": "11:21:04-08:00",
        "interest_calc_method": "avg_daily_12",
        "interest_grace_method": "NONE",
        "installment_interest_accrual_moment": "BEGINNING",
        "revolving_interest_applicable_balance": "PRINCIPAL",
        "installment_interest_applicable_balance": "EXPECTED",
        "is_limited_to_loan_duration": true
      },
      "default_attributes": {
        "default_credit_limit_cents": 600000,
        "default_late_fee_cents": 50000,
        "default_payment_reversal_fee_cents": 10000
      }
    },
    "promotional_policies": {
      "promo_len": 6,
      "promo_min_pay_type": "PERCENT_PRINCIPAL",
      "promo_min_pay_floor_cents": 500,
      "promo_purchase_window_len": 5,
      "promo_min_pay_percent": 100,
      "promo_interest_deferred": true,
      "promo_reset_on_first_charge": true,
      "promo_default_interest_rate_percent": 3,
      "promo_apr_range_inclusive_lower": 2,
      "promo_apr_range_inclusive_upper": 5
    },
    "post_promotional_policies": {
      "post_promo_len": 48,
      "post_promo_am_len_range_inclusive_lower": 2,
      "post_promo_am_len_range_inclusive_upper": 5,
      "post_promo_min_pay_type": "AM",
      "post_promo_default_interest_rate_percent": 3,
      "post_promo_apr_range_inclusive_lower": 2,
      "post_promo_apr_range_inclusive_upper": 5
    },
    "product_summary": {
      "accounts_overview": {
        "account_count_total": 10005
      },
      "product_status": "ACTIVE"
    },
    "admin": {
      "migration_mode": true
    },
    "metro2_config": {
      "bloom_metadata": {
        "industry": "CREDIT_CARD_ISSUER",
        "portfolio_type": "REVOLVING",
        "account_type": "CREDIT_CARD",
        "interest_type": "VARIABLE",
        "terms_frequency": "MONTHLY"
      }
    }
  },
  "customer": {
    "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"
          }
        ]
      }
    }
  }
}