Canopy API - Latest

Get a specific statement for a specific account.

GET /accounts/{account_id}/statements/{statement_id}

This will return a statement that corresponds with the passed Statement ID. Relevant IDs for an account's historical statements can be obtained from the accounts/{account_id}/statements/list route.

Path parameters

account_id string Required

ID of the Account
statement_id string Required

The ID of a specific statement you would like returned.

Responses

• 200 object
- account_id string Required
  
  The Canopy-generated ID for the account
- statement_id string Required
  
  The Canopy-generated ID for the statement
- pdf_url string | null
  
  Secure, temporary URL for the generated PDF
- account_overview object
  promo_purchase_window_inclusive_start string(date-time) | null
  
  If applicable, the Date-Time the purchase window for the account ends.
  
  promo_purchase_window_exclusive_end string(date-time) | null
  
  If applicable, the Date-Time the purchase window for the account ends.
  
  promo_inclusive_start string(date-time) | null
  
  If applicable, the Date-Time the promo period for the account starts.
  
  promo_exclusive_end string(date-time) | null
  
  If applicable, the Date-Time the promo period for the account ends.
  
  account_status string
  
  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.
  
  payout_entities array[object] | null
  
  An array of payout entities who have been 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.
- open_to_buy object
  credit_limit_cents integer | null
  
  Total Amount (in cents) that this account can borrow.
  
  Default value is 0.
  
  total_charges_cents integer | null
  
  Sum of all charges that occurred on the account since account origination.
  
  Default value is 0.
  
  available_credit_cents integer | null
  
  The total available credit balance (in cents) for the account.
  
  Default value is 0.
  
  open_to_buy_cents integer | null
  
  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.
- cycle_summary object
  cycle_inclusive_start string(date-time) | null
  
  The inclusive starting Date-Time that defines which transactions are part of this statement.
  
  cycle_exclusive_end string(date-time) | null
  
  The inclusive ending Date-Time that defines which transactions are part of this statement.
  
  cycle_length_days integer
  
  Number of days within the billing cycle
  
  cycle_charges_cents integer
  
  Sum of all charges that occurred on the account during the billing cycle.
  
  Default value is 0.
  
  cycle_loans_cents integer
  
  Sum of all loans amounts that were initiated on the account during the billing cycle.
  
  Default value is 0.
  
  cycle_charge_returns_cents integer
  
  Sum of all retroactive charge reversals that occurred on the account during the billing cycle.
  
  Default value is 0.
  
  cycle_refunds_cents integer
  
  Sum of all refunds that occurred on the account during the billing cycle.
  
  Default value is 0.
  
  cycle_payments_cents integer
  
  Sum of all payments that occurred on the account during the billing cycle.
  
  Default value is 0.
  
  cycle_payment_reversals_cents integer
  
  Sum of all payment reversal amounts that occurred on the account during the billing cycle.
  
  Default value is 0.
  
  cycle_debit_adjustments_cents integer
  
  Sum of all debit adjustment amounts that occurred on the account during the billing cycle.
  
  Default value is 0.
  
  cycle_credit_adjustments_cents integer
  
  Sum of all credit adjustment amounts that occurred on the account during the billing cycle.
  
  Default value is 0.
  
  cycle_total_credits_cents integer
  
  Net total of all postive and negative adjustments made to an account during the billing cycle. This field sums against the following line item types: PAYMENT_REVERSAL, DEBIT_OFFSET, CREDIT_OFFSET, CHARGE_REVERSAL
  
  Default value is 0.
  
  cycle_interest_cents integer
  
  Total interest accrued during the billing cycle.
  
  Default value is 0.
  
  cycle_am_interest_cents integer
  
  The current AM interest balance of the line item. Canopy tracks interest during an amortization period separately from deferred interest accrued during a revolving period.
  
  Default value is 0.
  
  cycle_deferred_interest_cents integer | null
  
  Total deferred interest accrued during the billing cycle.
  
  Default value is 0.
  
  cycle_am_deferred_interest_cents integer | null
  
  Total interest accrued during the billing cycle. Canopy tracks deferred interest during an amortization period separately from deferred interest accrued during a revolving period.
  
  Default value is 0.
  
  cycle_total_interest_cents integer
  
  Total interest across all interest types charged to the borower during the billing cycle.
  
  Default value is 0.
  
  cycle_late_fees_cents integer
  
  Total late fees incurred during the billing cycle.
  
  Default value is 0.
  
  cycle_fees_total_cents integer
  
  Total fees incurred during the billing cycle.
  
  Default value is 0.
  
  cycle_payment_reversals_fees_cents integer
  
  Total payment reversal fees incurred during the billing cycle.
  
  Default value is 0.
  
  cycle_waived_deferred_interest_cents integer
  
  Total deferred interest that was forgiven on the account during the billing cycle.
  
  Default value is 0.
- inception_to_date_summary object
  inception_to_date_payments_total_cents integer
  
  Total payments in cents made since account inception
  
  inception_to_date_purchases_total_cents integer
  
  Total purchases in cents made since account inception
  
  inception_to_date_credits_total_cents integer
  
  Total credits applied in cents made since account inception
  
  inception_to_date_credits_and_payments_total_cents integer
  
  Total payments and credits in cents applied since account inception
  
  inception_to_date_interest_total_cents integer
  
  Total interest in cents accumulated from account inception
  
  inception_to_date_fees_total_cents integer
  
  Total fees in cents assessed from account inception
  
  inception_to_date_interest_prior_total integer
  
  Total interest in cents charged since account inception minus interest charged in current billing cycle
- year_to_date_summary object
  year_to_date_interest_total_cents integer
  
  Total interest in cents charged from year start
  
  year_to_date_fees_total_cents integer
  
  Total fees in cents charged from year start
- min_pay_due object
  min_pay_cents integer Required
  
  Total amount due for the billing cycle, summing cycle principal, interest, deferred interest, and fees outstanding.
  
  min_pay_due_at string(date-time) | null Required
  
  The Date-Time the payment for this billing cycle is due.
- additional_min_pay_details object
  min_pay_charges_principal_cents integer
  
  Total principal due for the billing cycle coming from charges.
  
  min_pay_revolving_principal_cents integer
  
  Total principal due for the billing cycle.
  
  min_pay_interest_cents integer Required
  
  Total interest due for the billing cycle.
  
  min_pay_am_interest_cents integer
  
  Total am interest due for the billing cycle.
  
  min_pay_deferred_cents integer Required
  
  Total deferred interest due for the billing cycle.
  
  min_pay_am_deferred_interest_cents integer
  
  The current AM deferred interest balance of the line item. Canopy tracks deferred interest during an amortization period separately from deferred interest accrued during a revolving period.
  
  Default value is 0.
  
  min_pay_fees_cents integer Required
  
  Total fees due for the billing cycle.
  
  previous_min_pay_cents integer | null Required
  
  Minimum payment from the last statement.
  
  current_min_pay_cents integer | null
  
  Portion of the current minimum payment that comes from current cycle balances.
  
  unpaid_min_pay_cents integer | null
  
  Portion of the current minimum payment that comes from unpaid balances.
  
  min_pay_floor_excess_cents integer | null
  
  The extra amount added, if any, to the regular minimum payment to meet the promo_min_pay_floor
- balance_summary object
  charges_principal_cents integer
  
  Total principal balance for charges for the account.
  
  Default value is 0.
  
  loans_principal_cents integer
  
  Total principal balance for loans for the account.
  
  Default value is 0.
  
  interest_balance_cents integer
  
  Total interest balance for the account.
  
  Default value is 0.
  
  am_interest_balance_cents integer
  
  Total AM interest balance for the account.
  
  Default value is 0.
  
  deferred_interest_balance_cents integer
  
  Total deferred interest balance for the account.
  
  Default value is 0.
  
  am_deferred_interest_balance_cents integer
  
  The total deferred interest balance (in cents) associated with the account.
  
  Default value is 0.
  
  fees_balance_cents integer
  
  Total fee balance for the account.
  
  Default value is 0.
  
  total_balance_cents integer
  
  The total balance (in cents) associated with the account.
  
  Default value is 0.
  
  previous_total_balance_cents integer
  
  The total balance (in cents) associated with the account from the billing cycle prior to the requested statement. Will be set to 0 if the most recent statement is the first statement for the account.
  
  Default value is 0.
- payoff object
  total_payoff_cents integer
  
  The total amount needed to pay off the loan at this exact moment.
  
  Default value is 0.
  
  expected_remaining_payment_amount_cents integer | null
  
  The total amount slated to pay off the account over the lifecycle of the loan.
  
  Default value is 0.
- line_items array[object]
  
  A snapshot of all line items that occurred during the cycle and were VALID at the time of Statement cut.
  
  Not more than 1000 elements.
  account_id string Required
  
  The account associated with the line item
  
  line_item_id string Required
  
  The ID associated with the line item
  
  effective_at string(date-time)
  
  The Date-Time that this line item became/becomes active.
  
  valid_at string(date-time)
  
  The Date-Time that this line item became valid.
  
  created_at string(date-time)
  
  The Date-Time which the line item was created.
  
  updated_at string(date-time)
  
  The Date-Time which the line item was updated.
  
  product_id string Required
  
  the Product ID of the account
  
  line_item_overview object
  
  line_item_status string
  
  the corresponding Status for a line item
  
  Values are AUTHORIZED, DECLINED, INVALID, OFFSET, PENDING, POSTED, REFINANCED, PROCESSING, RETRO_VALID, REVERSED, ROLLED, SETTLED, SPLIT_INVALID, SPLIT_VALID, VALID, or VOID. Default value is VALID.
  
  line_item_type string Required
  
  The Line Item Type. i.e. CHARGE, PAYMENT, CREDIT_OFFSET, DEBIT_OFFSET, MANUAL_FEE.
  
  description string | null
  
  A description of this particular line item if any. More common for adjustments.
  
  allocation string | null
  
  Optional designation for which balance bucket an offset was allocated to. Only applicable to CREDIT_OFFSET and DEBIT_OFFSET type line_items.
  
  Values are INTEREST, DEFERRED_INTEREST, PRINCIPAL, FEE, or null.
  
  line_item_summary object
  
  original_amount_cents integer
  
  The originating amount of money (in cents) relating to this line item.
  
  balance_cents integer
  
  The current balance of the line item, which accounts for interest accrued per the product's interest policy and the account's interest rate attribute.
  
  principal_cents integer
  
  The principal balance of the line item.
  
  interest_percent number | null
  
  Annual interest in percentage.
  
  Default value is 0.
  
  interest_balance_cents integer
  
  The current interest balance of the line item.
  
  am_interest_balance_cents integer
  
  The current AM interest balance of the line item. Canopy tracks interest during an amortization period separately from deferred interest accrued during a revolving period.
  
  deferred_interest_balance_cents integer
  
  The current deferred interest balance of the line item.
  
  am_deferred_interest_balance_cents integer
  
  The current AM deferred interest balance of the line item. Canopy tracks deferred interest during an amortization period separately from deferred interest accrued during a revolving period.
  
  am_fees_balance_cents integer
  
  The current AM fees balance of the line item.
  
  total_interest_paid_to_date_cents integer
  
  The sum (in cents) of all payments towards interest charges, if any, applied to this line item to date
  
  merchant_data object | null
  
  Merchant information if applicable.
  
  name string
  
  id string
  
  mcc_code string
  
  phone_number string
  
  issuer_processor_details object | null
  
  lithic object
  
  last_four string | null
  
  Last four digits of the card against which the spend was made.
  
  transaction_token string(uuid) | null
  
  The external unique identifier of the transaction.
  
  card_token string(uuid) | null
  
  The external unique identifier of the card related to this line item.
  
  external_fields array[object] | null
  
  An array of static references to fields in a third party system.
  
  Not more than 1000 elements.
  
  key string
  
  Key - i.e. Name of the External Party
  
  value string
  
  Value - i.e. External Account ID
  
  Additional properties are allowed
• 401

Unauthorized.
• 403

Forbidden.
• 404

Statement not found
• 429

Too many requests.
• default

Unexpected Error.

GET /accounts/{account_id}/statements/{statement_id}

curl \
 -X GET https://<your_environment_name>-uat-api.canopyservicing.com/accounts/can_52322/statements/186282 \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response example (200)

{
  "account_id": "31mNprzLd2bKl6koVna68ARM",
  "statement_id": "31mNprzLd2bKl6koVna68ARM",
  "pdf_url": "https://bucket.s3.statement.pdf",
  "account_overview": {
    "promo_purchase_window_inclusive_start": "2015-08-31T10:49:44.461+00:00",
    "promo_purchase_window_exclusive_end": "2015-08-31T10:49:44.461+00:00",
    "promo_inclusive_start": "2015-08-31T10:49:44.461+00:00",
    "promo_exclusive_end": "2015-08-31T10:49:44.461+00:00",
    "account_status": "SUSPENDED",
    "account_status_subtype": "BANKRUPTCY",
    "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"
      }
    ]
  },
  "open_to_buy": {
    "credit_limit_cents": 400000,
    "total_charges_cents": 800000,
    "available_credit_cents": 600000,
    "open_to_buy_cents": 600000
  },
  "cycle_summary": {
    "cycle_inclusive_start": "2023-05-04T09:42:00+00:00",
    "cycle_exclusive_end": "2023-05-04T09:42:00+00:00",
    "cycle_length_days": 5,
    "cycle_charges_cents": 700000,
    "cycle_loans_cents": 700000,
    "cycle_charge_returns_cents": 100000,
    "cycle_refunds_cents": 100000,
    "cycle_payments_cents": 200000,
    "cycle_payment_reversals_cents": 200000,
    "cycle_debit_adjustments_cents": 40000,
    "cycle_credit_adjustments_cents": 53000,
    "cycle_total_credits_cents": 53000,
    "cycle_interest_cents": 110000,
    "cycle_am_interest_cents": 0,
    "cycle_deferred_interest_cents": 300000,
    "cycle_am_deferred_interest_cents": 300000,
    "cycle_total_interest_cents": 110000,
    "cycle_late_fees_cents": 300000,
    "cycle_fees_total_cents": 300000,
    "cycle_payment_reversals_fees_cents": 300000,
    "cycle_waived_deferred_interest_cents": 40000
  },
  "inception_to_date_summary": {
    "inception_to_date_payments_total_cents": 10000,
    "inception_to_date_purchases_total_cents": 10000,
    "inception_to_date_credits_total_cents": 10000,
    "inception_to_date_credits_and_payments_total_cents": 10000,
    "inception_to_date_interest_total_cents": 10000,
    "inception_to_date_fees_total_cents": 10000,
    "inception_to_date_interest_prior_total": 10000
  },
  "year_to_date_summary": {
    "year_to_date_interest_total_cents": 10000,
    "year_to_date_fees_total_cents": 10000
  },
  "min_pay_due": {
    "min_pay_cents": 160000,
    "min_pay_due_at": "2019-10-18T23:04:48.321+00:00"
  },
  "additional_min_pay_details": {
    "min_pay_charges_principal_cents": 100000,
    "min_pay_revolving_principal_cents": 100000,
    "min_pay_interest_cents": 30000,
    "min_pay_am_interest_cents": 0,
    "min_pay_deferred_cents": 10000,
    "min_pay_am_deferred_interest_cents": 200,
    "min_pay_fees_cents": 20000,
    "previous_min_pay_cents": 400000,
    "current_min_pay_cents": 400000,
    "unpaid_min_pay_cents": 400000,
    "min_pay_floor_excess_cents": 20000
  },
  "balance_summary": {
    "charges_principal_cents": 900000,
    "loans_principal_cents": 900000,
    "interest_balance_cents": 100000,
    "am_interest_balance_cents": 100000,
    "deferred_interest_balance_cents": 700000,
    "am_deferred_interest_balance_cents": 40000,
    "fees_balance_cents": 700000,
    "total_balance_cents": 400000,
    "previous_total_balance_cents": 400000
  },
  "payoff": {
    "total_payoff_cents": 900000,
    "expected_remaining_payment_amount_cents": 1100000
  },
  "line_items": [
    {
      "account_id": 4,
      "line_item_id": 2,
      "effective_at": "2018-07-20T09:12:30+00:00",
      "valid_at": "2022-09-30T09:12:30+00:00",
      "created_at": "2018-06-20T09:12:30+00:00",
      "updated_at": "2019-07-21T10:13:31+00:00",
      "product_id": "li_4Yxb5",
      "line_item_overview": {
        "line_item_status": "VALID",
        "line_item_type": "CHARGE",
        "description": "Refund for invalid purchase",
        "allocation": "INTEREST"
      },
      "line_item_summary": {
        "original_amount_cents": 2484,
        "balance_cents": 3600,
        "principal_cents": 2400,
        "interest_percent": 2.34,
        "interest_balance_cents": 1100,
        "am_interest_balance_cents": 0,
        "deferred_interest_balance_cents": 200,
        "am_deferred_interest_balance_cents": 0,
        "am_fees_balance_cents": 0,
        "total_interest_paid_to_date_cents": -16
      },
      "merchant_data": {
        "name": "string",
        "id": "string",
        "mcc_code": "string",
        "phone_number": "string"
      },
      "issuer_processor_details": {
        "lithic": {
          "last_four": 3324,
          "transaction_token": "33xd08bc-d100-488y-bb93-f8a1f081ff0e",
          "card_token": "c6cd08bc-c524-48f5-b64d-f79ec0810df4"
        }
      },
      "external_fields": [
        {
          "key": "Globex Card Processing Account ID",
          "value": "22445702-a389-431f-927d-07b8d0750787"
        }
      ]
    }
  ]
}