Creates a payment run. You can create a payment run to be executed immediately after it is created, or a scheduled payment run to be executed in future.
To filter the payments to be collected for a payment run, you can use either of the following methods but not both:
accountId
, batch
, billCycleDay
, currency
, paymentGatewayId
, and billingRunId
fields to define the billing documents to be collected.data
field to specify the records of accounts and billing documents to be collected, in a more flexible manner. See Create custom payment runs through Zuora REST API for more information.If no filter criteria are specified in the request body, the payment run collects payments for all accounts.
Idempotency-Key | string <= 255 characters 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. |
Accept-Encoding | string Include the If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a |
Content-Encoding | string Include the |
Authorization | string The value is in the |
Zuora-Track-Id | string <= 64 characters 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 ( |
Zuora-Entity-Ids | string 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. |
Zuora-Org-Ids | string Comma separated IDs. If you have Zuora Multi-Org 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. If the header is not set, the operation is performed in scope of the user's accessible orgs. |
accountId | string <uuid> The ID of the customer account associated with the payment run. This field conflicts with each of the |
applyCreditBalance | boolean If |
autoApplyCreditMemo | boolean Note: This field 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. Whether to automatically apply a posted credit memo to one or more receivables in the payment run. |
autoApplyUnappliedPayment | boolean Note: This field 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. Whether to automatically apply unapplied payments to one or more receivables in the payment run. |
batch | string The alias name given to a batch. The batch name is a string of 50 characters or less. This field conflicts with the Note: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package. |
billCycleDay | string The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. The value must be equal to or less then 31, and 31 is mean the EOM. This field conflicts with the |
billingRunId | string <uuid> The ID of a bill run. This field conflicts with the |
collectPayment | boolean Whether to process electronic payments during the execution of payment runs. If the Payment user permission "Process Electronic Payment" is disabled, this field will be ignored. |
consolidatedPayment | boolean Note: The Process Electronic Payment permission also needs to be allowed for a Manage Payment Runs role to work. See Payments Roles for more information. Whether to process a single payment for all receivables that are due on an account. |
currency | string A currency defined in the web-based UI administrative settings. This field conflicts with the |
Array of objects (payment run data) The array of data for specifying records of accounts and invoices/debit memos that will be collected and processed by a payment run. When you specify the data array, ensure that at least one record is passed in. If an empty array is specified, A maximum of 50K records are allowed to be passed into the Here is an example:
Here is another example for a standalone payment:
| |
Array of objects The organizations that the run is created for. For each item in the array, either the This field is only required when you have already turned on Multi-Org feature. | |
paymentGatewayId | string <uuid> The ID of the gateway instance that processes the payment. This field conflicts with the |
processPaymentWithClosedPM | boolean Note: The Process Electronic Payment permission also needs to be allowed for a Manage Payment Runs role to work. See Payments Roles for more information. Whether to process payments even if the default payment method is closed. |
runDate | string <date-time> The date and time when the scheduled payment run is to be executed, in You must specify either the |
targetDate | string <date> The target date used to determine which receivables to be paid in the payment run. The payments are collected for all receivables with the due date no later than the target date. You must specify either the |
{- "accountId": "8ad09be48db5aba7018db604776d4854",
- "targetDate": "2024-07-24"
}
{- "id": "8ad0835290e7dcf90190fd37f43e4bd8",
- "number": "PR-00000006",
- "targetDate": "2024-07-24",
- "runDate": null,
- "status": "Pending",
- "accountId": "8ad09be48db5aba7018db604776d4854",
- "executedOn": null,
- "completedOn": null,
- "autoApplyCreditMemo": false,
- "autoApplyUnappliedPayment": false,
- "consolidatedPayment": false,
- "processPaymentWithClosedPM": false,
- "collectPayment": true,
- "createdDate": "2024-07-28 23:40:21",
- "createdById": "b243314d594646d3b2651aeedd4be47e",
- "updatedDate": "2024-07-28 23:40:21",
- "updatedById": "b243314d594646d3b2651aeedd4be47e",
- "success": true
}