Skip to main content
Retrieves a PDF paycheck direct-deposit form 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. depositAmount is required when depositType is FIXED. depositPercentage (1-100) is required when depositType is PERCENTAGE. 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.
​
PaycheckDepositType!
required
How much of each paycheck to deposit: the entire check, a fixed amount, or a percentage.
​
Float
Dollar amount to deposit each paycheck. Required when depositType is FIXED, ignored otherwise.
​
Float
Percentage (1-100) of each paycheck to deposit. Required when depositType is PERCENTAGE, ignored otherwise.
​
String
Employer name to print on the form’s employer line, 1-150 characters. Left blank when omitted.
​
String
Name to print as the account holder on the form, 1-150 characters. Defaults to the account’s legal name, with any DBA name on a second line.
​
Boolean
When true, pre-fills the signature line with the printed account-holder name in italics. Defaults to false, which leaves the signature line blank to be signed by hand.

​
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.