Create a payment
Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.
Creates a payment in the following scenarios:
- A full or partial payment on an invoice or a debit memo
- A full or partial payment on several invoices and debit memos
- An unapplied payment in the following situations:
- You do not know which customer account the payment belongs to.
- You know which customer account the payment belongs to, but you do not know which invoice the payment is applied to.
- You receive a payment from your customer that exceeds the balance on the invoice.
- You receive a payment from your customer before the invoice has been created.
- You intend to create a payment without any invoices or debit memos.
- A standalone payment. If you only need to create and process an electronic payment in Zuora through a Zuora gateway integration but settle the payment outside of Zuora, you can create a standalone payment. For a standalone payment, you can specify a currency different from the payment currency in the customer account settings. When Standalone Payment is not enabled, the currency of the standalone payment can be different from the payment currency defined in the customer account settings if you have the Multiple Currencies feature enabled.
If you do not know to which customer account the payment belongs, you can create a payment without specifying a customer account.
When you create a payment, the total number of invoice items and debit memo items that the payment will apply to should be less than or equal to 15,000.
For more information, see Create Payments and Create Payments Without Specifying Customer Accounts.
Headers
Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.
With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.
If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.
Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.
The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').
An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.
Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.
The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.
The minor API version.
For a list of available minor versions, see API upgrades.
Request body
Example request
{
"accountId": "8a90b4488e7d5c0f018e7db3892400b2",
"type": "External",
"paymentMethodId": "2c92c8f95e2d6ebb015e325df7a70356",
"amount": 14.99,
"currency": "USD",
"invoices": [
{
"invoiceId": "8a90e5e4914ad4fa01914b25ff2c036e",
"amount": 14.99
}
]
}Response
OK