Get payment methods
List the payment methods configured for your company. A payment method is how money changes hands on a payment — its type is one of CASH, CHECK, CREDIT_CARD, BANK_REMITTANCE, or BANK_TRANSFER, and each method has a company-chosen name on top of that type. Use this to resolve the payment method a payment references, or to discover the set of methods available when recording payments.
Payment methods can be linked to a QuickBooks Online payment method; when they are, the response's qb_payment_method_id holds the QuickBooks Online identifier the method is mapped to (null when it isn't mapped).
This endpoint does not paginate: it returns every matching payment method in a single data array, and next_page is always null. Results are scoped to your company only.
Note: this endpoint returns eventually consistent data — a create, edit, or delete can take up to 1 second to be reflected here.
Required permission: settings_permissions_payment_methods.
Query parameters
Restrict the result to specific payment methods by ID (the same ID returned as each payment method's id). Repeat the bracketed key once per ID. Unknown IDs simply match nothing; an empty list is treated as no filter. At most 200 IDs may be given.
Controls whether soft-deleted payment methods are included. no (the default) returns only active, non-deleted methods; only returns exclusively soft-deleted methods (those with a non-null deleted_at); include returns both together. Soft-deleted methods are hidden from new use but stay attached to the historical payments that already referenced them, so only/include are how you resolve those older references. Values are lowercase. Example: ?deleted=include.
Filter to payment methods by their creation datetime, given as a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted for an open-ended range: 2022-07-10T00:00:00Z, matches on or after that instant, ,2022-07-10T00:00:00Z matches on or before it.
Filter to payment methods by their last-updated datetime, given as a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted for an open-ended range.
Response
A list of payment methods
Changes
No recorded changes to this endpoint across all 1 revision of this API.