Sign in
Object Queries

Retrieve a refund

Retrieve the details of a specific Refund object.

get/object-query/refunds/{key}

Path parameters

keystring required

Object ID or Number.

Query parameters

pageSizeinteger

The maximum number of results to return in a single page. If the specified pageSize is less than 1 or greater than 99, Zuora will return a 400 error.

cursorstring

A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with next_page=W3sib3JkZXJ=, your subsequent call can include cursor=W3sib3JkZXJ= in order to fetch the next page of the list.

sort[]string[]

A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. accountnumber.ASC) or descending (e.g. accountnumber.DESC). You cannot sort on properties in arrays. If the array-type properties are specified for the sort[] parameter, they are ignored.

expand[]string[]

Allows you to expand responses by including related object information in a single call.

filter[]string[]

A case-insensitive filter on the list.

fields[]string[]

A case-insensitive query parameter that allows you to specify which fields are returned in the response.

includeNullFieldsboolean

Specifies whether to include fields with the null value in the response.

  • If set to true, all fields will be returned in the response, including those with the null value.
  • If set to false, only fields with non-null values will be returned.

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.

Response

OK

idstring

The unique identifier of the refund.

createdByIdstring

The unique identifier of the user who created the refund.

createdDatestring date-time

The date and time when the refund was created.

updatedByIdstring

The unique identifier of the user who last updated the refund.

updatedDatestring date-time

The date and time when the refund was last updated.

accountIdstring

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

amountnumber double

The total amount of the refund.

cancelledOnstring date-time

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

commentstring nullable

Comments about the refund.

paymentMethodSnapshotIdstring

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

accountingCodestring

The accounting code that maps to this refund transaction in your accounting system.

currencystring

The currency of the refund.

gatewayReconciliationReasonstring

The reason of gateway reconciliation.

gatewayReconciliationStatusstring

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.

markedForSubmissionOnstring date-time

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.

paymentMethodIdstring

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

payoutIdstring

The payout ID of the refund from the gateway side.

reasonCodestring

A code identifying the reason for the transaction.

refundNumberstring

The number of the refund.

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. For example, 2017-03-01.

refundTransactionTimestring date-time

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

sourceType'Payment' | 'CreditBalance' | 'CreditMemo'

Specifies whether the refund is a refund payment or a credit balance.

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.

settledOnstring date-time

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

A payment gateway-specific field that maps Zuora to other gateways.

softDescriptorPhonestring

A payment gateway-specific field that maps Zuora to other gateways.

status'Processed' | 'Canceled' | 'Error' | 'Processing'

The status of the refund.

submittedOnstring date-time

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

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.

type'External' | 'Electronic'

The type of the refund.

associatedTransactionNumberstring

The number of the associated transactions, such as payments.

gatewaystring

The gateway that processed the original payment. A gateway is an online service provider that connects an online shopping cart to a payment processor. Zuora uses this same gateway for the corresponding refund. If this payment gateway is no longer active, then the electronic refund fails.

Example response

{
  "paymentMethod": {
    "paypalBaid": "I-1TJ3GAGG82Y9"
  }
}

Changes