POST /v1/payments/{paymentKey}/refunds

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. To refund applied payments, you must unapply the applied payments from the invoices or debit memos, and then refund the unapplied payments to customers.

For more information, see Refund Payments.

Servers

https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com

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.
`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.
`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.
`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"`
`customRates[]`	Array	No	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.
`customRates[].rateDate`	String	No	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.
`customRates[].currency`	String	Yes	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.
`customRates[].customFxRate`	Number	Yes	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.
`totalAmount`	Number	Yes	The total amount of the refund. The amount cannot exceed the unapplied amount of the associated payment. If the original payment was applied to one or more invoices or debit memos, you have to unapply a full or partial payment from the invoices or debit memos, and then refund the full or partial unapplied payment to your 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.
`softDescriptor`	String	No	A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.