Pricing Templates
Log in Sign up
Integrations / Zuora / ...

POST /v1/payments/{paymentKey}/refunds/unapply

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.

Refunds a full or partial unapplied payment to your customers, without the need to unapply the payment first, followed by processing the refund. To refund applied payments, you can now leverage this API to unapply and refund the payment simultaneously.

For more information, see Refund a payment with auto-unapplying.

Servers

Path parameters

Name Type Required Description
paymentKey String Yes

The unique ID or number of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1, or P-00000001.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"
Content-Encoding String No

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-Id String No

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

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

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.
Zuora-Entity-Ids String No

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 No

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.
Accept-Encoding String No

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.

Request body fields

Name Type Required Description
refundDate String No

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

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

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

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

Origin of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
invoices[] Array No

Container for invoices. The maximum number of invoices is 1,000.
invoices[].invoiceNumber String No

The number of the invoice that the payment is applied to. For example, INV00000001.

Note: When both the invoiceNumber and invoiceId fields are specified, the two fields must match with each other.
invoices[].amount Number Yes

The amount that is applied from the payment to the invoice.
invoices[].items[] Array No

Container for invoice 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.
invoices[].items[].invoiceItemId String No

The ID of the specific invoice item.
invoices[].items[].amount Number Yes

The amount of the payment that is applied to the specific invoice or taxation item.
invoices[].items[].taxItemId String No

The ID of the specific taxation item.
invoices[].invoiceId String No

The unique ID of the invoice that the payment is applied to.
financeInformation Object No

Container for the finance information related to the refund.
financeInformation.unappliedPaymentAccountingCode String No

The accounting code for the unapplied payment.
financeInformation.bankAccountAccountingCode String No

The accounting code that maps to a bank account in your accounting system.
financeInformation.transferredToAccounting String No

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"
reasonCode String 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.
refundTransactionType String No

The transaction type of the refund.

Possible values:

  • "Chargeback"
  • "PaymentReversal"
SynctoNetSuite__NS String No

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

Comments about the refund.
debitMemos[] Array No

Container for debit memos. The maximum number of debit memos is 1,000.
debitMemos[].debitMemoNumber String No

The number of the debit memo that the payment is applied to.
debitMemos[].debitMemoId String No

The unique ID of the debit memo that the payment is applied to.
debitMemos[].amount Number Yes

The amount that is applied from the payment to the debit memo.
debitMemos[].items[] Array No

Container for debit 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.
debitMemos[].items[].debitMemoItemId String No

The ID of the specific debit memo item.
debitMemos[].items[].amount Number Yes

The amount of the payment that is applied to the specific debit memo or taxation item.
debitMemos[].items[].taxItemId String No

The ID of the specific taxation item.
SyncDate__NS String No

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

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

The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in Zuora Knowledge Center.

Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
gatewayOptions.key String No

The name of a gateway-specific parameter.
gatewayOptions.value String No

The value of the gateway-specific parameter.
writeOff Boolean No

Indicates whether to write off a document.

Default value: false
methodType String No

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 an electronic payment.

Possible values:

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

The type of the refund.

Possible values:

  • "External"
  • "Electronic"
totalAmount Number No

The total amount of the refund. If you do not specify a value, Zuora initiates a full refund of the payment amount, which is the sum of the applied and unapplied payment amounts.

  • Full Refund: If the refund amount and debit memo/ invoice are not specified, then the payment will be unapplied completely, followed by processing a full refund.
  • Partial Refund:
    • If the total amount is specified, and the debit memo/invoice is not specified, you can unapply the refund amount from the available debit memo/invoice and refund the unapplied payment to the customer.
    • If the total amount is specified, along with the debit memo and the invoice, you can unapply the applied payments from the mentioned invoices and debit memos, and refund the unapplied payments to customers.
secondRefundReferenceId String No

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.
writeOffOptions Object No

Container for the write-off information to create credit memo.
writeOffOptions.comment String No

Comments about the credit memo which is created as a result of the write off.
writeOffOptions.reasonCode String No

A code identifying the reason for the credit memo.
writeOffOptions.memoDate String No

The date when the credit memo takes effect.
softDescriptor String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy