List payments

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

Request
query Parameters
page
integer >= 1
Default: 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.

pageSize
integer <= 40
Default: 20

The number of records returned per page in the response.

accountId
string

This parameter filters the response based on the accountId field.

amount
number <double>

This parameter filters the response based on the amount field.

appliedAmount
number <double>

This parameter filters the response based on the appliedAmount field.

createdById
string

This parameter filters the response based on the createdById field.

createdDate
string <date-time>

This parameter filters the response based on the createdDate field.

creditBalanceAmount
number <double>

This parameter filters the response based on the creditBalanceAmount field.

currency
string

This parameter filters the response based on the currency field.

effectiveDate
string <date-time>

This parameter filters the response based on the effectiveDate field.

number
string

This parameter filters the response based on the number field.

refundAmount
number <double>

This parameter filters the response based on the refundAmount field.

status
string

This parameter filters the response based on the status field.

Enum: "Draft" "Processing" "Processed" "Error" "Canceled" "Posted"
type
string

This parameter filters the response based on the type field.

Enum: "External" "Electronic"
unappliedAmount
number <double>

This parameter filters the response based on the unappliedAmount field.

updatedById
string

This parameter filters the response based on the updatedById field.

updatedDate
string <date-time>

This parameter filters the response based on the updatedDate field.

sort
string

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

  • 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

header Parameters
Accept-Encoding
string

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-Encoding
string

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.

Authorization
string

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

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora-Org-Ids
string

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Responses
200
get/v1/payments
Request samples 
Response samples 
application/json
{
  • "payments": [
    ],
  • "success": true
}