Skip to content

CRUD: Update a payment

Request

Updates a payment.

Path
idstringrequired

The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352.

Query
rejectUnknownFieldsboolean

Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:

{
    "message": "Error - unrecognised fields"
}

By default, Zuora ignores unknown fields in the request body.

Default:false
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.

Authorizationstring

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

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

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

Bodyapplication/jsonrequired
AccountingCodestring, [ 0 .. 100 ] characters

The accounting code for the payment. Accounting codes group transactions that contain similar accounting attributes.

Example:"Accounts Receivable"
Statusstring

The updated status of the payment. The value depends on the type of payment.

  • For Electronic payment, the available value is Voided.
  • For External payment, the available value is Canceled.
Enum:"Voided""Canceled"
TransferredToAccountingstring

Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite.

Enum:"Processing""Yes""Error""Ignore"
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 Manage Custom Fields for more information.

{ "AccountingCode": "Accounts Receivable" }

Responses

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.

Bodyapplication/json
Idstring
Example:"2c93808457d787030157e030232f3748"
Successboolean
Example:true
Response
{ "Id": "2c92c0f85d5964dc015d59bb40ff3f0e", "Success": true }