# CRUD: Retrieve a payment

Retrieves the information about one specific payment.

Endpoint: GET /v1/object/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 (').

## Path parameters:

  - `id` (string, required)
    The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352.

## Response 200 fields (application/json):

  - `AccountId` (string)
    The unique account ID for the customer that the payment is for.

  - `AccountingCode` (string)
    The accounting code for the payment. Accounting codes group transactions that contain similar accounting attributes.

  - `Amount` (number)
    The amount of the payment.

  - `AppliedAmount` (number)
    The applied amount of the payment.

Note: This field is only available if you have the Invoice Settlement feature enabled.

  - `AppliedCreditBalanceAmount` (number)
    If you have the Invoice Settlement feature disabled, the value of this field is the amount of the payment to apply to a credit balance.

If you have the Invoice Settlement feature enabled, the value of this field returned in the response is 0 for the payments that are created after the enablement.

  - `AuthTransactionId` (string)
    The authorization transaction ID from the payment gateway.

  - `BankIdentificationNumber` (string)
    The first six or eight digits of the credit card or debit card used for the payment, when applicable.

  - `CancelledOn` (string)
    The date and time when the payment was canceled.

  - `Comment` (string)
    Additional information related to the payment.

  - `CreatedById` (string)
    The ID of the Zuora user who created the payment.

  - `CreatedDate` (string)
    The date and time when the payment was created.

  - `EffectiveDate` (string)
    The date when the payment takes effect.

  - `Gateway` (string)
    The name of the gateway instance that processes the payment.

  - `GatewayOrderId` (string)
    A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.

  - `GatewayResponse` (string)
    The message returned from the payment gateway for the payment. This message is gateway-dependent.

  - `GatewayResponseCode` (string)
    The code returned from the payment gateway for the payment. This code is gateway-dependent.

  - `GatewayState` (string)
    The status of the payment in the gateway; use for reconciliation.
    Enum: "MarkedForSubmission", "Submitted", "Settled", "NotSubmitted", "FailedToSettle"

  - `Id` (string)
    The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352.

  - `MarkedForSubmissionOn` (string)
    The date and time when a payment was marked and waiting for batch submission to the payment process.

  - `PaymentMethodId` (string)
    The ID of the payment method used for the payment.

  - `PaymentMethodSnapshotId` (string)
    The unique ID of the payment method snapshot which is a copy of the particular payment method used in a transaction.

  - `PaymentNumber` (string)
    The unique identification number of the payment. For example, P-00000028.

  - `ReferenceId` (string)
    The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.

  - `RefundAmount` (number)
    The amount of the payment that is refunded. The value of this field is 0 if no refund is made against the payment.

  - `SecondPaymentReferenceId` (string)
    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.

  - `SettledOn` (string)
    The date and time when the payment was settled in the payment processor. This field is used by the Spectrum gateway only and not applicable to other gateways.

  - `SoftDescriptor` (string)
    A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.

  - `SoftDescriptorPhone` (string)
    A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.

  - `Source` (string)
    How the payment was created, whether through the API, manually, import, or payment run.
    Enum: "PaymentRun", "Import", "Manually", "API"

  - `SourceName` (string)
    The name of the source. The value is a Payment Run number or a file name.

  - `Status` (string)
    The status of the payment in Zuora. The value depends on the type of payments.

- If you have the Invoice Settlement feature disabled, for electronic payments, the status can be Processed, Processing, Error, or Voided. For external payments, the status can be Processed or Canceled.
- If you have the Invoice Settlement feature enabled, for electronic payments, the status can be Processed, Processing, Error, or Canceled. For external payments, the status can be Processed or Canceled.
    Enum: "Processed", "Error", "Voided", "Canceled"

  - `SubmittedOn` (string)
    The date and time when the payment was submitted.

  - `TransferredToAccounting` (string)
    Indicates if the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite.
    Enum: "Processing", "Yes", "Error", "Ignore"

  - `Type` (string)
    The type of the payment, whether the payment is external or electronic.
    Enum: "External", "Electronic"

  - `UnappliedAmount` (number)
    The unapplied amount of the payment.

Note: This field is only available if you have the Invoice Settlement feature enabled.

  - `UpdatedById` (string)
    The ID of the Zuora user who last updated the payment.

  - `UpdatedDate` (string)
    The date and time when the payment was last updated.

  - `IntegrationId__NS` (string)
    ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `IntegrationStatus__NS` (string)
    Status of the payment's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `Origin__NS` (string)
    Origin of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `SyncDate__NS` (string)
    Date when the payment was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `Transaction__NS` (string)
    Related transaction in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

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