- CRUD: Retrieve a refund
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.
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.
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 (').
- https://rest.zuora.comhttps://rest.zuora.com/v1/object/refund/{id}
curl -i -X GET \
'https://rest.zuora.com/v1/object/refund/{id}?fields=string' \
-H 'Accept-Encoding: string' \
-H 'Authorization: string' \
-H 'Content-Encoding: string' \
-H 'Zuora-Entity-Ids: string' \
-H 'Zuora-Track-Id: string'This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
application/jsonapplication/xmltext/htmltext/csvtext/plain
The request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The Zuora internal identifier of the API call. You cannot control the value of this header.
The ID of the account associated with this refund. Specify a value for this field only if you're creating an electronic non-referenced refund. Don't specify a value for any other type of refund; Zuora associates the refund automatically with the account from the associated payment. Character limit: 32 Values: a valid account ID
The accounting code for the payment or invoice line item that the refund applies to. If there is no accounting code, then this value is null. Accounting codes group transactions that contain similar accounting attributes. Character limit: 50 Values: automatically generated
The amount of the refund. The amount can't exceed the amount of the associated payment. If the original payment was applied to a single invoice, you can create a partial refund by specifying an amount in this field or through the UI. If the payment was applied to multiple invoices, you can create a partial refund by using the RefundInvoicePaymentData field of this operation or through the UI. Character limit: 16 Values: a valid currency amount
Use this field to record comments about the refund. Character limit: 255 Values: a string of 255 characters or fewer
The ID of the Zuora user who created the Refund object. Character limit: 32 Values: automatically generated
The date when the Refund object was created. Character limit: 29 Values: automatically generated
The gateway that processed the original payment. Zuora uses this same gateway for the corresponding refund. If this payment gateway is no longer active, then the electronic refund fails. A gateway is an online service provider that connects an online shopping cart to a payment processor. Values: automatically inherited from the Payment object
The message returned from the payment gateway for the refund. This message is gateway-dependent. Character limit: 500 Values: automatically generated
The code returned from the payment gateway for the payment. This code is gateway-dependent. Character limit: 20 System****Values: automatically generated
The status of the payment in the gateway. Character limit: 19 Values: automatically generated
The date when a payment was marked and waiting for batch submission to the payment process. Character limit: 29 Values: automatically generated
Indicates how an external refund was issued to a customer. This field is required for an external refund. You can issue an external refund on an electronic payment. Character limit: 30 Values:
ACHCashCheckCreditCardOtherPayPalWireTransferDebitCardCreditCardReferenceTransaction
The unique ID of the payment method that the customer used to make the payment. Specify a value for this field only if you're creating an electronic non-referenced refund. Character limit: 32 V****alues: a valid payment method ID
The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction. Character limit: 32 V****alues: a valid payment method snapshot ID
A code identifying the reason for the transaction. Must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. Character limit: 32 V****alues: a valid reason code
The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments. Character limit: 60 Values: a string of 60 characters or fewer
The date of the refund, 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. Character limit: 29
The unique identifier of the refund. Character limit: 50 Values: automatically generated
The date and time when the refund was issued. Character limit: 29 Values: automatically generated
The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments. Character limit: 60 Values: a string of 60 characters or fewer
The date when the payment was settled in the payment processor. This field is used by the Spectrum gateway only and not applicable to other gateways. Character limit: 29 Values: automatically generated
A payment gateway-specific field that maps Zuora to other gateways . Character limit: 35 Values:
- 3-byte company identifier "*" 18-byte descriptor
- 7-byte company identifier "*" 14-byte descriptor
- 12-byte company identifier "*" 9-byte descriptor
A payment gateway-specific field that maps Zuora to other gateways . Character limit: 20 Values:
- Customer service phone number formatted as:
NNN-NNN-NNNNorNNN-AAAAAAA - URL (non-e-Commerce): Transactions sent with a URL do not qualify for the best interchange rate
- Email address
Specifies whether the refund is a refund payment or a credit balance. This field is required when creating an non-referenced refund. If you creating an non-referenced refund, then set this value to CreditBalance. Character limit: 13 Values:
PaymentCreditBalance
The status of the refund. Character limit: 10 Values: automatically generated:
CanceledErrorProcessedProcessing
The date when the payment was submitted. Character limit: 29 Values: automatically generated
Specifies whether or not the object has been transferred to an external accounting system. Use this field for integrations with accounting systems such as NetSuite. Character limit: 10 Values: automatically generated:
ProcessingYesErrorIgnore
Specifies if the refund is electronic or external. Character limit: 10 Values:
Electronic- External
The ID of the last user to update the object. Character limit: 32 Values: automatically generated
The date when the object was last updated. Character limit: 29 Values: automatically generated
ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Status of the refund's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Origin of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Date when the refund was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Specifies whether the refund should be synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
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.
// No response example