The QuickBooks Payments team is pleased to introduce a new Payment Receipt API that allows third-party apps to retrieve a receipt for completed transactions that can be provided—or made accessible—to the payor for each transaction.
With a simple API call, you can now retrieve payment receipts in PDF format. To use the API to retrieve a PDF receipt, follow these steps:
- Use the charges entity to make a payment for a transaction (e.g., invoices and sales receipts). Retrieve the client transaction ID (field clientTransID) from the response.
- Call the payment receipt endpoint by passing the client transaction ID in the request URL.
Here is a sample Request:
GET https://quickbooksapi.api.intuit.com/quickbooks/v4/payments/receipt/<client-trans-id>
Note that there can be a delay in generating a receipt when the payment is received (during this time the API will return an error in retrieving the receipt). For a PDF endpoint, make sure to set the content-type as application/pdf.
Here is a sample Payment Receipt:
The receipt will display specific fields as shown below:
| Field | Description |
|---|---|
| Payment Amount | Amount of money to be transferred |
| TransID | Client transaction id of the payment |
| Date of Transaction | Date payment is processed |
| Payment Method | Payment method/funding account |
| Auth Code | Authorization Code/Number |
For more information about individual entities or fields, refer to the API Reference.
Have additional questions or comments? Share them on our developer forums!