statements.created

wbhk

statements.created

Occurs when a statement has been created

Payload

event_type

const

enum

required

The type of event that occurred.

Allowed:

token

string

required

Globally unique identifier for a statement

financial_account_token

uuid

required

Globally unique identifier for a financial account

statement_start_date

date

required

Date when the billing period began

statement_end_date

date

required

Date when the billing period ended

next_statement_end_date

date

Date when the next billing period will end

payment_due_date

required

next_payment_due_date

date

Date when the next payment is due

days_in_billing_cycle

integer

required

Number of days in the billing cycle

credit_limit

integer

required

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

available_credit

integer

required

Amount of credit available to spend in cents

starting_balance

integer

required

Balance at the start of the billing period

ending_balance

integer

required

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

period_totals

object

required

ytd_totals

object

required

statement_totals

object

created

date-time

required

Timestamp of when the statement was created

updated

date-time

required

Timestamp of when the statement was updated

credit_product_token

required

Globally unique identifier for a credit product

account_standing

object

required

amount_due

object

required

payoff_details

interest_details

statement_type

string

enum

required

Allowed:

Response

200

Return a 200 status to indicate that the data was received successfully

Payload

Choose an example