Update a payment

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.

Request
path Parameters
paymentId
required
string

The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.

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.

Request Body schema: application/json
required
comment
string [ 0 .. 255 ] characters

Comments about the payment.

object

Container for the finance information related to the payment.

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

gatewayState
string

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"
paymentScheduleKey
string

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.

referenceId
string [ 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__NS
string <= 255 characters

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

IntegrationStatus__NS
string <= 255 characters

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

Origin__NS
string <= 255 characters

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

SyncDate__NS
string <= 255 characters

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

Transaction__NS
string <= 255 characters

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

property name*
additional property
any

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.

Responses
200
put/v1/payments/{paymentId}
Request samples
application/json
{
  • "comment": "new comment",
  • "financeInformation": {
    }
}
Response samples
application/json
{
  • "accountId": "4028905f5a87c0ff015a88889fe500a8",
  • "accountNumber": "A00000001",
  • "amount": 44.1,
  • "appliedAmount": 0,
  • "authTransactionId": null,
  • "bankIdentificationNumber": null,
  • "cancelledOn": null,
  • "comment": "new comment",
  • "createdById": "402881e522cf4f9b0122cf5d82860002",
  • "createdDate": "2017-03-01 11:30:37",
  • "creditBalanceAmount": 0,
  • "currency": "USD",
  • "effectiveDate": "2017-03-01",
  • "financeInformation": {
    },
  • "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"
}