Skip to content
Legacy API Reference
/Refund Invoice Payments/
CRUD: Retrieve a refund i...

CRUD: Retrieve a refund invoice payment

Request

Path
idstringrequired

Object id

Query
fieldsstring

Object fields to return

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

Authorizationstring

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

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 do not need to set this header.

Zuora-Track-Idstring, <= 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 (').

cURL
curl -i -X GET \
  'https://rest.zuora.com/v1/object/refund-invoice-payment/{id}?fields=string' \
  -H 'Accept-Encoding: string' \
  -H 'Authorization: string' \
  -H 'Content-Encoding: string' \
  -H 'Zuora-Entity-Ids: string' \
  -H 'Zuora-Track-Id: string'

Responses

Headers
Content-Encodingstring

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/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring, = 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring, <= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Bodyapplication/json
CreatedByIdstring

The ID of the Zuora user who created the RefundInvoicePayment object. Character limit: 32 Values: automatically generated

CreatedDatestring, (date-time)

The date when the RefundInvoicePayment object was created. Character limit: 29 Values: automatically generated

Idstring

Object identifier.

InvoiceIdstring

The unique ID of the invoice associated with this refund invoice payment. Character limit: 32 Values: a valid invoice ID

InvoicePaymentIdstring

The ID of the InvoicePayment.Id

RefundAmountnumber, (double)

Specifies the amount of a refund applied against a payment. Character limit: 16 Values: automatically generated

RefundIdstring

The ID of the Refund object Character limit: 32 Values: inherited from Refund.Id

UpdatedByIdstring

The ID of the last user to update the object. Character limit: 32 Values: automatically generated

UpdatedDatestring, (date-time)

The date when the object was last updated. Character limit: 29 Values: automatically generated

Response
{
  "CreatedById": "string",
  "CreatedDate": "2019-08-24T14:15:22Z",
  "Id": "string",
  "InvoiceId": "string",
  "InvoicePaymentId": "string",
  "RefundAmount": 0.1,
  "RefundId": "string",
  "UpdatedById": "string",
  "UpdatedDate": "2019-08-24T14:15:22Z"
}