Home / Issuing / Manage Credit

Deliver Credit Statements

Overview

Billing statements reflect money movement, balances, and fees for an account holder's financial account. Billing statements are often required for credit card products. This guide provides steps for generating and simulating billing statements using the Highnote API.

Prerequisites

  1. A Highnote account
  2. An API key or the API Explorer
  3. A card product, financial account, and payment card
  4. Optional - Real or simulated transactions

Generating billing statements

Billing statements are typically available within 48 hours of the end of a billing cycle. The billing period and end date for credit card products may vary across accounts. To be notified when billing statements are ready for financial accounts, use the financial account statement notification.

To generate a billing statement, query the FinancialAccountStatementSnapshot object as follows:

  • To generate billing statements with posted transactions and balances for a billing period: Query the FinancialAccountStatementSnapshot and use the latestClosedStatement.
  • To generate billing statements with transactions for the current billing period and their upcoming due date: Query the FinancialAccountStatementSnapshot and use the currentOpenStatement.

Refer to the appropriate statement snapshot type based on your card product:

Card product typeStatement snapshot
Commercial revolving creditCommercialRevolvingCardFinancialAccountStatementSnapshot
Commercial chargeCreditPayInFullCardFinancialAccountStatementSnapshot
Consumer chargeConsumerChargeCardFinancialAccountStatementSnapshot
Consumer revolving creditConsumerRevolvingCardFinancialAccountStatementSnapshot

Current amount due

When a balance is due, the currentAmountDue on the statement snapshot reflects payments or refunds made between the billing period end date and the payment due date.

Use currentAmountDue to display the account holder's balance on your website or application outside of their billing statements.

Period and payment due dates

Payment due dates are determined by (1) the financial account's creation date, and (2) the card product's grace period.

Billing dates are set with timestamps at the beginning or end of the day:

  • Period Dates occur at the beginning of the day at 00:00:00 Eastern Time (EST/EDT).
  • Payment Due Date occurs at the end of the day at 11:59:59 Eastern Time (EST/EDT).

The Highnote API response returns these values in Coordinated Universal Time (UTC), which means that you mean need to adjust the Payment Due Date before displaying to card holders in select regions.

spacer

Adjusting due date for North America

You must adjust the date when presenting paymentDueDate to account holders in North America. This is because (1) the actual end date occurs at 11:59:59 Eastern Time, and (2) the value in the API response is in UTC which moves it to the next day.

FieldInternal Date (EST)API Response (UTC)Action NeededYour Display
Period Start2025-06-26 00:00:002025-06-26 05:00:00Leave as is2025-06-26 05:00:00
Period End2025-07-26 00:00:002025-07-26 05:00:00Leave as is2025-07-26 05:00:00
Payment Due2025-08-24 11:59:592025-08-25 04:59:59Subtract 1 cal day2025-08-24 04:59:59

Examples of due date adjustments

The following tables demonstrate adjusting the period due date for card holders in North America.

Legend

  • Start Date (Account activation time)

  • End Date (Beginning of day 12am EST/EDT)

  • Due Date (End of day 11:59:59pm EST/EDT)

  • Start Date of next cycle (Beginning of day 12am EST/EDT)

  • End date of next cycle (Beginning of day 12am EST/EDT)

  • Due Date (End of day 11:59:59pm EST/EDT)

spacer

Grace Period = 21 Days

Start DateEnd Date (12am ET)Due Date (11:59:59pm)Start Date Next CycleEnd date Next Cycle (12am ET)Due Date Next Cycle (11:59:59pm ET)
Aug 1Sep 19/22Sep 1Oct 110/22
Aug 2Sep 29/23Sep 2Oct 210/23
Aug 3Sep 39/24Sep 3Oct 310/24
Aug 4Sep 49/25Sep 4Oct 410/25
Aug 5Sep 59/26Sep 5Oct 510/26
Aug 6Sep 69/27Sep 6Oct 610/27
Aug 7Sep 79/28Sep 7Oct 710/28
Aug 8Sep 89/29Sep 8Oct 810/29
Aug 9Sep 99/30Sep 9Oct 910/30
Aug 10Sep 1010/1Sep 10Oct 1010/31
Aug 11Sep 1110/2Sep 11Oct 1111/1
Aug 12Sep 1210/3Sep 12Oct 1211/2
Aug 13Sep 1310/4Sep 13Oct 1311/3
Aug 14Sep 1410/5Sep 14Oct 1411/4
Aug 15Sep 1510/6Sep 15Oct 1511/5
Aug 16Sep 1610/7Sep 16Oct 1611/6
Aug 17Sep 1710/8Sep 17Oct 1711/7
Aug 18Sep 1810/9Sep 18Oct 1811/8
Aug 19Sep 1910/10Sep 19Oct 1911/9
Aug 20Sep 2010/11Sep 20Oct 2011/10
Aug 21Sep 2110/12Sep 21Oct 2111/11
Aug 22Sep 2210/13Sep 22Oct 2211/12
Aug 23Sep 2310/14Sep 23Oct 2311/13
Aug 24Sep 2410/15Sep 24Oct 2411/14
Aug 25Sep 2510/16Sep 25Oct 2511/15
Aug 26Sep 2610/17Sep 26Oct 2611/16
Aug 27Sep 2710/18Sep 27Oct 2711/17
Aug 28Sep 2810/19Sep 28Oct 2811/18
Aug 29Sep 2810/19Sep 28Oct 2811/18
Aug 30Sep 2810/19Sep 28Oct 2811/18
Aug 31Sep 2810/19Sep 28Oct 2811/18

spacer

Grace Period = 10 Days

Start DateEnd Date (12am ET)Due Date (11:59:59pm)
Aug 1Aug 158/25
Aug 2Aug 168/26
Aug 3Aug 178/27
Aug 4Aug 188/28
Aug 5Aug 198/29
Aug 6Aug 208/30
Aug 7Aug 218/31
Aug 8Aug 229/1
Aug 9Aug 239/2
Aug 10Aug 249/3
Aug 11Aug 259/4
Aug 12Aug 269/5
Aug 13Aug 279/6
Aug 14Aug 289/7
Aug 15Aug 299/8
Aug 16Aug 309/9
Aug 17Aug 319/10
Aug 18Sep 19/11
Aug 19Sep 29/12
Aug 20Sep 39/13
Aug 21Sep 49/14
Aug 22Sep 59/15
Aug 23Sep 69/16
Aug 24Sep 79/17
Aug 25Sep 89/18
Aug 26Sep 99/19
Aug 27Sep 109/20
Aug 28Sep 119/21
Aug 29Sep 129/22
Aug 30Sep 139/23
Aug 31Sep 149/24

spacer

Grace Period = 5 Days

Start DateEnd Date (12am ET)Due Date (11:59:59pm)
Aug 1Aug 88/13
Aug 2Aug 98/14
Aug 3Aug 108/15
Aug 4Aug 118/16
Aug 5Aug 128/17
Aug 6Aug 138/18
Aug 7Aug 148/19
Aug 8Aug 158/20
Aug 9Aug 168/21
Aug 10Aug 178/22
Aug 11Aug 188/23
Aug 12Aug 198/24
Aug 13Aug 208/25
Aug 14Aug 218/26
Aug 15Aug 228/27
Aug 16Aug 238/28
Aug 17Aug 248/29
Aug 18Aug 258/30
Aug 19Aug 268/31
Aug 20Aug 279/1
Aug 21Aug 289/2
Aug 22Aug 299/3
Aug 23Aug 309/4
Aug 24Aug 319/5
Aug 25Sep 19/6
Aug 26Sep 29/7
Aug 27Sep 39/8
Aug 28Sep 49/9
Aug 29Sep 59/10
Aug 30Sep 69/11
Aug 31Sep 79/12

Generate current billing statement

Use the following query to generate the current billing statement for an account holder:

Find billing statement history

To display billing statement history, you can look up past billing statements for up to 24 months. To filter data, you can search by periodStart or periodEnd of the billing period. If there is no data for a specific period, the query will return no results.

Use the following query to find billing statement history for a consumer revolving credit card. If you are querying for billing statement history for commercial or consumer charge, you must update the statement snapshot type for your card product:

Fetch statement details

You can search for details on a billing statement using a statement ID. Billing statement details include the following:

  • Information from financial events in the statement's billing cycle period
  • Summary-level balances

The following table provides an overview of data from the summary statement balance that can be retrieved from a billing statement. Use the objects in the field column in your query to return specific data:

SUMMARY STATEMENT BALANCEFIELDDESCRIPTION
Beginning balancestartingPrimaryCreditBalance or startingPrimaryDebitBalanceInitial outstanding balance at the start of the statement's billing cycle
Total purchasesperiodPurchasesAmountTotal purchases posted to the financial account during the billing cycle
Total payments and refundsperiodRefundsAndPaymentsAmountSum of payments, returns, and refunds posted to the financial account during the billing cycle
Total feesperiodFeeAmountThe total fees assessed during the billing cycle
Total interest chargesperiodInterestChargesThe total interest charges for the billing cycle
Ending balanceendingPrimaryCreditBalance or endingPrimaryDebitBalanceFinal outstanding balance on the financial account at the end of the billing cycle
Past due balancepastDueAmountOverdue balance at the close of the statement's billing cycle

For consumer revolving credit card products, a statement includes detailed balances, interest charges, and transactions for each credit plan, categorized by balance type. It also includes a payOffWarning field, which shows the monthly payment amount, estimated days to pay off the balance, and total balance to be paid in the following scenarios:

  • If the minimum payment amount is made monthly
  • If the total balance is paid off over three years

Use the following query to fetch statement details by ID:

Filter statement entries

Statement entries are presented in a paginated format. You can filter these entries based on their posting date and by distinguishing between credit and debit transactions.

The following query applies these filters to statement entries for a consumer revolving credit card product:

Simulate shifting the statement end period

This simulation feature is only compatible with credit card products at this time.

In the test environment, you can end a financial account’s billing period early to simulate a billing statement. When performing this simulation, refer to the following guidelines:

  • Set the new period at least 60 seconds in the future.
  • If no periodBoundary is provided, the system defaults the statement’s endPeriod to 60 seconds from now.

To simulate changing a statement's end period for a consumer revolving credit card, use the following mutation:

Simulate rolling to the next billing cycle

This simulation feature only works with credit card products at this time.

In the test environment, you can transition a financial account’s billing period to the next cycle, simulating the end of one billing cycle and the start of another. To retrieve the simulated current amount due, refer to the appropriate statement snapshot type:

Card product typeStatement snapshot
Commercial revolving creditCommercialRevolvingCardFinancialAccountStatementSnapshot
Commercial chargeCreditPayInFullCardFinancialAccountStatementSnapshot
Consumer chargeConsumerChargeCardFinancialAccountStatementSnapshot
Consumer revolving creditConsumerRevolvingCardFinancialAccountStatementSnapshot

Use the following mutation to simulate rolling over the current statement period for a consumer revolving credit card:

Provide Feedback

Was this content helpful?