Cancel a refund

PUT

/v1/refunds/:refundKey/cancel

PUT

/v1/refunds/:refundKey/cancel

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.refunds.put_cancel_refund(
    refund_key="refundKey",
)

{
  "accountId": "4028905f5a87c0ff015a87d25ae90025",
  "amount": 4,
  "cancelledOn": "2017-03-01 17:03:07",
  "comment": "update comment",
  "createdById": "402881e522cf4f9b0122cf5d82860002",
  "createdDate": "2017-03-01 14:46:03",
  "creditMemoId": null,
  "financeInformation": {
    "transferredToAccounting": "No"
  },
  "gatewayId": null,
  "gatewayReconciliationReason": null,
  "gatewayReconciliationStatus": null,
  "gatewayResponse": null,
  "gatewayResponseCode": null,
  "gatewayState": "NotSubmitted",
  "id": "4028905f5a87c0ff015a889e590e00c9",
  "markedForSubmissionOn": null,
  "methodType": "CreditCard",
  "number": "R-00000001",
  "paymentId": "4028905f5a87c0ff015a889ddfb800c0",
  "paymentMethodId": null,
  "paymentMethodSnapshotId": null,
  "payoutId": null,
  "reasonCode": "Standard Refund",
  "referenceId": null,
  "refundDate": "2017-03-01",
  "refundTransactionTime": null,
  "secondRefundReferenceId": null,
  "settledOn": null,
  "softDescriptor": null,
  "softDescriptorPhone": null,
  "status": "Canceled",
  "submittedOn": null,
  "success": true,
  "type": "External",
  "updatedById": "402881e522cf4f9b0122cf5d82860002",
  "updatedDate": "2017-03-01 17:03:07"
}

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.

Cancels a refund.

If you have the Invoice Settlement feature enabled, refunds applied to credit balance cannot be cancelled.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

refundKeystringRequired

The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9.

Headers

Content-EncodingstringOptional

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-Org-IdsstringOptional

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. 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.

Response headers

Content-EncodingstringOptional

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-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

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.

Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

accountIdstringOptional

The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment or credit memo.

amountdoubleOptional

The total amount of the refund.

cancelledOnstringOptional

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

commentstring or nullOptional

Comments about the refund.

createdByIdstringOptional

The ID of the Zuora user who created the refund.

createdDatestringOptional

The date and time when the refund was created, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-01 15:31:10.

creditMemoIdstringOptional

The ID of the credit memo that is refunded.

financeInformationobjectOptional

Container for the finance information related to the refund.

gatewayIdstringOptional

The ID of the gateway instance that processes the refund.

gatewayReconciliationReasonstringOptional

The reason of gateway reconciliation.

gatewayReconciliationStatusstringOptional

The status of gateway reconciliation.

gatewayResponsestringOptional

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

gatewayResponseCodestringOptional

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

gatewayStateenumOptional

The status of the refund in the gateway.

Allowed values:

idstringOptional

The ID of the refund.

markedForSubmissionOnstringOptional

The date and time when a refund was marked and waiting for batch submission to the payment process, in yyyy-mm-dd hh:mm:ss format.

methodTypeenumOptional

How an external refund was issued to a customer.

numberstringOptional

The unique identification number of the refund.

organizationLabelstringOptional

The organization that this object belongs to.

Note: This field is available only when the Multi-Org feature is enabled.

paymentIdstringOptional

The ID of the payment that is refunded.

paymentMethodIdstringOptional

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

paymentMethodSnapshotIdstringOptional

The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.

payoutIdstringOptional

The payout ID of the refund from the gateway side.

reasonCodestringOptional

A code identifying the reason for the transaction.

referenceIdstringOptional

The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.

refundDatedateOptional

The date when the refund takes effect, in yyyy-mm-dd format. For example, 2017-03-01.

refundTransactionTimestringOptional

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

secondRefundReferenceIdstringOptional

The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.

settledOnstringOptional

The date and time when the refund 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.

softDescriptorstringOptional

A payment gateway-specific field that maps Zuora to other gateways.

softDescriptorPhonestringOptional

A payment gateway-specific field that maps Zuora to other gateways.

statusenumOptional

The status of the refund.

Allowed values:

submittedOnstringOptional

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

successbooleanOptional

Returns true if the request was processed successfully.

typeenumOptional

The type of the refund.

Allowed values:

updatedByIdstringOptional

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

updatedDatestringOptional

The date and time when the refund was last updated, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-02 15:36:10.

IntegrationId__NSstringOptional<=255 characters

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

IntegrationStatus__NSstringOptional<=255 characters

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

Origin__NSstringOptional<=255 characters

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

SyncDate__NSstringOptional<=255 characters

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

SynctoNetSuite__NSstringOptional<=255 characters

Specifies whether the refund should be synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Errors

4XX

Client Request Error

500

Internal Server Error