Event Types

statements.created

Occurs when a statement has been created.

postWebhookstatements.created

Payload

event_type'statements.created' required

The type of event that occurred.

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

{
  "event_type": "statements.created"
}

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

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.