Sign in
Payments

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.

put/v1/payments/{paymentKey}

Path parameters

paymentKeystring required

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

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 <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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.

Request body

commentstring

Comments about the payment.

gatewayState'NotSubmitted' | 'Submitted' | 'Settled' | 'FailedToSettle'

This field is mainly used for gateway reconciliation. See <a href="https://docs.zuora.com?resourceId=payments-gateway-reconciliation-state-consideration" target="_blank">Electronic payment processing</a> for details.

You must have the Edit Payment Gateway Status <a href="https://docs.zuora.com?resourceId=platform-payments-roles" target="_blank">user permission</a> to update this field.

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

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

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

IntegrationStatus__NSstring

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

Origin__NSstring

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

SyncDate__NSstring

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

Transaction__NSstring

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

Example request

{
  "comment": "Details about this payment"
}

Response

OK

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 nullable

The authorization transaction ID from the payment gateway.

bankIdentificationNumberstring nullable

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

cancelledOnstring nullable

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

commentstring nullable

Comments about the payment.

createdByIdstring

The ID of the Zuora user who created the payment.

createdDatestring

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

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

gatewayIdstring nullable

The ID of the gateway instance that processes the payment.

gatewayOrderIdstring nullable

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 nullable

The reason of gateway reconciliation.

gatewayReconciliationStatusstring nullable

The status of gateway reconciliation.

gatewayResponsestring nullable

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

gatewayResponseCodestring nullable

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

gatewayState'MarkedForSubmission' | 'Submitted' | 'Settled' | 'NotSubmitted' | 'FailedToSettle'

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

idstring

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

markedForSubmissionOnstring nullable

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 nullable

The natural key for the payment gateway.

paymentMethodIdstring

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

paymentMethodSnapshotIdstring nullable

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 nullable

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 nullable

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 nullable

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 nullable

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 nullable

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

softDescriptorPhonestring nullable

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.

status'Draft' | 'Processing' | 'Processed' | 'Error' | 'Canceled' | 'Posted'

The status of the payment.

submittedOnstring nullable

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.

type'External' | 'Electronic'

The type of the payment.

unappliedAmountnumber double

The unapplied amount of the payment.

updatedByIdstring

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

updatedDatestring

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

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

IntegrationStatus__NSstring

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

Origin__NSstring

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

SyncDate__NSstring

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

Transaction__NSstring

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

Changes