Query parameters
-
limit integer
The maximum number of customer accounts to be returned. Defaults to 12.
Minimum value is
0
, maximum value is10000
. -
starting_after string
Pass the value from the
paging
response body in your previous request. If not provided, the zero-indexed starting point will be used. Either starting_after or ending_before may be provided, but not both. -
ending_before string
Pass the value from the
paging
response body in your previous request. If not provided, the zero-indexed starting point will be used. Either starting_after or ending_before may be provided, but not both. -
status string
Comma-separated list of statuses of the Financial Requests to filter by (no whitespaces).
Allowed values: APPROVED, CONVERTED, IN_REVIEW, PENDING, REJECTED, VOID -
The moment in time the financial requests to be returned should have their requested_conversion_at older than
-
The moment in time the financial requests to be returned should have their requested_conversion_at younger than
-
product_type string
Comma-separated list of the product types of the accounts to filter by (no whitespaces).
Allowed values: INSTALLMENT, INVENTORY_FINANCING, REVOLVING, LOGISTICS_FINANCING, etc. -
partner_entity_id string
Comma-separated list of Partner Entity IDs for the Financial Requests to filter by (no whitespaces)
-
customer_filter string
Comma-separated list of customer ids for the Financial Requests to filter by (no whitespaces)
-
search_parameters string
Searches by
finance_request_id
,product_name
,doing_business_as
,business_legal_name
or customer's first and last name. Based on the input search parameter, the top responses from our API search, up to or less than the providedlimit
will be returned.
curl \
-X GET https://<your_environment_name>-uat-api.canopyservicing.com/finance_requests \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"results": [
{
"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"
}
]
}
}
}
}
]
}