Path parameters

• account_id string Required

  Account ID

• statement_id string Required

  The ID of a specific statement you would like returned.

Responses

• 200
  Hide response attributes Show response attributes 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
    Hide account_overview attributes Show account_overview attributes 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 , INACTIVITY, INELIGIBLE, DELINQUENT, CHARGE_OFF, GRANTOR_REQUEST, BANKRUPTCY, PAID_OFF, CUSTOMER_REQUEST_PENDING_PAYOFF, GRANTOR_REQUEST_PENDING_PAYOFF, DECEASED, RISK_REVIEW, FRAUD, CUSTOMER_REQUEST, or RISK. Default value is empty.

  • open_to_buy object
    Hide open_to_buy attributes Show open_to_buy attributes 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
    Hide cycle_summary attributes Show cycle_summary attributes 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_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 returns 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_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 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_late_fees_cents integer

      Total late 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.

  • min_pay_due object
    Hide min_pay_due attributes Show min_pay_due attributes 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
    Hide additional_min_pay_details attributes Show additional_min_pay_details attributes object

    • min_pay_charges_principal_cents integer Required

      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

      Previous amounts due, including fees. This is a subset of min_pay_cents.

  • balance_summary object
    Hide balance_summary attributes Show balance_summary attributes object

    • charges_principal_cents integer

      Total principal balance 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.

  • payoff object
    Hide payoff attributes Show payoff attributes 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.

    Hide line_items attributes Show line_items attributes array[object]

    • 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

    • created_at string(date-time)

      The Date-Time which the line item was created.

    • product_id string Required

      the Product ID of the account

    • line_item_overview object
      Hide line_item_overview attributes Show line_item_overview attributes object

      • line_item_status string

        the corresponding Status for a line item

        Values are AUTHORIZED, DECLINED, INVALID, OFFSET, PENDING, POSTED, 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.

    • line_item_summary object
      Hide line_item_summary attributes Show line_item_summary attributes 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_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.

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

      Hide merchant_data attributes Show merchant_data attributes object | null

      • name string
      • id string
      • mcc_code string
      • phone_number string
    • issuer_processor_details object | null
      Hide issuer_processor_details attribute Show issuer_processor_details attribute object | null

      • lithic object
        Hide lithic attributes Show lithic attributes 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.

      Hide external_fields attributes Show external_fields attributes array[object] | null

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