Home / Guides/ Handle Transactions
Providing your customers with billing statements is recommended whenever your product assesses fees and may be required for certain products, such as Consumer Credit. Highnote provides the data necessary to create a statement, which you can leverage to populate your own statement template. This guide will walk you through how to retrieve a Financial Accounts' billing data for your customers.
For questions on your product’s billing statement requirements or regulatory requirements, please contact the Highnote team.
You may opt to be notified when new billing statements are available for Financial Accounts so you can generate statements to provide to your account holders. To learn more on how to subscribe to Events, please see Notifications.
Billing statement data is created on Financial Accounts and becomes available at the end of a billing cycle. For Credit Card products, the billing period end date may vary across Financial Accounts on your portfolio. Statement data is typically available within 48 hours of a billing period end date.
You can query the latest billing statement data for a Financial Account to generate the Account’s statement in the
latestClosedStatement. Billing statements will only include posted transactions and the associated balances for a given billing period. Transactions for the Financial Account’s current billing period and their next, upcoming due date can be found in the
When there is a balance due on the Financial Account, the
currentAmountDue will be updated based on credits (e.g. payments, refunds) to the Financial Account between the billing period end date and the due date. You’ll need to reference the type of
SecuredDepositCommercialCreditCardFinancialAccountStatementSnapshot to retrieve the current amount due, based on your Card Product. You can present this balance to your customer outside of the statement itself so they are informed on the remaining amount owed since their last statement was generated.
You can also search for the history of billing statements on a Financial Account based on a date range for your customers to view. Up to 24 months of billing statement history can provided. The results will be empty if statement data is not yet available for the Financial Account. You can query by periodStart and/or periodEnd.
You can search for a statement’s details with a provided statement ID.
Statement entries are paginated and can be filtered by their post date and whether they are credit or debit.
In the Test Environment, you can end a Financial Account’s billing period early so you can simulate a billing period’s statement without waiting for the billing period to end. The new period must be at least 60 seconds in the future, and if the periodBoundary is not supplied, the statement endPeriod will be set to 60 seconds in the future.
In the Test Environment, you can roll over a Financial Account’s billing period to the next billing cycle so you can simulate ending and starting a new billing cycle for a Financial Account. You’ll need to reference the type of
SecuredDepositCommercialCreditCardFinancialAccountStatementSnapshot to retrieve the simulated, current amount due, based on your Card Product.