POST /v1/payment-runs

Default value: "application/json"

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

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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.

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 do not need to set this header.

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.

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.

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.

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.

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.

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

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.

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 number of the customer account associated with the payment run, such as A00000001.

You can specify either accountNumber or accountId for a customer account, but not both of them.

If consolidatedPayment is set to true, this field is used in processing a single payment for invoices, debit memos, and standalone payments due on an account.

Additional comments.

The ID of the payment method for collecting invoices/debit memos. The specified payment method must be a valid non-system payment method. If it is not specified, the default payment method of the account is used regardless of the autoPay value of the account.

If processPaymentWithClosedPM is set to false, the payment method cannot be closed.

If the payment retry rules are enabled, the payment method must meet the rules.

If consolidatedPayment is set to true, this field is used in processing a single payment for invoices/debit memos due on an account.

A valid account ID associated with the payment run.

If consolidatedPayment is set to true, this field is used in processing a single payment for invoices/debit memos due on an account.

The ID of a billing document associated with the payment run. documentId must be valid and match with documentType.

You must either specify both documentId and documentType, or specify neither of them.

If neither of documentType and documentId is specified, all invoices/debit memos with open balance of the account are collected.

The ID of the payment gateway for collecting invoices/debit memos. The specified payment gateway must be valid and active.

If Payment Gateway Routing is enabled:

• If this field is not specified, gateway routing rules will be invoked.
• If this field is specified, the specified gateway will be used to process the payment.

If Payment Gateway Routing is disabled:

• If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant.
• If this field is specified, the specified gateway will be used to process the payment.

If consolidatedPayment is set to true, this field is used in processing a single payment for invoices/debit memos due on an account.

The amount to be collected for the specified invoice/debit memo. amount must be a positive numeric value no more than the balance of the specified invoice/debit memo.

This field is only available when documentId is specified. If amount is not specified, whole balance of the invoice/debit memo is collected.

Note: This field is only available if support for standalone payments is enabled.

Specify true to indicate that this is a standalone payment that will be created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. When standalone is set to true:

• accountId or accountNumber is required.
• amount is required.
• The amount will not be summed up into the account balance and key metrics regardless of the payment currency.
• No settlement data will be created.
• Either the applied amount or the unapplied amount of the payment is zero.
• The standalone payment cannot be applied, unapplied, or transferred.

Default value: false

The array of data for each Invoice if you want to collect payment for particular items through one payment method. The grouped items are sent as one data record. This field is available if the Invoice Item Settlement permission is enabled.

Here is another example for a data item:

{
  "accountId": "60c81b5bc51649e8a7d1b48303194790",
  "documentId": "2c9081a03c63c94c013c6894af5602dd",
  "documentType": "Invoice",
  "dataItems": [
    {
        "documentItemId": "8a92ab0e8ab14c53018ac746961c10d1",
        "amount": 40
    },
    {
        "taxItemId": "8a92ab0e8ab14c53018ac746961c10d2",
        "amount": 40
    }
],
  "amount": 80,
  "paymentMethodId": "2c9081a03c6d7b51013c6d7e4ada0a1c",
  "paymentGatewayId": "d2abe8342e1811ea80e774b9452e17ea",
  "comment": "Payment Comments",
  "customField1__c": "cf_value1",
  "customField2__c": "cf_value2"
},

The ID of a billing document of the invoice item or debit memo item.

The total amount to be collected for the specified invoice/debit memo item. The sum of the item amount should be equal to document amount.

The tax ID of the invoice item or debit memo item.

The type of a billing document associated with the payment run. The value can be Invoice or DebitMemo, but DebitMemo is only supported if the Invoice Settlement feature is enabled.

You must either specify both documentType and documentId, or specify neither of them.

If neither of documentType and documentId is specified, all invoices/debit memos with open balance of the account are collected.

Possible values:

• "Invoice"
• "DebitMemo"

The number of a billing document associated with the payment run. documentNumber must be valid and match with documentType.

You must either specify both documentNumber and documentType, or specify neither of them.

If neither of documentType and documentNumber is specified, all invoices/debit memos with open balance of the account are collected.

Note: This field is only available if support for standalone payments is enabled.

The currency of the standalone payment. Specify this field only if the standalone field is true. The currency of the standalone payment can be different from the payment currency defined in the customer account settings.

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.

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 organization name.

The organization ID.

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.

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.

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.

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.

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.

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.

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.