Payment Fields

Each payment has a number of fields that they consist of. The fields are listed below for your reference.

ID Name Field Key Info
1 payee Payee Name The name of the payee
2 payee_first Payee First Name The first name of the payee
3 payee_last Payee Last Name The last name of the payee
4 address Address The email or mailing address to deliver the payment to
5 amount Amount The amount of the payment
6 currency Currency The currency of the payment
7 send_date Send Date The date to send the payment on
11 memo Memo A memo/note for the payment
12 reference Reference An internal reference for the payment
13 check_num Check Number Check number
14 postage_id Postage Type The type of postage to use on mailed checks
15 funding_source Funding Source The funding source to use for this payment
16 insert Insert The insert to include with the payment
17 address2 Address 2 Secondary part of a mailing address
18 city City The city part of the address
19 state State The state part of the mailing address
20 zip Zip The zip code part of the mailing address
23 country Country The country part of the mailing address
24 generic_1 Generic #1 A generic field for random data
25 generic_2 Generic #2 A generic field for random data
26 generic_3 Generic #3 A generic field for random data
27 generic_4 Generic #4 A generic field for random data
28 generic_5 Generic #5 A generic field for random data
29 generic_6 Generic #6 A generic field for random data
30 generic_7 Generic #7 A generic field for random data
31 generic_8 Generic #8 A generic field for random data
32 generic_9 Generic #9 A generic field for random data
33 generic_10 Generic #10 A generic field for random data
34 stub_details_header Stub Details Header A delimited list of headers for the stub 'details' table
35 stub_details Stub Details A doubly delimited list of lines for the stub 'details' table. Lines are | delimited, columns are ; delimited; avoid trailing delimiters and match the header column count (maximum 7) Detail lines beyond the first 21 print on additional overflow pages (31 lines per overflow page); overflow pages always print duplex and their sheets count toward the piece's sheet total and weight for postage classification.
36 check_date Check Date The date printed on the actual check. Use MM/DD/YYYY or YYYY-MM-DD — dash- or dot-separated dates (e.g. 08-07-2026) are read as day-month-year, not month-day-year
37 mail_to Mail To Name The name on the mailing address
38 taxid TaxID / SSN The payee's ssn or taxid
39 trans_id Client Transaction ID An internal transaction id
40 logo Logo Logo to use for this file
41 generic_11 Generic #11 A generic field for random data
42 generic_12 Generic #12 A generic field for random data
43 generic_13 Generic #13 A generic field for random data
44 generic_14 Generic #14 A generic field for random data
45 generic_15 Generic #15 A generic field for random data
46 insert_color Insert is Color When a url is passed in the insert field, this field is used to tell the system if the insert being added is black & white or color.
47 insert_name Insert Name When a url is passed in the insert field, this field specifies what to name it when it is added to the system.
48 insert_desc Insert Description When a pdf url is passed in the insert field, this field specifies what to set it's description as when adding it to the system.
49 mobile_number Mobile Number Payee's mobile phone number
50 digital_check_pass Digital Check Password Password required to claim a digital check
51 method_id Method ID The payment method to use
52 account_type Account Type Account Type for ACH payments
53 account_num Payee Account Number Payee's account number for ACH payments
54 routing_num Payee Routing Number Payee's routing number for ACH payments
56 stub_text Stub Text Text for the check stub
57 client_id Client The client to send the payment from
58 onboard_pass ACH Onboarding Password Password required to specify ACH account information and claim an ACH payment.
59 ach_info_threshold ACH Info Matching Specifies when to pull previous ACH info for a payee.
60 generic_16 Generic #16 A generic field for random data
61 generic_17 Generic #17 A generic field for random data
62 generic_18 Generic #18 A generic field for random data
63 generic_19 Generic #19 A generic field for random data
64 generic_20 Generic #20 A generic field for random data
65 wl_id Whitelabel ID Override the whitelabel ID from the payments funding source
66 stub_header Stub Header Stub Header
67 generic_21 Generic #21 A generic field for random data
68 generic_22 Generic #22 A generic field for random data
69 generic_23 Generic #23 A generic field for random data
70 generic_24 Generic #24 A generic field for random data
71 generic_25 Generic #25 A generic field for random data
72 generic_26 Generic #26 A generic field for random data
73 generic_27 Generic #27 A generic field for random data
74 generic_28 Generic #28 A generic field for random data
75 generic_29 Generic #29 A generic field for random data
76 generic_30 Generic #30 A generic field for random data
77 logo_color Logo is Color When a png url is passed in the logo field, or a logo is uploaded, this field is used to tell the system if the logo being added should be printed black & white or color.
78 logo_desc Logo Description When a png url is passed in the logo field or one is uploaded, this field specifies what to set it's description as when adding it to the system.
79 logo_name Logo Name When a url is passed in the logo field or a png is uploaded, this field specifies what to name it when it is added to the system.
80 qbo_acct_id QuickBooks Online Account QuickBooks Online account ID for syncing payments
81 qbo_vendor_id QuickBooks Online Vendor QuickBooks Online vendor ID for syncing payments
82 qbo_bill_id QuickBooks Online Bill QuickBooks Online bill ID for syncing payments
83 recipient_instructions Recipient Instructions ATTN: line on mailing address
84 approved Approved Auto Approve (API Only)
85 return_envelope_id Return Envelope Optional integer ID of an active Return Envelope owned by the payment's client. For creation or upload, omit, pass null, or pass 0 for none. For updates, omit to preserve the current assignment; pass null or 0 to clear it.

Mail Profile Response Fields

These eight fields appear directly on the payment objects returned by add, update, upload, confirm, and get-by-ID. List Payments omits them and includes mail_profile_url on each payment instead. Follow that URL with an authenticated GET to retrieve a mail_profile object containing payment_id and these eight fields; see Get Payment Mail Profile.

return_envelope_id is also an accepted request field, as described above. The other seven fields are computed by the system and are response-only. For a payment that has not been profiled, the nullable fields are null, both split counts are 0, and large_envelope is 0. A profiled payment can also have a null return_envelope_id when no return envelope is attached.

postage_id remains part of the payment response and reflects saved postage changes. Add and update keep their existing conditional top-level postage_message when an automatic Priority upgrade occurs; see their response documentation.

ID Name Field Key Info
1 return_envelope_id Return Envelope The id of the active return envelope attached to the payment (int), or null when none
2 mail_class Mail Class Computed mail classification: letter, large_envelope, large_envelope_intl, or priority (string), or null. Older stored profiles may return the equivalent legacy values usps_first_class_letter, usps_first_class_large_envelope, usps_first_class_large_envelope_intl, or usps_priority, respectively.
3 mail_class_reason Mail Class Reason Why the classification was assigned: letter, sheet_count_triggered_large_envelope, weight_triggered_large_envelope, or priority_upgrade (string), or null
4 sheet_count Sheet Count Total physical sheets in the piece: check stock plus insert and overflow sheets (int), or null
5 check_sheet_count Check Sheet Count Number of check-stock sheets in the piece (int)
6 insert_sheet_count Insert Sheet Count Number of insert and overflow paper sheets in the piece (int)
7 computed_weight_oz Computed Weight Oz Total computed weight of the piece in ounces, including the outer envelope and any return envelope (decimal string), or null
8 large_envelope Large Envelope Whether the piece mails in a large (9x12) envelope: 1 for yes, 0 for no