--- title: "Cancel a payment" method: PUT path: "/v1/payments/{paymentKey}/cancel" tags: ["Payments"] --- # Cancel a payment `PUT /v1/payments/{paymentKey}/cancel` **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-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](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. Cancels a payment. If you have the Invoice Settlement feature enabled, overpayments applied to credit balance cannot be cancelled. ## Path parameters - `paymentKey` string, required ## Headers - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Version` string ## Response `200` OK - GETARPaymentType — Container for custom fields of a Payment object. - `accountId` string — The ID of the customer account that the payment is for. - `accountNumber` string — The number of the customer account that the payment is for. - `amount` number, double — The total amount of the payment. - `appliedAmount` number, double — The applied amount of the payment. - `authTransactionId` string, nullable — The authorization transaction ID from the payment gateway. - `bankIdentificationNumber` string, nullable — The first six or eight digits of the credit card or debit card used for the payment, when applicable. - `cancelledOn` string, nullable — The date and time when the payment was cancelled, in `yyyy-mm-dd hh:mm:ss` format. - `comment` string, nullable — Comments about the payment. - `createdById` string — The ID of the Zuora user who created the payment. - `createdDate` string — 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. - `creditBalanceAmount` number, 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. - `currency` string — 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. - `effectiveDate` string — The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format. - `financeInformation` object — Container for the finance information related to the payment. - `bankAccountAccountingCode` string, nullable — The accounting code that maps to a bank account in your accounting system. - `bankAccountAccountingCodeType` string, nullable — The type of the accounting code that maps to a bank account in your accounting system. - `transferredToAccounting` 'Processing' | 'Yes' | 'No' | 'Error' | 'Ignore' — Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. - `unappliedPaymentAccountingCode` string, nullable — The accounting code for the unapplied payment. - `unappliedPaymentAccountingCodeType` string, nullable — The type of the accounting code for the unapplied payment. - `gatewayId` string, nullable — The ID of the gateway instance that processes the payment. - `gatewayOrderId` string, 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. - `gatewayReconciliationReason` string, nullable — The reason of gateway reconciliation. - `gatewayReconciliationStatus` string, nullable — The status of gateway reconciliation. - `gatewayResponse` string, nullable — The message returned from the payment gateway for the payment. This message is gateway-dependent. - `gatewayResponseCode` string, 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. - `id` string — The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f. - `markedForSubmissionOn` string, 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. - `number` string — The unique identification number of the payment. For example, P-00000001. - `organizationLabel` string — The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. - `paymentGatewayNumber` string, nullable — The natural key for the payment gateway. - `paymentMethodId` string — The unique ID of the payment method that the customer used to make the payment. - `paymentMethodSnapshotId` string, nullable — The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction. - `paymentScheduleKey` string — The unique ID or the number of the payment schedule that is linked to the payment. See [Link payments to payment schedules](https://docs.zuora.com?resourceId=payments-link-payments-with-payment-schedules) for more information. - `payoutId` string, nullable — The payout ID of the payment from the gateway side. - `prepayment` boolean — Indicates whether the payment is used as a reserved payment. See [Prepaid Cash with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) for more information. - `referenceId` string, nullable — The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments. - `refundAmount` number, double — The amount of the payment that is refunded. - `secondPaymentReferenceId` string, 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. - `settledOn` string, 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. - `softDescriptor` string, nullable — A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. - `softDescriptorPhone` string, nullable — A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. - `standalone` boolean — 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. - `submittedOn` string, nullable — The date and time when the payment was submitted, in `yyyy-mm-dd hh:mm:ss` format. - `success` boolean — Returns `true` if the request was processed successfully. - `type` 'External' | 'Electronic' — The type of the payment. - `unappliedAmount` number, double — The unapplied amount of the payment. - `updatedById` string — The ID of the Zuora user who last updated the payment. - `updatedDate` string — 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__NS` string — ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). - `IntegrationStatus__NS` string — Status of the payment's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). - `Origin__NS` string — Origin of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). - `SyncDate__NS` string — Date when the payment was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). - `Transaction__NS` string — Related transaction in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). ## Other responses - `500` — Internal Server Error - `4XX` — Request Errors --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)