Sample statement layout
Your statement’s visual design is up to you. The layout below shows a consumer account statement with sample data filled in. Check your platform agreement for the fields and disclosures your program requires: The sample is a consumer statement. It carries three items a commercial statement omits: the asterisk on each line the error-resolution notice covers, the notice itself, and the terminal location on card purchases. Your platform agreement sets out which transaction types carry the marker.When to send a statement
Close the statement period on the same day each month and issue a statement for every account, with or without activity. Send the statement to the account holder when the period closes, by email, in-app notification, or any channel that lets the account holder retain it, and record the issue date. Your platform agreement sets out the cadence, who delivers the statement, and who keeps the delivery record and for how long.List every transaction that moved the balance in the period. Without them, your opening and closing balances do not reconcile. Once you issue a statement, freeze its contents. A refund that posts later appears on the next statement as its own dated line.
What a statement contains
A statement has two parts: disclosure text, and fields you fill from the account and its transactions.Provider disclosures
Every statement carries the provider line. A consumer statement also carries the error-resolution notice, which gives the phone number and mailing address. A commercial statement has no notice, so it carries a contact line instead. The sample uses the wording below; your platform agreement provides the disclosure text for your program.Statement fields
Mapping Grid data to statement fields
You build a statement from three calls: Get customer by ID for the account holder, List Customer internal accounts for the account, and List transactions for the period’s activity. Bound the period withstartDate and endDate, both inclusive, sort with sortOrder=asc, and page with cursor while hasMore is true. List payment transactions by accountIdentifier. If the account funds cards, card transactions are listed by customerId or cardId, so keep the rows whose accountId is the statement account. type=CARD cannot be combined with status. All amounts are integers in the smallest unit of their currency (for example, cents), so format them using the currency’s decimals.
Only settled money is a statement line. Card rows count when
status is SETTLED or PARTIALLY_SETTLED, at their settledAmount as of period close; later clearings appear on the next statement. Skip AUTHORIZED, DECLINED, and VOIDED rows, and hold EXCEPTION rows until they are reconciled. Payment transactions count only when status is COMPLETED. A merchant refund is its own CARD row (direction: CREDIT, originalTransactionId set). For the status model, see Reconciliation.