Create a payment run

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.

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.

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.

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.

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 Performance Booster Elite package.

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.

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.

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.

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.

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, accountId, batch, billCycleDay, currency, paymentGatewayId, and billingRunId fields will be used to define the billing documents to be collected. If the Multiple Currencies feature is enabled, you can filter the accounts by currency based on the customer’s billing document.

A maximum of 50K records are allowed to be passed into the data array.

Here is an example:

  {
    "accountId": "60c81b5bc51649e8a7d1b48303194790",
    "documentId": "2c9081a03c63c94c013c6894af5602dd",
    "documentType": "Invoice",
    "amount": 80,
    "paymentMethodId": "2c9081a03c6d7b51013c6d7e4ada0a1c",
    "paymentGatewayId": "d2abe8342e1811ea80e774b9452e17ea",
    "comment": "Payment Comments",
    "customField1__c": "cf_value1",
    "customField2__c": "cf_value2"
  }

Here is another example for a standalone payment:

  {
    "accountId": "account2",
    "amount": 100,
    "currency": "GBP",
    "standalone": true
  }

The organizations that the run is created for.

For each item in the array, either the organizationId or the organizationName field is required.

This field is only required when you have already turned on Multi-Org feature.

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.

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.

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.

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.