# QuickBooks Payment API

**Canonical:** https://apis.io/apis/quickbooks/quickbooks-payment-api/  
**Provider:** QuickBooks — https://apis.io/providers/quickbooks/  
**Base URL:** https://quickbooks.api.intuit.com  
**Documentation:** https://developer.intuit.com/app/developer/qbo/docs/develop

QuickBooks Payment API is one of 82 APIs that [QuickBooks](https://apis.io/providers/quickbooks/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 12 JSON Schema definitions. Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, an AsyncAPI specification, and 12 JSON Schemas.

A Payment object records a payment in QuickBooks. The payment can be applied for a particular customer against multiple Invoices and Credit Memos. It can also be created without any Invoice or Credit Memo, by just specifying an amount. A Payment can be updated as a full update or a sparse update. A Payment can be linked to multiple Invoices and Credit Memos. A Payment can be created as unapplied to any Invoice or Credit Memo, in which case it is recorded as a credit. If any element in any line needs to be updated, all the Line elements of the Payment object have to be provided. This is true for full or sparse update. Lines can be updated only ALL or NONE. To remove all lines, send an empty Line element. To remove some of the lines, send all the Lines that need to be present MINUS the lines that need to be removed. To add some lines, send all existing and new Lines that need to be present. The sequence in which the lines are received is the sequence in which lines are preserved. If you have a large number of invoice and corresponding payment records that you wish to import to the QuickBooks Online company, sort the invoice and payment records in chronological order and use the batch resource to send invoice and payments batches of 10, one after the other, to ensure any open invoices get credited with their payments.

## Operations (5)

| Method | Path | Summary |
|---|---|---|
| GET | `/v3/company/{realmID}/query` | Query an entity with a SELECT statement |
| POST | `/v3/company/{realmID}/payment` | Create a payment / Delete a payment / Void a payment / Full update a payment |
| GET | `/v3/company/{realmID}/payment/{paymentId}/pdf` | Get a payment as PDF |
| GET | `/v3/company/{realmID}/payment/{paymentId}` | Read a payment |
| POST | `/v3/company/{realmID}/payment/{paymentId}/send` | Send a payment |

## Machine-readable artifacts (23)

- **OpenAPI** — https://artifacts.apis.io/quickbooks/openapi/quickbooks-payment-api-openapi.yml
- **Documentation** — https://developer.intuit.com/app/developer/qbo/docs/develop
- **APIReference** — https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/account
- **GettingStarted** — https://developer.intuit.com/app/developer/qbo/docs/get-started
- **Authentication** — https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/oauth-2.0
- **AsyncAPI** — https://artifacts.apis.io/quickbooks/asyncapi/quickbooks-online-webhooks-asyncapi.yml
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-invoiceresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-salesreceiptresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-estimateresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-refundreceiptresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-customerresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-creditmemoresponse-schema.json
- **Documentation** — https://developer.intuit.com/app/developer/qbpayments/docs/develop
- **APIReference** — https://developer.intuit.com/app/developer/qbpayments/docs/api/resources/all-entities/charges
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-chargeresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-card-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-bankaccount-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-echeckresponse-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-chargerequest-schema.json
- **JSONSchema** — https://artifacts.apis.io/quickbooks/json-schema/quickbooks-bankaccountrequest-schema.json
- **Documentation** — https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account
- **Sandbox** — https://sandbox-quickbooks.api.intuit.com/v3/company/{realmId}
- **API Explorer** — https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/account

## Other QuickBooks APIs (12)

- [QuickBooks Online GraphQL API](https://apis.io/apis/quickbooks/graphql/)
- [QuickBooks Workforce Payroll API](https://apis.io/apis/quickbooks/payroll/)
- [QuickBooks Account API](https://apis.io/apis/quickbooks/quickbooks-account-api/)
- [QuickBooks Account List Detail API](https://apis.io/apis/quickbooks/quickbooks-accountlistdetail-api/)
- [QuickBooks AP Aging Detail API](https://apis.io/apis/quickbooks/quickbooks-apagingdetail-api/)
- [QuickBooks AP Aging Summary API](https://apis.io/apis/quickbooks/quickbooks-apagingsummary-api/)
- [QuickBooks AR Aging Detail API](https://apis.io/apis/quickbooks/quickbooks-aragingdetail-api/)
- [QuickBooks AR Aging Summary API](https://apis.io/apis/quickbooks/quickbooks-aragingsummary-api/)
- [QuickBooks Attachable API](https://apis.io/apis/quickbooks/quickbooks-attachable-api/)
- [QuickBooks Balance Sheet API](https://apis.io/apis/quickbooks/quickbooks-balancesheet-api/)
- [QuickBooks Batch API](https://apis.io/apis/quickbooks/quickbooks-batch-api/)
- [QuickBooks Bill API](https://apis.io/apis/quickbooks/quickbooks-bill-api/)

## Tags

Payments

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/quickbooks/quickbooks-payment-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/quickbooks/.