Sign in
Payments

Refund a payment

Note: This operation is only available if you have <a href="https://docs.zuora.com?resourceId=billing-invoice-settlement" target="_blank">Invoice Settlement</a> 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 <a href="https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide" target="_blank">Invoice Settlement Enablement and Checklist Guide</a> 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 on the payment refund use case, see <a href="https://docs.zuora.com?resourceId=payments-payment-schedules" target="_blank">Payment schedules use cases</a> in the Knowledge Center.

For more information, see <a href="https://docs.zuora.com/en/zuora-payments/process-payments/create-a-payment-using-zuora-ui/manage-unapplied-payments/management-of-unapplied-payments/refund-payments" target="_blank">Refund Payments</a>.

post/v1/payments/{paymentKey}/refunds

Path parameters

paymentKeystring required

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

Headers

Idempotency-Keystring

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.

Accept-Encodingstring

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.

Content-Encodingstring

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

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

Zuora-Entity-Idsstring

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 should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

commentstring

Comments about the refund.

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.

reasonCodestring

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.

referenceIdstring

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

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

secondRefundReferenceIdstring

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.

softDescriptorstring

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

softDescriptorPhonestring

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

totalAmountnumber double required

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.

type'External' | 'Electronic' required

The type of the refund.

refundTransactionType'Chargeback' | 'PaymentReversal'

The transaction type of the refund.

IntegrationId__NSstring

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

IntegrationStatus__NSstring

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

Origin__NSstring

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

SyncDate__NSstring

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

SynctoNetSuite__NSstring

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

Example request

{
  "type": "Electronic",
  "totalAmount": 10
}

Response

OK

accountIdstring

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

amountnumber double

The total amount of the refund.

cancelledOnstring nullable

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

commentstring nullable

Comments about the refund.

createdByIdstring

The ID of the Zuora user who created the refund.

createdDatestring

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.

creditMemoIdstring nullable

The ID of the credit memo associated with the refund.

gatewayIdstring

The ID of the gateway instance that processes the refund.

gatewayReconciliationReasonstring nullable

The reason of gateway reconciliation.

gatewayReconciliationStatusstring nullable

The status of gateway reconciliation.

gatewayResponsestring

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

gatewayResponseCodestring

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.

idstring

The ID of the created refund.

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

numberstring

The unique identification number of the refund.

organizationLabelstring

The organization that this object belongs to.

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

paymentGatewayNumberstring

The natural key for the payment gateway.

paymentIdstring

The ID of the payment that is refunded.

paymentMethodIdstring

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

paymentMethodSnapshotIdstring

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

payoutIdstring nullable

The payout ID of the refund from the gateway side.

reasonCodestring nullable

A code identifying the reason for the transaction.

referenceIdstring nullable

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

refundDatestring date

The date when the refund takes effect, in yyyy-mm-dd format.

refundTransactionTimestring

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

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

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

softDescriptorstring nullable

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

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

submittedOnstring

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

successboolean

Returns true if the request was processed successfully.

type'External' | 'Electronic'

The type of the refund.

updatedByIdstring

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

updatedDatestring

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__NSstring

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

IntegrationStatus__NSstring

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

Origin__NSstring

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

SyncDate__NSstring

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

SynctoNetSuite__NSstring

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

Changes