# CRUD: Retrieve an invoice payment

Endpoint: GET /v1/object/invoice-payment/{id}
Version: 2025-12-17

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

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

  - `Authorization` (string)
    The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

  - `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-Track-Id` (string)
    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 (').

## Query parameters:

  - `fields` (string)
    Object fields to return

## Path parameters:

  - `id` (string, required)
    Object id

## Response 200 fields (application/json):

  - `Amount` (number)
    The amount of the payment.
Character limit: 16 Values: a valid currency amount

  - `CreatedById` (string)
    The user ID of the person who created the invoice payment.
Character limit: 32 Values: automatically generated

  - `CreatedDate` (string)
    The date when the invoice payment was generated.
Character limit: 29 Values: automatically generated

  - `Id` (string)
    Object identifier.

  - `InvoiceId` (string)
    The unique ID of the invoice associated with this invoice payment.
Character limit: 32 Values: a valid invoice ID

  - `PaymentId` (string)
    The unique ID of the payment associated with this invoice payment.
Character limit: 32 Values: a valid payment ID

  - `RefundAmount` (number)
    Specifies the amount of a refund applied against this InvoicePayment. Character limit: 16 Values: automatically generated

  - `UpdatedById` (string)
    The ID of the user who last updated the invoice payment.
Character limit: 32 Values: automatically generated

  - `UpdatedDate` (string)
    The date when the invoice payment was last updated.
Character limit: 29 Values: automatically generated

## Response 401 fields (application/json):

  - `message` (string)
    Error message.

If the error message is "Authentication error", ensure that the Authorization request header contains valid authentication credentials, then retry the request. See [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/) for more information.

If the error message is "Failed to get user info", retry the request.

## Response 404 fields (application/json):

  - `done` (boolean)

  - `records` (array)

  - `size` (integer)