Statements

Get statement by token

Changed on

Get a specific statement for a given financial account.

get/v1/financial_accounts/{financial_account_token}/statements/{statement_token}

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/financial_accounts/{financial_account_token}/statements/{statement_token}
  • Auth
    API key in header Authorization

Path parameters

financial_account_tokenstring uuid required

Globally unique identifier for financial account.

statement_tokenstring required

Globally unique identifier for statements.

Response

OK

tokenstring required

Globally unique identifier for a statement

financial_account_tokenstring uuid required

Globally unique identifier for a financial account

statement_start_datestring date required

Date when the billing period began

statement_end_datestring date required

Date when the billing period ended

next_statement_end_datestring date nullable

Date when the next billing period will end

payment_due_datestring date nullable required

Date when the payment is due

next_payment_due_datestring date nullable

Date when the next payment is due

days_in_billing_cycleinteger required

Number of days in the billing cycle

credit_limitinteger required

This is the maximum credit balance extended by the lender in cents

available_creditinteger required

Amount of credit available to spend in cents

starting_balanceinteger required

Balance at the start of the billing period

ending_balanceinteger required

Balance at the end of the billing period. For charge cards, this should be the same at the statement amount due in cents

createdstring date-time required

Timestamp of when the statement was created

updatedstring date-time required

Timestamp of when the statement was updated

credit_product_tokenstring nullable required

Globally unique identifier for a credit product

statement_type'INITIAL' | 'PERIOD_END' | 'FINAL' required

Changes

  • 7732c7d99b3eRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • fac001c63373Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      added subschema #1 to the / response property oneOf list for the response status

    • breaking

      added subschema #1 to the / response property oneOf list for the response status

    • breaking

      added subschema #1 to the / response property oneOf list for the response status

    • breaking

      added subschema #1 to the / response property oneOf list for the response status

    • breaking

      added subschema #1 to the / response property oneOf list for the response status

    • breaking

      added subschema #1 to the / response property oneOf list for the response status

    • breaking

      added subschema #1 to the / response property oneOf list for the response status

    • breaking

      added subschema #1 to the / response property oneOf list for the response status

    • breaking

      added subschema #1 to the / response property oneOf list for the response status

    • breaking

      removed the pattern property ^.*$ from the / response property for the status

    • breaking

      removed the pattern property ^.*$ from the / response property for the status

    • breaking

      removed the pattern property ^.*$ from the / response property for the status

    • breaking

      removed the pattern property ^.*$ from the / response property for the status

    • breaking

      removed the pattern property ^.*$ from the / response property for the status

    • breaking

      removed the pattern property ^.*$ from the / response property for the status

    • breaking

      removed the pattern property ^.*$ from the / response property for the status

    • breaking

      removed the pattern property ^.*$ from the / response property for the status

    • breaking

      removed the pattern property ^.*$ from the / response property for the status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status