Skip to main content
Retrieves a PDF account status letter for a virtual account number belonging to a spend account (cash balance) of the authenticated user’s account. Defaults to the spend account’s primary virtual account number when virtualAccountNumberId is omitted. Set displayBalance to include the balance on the letter, optionally as of a past date via balanceCheckDate. Requires LIST_PAYMENT scope.

​
Arguments

​
UUID!
required
The spend account (cash balance) the virtual account number belongs to.
​
UUID
Which of the spend account’s virtual account numbers to document. Defaults to the primary one.
​
Boolean
Include the account balance on the letter. Omitted by default, since the balance is sensitive.
​
DateTime
Report the available balance as of the end of this day (US Eastern) rather than the current balance, and label the letter’s as-of line with that date. Cannot be in the future. Applies only when displayBalance is true; ignored otherwise.Requires a full RFC-3339 timestamp — a date alone (“2026-07-01”) is rejected. Only the day the instant falls on in US Eastern is used, so send an Eastern-anchored timestamp: UTC midnight (“2026-07-01T00:00:00Z”) is 8pm Eastern the day before and reports June 30.

​
Returns

SpendAccountPdfDocument! — A PDF artifact containing ACH routing and account instructions for funding a spend account’s virtual account number, returned as a base64-encoded string for the client to decode and render or download.