Sign in
Payment Transaction Logs

CRUD: Retrieve a payment transaction log

Retrieves information about a specific payment transaction log.

get/v1/object/payment-transaction-log/{id}

Path parameters

idstring required

The ID of a payment transaction log.

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.

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-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-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

AVSResponseCodestring

The response code returned by the payment gateway referring to the AVS international response of the payment transaction.

BatchIdstring

The ID of the batch used to send the transaction if the request was sent in a batch.

CVVResponseCodestring

The response code returned by the payment gateway referring to the CVV international response of the payment transaction.

Gatewaystring

The name of the payment gateway used to transact the current payment transaction log.

GatewayReasonCodestring

The code returned by the payment gateway for the payment. This code is gateway-dependent.

GatewayReasonCodeDescriptionstring

The message returned by the payment gateway for the payment. This message is gateway-dependent.

GatewayState'MarkedForSubmission' | 'Submitted' | 'Settled' | 'NotSubmitted' | 'FailedToSettle'

The state of the transaction at the payment gateway.

GatewayTransactionType'Authorization' | 'Sale' | 'Void' | 'Inquiry' | 'VoidAuth'

The type of the transaction, either making a payment, or canceling a payment.

Idstring

The ID of the payment transaction log.

PaymentIdstring

The ID of the payment wherein the payment transaction log was recorded.

RequestStringstring

The payment transaction request string sent to the payment gateway.

ResponseStringstring

The payment transaction response string returned by the payment gateway.

TransactionDatestring date-time

The transaction date when the payment was performed.

TransactionIdstring

The transaction ID returned by the payment gateway. This field is used to reconcile payment transactions between the payment gateway and records in Zuora.

Changes

No recorded changes to this endpoint across all 4 revisions of this API.