Sign in
Payment Runs

Create a payment run

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:

  • Use the accountId, batch, billCycleDay, currency, paymentGatewayId, and billingRunId fields to define the billing documents to be collected.
  • Use the 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.

post/v1/payment-runs

Headers

Idempotency-Keystring

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-Encodingstring

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.

Content-Encodingstring

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.

Zuora-Track-Idstring

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 (').

Zuora-Entity-Idsstring

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-Idsstring

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.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

accountIdstring uuid

The ID of the customer account associated with the payment run.

This field conflicts with each of the batch, billCycleDay, currency, paymentGatewayId, and billingRunId fields. If there are such conflicts, an error occurs and an error message is returned.

applyCreditBalanceboolean

If applyCreditBalance is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.

autoApplyCreditMemoboolean

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.

autoApplyUnappliedPaymentboolean

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.

batchstring

The alias name given to a batch. The batch name is a string of 50 characters or less.

This field conflicts with the accountId field. If they are both specified in the request body, an error occurs and an error message is returned.

Note: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the <a href="https://docs.zuora.com?resourceId=performance-booster-elite" target="_blank">Performance Booster Elite</a> package.

billCycleDaystring

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 accountId field. If they are both specified in the request body, an error occurs and an error message is returned.

billingRunIdstring uuid

The ID of a bill run.

This field conflicts with the accountId field. If they are both specified in the request body, an error occurs and an error message is returned.

collectPaymentboolean

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.

consolidatedPaymentboolean

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.

currencystring

A currency defined in the web-based UI administrative settings.

This field conflicts with the accountId field. If they are both specified in the request body, an error occurs and an error message is returned.

paymentGatewayIdstring uuid

The ID of the gateway instance that processes the payment.

This field conflicts with the accountId field. If they are both specified in the request body, an error occurs and an error message is returned.

processPaymentWithClosedPMboolean

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.

runDatestring

The date and time when the scheduled payment run is to be executed, in yyyy-mm-dd hh:mm:ss format. The backend will ignore mintues and seconds in the field value. For example, if you specify 2017-03-01 11:30:37 for this value, this payment run will be run at 2017-03-01 11:00:00.

You must specify either the runDate field or the targetDate field in the request body. If you specify the runDate field, the scheduced payment run is to be executed on the run date. If you specify the targetDate field, the payment run is executed immediately after it is created.

targetDatestring 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 runDate field or the targetDate field in the request body. If you specify the runDate field, the scheduced payment run is to be executed on the run date. If you specify the targetDate field, the payment run is executed immediately after it is created.

useCustomPaymentMethodsboolean

Whether to enable payment profiles for a payment run.

Example request

{
  "accountId": "8ad09be48db5aba7018db604776d4854",
  "targetDate": "2024-07-24"
}

Response

OK

accountIdstring

The ID of the customer account associated with the payment run.

applyCreditBalanceboolean

Note: This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.

Whether to apply credit balances in the payment run. This field is only available when you have Invoice Settlement feature disabled.

autoApplyCreditMemoboolean

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.

autoApplyUnappliedPaymentboolean

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.

batchstring

The alias name given to a batch.

billCycleDaystring

The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account.

billingRunIdstring uuid

The ID of the bill run.

collectPaymentboolean

Whether to process electronic payments during the execution of payment runs.

completedOnstring nullable

The date and time when the payment run is completed, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-01 11:39:58.

consolidatedPaymentboolean

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.

createdByIdstring

The ID of the Zuora user who created the payment run.

createdDatestring

The date and time when the payment run was created, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-01 15:31:10.

currencystring

A currency defined in the web-based UI administrative settings.

executedOnstring nullable

The date and time when the payment run is executed, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-01 11:30:37.

idstring

The ID of the payment run.

numberstring

The identification number of the payment run.

paymentGatewayIdstring uuid nullable

The ID of the gateway instance that processes the payment.

processPaymentWithClosedPMboolean

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.

runDatestring nullable

The date and time when the scheduled payment run is to be executed for collecting payments.

status'Pending' | 'Processing' | 'Completed' | 'Error' | 'Canceled'

The status of the created payment run.

successboolean

Returns true if the request was processed successfully.

targetDatestring date

The target date used to determine which receivables to be collected in the payment run.

updatedByIdstring

The ID of the Zuora user who last updated the payment run.

updatedDatestring

The date and time when the payment run was last updated, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-02 15:36:10.

useCustomPaymentMethodsboolean

Whether to enable payment profiles for a payment run.

Example response

{
  "batch": "Batch1",
  "currency": "USD"
}

Changes