Refund a payment

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.

Request
path Parameters
paymentKey
required
string

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

header Parameters
Accept-Encoding
string

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.

Authorization
string

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

Content-Encoding
string

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.

Idempotency-Key
string <= 255 characters

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

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

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.

Zuora-Track-Id
string <= 64 characters

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

Request Body schema: application/json
required
totalAmount
required
number <double>

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
required
string

The type of the refund.

Enum: "External" "Electronic"
comment
string [ 0 .. 255 ] characters

Comments about the refund.

Array of objects (customRates) <= 2 items

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.

object

Container for the finance information related to the refund.

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.

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.

IntegrationId__NS
string <= 255 characters

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

IntegrationStatus__NS
string <= 255 characters

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

methodType
string

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.

Enum: "ACH" "Cash" "Check" "CreditCard" "PayPal" "WireTransfer" "DebitCard" "CreditCardReferenceTransaction" "BankTransfer" "Other"
Origin__NS
string <= 255 characters

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

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 [ 0 .. 100 ] characters

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.

refundTransactionType
string

The transaction type of the refund.

Enum: "Chargeback" "PaymentReversal"
secondRefundReferenceId
string [ 0 .. 100 ] characters

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 <= 35 characters

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

softDescriptorPhone
string <= 20 characters

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

SyncDate__NS
string <= 255 characters

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

SynctoNetSuite__NS
string <= 255 characters

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

property name*
additional property
any

Custom fields of the Refund object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.

Responses
200
post/v1/payments/{paymentKey}/refunds
Request samples
application/json
{
  • "comment": "Create a refund for unapplied payment.",
  • "customRates": [
    ],
  • "gatewayOptions": {
    },
  • "methodType": "CreditCard",
  • "reasonCode": "Standard Refund",
  • "refundDate": "2017-03-01",
  • "totalAmount": 4,
  • "type": "External",
  • "refundTransactionType": "Chargeback"
}
Response samples
application/json
{
  • "accountId": "4028905f5a87c0ff015a87d25ae90025",
  • "amount": 4,
  • "cancelledOn": null,
  • "comment": "Create a refund for unapplied payment.",
  • "createdById": "402881e522cf4f9b0122cf5d82860002",
  • "createdDate": "2017-03-01 14:46:03",
  • "creditMemoId": null,
  • "financeInformation": {
    },
  • "gatewayId": null,
  • "gatewayReconciliationReason": null,
  • "gatewayReconciliationStatus": null,
  • "gatewayResponse": null,
  • "gatewayResponseCode": null,
  • "gatewayState": "NotSubmitted",
  • "id": "4028905f5a87c0ff015a889e590e00c9",
  • "markedForSubmissionOn": null,
  • "methodType": "CreditCard",
  • "number": "R-00000001",
  • "paymentGatewayNumber": "PG-00000001",
  • "paymentId": "4028905f5a87c0ff015a889ddfb800c0",
  • "paymentMethodId": null,
  • "paymentMethodSnapshotId": null,
  • "payoutId": null,
  • "reasonCode": "Standard Refund",
  • "referenceId": null,
  • "refundDate": "2017-03-01",
  • "refundTransactionTime": null,
  • "secondRefundReferenceId": null,
  • "settledOn": null,
  • "softDescriptor": null,
  • "softDescriptorPhone": null,
  • "status": "Processed",
  • "submittedOn": null,
  • "success": true,
  • "type": "External",
  • "updatedById": "402881e522cf4f9b0122cf5d82860002",
  • "updatedDate": "2017-03-01 14:46:03"
}