PUT /v1/payments/{paymentId}

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.

Servers

https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com

Path parameters

Name	Type	Required	Description
`paymentId`	String	Yes	The unique ID of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Content-Encoding`	String	No	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-Id`	String	No	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 (`'`).
`Authorization`	String	No	The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
`Zuora-Entity-Ids`	String	No	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	No	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.
`Accept-Encoding`	String	No	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.

Request body fields

Name	Type	Required	Description
`gatewayState`	String	No	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. Possible values: `"NotSubmitted"` `"FailedToSettle"` `"Settled"` `"Submitted"`
`comment`	String	No	Comments about the payment.
`IntegrationStatus__NS`	String	No	Status of the payment's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`SyncDate__NS`	String	No	Date when the payment was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`referenceId`	String	No	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__NS`	String	No	ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`paymentScheduleKey`	String	No	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.
`Transaction__NS`	String	No	Related transaction in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`Origin__NS`	String	No	Origin of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`financeInformation`	Object	No	Container for the finance information related to the payment. For a standalone payment, the finance information cannot be updated.
`financeInformation.unappliedPaymentAccountingCode`	String	No	The accounting code for the unapplied payment.
`financeInformation.bankAccountAccountingCode`	String	No	The accounting code that maps to a bank account in your accounting system.
`financeInformation.transferredToAccounting`	String	No	Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. Possible values: `"Processing"` `"Error"` `"Yes"` `"Ignore"` `"No"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.