--- title: "Refund a payment with auto-unapplying" method: POST path: "/v1/payments/{paymentKey}/refunds/unapply" tags: ["Payments"] --- # Refund a payment with auto-unapplying `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 on the payment refund use case, see Payment schedules use cases in the Knowledge Center. For more information, see Refund a payment with auto-unapplying. ## Path parameters - `paymentKey` string, required ## Headers - `Idempotency-Key` string - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Version` string ## Request body - PostRefundwithAutoUnapplyType — Container for custom fields of a Refund object. - `comment` string — Comments about the refund. - `debitMemos` PaymentDebitMemoApplicationApplyRequestType[] — Container for debit memos. The maximum number of debit memos is 1,000. - `amount` number, double, required — The amount that is applied from the payment to the debit memo. - `debitMemoId` string — The unique ID of the debit memo that the payment is applied to. If `debitMemoId` or `debitMemoNumber` is specified, the `writeOff` value can be set to true. This enables writing off a debit memo at the time of refund. **Note:** - The Payment Cross Account (PCA) feature is in the Early Adopter phase. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. - `debitMemoNumber` string — The number of the debit memo that the payment is applied to. **Note:** - The Payment Cross Account (PCA) feature is in the Early Adopter phase. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. - `items` PaymentDebitMemoApplicationItemApplyRequestType[] — 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](https://docs.zuora.com?resourceId=billing-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](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. - `amount` number, double, required — The amount of the payment that is applied to the specific debit memo or taxation item. - `debitMemoItemId` string — The ID of the specific debit memo item. - `taxItemId` string — The ID of the specific taxation item. - `financeInformation` object — Container for the finance information related to the refund. - `bankAccountAccountingCode` string — The accounting code that maps to a bank account in your accounting system. - `transferredToAccounting` 'Processing' | 'Yes' | 'No' | 'Error' | 'Ignore' — Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. - `unappliedPaymentAccountingCode` string — The accounting code for the unapplied payment. - `gatewayOptions` object — 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](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). 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. - `key` string — The name of a gateway-specific parameter. - `value` string — The value of the gateway-specific parameter. - `invoices` PaymentInvoiceApplicationApplyRequestType[] — Container for invoices. The maximum number of invoices is 1,000. - `amount` number, double, required — The amount that is applied from the payment to the invoice. - `invoiceId` string — The unique ID of the invoice that the payment is applied to. If `invoiceId` or `invoiceNumber` is specified, the `writeOff` value can be set to true. This enables writing off a debit memo at the time of refund. **Note:** - The Payment Cross Account (PCA) feature is in the Early Adopter phase. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. - `invoiceNumber` string — 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. - The Payment Cross Account (PCA) feature is in the Early Adopter phase. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. - `items` PaymentInvoiceApplicationItemApplyRequestType[] — 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](https://docs.zuora.com?resourceId=billing-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](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. - `amount` number, double, required — The amount of the payment that is applied to the specific invoice or taxation item. - `invoiceItemId` string — The ID of the specific invoice item. - `taxItemId` string — The ID of the specific taxation item. - `methodType` 'ACH' | 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'WireTransfer' | 'DebitCard' | 'CreditCardReferenceTransaction' | 'BankTransfer' | 'Other' — 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. - `reasonCode` string — 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. - `referenceId` string — The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments. - `refundDate` string, date — 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. - `secondRefundReferenceId` string — 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 — A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. - `softDescriptorPhone` string — A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. - `totalAmount` number, double — 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. - `type` 'External' | 'Electronic', required — The type of the refund. - `refundTransactionType` 'Chargeback' | 'PaymentReversal' — The transaction type of the refund. - `writeOff` boolean — Indicates whether to write off a document. - `writeOffOptions` object — Container for the write-off information to create credit memo. - `comment` string — Comments about the credit memo which is created as a result of the write off. - `memoDate` string, date — The date when the credit memo takes effect. - `reasonCode` string — A code identifying the reason for the credit memo. - `taxAutoCalculation` boolean — Specifies whether taxes are automatically recalculated for the credit memo generated during the write-off process. When set to `true`, the system fetches the latest tax rates from the tax vendor instead of copying the tax amounts from the original invoice. The default value is `false`. **Note**: This feature is in the **Early Availability** phase. Contact Zuora Global Support to enable this feature before using it. - `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 refund'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 refund was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). - `SynctoNetSuite__NS` string — Specifies whether the refund should be synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). ## Response `200` OK - GETRefundPaymentTypeAutoUnapply — Container for custom fields of a Refund object. - `accountId` string — The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment. - `amount` number, double — The total amount of the refund. - `cancelledOn` string, nullable — The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format. - `comment` string, nullable — Comments about the refund. - `createdById` string — The ID of the Zuora user who created the refund. - `createdDate` string — 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. - `creditMemoId` string, nullable — The ID of the credit memo associated with the refund. - `financeInformation` object — Container for the finance information related to the refund. - `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 refund 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 — The ID of the gateway instance that processes the refund. - `gatewayReconciliationReason` string, nullable — The reason of gateway reconciliation. - `gatewayReconciliationStatus` string, nullable — The status of gateway reconciliation. - `gatewayResponse` string — The message returned from the payment gateway for the refund. This message is gateway-dependent. - `gatewayResponseCode` string — The code returned from the payment gateway for the refund. This code is gateway-dependent. - `gatewayState` 'MarkedForSubmission' | 'Submitted' | 'Settled' | 'NotSubmitted' | 'FailedToSettle' — The status of the refund in the gateway. - `id` string — The ID of the created refund. - `markedForSubmissionOn` string, nullable — 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. - `methodType` 'ACH' | 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'WireTransfer' | 'DebitCard' | 'CreditCardReferenceTransaction' | 'BankTransfer' | 'Other' — How an external refund was issued to a customer. - `number` string — The unique identification number of the refund. - `paymentGatewayNumber` string — The natural key for the payment gateway. - `paymentId` string — The ID of the payment that is refunded. - `paymentMethodId` string — The unique ID of the payment method that the customer used to make the refund. - `paymentMethodSnapshotId` string — The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction. - `payoutId` string, nullable — The payout ID of the refund from the gateway side. - `reasonCode` string, nullable — A code identifying the reason for the transaction. - `referenceId` string — The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments. - `refundDate` string, date — The date when the refund takes effect, in `yyyy-mm-dd` format. - `refundTransactionTime` string — The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format. - `secondRefundReferenceId` string, nullable — 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. - `settledOn` string, nullable — 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. - `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. - `status` 'Processed' | 'Canceled' | 'Error' | 'Processing' — The status of the refund. - `submittedOn` string — The date and time when the refund 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 refund. - `updatedById` string — The ID of the the Zuora user who last updated the refund. - `updatedDate` string — 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. - `writeOffResults` object, nullable — Container for the write-off information of credit memo and apply information. - `errorMessage` string — The error message about write off failed. - `transactions` object — The credit memo apply information. - `appliedAmount` number, double — The credit memo applied amopunt. - `creditMemoAmount` string — The credit memo amount. - `creditMemoNumber` string — The unique identification number of the credit memo. - `creditMemoStatus` 'Draft' | 'Posted' | 'Canceled' | 'Error' | 'PendingForTax' | 'Generating' | 'CancelInProgress' — The status of the credit memo. - `invoiceNumber` string — The unique identification number of the invoice. - `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 refund'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 refund was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). - `SynctoNetSuite__NS` string — Specifies whether the refund should be synchronized with 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)