POST /v1/creditmemos/{creditMemoKey}/refunds

The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.

Default value: "application/json"

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.

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 (').

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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.

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.

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.

The date when the refund takes effect, in yyyy-mm-dd format. The date of the refund cannot be before the credit memo date. Specify this field only for external refunds. Zuora automatically generates this field for electronic refunds.

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

The ID of the payment method used for the refund. This field is required for an electronic refund, and the value must be an electronic payment method ID. This field must be left empty for an external refund.

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

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

Container for credit memo items. The maximum number of items is 1,000.

Note: This field is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

The amount of the refund on the specific item.

The ID of the credit memo taxation item that is refunded.

The ID of the credit memo item that is refunded.

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

Container for the finance information related to the refund.

The accounting code for the unapplied payment.

The accounting code that maps to a bank account in your accounting system.

The accounting code that maps to an on account in your accounting system.

Whether the refund 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"

A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.

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

Comments about the refund.

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

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

The ID of the gateway instance that processes the refund. This field can be specified only for electronic refunds. The ID must be a valid gateway instance ID, and this gateway must support the specific payment method.

If no gateway ID is specified, the default gateway in the billing account configuration will be used. If no gateway is specified in the billing account, the default gateway of the corresponding tenant will be used.

The field used to pass gateway-specific parameters and parameter values.

The name of a gateway-specific parameter.

The value of the gateway-specific parameter.

How an external refund was issued to a customer. This field is required for an external refund and must be left empty for an electronic refund. You can issue an external refund on a credit memo.

Possible values:

• "PayPal"
• "Other"
• "ACH"
• "WireTransfer"
• "BankTransfer"
• "DebitCard"
• "Check"
• "CreditCard"
• "Cash"
• "CreditCardReferenceTransaction"

The type of the refund.

Possible values:

• "External"
• "Electronic"

It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item, Reporting currency item, or both).

Note: The API custom rate feature is permission controlled.

The date on which a particular currency rate is fixed or obtained on.

Note: This field is only available if you set the zuora-version request header to 224.0 or later available versions.

The currency code for either Reporting or Home currency.

Note: This field is only available if you set the zuora-version request header to 224.0 or later available versions.

The Custom FX conversion rate between Home/Reporting and Transactional currency items.

Note: This field is only available if you set the zuora-version request header to 224.0 or later available versions.

The total amount of the refund. The amount cannot exceed the unapplied amount of the associated credit memo. If the original credit memo was applied to one or more invoices or debit memos, you have to unapply a full or partial credit memo from the invoices or debit memos, and then refund the full or partial unapplied credit memo to your customers.

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.

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