Payments

OAuth

Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST API.

You must first create an OAuth client in the Zuora UI before using the Create an OAuth token operation to create an OAuth token. See Authentication for more information.

Operations

Commerce

The Commerce APIs provide access to product catalog, plans, charges, and order management functionality in Zuora. These endpoints are used to create, update, and query product rate plans, charges, and dynamic pricing details that drive subscription and billing behavior.

In a typical use case, the Commerce APIs are called to provision new products or plans in the catalog, configure dimensional pricing, or submit orders that create and modify subscriptions.

Changes made with these APIs affect the product catalog and active subscriptions, depending on the endpoint. Catalog changes update future subscription behavior, while order operations directly impact customer subscriptions in real time.'

Operations

Accounts

Some operations in this section are similar to each other, but are provided for different use scenarios. You should choose the one that best suits your needs.

For example, the Retrieve an account operation retrieves the basic information of an account, such as bill-to and sold-to contacts, billing and payments setup information, and metrics data for the account.

The Retrieve an account summary operation returns the more detailed information of an account, such as bill-to and sold-to contacts, subscriptions, invoices, payments, and usages associated with this account.

Operations

Contacts

A contact defines the customer who holds an account or who is otherwise a person to contact about an account. An account requires a contact for the BillToId and SoldToId fields before the account can be active.

Operations

Contact Snapshots

Every time a contact is updated a snapshot is taken.

Operations

Sign Up

A light-weight API to sign up customers and subscribe.

You need to have the Orders or Orders Harmonization feature enabled to use this API.

Operations

Orders

Orders are contractual agreements between merchants and customers.

You can create multiple subscriptions and subscription amendments at once in a single order. All the operations on subscriptions in orders are done by order actions. You can also create order line items to support your non-subscription based business models.

Zuora calculates order delta metrics when orders take place. You can retrieve order delta metrics and measure billed and unbilled amounts by order.

For more information about Orders, see Overview Of Orders. To learn how orders interacts with billing accounts, subscriptions, and product catalog, see Zuora object model.

Operations

Order Actions

You need to have the Orders or Orders Harmonization feature enabled to use this API.

Operations

Order Line Items

Use order line item to launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. For more information about order line items, see Order Line Items.

Operations

Fulfillments

Fulfillments are subordinate objects attached to their related order line item. Fulfillment items are subordinate objects attached to their related fulfillment.

For more information, see Overview of Order Line Items.

Operations

Ramps

A Ramp is a time container to associate with rate plan charges in your subscription. Inside the Ramp, you can further define a set of Ramp Intervals (time-based periods) where products or pricing can change. These periods are sub time containers to enable you to report out-of-the-box metrics based on Ramp Intervals.

Notes: You must have both the Ramps feature and Orders feature enabled for your tenant to use the Ramps operations.

For more information, see Ramps and Ramp Metrics.

Operations

Subscriptions

A subscription is a product or service that has recurring charges, such as a monthly flat fee or charges based on usage. Subscriptions can also include one-time charges, such as activation fees. Every subscription must be associated with an account. At least one active account must exist before any subscriptions can be created.

For more information, see Subscriptions.

Operations

Omnichannel Subscriptions

An omnichannel subscription is a subscription originating from external and source systems, such as the Apple App Store, Google Play Store, and Roku Store.

To create, update, delete, or retrieve an omnichannel subscription, you must turn on the Omni-Channel Subscription feature. For more information, see Omni-Channel Subscription.

Operations

Subscription Change History

The change histories of single version subscriptions.

Note: To access the change histories, you must turn on the following features:

Operations

Rate Plans

A rate plan is part of a subscription or an amendment to a subscription, and it comes from a product rate plan. Like a product and its product rate plans, a subscription can have one or more rate plans. Rate plans are sometimes called subscription rate plans. Rate plans that are part of an amendment are sometimes called amendment rate plans.

Rate plans represent a price or a collection of prices for a service you sell. An individual rate plan contains all charges specific to a particular subscription.

Operations

Commitments

A commitment represents a minimum or maximum spend amount a customer is obligated to pay within a spend period, compared with customer's actual fees incurred in connection with customer's accounts and their use of applicable products. The Commitments API allows you to retrieve details of the commitments a customer has.

Operations

Prepaid with Drawdown

The Prepaid with Drawdown feature is a pricing model for consumption-based services, such as data storage. Under this model, customers pay upfront to receive a number of units, usually for a period of time like a month or a year. Then they consume against that prepayment balance in a use-it-or-lose-it fashion, with a possibility of topping up more units or being charged for any overage. This model strikes a balance between upfront commitment and the pure pay-as-you-go pricing models. For more information, see Prepaid with Drawdown.

Operations

Usage

Consumption of a billable service or resource (such as database storage space or bundles of emails sent) provides the basis for some charge models - simple usage, tiered pricing, or volume pricing. To make this work, usage must be tracked in the system and usage charges must be calculated and invoiced. Usage is always billed in arrears - for example, you might bill customers in February for their January usage. Usage can be billed on a recurring monthly, quarterly, semi-annual, or annual basis.

Operations

Meters

The Zuora Mediation APIs provide a comprehensive set of endpoints to manage, test, run, and monitor usage meters. These APIs support actions such as running or testing specific meter versions, importing and exporting meter configurations, managing input files, performing event store operations, and ingesting usage data in real time via streaming. All APIs follow a consistent response structure to simplify integration and error handling. Use these APIs to automate and streamline your usage processing pipeline—from data ingestion to transformation and billing.

Operations

Delivery Adjustments

Delivery Adjustments are used to handle end customer delivery complaints for the Delivery Pricing charge model. For more information, see Delivery Adjustments.

Operations

Billing Documents

Billing documents include invoices, credit memos, and debit memos.

Note: Credit memos and debit memos are only available if you have the Invoice Settlement feature enabled.

Operations

Invoices

Invoices provides information about customers' accounts for invoices, for examples, dates, status, and amounts.

For more information about invoices, see Invoice.

Operations

Credit Memos

Credit memos reduce invoice and account balances. By applying one or more credit memos to invoices with positive balances, you can reduce the invoice balances in the same way that applying a payment to an invoice.

For more information about credit memos, see Credit and debit memos.

Operations

Debit Memos

Debit memos increase the amount a customer owes. It is a separate document from the invoice. Debit memos can be used to correct undercharging on an invoice or to levy ad hoc charges outside the context of a subscription. Just like an invoice, debit memo balances can be settled by applying either a payment or a credit memo.

For more information about debit memos, see Credit and debit memos.

Operations

E-Invoicing

With the E-Invoicing feature, Zuora supports electronic invoices through an integration with partners that have a local presence, where required, which guarantees compliance with local invoice regulations.

All the operations in this section are available only if you have the E-Invoicing feature enabled.

Operations

Invoice Schedules

Use invoice schedules to trigger invoice generation processes.

For more information about invoice schedules, see Billing Schedule overview.

Operations

Taxation Items

The TaxationItem object is used to add a tax amount to an invoice item. In the typical use case, the tax amount that you specify in the object is calculated by Z-Tax or a third-party tax engine such as Avalara or Connect tax engine.

Changes that you make with this object affect the product charges in your product catalog, but not the charges in existing subscriptions.

Operations

Sequence Sets

You can create billing document sequence sets through the REST API or the Zuora UI, allowing distinct numbering sequences for billing documents, payments, and refunds.

To create a billing document sequence set through the Zuora UI, see Create Billing Document Sequence Sets for more information.

Operations

Use operations to generate invoices and credit memos, collect payments for posted invoices, and generate previews of future invoice items for customer accounts.

Operations

Summary Statements

The Summary Statement feature provides a comprehensive overview of billing activities for each account using HTML templates that compile data like invoices, credit memos, payments, and more. The associated APIs help automate the creation and management of these statements. See Account Summary Statements for more information.

Operations

Bill Run

Use the Bill Run call to create ad hoc bill runs and Post, Cancel, Query, and Delete bill runs.

For more information about bill runs, see Bill runs.

Operations

Billing Preview Run

A billing preview run asynchronously generates a downloadable CSV file containing a preview of future invoice item data and credit memo item data for a batch of customer accounts.

Note: Credit memo item data is only available if you have the Invoice Settlement feature enabled.

Operations

Payment Methods

Payment methods represents payment method details associated with a customer account.

Operations

Custom Payment Method Types

Open Payment Method (OPM) service is a framework developed by Zuora, which allows you to integrate your custom payment method to Zuora subscription, billing, and revenue management in a dynamic and flexible manner. With the support of the OPM service, you are able to define your custom payment method types and create custom payment methods of the defined types. The custom payment method of the defined type can only be used with the custom payment gateway that you set up through the Universal Payment Connector (UPC) service. It cannot be used with the Zuora out-of-box gateway integrations such as GoCardless, Stripe, etc.

You can define up to 20 custom payment method types for one tenant. Do not define your fields with the Zuora-reserved fields.

See Set up custom payment gateways and payment methods for more information about the OPM and UPC services.

Note: You can only use the bearer token to access the "Custom Payment Method Types" API operations. Access with apiAccessKeyId and apiSecretAccessKey is not supported.

Operations

Payment Method Updater

Zuora Payment Method Updater (PMU) enables merchants to automatically incorporate changes made to a customer's credit cards. For more information about Zuora PMU, see Payment Method Updater.

Operations

Payment Method Snapshots

A Payment Method Snapshot is a copy of the particular Payment Method used in a transaction. If the Payment Method is deleted, the Snapshot continues to retain the data used in each of the past transactions. As such, the Snapshot helps with display of historical transactions, integrations to external systems, and reporting.

Operations

Payment Method Transaction Logs

The PaymentMethodTransactionLog object contains payment method transaction log data.

You can use the CRUD: Retrieve a payment method transaction log operation to export such data.

Operations

Hosted Pages

Hosted payment pages allow your customers to set up a payment method, such as providing a credit card. Since it only handles the payment method, it is suitable for a simple workflow or a complex multi-page, multi-product workflow.

For more information, see Hosted Payment Pages.

Operations

RSA Signatures

The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature.

You can use the Generate an RSA signature operation to generate the required digital signature and token for a Payment Pages 2.0 form, then use the Decrypt an RSA signature operation to decrypt the signature to validate the signature and key."

Operations

Payment Authorization

The Delayed Capture feature allows you to authorize the availability of funds for a transaction but delay the capture of funds until a later time.

You can use the Create authorization operation to authorize a payment amount before capturing the payment. Subsequently, you can use Create a payment or Create an order to capture the authorized funds, or use Cancel authorization to cancel the authorization.

Operations

Payment Gateways

Use payment gateways to pass authorization, payments, and settlement data securely to and from the merchant's website to the merchant's processor.

For more information about payment gateways, see Payment Gateways.

Operations

Payment Gateway Reconciliation

Gateway reconciliation is the process of verifying that the electronic payment and refund transactions processed in Zuora match the transactions reported by the gateway. For example, if Zuora processed 200 transactions through a gateway, you should see the same number of transactions on the gateway's reconciliation report, sometimes also called the settlement report.

You can complete the following Gateway Reconciliation tasks through API:

Operations

Payments

Use payments to process payments, for example, automate recurring payments, manage overpayments, and create refunds. For more information about payments, see Payments.

Operations

List payments

Request

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.

Retrieves the information about all payments from all your customer accounts.

Filtering

You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.

The unappliedAmount or any other query parameter does not support the less than(<) and the greater than(>) operators.

If the value of a filterable field is string, you can set the corresponding query parameter to null when filtering. Then, you can get the response data with this field value being null.

Examples:

/v1/payments?status=Processed
/v1/payments?currency=USD&status=Processed
/v1/payments?status=Processed&type=External&sort=+number

Security

bearerAuth

Query

pageinteger>= 1

The index number of the page that you want to retrieve. This parameter is dependent on pageSize. You must set pageSize before specifying page. For example, if you set pageSize to 20 and page to 2, the 21st to 40th records are returned in the response.

Default 1

pageSizeinteger<= 40

The number of records returned per page in the response.

Default 20

accountIdstring

This parameter filters the response based on the accountId field.

amountnumber(double)

This parameter filters the response based on the amount field.

appliedAmountnumber(double)

This parameter filters the response based on the appliedAmount field.

createdByIdstring

This parameter filters the response based on the createdById field.

createdDatestring(date-time)

This parameter filters the response based on the createdDate field.

creditBalanceAmountnumber(double)

This parameter filters the response based on the creditBalanceAmount field.

currencystring

This parameter filters the response based on the currency field.

effectiveDatestring(date-time)

This parameter filters the response based on the effectiveDate field.

numberstring

This parameter filters the response based on the number field.

refundAmountnumber(double)

This parameter filters the response based on the refundAmount field.

statusstring

This parameter filters the response based on the status field.

Enum"Draft""Processing""Processed""Error""Canceled""Posted"

typestring

This parameter filters the response based on the type field.

Enum"External""Electronic"

unappliedAmountnumber(double)

This parameter filters the response based on the unappliedAmount field.

updatedByIdstring

This parameter filters the response based on the updatedById field.

updatedDatestring(date-time)

This parameter filters the response based on the updatedDate field.

sortstring

This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.

A sortable field uses the following form:

operator field_name

You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: operator field_name, operator field_name

operator is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by payment effective date.

The - operator indicates an ascending order.
The + operator indicates a descending order.

By default, the response data is displayed in descending order by payment number.

field_name indicates the name of a sortable field. The supported sortable fields of this operation are as below:

number
accountId
amount
appliedAmount
unappliedAmount
refundAmount
creditBalanceAmount
effectiveDate
createdDate
createdById
updatedDate
updatedById

Examples:

/v1/payments?sort=+number
/v1/payments?status=Processed&sort=-number,+amount

Headers

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<= 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 (:), 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 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. 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.

curl -i -X GET \
  'https://developer.zuora.com/_mock/v1-api-reference/api/v1/payments?page=1&pageSize=20&accountId=string&amount=0.1&appliedAmount=0.1&createdById=string&createdDate=2019-08-24T14%3A15%3A22Z&creditBalanceAmount=0.1&currency=string&effectiveDate=2019-08-24T14%3A15%3A22Z&number=string&refundAmount=0.1&status=Draft&type=External&unappliedAmount=0.1&updatedById=string&updatedDate=2019-08-24T14%3A15%3A22Z&sort=string' \
  -H 'Accept-Encoding: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Encoding: string' \
  -H 'Zuora-Entity-Ids: string' \
  -H 'Zuora-Org-Ids: string' \
  -H 'Zuora-Track-Id: string' \
  -H 'Zuora-Version: string'

Responses

OK

Headers

Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring= 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring<= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-Typestring

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Bodyapplication/json

nextPagestring(URL)

URL to retrieve the next page of the response if it exists; otherwise absent.

paymentsArray of objects(paymentFieldsCustom)

Container for payments.

successboolean

Returns true if the request was processed successfully.

Response

application/json

{
  "payments": [
    { … }
  ],
  "success": true
}

Create a payment

Request

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.

Security

bearerAuth

Headers

Idempotency-Keystring<= 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-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<= 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 (:), 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 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. 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.

Bodyapplication/jsonrequired

accountIdstring

The ID of the customer account that the payment is created for.

Example: "8a90b4488e7d5c0f018e7db3892400b2"

accountNumberstring

The number of the customer account that the payment is created for, such as A00000001.

You can specify either accountNumber or accountId for a customer account. If both of them are specified, they must refer to the same customer account.

amountnumber(double)required

The total amount of the payment.

Example: 14.99

authTransactionIdstring<= 50 characters

The authorization transaction ID from the payment gateway. Use this field for electronic payments, such as credit cards.

When you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the Create authorization operation, together with the authTransactionId field.

The following payment gateways support this field:

Adyen Integration v2.0
CyberSource 1.28
CyberSource 1.97
CyberSource 2.0
Chase Paymentech Orbital
Ingenico ePayments
SlimPay
Stripe v2
Verifi Global Payment Gateway
WePay Payment Gateway Integration

commentstring[ 0 .. 255 ] characters

Additional information related to the payment.

currencystringrequired

When Standalone Payment is not enabled, the currency of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI. But if you have the Multiple Currencies feature enabled, you can have a different payment currency.

When Standalone Payment is enabled and standalone is true, the currency of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.

Example: "USD"

customRatesArray of objects(customRates)<= 2 items

It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both).

Note:

This field is only available if you are on the latest Zuora API minor version, or you set the Zuora-Version request header to 224.0 or a later available version.
You cannot set the custom rates, if both the Automatically include additional Currency Conversion information in data source exports option and Fx data feature are enabled.
Payment, PaymentApplication, and PaymentApplicationItem will utilize the provided custom Fx rate to convert amounts from the transactional currency to the home currency.

debitMemosArray of objects(debitMemos)

Container for debit memos. The maximum number of debit memos is 1,000.

effectiveDatestring(date)

The date when the payment takes effect, in yyyy-mm-dd format.

Note:

This field is required for only electronic payments. It's an optional field for external payments.
When specified, this field must be set to the date of today.
When applying or transferring payments, this field must be later than or equal to the maximum effective date of the payment.

financeInformationobject

Container for the finance information related to the payment.

gatewayIdstring

The ID of the gateway instance that processes the payment. The ID must be a valid gateway instance ID and this gateway must support the specific payment method.

If Payment Gateway Routing is enabled, when creating electronic payments, this field is optional.
- 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, when creating electronic payments, this field is required.
When creating external payments, this field is optional.

Use the same gateway instance if both paymentGatewayNumber and gatewayId are sent in the request.

gatewayOptionsobject

The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in Zuora Knowledge Center.

Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.

gatewayOrderIdstring<= 50 characters

A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.

Gateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems.

When you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the Create authorization operation, together with the authTransactionId field.

invoicesArray of objects(invoices)

Container for invoices. The maximum number of invoices is 1,000.

Example: [{"invoiceId":"8a90e5e4914ad4fa01914b25ff2c036e","amount":14.99}]

mitTransactionSourcestring

Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework.

C_Unscheduled: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.
M_Recurring: Merchant-initiated transaction (MIT) that occurs at regular intervals.
M_Unscheduled: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.
M_MOTO: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See Overview of Stripe payment gateway integration for more information.

Enum"C_Unscheduled""M_Recurring""M_Unscheduled""M_MOTO"

paymentGatewayNumberstring

The natural key for the payment gateway.

Use the same gateway instance if both paymentGatewayNumber and gatewayId are sent in the request.

paymentMethodIdstring

The unique ID of the payment method that the customer used to make the payment.

If no payment method ID is specified in the request body, the default payment method for the customer account is used automatically. If the default payment method is different from the type of payments that you want to create, an error occurs.

Example: "2c92c8f95e2d6ebb015e325df7a70356"

paymentMethodTypestring

The type of the payment method that the customer used to make the payment.

Specify this value when you are creating an external payment method. If both paymentMethodType and paymentMethodId are specified, only the paymentMethodId value is used to create the payment.

Default null

paymentOptionArray of objects(paymentOption)

Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.

Here is an example:

"paymentOption": [
  {
    "type": "GatewayOptions",
    "detail": {
      "SecCode":"WEB"
    }
  }
]

paymentOption of the payment schedule takes precedence over paymentOption of the payment schedule item.

You can use this field or the gatewayOptions field to pass the Gateway Options fields supported by a payment gateway. However, the Gateway Options fields passed through the paymentOption field will be stored in the Payment Option object and can be easily retrieved.

paymentScheduleKeystring

The unique ID or the number of the payment schedule to be linked with the payment. See Link payments to payment schedules for more information.

prepaymentboolean

Indicates whether the payment will be used as a reserved payment. See Prepaid Cash with Drawdown for more information.

referenceIdstring[ 0 .. 100 ] characters

The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.

softDescriptorstring<= 35 characters

A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.

softDescriptorPhonestring<= 20 characters

A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.

standaloneboolean

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

Specify true to create a standalone payment that will be processed in Zuora through Zuora gateway integration but will be settled outside of Zuora.

When standalone is set to true:

accountId, amount, currency, and type are required.
type must be Electronic.
currency of the payment can be different from the payment currency in the customer account settings.
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.

Specify false to create an ordinary payment that will be created, processed, and settled in Zuora. The currency of an ordinary payment must be the same as the currency in the customer account settings.

Default false

typestringrequired

The type of the payment.

Note: If you specify the type as Electronic, you must specify the value for accountId or accountNumber.

Enum"External""Electronic"

Example: "External"

IntegrationId__NSstring<= 255 characters

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationStatus__NSstring<= 255 characters

Status of the payment's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Origin__NSstring<= 255 characters

Origin of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

SyncDate__NSstring<= 255 characters

Date when the payment was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Transaction__NSstring<= 255 characters

Related transaction in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

property name*anyadditional property

Custom fields of the Payment object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Custom Fields for more information.

curl -i -X POST \
  https://developer.zuora.com/_mock/v1-api-reference/api/v1/payments \
  -H 'Accept-Encoding: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Encoding: string' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -H 'Zuora-Entity-Ids: string' \
  -H 'Zuora-Org-Ids: string' \
  -H 'Zuora-Track-Id: string' \
  -H 'Zuora-Version: string' \
  -d '{
    "accountId": "8a90b4488e7d5c0f018e7db3892400b2",
    "type": "External",
    "paymentMethodId": "2c92c8f95e2d6ebb015e325df7a70356",
    "amount": 14.99,
    "currency": "USD",
    "invoices": [
      {
        "invoiceId": "8a90e5e4914ad4fa01914b25ff2c036e",
        "amount": 14.99
      }
    ]
  }'

Responses

OK

Headers

Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring= 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring<= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-Typestring

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Bodyapplication/json

accountIdstring

The ID of the customer account that the payment is for.

accountNumberstring

The number of the customer account that the payment is for.

amountnumber(double)

The total amount of the payment.

appliedAmountnumber(double)

The applied amount of the payment.

authTransactionIdstring

The authorization transaction ID from the payment gateway.

bankIdentificationNumberstring

The first six or eight digits of the credit card or debit card used for the payment, when applicable.

cancelledOnstring or null(date-time)

The date and time when the payment was cancelled, in yyyy-mm-dd hh:mm:ss format.

commentstring or null

Comments about the payment.

createdByIdstring

The ID of the Zuora user who created the payment.

createdDatestring(date-time)

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

creditBalanceAmountnumber(double)

The amount that the payment transfers to the credit balance. The value is not 0 only for those payments that come from legacy payment operations performed without the Invoice Settlement feature.

currencystring

When Standalone Payment is not enabled, the currency of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI.

When Standalone Payment is enabled and standalone is true, the currency of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.

effectiveDatestring(date-time)

The date and time when the payment takes effect, in yyyy-mm-dd hh:mm:ss format.

financeInformationobject

Container for the finance information related to the payment.

gatewayIdstring or null

The ID of the gateway instance that processes the payment.

gatewayOrderIdstring

A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.

gatewayReconciliationReasonstring or null

The reason of gateway reconciliation.

gatewayReconciliationStatusstring or null

The status of gateway reconciliation.

gatewayResponsestring or null

The message returned from the payment gateway for the payment. This message is gateway-dependent.

gatewayResponseCodestring

The code returned from the payment gateway for the payment. This code is gateway-dependent.

gatewayStatestring

The status of the payment in the gateway; use for reconciliation.

Enum"MarkedForSubmission""Submitted""Settled""NotSubmitted""FailedToSettle"

idstring

The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f.

markedForSubmissionOnstring(date-time)

The date and time when a payment was marked and waiting for batch submission to the payment process, in yyyy-mm-dd hh:mm:ss format.

numberstring

The unique identification number of the payment. For example, P-00000001.

organizationLabelstring

The organization that this object belongs to.

Note: This field is available only when the Multi-Org feature is enabled.

paymentGatewayNumberstring or null

The natural key for the payment gateway.

paymentMethodIdstring

The unique ID of the payment method that the customer used to make the payment.

paymentMethodSnapshotIdstring or null

The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.

paymentOptionArray of objects(paymentOption)

Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.

paymentOption of the payment schedule takes precedence over paymentOption of the payment schedule item.

paymentScheduleKeystring

The unique ID or the number of the payment schedule that is linked to the payment. See Link payments to payment schedules for more information.

payoutIdstring or null

The payout ID of the payment from the gateway side.

prepaymentboolean

Indicates whether the payment is used as a reserved payment. See Prepaid Cash with Drawdown for more information.

referenceIdstring or null

The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.

refundAmountnumber(double)

The amount of the payment that is refunded.

secondPaymentReferenceIdstring or null

The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments.

settledOnstring or null(date-time)

The date and time when the payment was settled in the payment processor, in yyyy-mm-dd hh:mm:ss format. This field is used by the Spectrum gateway only and not applicable to other gateways.

softDescriptorstring or null

A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.

softDescriptorPhonestring or null

A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.

standaloneboolean

This field is only available if the support for standalone payment is enabled. This field is not available for transferring, applying, or unapplying a payment.

The value true indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred.

The value false indicates this is an ordinary payment that is created, processed, and settled in Zuora.

Default false

statusstring

The status of the payment.

If the Asynchronous Payment Statuses feature is not enabled, possible values are Draft, Processing, Processed, Error, Canceled, and Posted.

If the Asynchronous Payment Statuses feature is enabled, when the ACH or Bank Transfer payment is created, it is in a Pending status upon successful network communication with the gateway. To transition from a Pending status to another status, use one of our Gateway Reconciliation options or cancel the payment.

Enum"Draft""Processing""Processed""Error""Canceled""Posted""Pending"

submittedOnstring(date-time)

The date and time when the payment was submitted, in yyyy-mm-dd hh:mm:ss format.

successboolean

Returns true if the request was processed successfully.

typestring

The type of the payment.

Enum"External""Electronic"

unappliedAmountnumber(double)

The unapplied amount of the payment.

updatedByIdstring

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

updatedDatestring(date-time)

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

IntegrationId__NSstring<= 255 characters

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationStatus__NSstring<= 255 characters

Status of the payment's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Origin__NSstring<= 255 characters

Origin of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

SyncDate__NSstring<= 255 characters

Date when the payment was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Transaction__NSstring<= 255 characters

Related transaction in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

property name*anyadditional property

Custom fields of the Payment object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Custom Fields for more information.

Response

application/json

{
  "id": "8a90a04d914ac24801914b29e47f0777",
  "number": "P-00000389",
  "status": "Processed",
  "type": "External",
  "accountId": "8a90b4488e7d5c0f018e7db3892400b2",
  "accountNumber": "A00000370",
  "amount": 14.99,
  "appliedAmount": 14.99,
  "unappliedAmount": 0,
  "refundAmount": 0,
  "creditBalanceAmount": 0,
  "currency": "USD",
  "effectiveDate": "2024-08-13",
  "comment": null,
  "paymentMethodId": "2c92c8f95e2d6ebb015e325df7a70356",
  "paymentMethodSnapshotId": null,
  "authTransactionId": null,
  "bankIdentificationNumber": null,
  "gatewayId": null,
  "paymentGatewayNumber": null,
  "gatewayOrderId": null,
  "gatewayResponse": null,
  "gatewayResponseCode": null,
  "gatewayState": "NotSubmitted",
  "markedForSubmissionOn": null,
  "referenceId": null,
  "secondPaymentReferenceId": null,
  "softDescriptor": null,
  "softDescriptorPhone": null,
  "submittedOn": null,
  "settledOn": null,
  "cancelledOn": null,
  "createdDate": "2024-08-13 17:55:22",
  "createdById": "2c92c8f95e2d6ebb015e325df48e02da",
  "updatedDate": "2024-08-13 17:55:22",
  "updatedById": "2c92c8f95e2d6ebb015e325df48e02da",
  "financeInformation": {
    "bankAccountAccountingCode": null,
    "bankAccountAccountingCodeType": null,
    "unappliedPaymentAccountingCode": null,
    "unappliedPaymentAccountingCodeType": null,
    "transferredToAccounting": false
  },
  "gatewayReconciliationStatus": null,
  "gatewayReconciliationReason": null,
  "payoutId": null,
  "prepayment": false,
  "success": true
}

Update a payment

Request

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.

Updates a payment.

Security

bearerAuth

Path

paymentKeystringrequired

The unique ID or number of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1 or P-00000001.

Headers

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<= 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 (:), 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 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. 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.

Bodyapplication/jsonrequired

commentstring[ 0 .. 255 ] characters

Comments about the payment.

Example: "Details about this payment"

financeInformationobject

Container for the finance information related to the payment.

For a standalone payment, the finance information cannot be updated.

gatewayStatestring

This field is mainly used for gateway reconciliation. See Electronic payment processing for details.

You must have the Edit Payment Gateway Status user permission to update this field.

Enum"NotSubmitted""Submitted""Settled""FailedToSettle"

paymentScheduleKeystring

The unique ID or the number of the payment schedule to be linked with the payment. See Link payments to payment schedules for more information.

referenceIdstring[ 0 .. 100 ] characters

The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.

You can only update the reference ID for external payments.

IntegrationId__NSstring<= 255 characters

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationStatus__NSstring<= 255 characters

Status of the payment's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Origin__NSstring<= 255 characters

Origin of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

SyncDate__NSstring<= 255 characters

Date when the payment was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Transaction__NSstring<= 255 characters

Related transaction in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

property name*anyadditional property

Custom fields of the Payment object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Custom Fields for more information.

curl -i -X PUT \
  'https://developer.zuora.com/_mock/v1-api-reference/api/v1/payments/{paymentKey}' \
  -H 'Accept-Encoding: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Encoding: string' \
  -H 'Content-Type: application/json' \
  -H 'Zuora-Entity-Ids: string' \
  -H 'Zuora-Org-Ids: string' \
  -H 'Zuora-Track-Id: string' \
  -H 'Zuora-Version: string' \
  -d '{
    "comment": "Details about this payment"
  }'

Responses

OK

Headers

Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring= 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring<= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-Typestring

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Bodyapplication/json

accountIdstring

The ID of the customer account that the payment is for.

accountNumberstring

The number of the customer account that the payment is for.

amountnumber(double)

The total amount of the payment.

appliedAmountnumber(double)

The applied amount of the payment.

authTransactionIdstring

The authorization transaction ID from the payment gateway.

bankIdentificationNumberstring

The first six or eight digits of the credit card or debit card used for the payment, when applicable.

cancelledOnstring(date-time)

The date and time when the payment was cancelled, in yyyy-mm-dd hh:mm:ss format.

commentstring or null

Comments about the payment.

createdByIdstring

The ID of the Zuora user who created the payment.

createdDatestring(date-time)

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

creditBalanceAmountnumber(double)

The amount that the payment transfers to the credit balance. The value is not 0 only for those payments that come from legacy payment operations performed without the Invoice Settlement feature.

currencystring

When Standalone Payment is not enabled, the currency of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI.

When Standalone Payment is enabled and standalone is true, the currency of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.

effectiveDatestring(date-time)

The date and time when the payment takes effect, in yyyy-mm-dd hh:mm:ss format.

financeInformationobject

Container for the finance information related to the payment.

gatewayIdstring

The ID of the gateway instance that processes the payment.

gatewayOrderIdstring

A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.

gatewayReconciliationReasonstring

The reason of gateway reconciliation.

gatewayReconciliationStatusstring

The status of gateway reconciliation.

gatewayResponsestring

The message returned from the payment gateway for the payment. This message is gateway-dependent.

gatewayResponseCodestring

The code returned from the payment gateway for the payment. This code is gateway-dependent.

gatewayStatestring

The status of the payment in the gateway; use for reconciliation.

Enum"MarkedForSubmission""Submitted""Settled""NotSubmitted""FailedToSettle"

idstring

The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f.

markedForSubmissionOnstring(date-time)

The date and time when a payment was marked and waiting for batch submission to the payment process, in yyyy-mm-dd hh:mm:ss format.

numberstring

The unique identification number of the payment. For example, P-00000001.

organizationLabelstring

The organization that this object belongs to.

Note: This field is available only when the Multi-Org feature is enabled.

paymentGatewayNumberstring

The natural key for the payment gateway.

paymentMethodIdstring

The unique ID of the payment method that the customer used to make the payment.

paymentMethodSnapshotIdstring

The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.

paymentScheduleKeystring

The unique ID or the number of the payment schedule that is linked to the payment. See Link payments to payment schedules for more information.

payoutIdstring

The payout ID of the payment from the gateway side.

prepaymentboolean

Indicates whether the payment is used as a reserved payment. See Prepaid Cash with Drawdown for more information.

referenceIdstring

The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.

refundAmountnumber(double)

The amount of the payment that is refunded.

secondPaymentReferenceIdstring

The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments.

settledOnstring(date-time)

The date and time when the payment was settled in the payment processor, in yyyy-mm-dd hh:mm:ss format. This field is used by the Spectrum gateway only and not applicable to other gateways.

softDescriptorstring

A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.

softDescriptorPhonestring

A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.

standaloneboolean

This field is only available if the support for standalone payment is enabled. This field is not available for transferring, applying, or unapplying a payment.

The value true indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred.

The value false indicates this is an ordinary payment that is created, processed, and settled in Zuora.

Default false

statusstring

The status of the payment.

Enum"Draft""Processing""Processed""Error""Canceled""Posted"

submittedOnstring(date-time)

The date and time when the payment was submitted, in yyyy-mm-dd hh:mm:ss format.

successboolean

Returns true if the request was processed successfully.

typestring

The type of the payment.

Enum"External""Electronic"

unappliedAmountnumber(double)

The unapplied amount of the payment.

updatedByIdstring

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

updatedDatestring(date-time)

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

IntegrationId__NSstring<= 255 characters

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationStatus__NSstring<= 255 characters

Status of the payment's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Origin__NSstring<= 255 characters

Origin of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

SyncDate__NSstring<= 255 characters

Date when the payment was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Transaction__NSstring<= 255 characters

Related transaction in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

property name*anyadditional property

Custom fields of the Payment object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Custom Fields for more information.

Response

application/json

{
  "accountId": "4028905f5a87c0ff015a88889fe500a8",
  "accountNumber": "A00000001",
  "amount": 44.1,
  "appliedAmount": 0,
  "authTransactionId": null,
  "bankIdentificationNumber": null,
  "cancelledOn": null,
  "comment": "Details about this payment",
  "createdById": "402881e522cf4f9b0122cf5d82860002",
  "createdDate": "2017-03-01 11:30:37",
  "creditBalanceAmount": 0,
  "currency": "USD",
  "effectiveDate": "2017-03-01",
  "financeInformation": {
    "bankAccountAccountingCode": null,
    "bankAccountAccountingCodeType": null,
    "transferredToAccounting": "No",
    "unappliedPaymentAccountingCode": null,
    "unappliedPaymentAccountingCodeType": null
  },
  "gatewayId": null,
  "gatewayOrderId": null,
  "gatewayReconciliationReason": null,
  "gatewayReconciliationStatus": null,
  "gatewayResponse": null,
  "gatewayResponseCode": null,
  "gatewayState": "NotSubmitted",
  "id": "4028905f5a87c0ff015a87eb6b75007f",
  "markedForSubmissionOn": null,
  "number": "P-00000001",
  "paymentGatewayNumber": "PG-00000001",
  "paymentMethodId": "402881e522cf4f9b0122cf5dc4020045",
  "paymentMethodSnapshotId": null,
  "payoutId": null,
  "referenceId": null,
  "refundAmount": 0,
  "secondPaymentReferenceId": null,
  "settledOn": null,
  "softDescriptor": null,
  "softDescriptorPhone": null,
  "status": "Processed",
  "submittedOn": null,
  "success": true,
  "type": "External",
  "unappliedAmount": 44.1,
  "updatedById": "402881e522cf4f9b0122cf5d82860002",
  "updatedDate": "2017-03-01 14:25:34"
}

Payment Transaction Logs

Use payment transaction logs to export logs of all transactions from Zuora to the Gateway for Payments.

Operations

Payment Runs

Use payment runs to collect payments using electronic payment methods, for example, credit cards and ACH. For more information about payment runs, see Payment Runs.

Operations

Payment Schedules

Use payment schedules to split invoice or account balances into several installments and automatically process payments for the installments. For more information about payment schedules, see Payment Schedules.

Operations

Refunds

Zuora allows you to issue and track refunds on payments. Similar to external payments, users can enter external refunds to track refunds that have been performed outside of Zuora Payments (for example, by issuing a check). In addition, you can make electronic refunds using our supported payment gateways, which will automatically refund money to the customer.

Operations

Payment Profiles

Payment profiles enable payment flexibility for subscribers by allowing payment methods to be associated with specific subscriptions.

To learn more about the configuration and usage of Payment Profiles, see Payment Profiles.

Operations

Configurable Payment Retry

Configurable Payment Retry APIs use basic authentication. The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry. Click the drop-down arrow at the end of an endpoint to display the full endpoint. To learn more about the configuration and usage of Configurable Payment Retry, see Configurable Payment Retry.

Operations

Object Queries

The Object Query API contains GET operations that allow you to query objects in your Zuora tenant in an efficient, consistent, and flexible manner.

With the expand[] and filter[] query parameters, you have the flexibility to retrieve related object information in a single call and define the returned response that best suits your needs. You can also use the fields[] query parameter to define which fields are returned in the response for a given object. The sort[] query parameter allows you to sort the results in ascending or descending order based on the specified field.

These parameters are case-insensitive matching.

For general Object Queries limitations and comprehensive introduction to these query parameters, see Expand, filter, fields, and sort.

For filterable, expandable, and sortable fields on each object, refer to the Query Parameters section for each API operation.

Operations

Accounting Codes

Accounting Codes are commonly referred to as General Ledger Accounts or General Ledger Account Codes. In Zuora, the use of accounting codes are optional but recommended.

This section contains the operations that allow you to create, update, get, delete, activate, or deactivate accounting codes in Zuora.

Operations

Accounting Periods

A key step in configuring Finance is to create accounting periods in Zuora to match your company's financial calendar. This allows Zuora to produce reports and data exports organized by accounting periods, and to perform the work of closing the accounting periods for the revenue sub-ledger.

Operations

Summary Journal Entries

A summary journal entry is a summary of Zuora transaction amounts organized by accounting code and general ledger segments. A segment adds more reporting granularity through business dimensions, such as country or product.

For more information, see Summary Journal Entries Introduction

Operations

Journal Runs

Use journal runs to automatically create summary journal entities that are suitable for importing into your general ledger system.

For more information about journal runs, see Journal Runs.

Operations

Mass Updater

Use mass updater to perform mass actions more easily.

For more information about mass updater, see Mass Updater.

Operations

Notifications

Notifications are the actions taken to inform users or call third-party endpoints when a certain event happens. Typical actions include emails and callouts. Callouts typically refer to HTTP invocations, such as HTTP calls to REST services.

Zuora notification system processes the events in the same order in which they are triggered. The timing and delivery of notifications can still vary based on factors such as retries, concurrency, and network latency. But Zuora guarantees the best performance possible with the right performance boosters and tuning.

Notifications are associated with Communication Profiles, which allow you to send specific event-driven notifications to targeted customers. Zuora provides the following Settings API to access the settings of Communication Profiles:* Get all Communication Profiles

Operations

Custom Event Triggers

The Event Trigger service manages the business events and trigger conditions that are defined on Zuora Business Object Model or custom objects. When a Zuora object changes, the trigger conditions defined on the object are evaluated, and if any condition qualifies, a business event will be triggered and turned into a notification.

Note: Event Triggers operations are only applicable to custom events.

Operations

Custom Scheduled Events

A custom scheduled event notification is evaluated at the scheduled time of the related scheduled event on a daily basis. If the date meets the combination of the base field and the notification parameters, the notification will be triggered immediately.

For more information about Custom Scheduled Events, see Custom Scheduled Events.

Operations

Custom Object Definitions

With Custom Objects service, you can define custom objects, extending the Zuora data model to accommodate your specific use cases.

If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works.

You can sign up for a free account on the Postman website and download the app in case you do not use Postman yet.

Note that the Custom Object Definitions API is versioned by Zuora-Version in the request header. The response may be different for the same request with a different API version. Specify Zuora-Version in the request header if you expect a specific response schema.

Operations

Custom Object Records

With Custom Objects service, you can create, update, delete and find custom object records.

If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works.

You can sign up for a free account on the Postman website and download the app in case you do not use Postman yet.

Note that the Custom Object Records API is versioned by Zuora-Version in the request header. The response may be different for the same request with a different API version. Specify Zuora-Version in the request header if you expect a specific response schema.

Operations

Custom Object Jobs

With Custom Objects service, you can submit a bulk job request to create, update, or delete custom object records in a batch.

If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works.

You can sign up for a free account on the Postman website and download the app in case you do not use Postman yet.

Note that the Custom Object Jobs API is versioned by Zuora-Version in the request header. The response may be different for the same request with a different API version. Specify Zuora-Version in the request header if you expect a specific response schema.

Operations

API Health

Zuora System Health dashboard for API (API dashboard) collects and displays data about API usage, failure, performance, and concurrency limit in near real time. It enables you to view all the APIs in your Zuora tenant within the last 14 days. For more information, see APIs dashboard.

Operations

Bill Run Health

Zuora System Health dashboard for Bill Run (Bill Run dashboard) collects and displays data about bill run usage, failure, and performance in near real time. Through the Bill Run dashboard, you can view data about all the bill runs in your Zuora tenant within the last 30 days. For more information, see Bill Run dashboard.

Operations

Electronic Payments Health

Zuora System Health dashboard for Electronic Payments (Electronic Payment dashboard) collects and displays usage, failure, and performance data about electronic payments in near real time. It enables you to view all the electronic payments in your Zuora tenant within the last 30 days. For more information, see Electronic Payments dashboard.

Operations

Tax Health

Zuora System Health dashboard for Tax Health (Tax Health dashboard) collects and displays usage, failure, and performance data about Tax in near real time. It enables you to view all the tax details in your Zuora tenant within the last 30 days. For more information, see Tax Health Dashboard.

Operations

Workflows

A workflow is a sequence of tasks that are performed based on predefined logic. A workflow improves efficiency and reduces errors by automating a series of complex tasks that otherwise need to be performed manually and repetitively.

For more information, see Workflow.

Operations

Data Queries

The Data Query feature enables you to perform SQL queries in your Zuora tenant. To learn how to get started with Data Query, see Overview of Data Query.

Operations

Aggregate Queries

The Aggregate Query API (AQuA) is a REST API that executes multiple Export ZOQL or ZOQL queries. The queries are performed in a sequential order and in a single read-only database transaction.

AQuA enforces the following limits:

The maximum processing time per query is 3 hours. If a query in an AQuA job is executed for longer than 3 hours, this job will be killed automatically. See the best practices for bulk data extraction with AQuA.
AQuA enforces limits on both the stateful concurrent AQuA jobs and the stateless concurrent AQuA jobs per tenant:
- The maximum number of stateful concurrent AQuA jobs per tenant is 50. - The maximum number of stateless concurrent AQuA jobs per tenant is 50. AQuA jobs in the following status are counted towards your concurrent AQuA job limits:
- Submitted - Executing Zuora system will reject the subsequent stateful or stateless job requests once the corresponding concurrent job limit is reached.

For more information about the Aggregate Query API(AQuA), see Aggregate Query.

Operations

Configuration Templates

Configuration Templates in Zuora Deployment Manager enable you to configure your tenants in minutes by importing a templated metadata configuration file. This feature eliminates the need for long manual configuration processes that would have previously taken hours. You will be able to access a comprehensive repository of industry-specific templates. It will be easier for you to deploy and release. To use this API for migrating metadata from a source tenant to a destination tenant, you should authenticate using credentials of the source tenant The user will have to provide the client id and secret key from the sou.rce tenant. To understand the known behavior of configuration templates and APIs, see the following sections: Product Catalog deployment known facts and system behavior Product Catalog deployment FAQs Deployment Manager Known Facts and Limitations

Operations

Metadata

The Metadata API in Zuora promotes a programmatic way to retrieve, compare, and validate metadata within Zuora tenants for performing create and update actions between the source and the target. To use this API for migrating metadata from a source tenant to a destination tenant, you should authenticate using credentials of the source tenant. The user will have to provide the client id and secret key from the source tenant. To understand the known behavior of configuration templates and APIs, see the following sections: Product Catalog deployment known facts and system behavior Product Catalog deployment FAQs Deployment Manager Known Facts and Limitations

Operations

Bulk Data

The Bulk Data API operations allow you to manage bulk data loader services and perform programmatic CRUD (Create, Update, Read/export, Delete) operations.
To perform data ingestion with a CSV file in Zuora Billing using the Data Loader Bulk Data APIs, see Tutorial for Bulk job API with CSV. For more information, see Process Bulk Job with JSON-lines in Data Loader.

Operations

SCIM

System for Cross-domain Identity Management, or SCIM, is an API specification created to facilitate the management of people and groups of people in cloud-based applications and services. Universal Identity SCIM API is built on top of the SCIM 2.0 specification and can be integrated with major Identity Providers like Okta, Microsoft Entra ID and OneLogin.

Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST API.

You must first create an OAuth client in the Zuora UI before using the Create an OAuth token operation to create an OAuth token. See Authentication for more information.

Operations

Data Labeling

The Data Labeling APIs help you to label your existing data with organization(s) in Zuora.

Once you turned on Multi Org feature, if you don't label your existing data, they are simply unlabeled, and unlabeled data can be accessed by all organizations in your tenant.

To limit the access of your existing data, you need to label them with organization(s) you defined in the organization hierarchy management setting page. Once labeled, the data can only be accessed by users who have been granted with the labeled organization(s).

Note that you have to enable the "Multi Org" feature before using the Data Labeling APIs.

Operations

Data Backfill

If you are an Order to Revenue user, you can use the data backfill operations to perform, view or stop data backfill tasks.

Operations

Regenerate

If you are an Order to Revenue user, you can use the Regenerate operations to regenerate transactions objects.

Operations

Test Environments

A Test Environment is a dedicated sandbox tenant designed for development, integration, and user acceptance testing of your system configurations and business processes.

Operations

Test Environment Jobs

A Test Environment Job represents an asynchronous operation initiated to refresh a Test Environment. These jobs track the status and progress of environment provisioning and refresh.

Operations

Test Environment Notifications

A Test Environment Notification is an automated email dispatched to inform stakeholders when a Test Environment Job is completed or cancelled.

Operations

Actions

Actions are operations that are batch in nature. For example, the "create", "update", "delete", and other operations allow changes to up-to 50 objects at a time. The "query" operation will return up-to 2000 result records back at a time, before requiring additional pages of data to be returned via a subsequent "queryMore" operation.

The default WSDL version for Actions is 79. If you want to change the WSDL version, set the X-Zuora-WSDL-Version header. To find out in which WSDL version a particular object or field was introduced, see Zuora SOAP API Version History.

Note: Actions do not support the Invoice Settlement feature. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. Actions also do not support the Orders feature.

Operations

Settings

The Setting API provides a central API for managing settings in your Zuora tenant.

If you use Postman, you can import the Settings API endpoints as a collection into your Postman app and try out different requests to learn how the API works. You can sign up for a free account on the Postman website and download the app in case you do not use Postman yet.

Operations

Files

You can use the operations contained in this section to retrieve files such as export results, invoices, accounting period reports, and so on.

Operations

Imports

An import uploads content, especially when you have a large amount of content. The Import object contains all of the information you need to upload content, such as a large number of usage records.

Operations

Custom Exchange Rates

If you use a custom exchange rate provider and upload rates with the Import Foreign Exchange Rates mass action, you can query custom foreign exchange rates from Zuora through API.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

Operations

Attachments

Use attachments in Zuora to upload documents of various formats to associate additional information with accounts, subscriptions, invoices, credit memos, or debit memos. Example attachments could be purchase orders (PO's), tax exemption document, or ownership transfer forms.

For more information about attachments, see Attachments.

Operations

Describe

You can use the Describe an object operation to get a reference listing of each object that is available in your Zuora tenant.

By default, the information returned by the "Describe an object" operation corresponds to the latest version of the Zuora WSDL.

Operations