--- title: "Get payment details" method: GET path: "/api/pvt/transactions/{transactionId}/payments/{paymentId}" tags: ["Transaction process"] --- # Get payment details `GET /api/pvt/transactions/{transactionId}/payments/{paymentId}` ## Request - Base URL: `https://apiexamples.vtexpayments.com.br` - URL: `https://apiexamples.vtexpayments.com.br/api/pvt/transactions/{transactionId}/payments/{paymentId}` - Auth: one of: - API key in header `X-VTEX-API-AppKey` and API key in header `X-VTEX-API-AppToken` - API key in header `VtexIdclientAutCookie` Returns data about all payments created for a transaction or a specific payment made in your store. >⚠️ To get information about a specific payment, use the `paymentId` parameter in the request path. ## Permissions Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint: | **Product** | **Category** | **Resource** | | --------------- | ----------------- | ----------------- | | PCI Gateway | Payment-Make Payments | **View Payment Data** | There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication). >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations. ## Path parameters - `transactionId` string, required - `paymentId` string ## Headers - `Content-Type` string, required - `Accept` string, required ## Response `200` OK - PaymentDetailsResponse: Payment details information. - `id` string, required: Payment identification. - `paymentSystem` number, required: Payment system identification. - `paymentSystemName` string, required: Payment system name. - `merchantName` string, nullable, required: Merchant name. - `group` string, required: Payment group name. - `userProfileId` string, nullable, required: Unique ID associated with the customer profile. - `isCustom` boolean, required: Indicates whether it is custom. - `allowInstallments` boolean, required: Indicates whether the payment method allows installments. - `requiresAuthentication` boolean, required: Indicates whether it is necessary to log in to make the payment. - `allowIssuer` boolean, required: Indicates whether it is possible to identify the name of the bank responsible for issuing the card. - `allowNotification` boolean, required: Indicates the possibility of payment notification (used by bank invoices and notes payable). - `isAvailable` boolean, required: Indicates whether the payment method is available for use. - `description` string, nullable, required: Description of the payment method. - `authorizationDate` string, nullable, required: Payment authorization date. - `self` Self, required: Object containing the payment system reference route. - `href` string, required: Payment system reference route. - `tid` string, nullable, required: Provider's unique identifier for the transaction. - `nsu` string, nullable: Provider's unique sequential number for the transaction. - `returnCode` string, nullable, required: Connector return code. - `returnMessage` string, nullable, required: Connector return message. - `status` string, required: Payment status. - `connector` string, nullable, required: Connector name. - `ConnectorResponses` object, required: Connector responses information. - `Tid` string: Provider's unique identifier for the transaction. - `ReturnCode` string, nullable: Connector return code. - `Message` string, nullable: Connector return message. - `authId` string, nullable: Authorization identification. - `nsu` string: Provider's unique sequential number for the transaction. - `connectorResponse` object, required: Connector response information. - `Tid` string: Provider's unique identifier for the transaction. - `ReturnCode` string, nullable: Connector return code. - `Message` string, nullable: Connector return message. - `authId` string, nullable: Authorization identification. - `nsu` string: Provider's unique sequential number for the transaction. - `ShowConnectorResponses` boolean, required: Indicates whether to display connector responses. - `value` number, required: Payment value. - `installmentsInterestRate` number, required: The interest rate. - `installmentsValue` number, required: The value of each installment. - `referenceValue` number, required: Value amount of the payment without interest applied. This value is the same as the {value` field when `installmentsInterestRate` is 0.0. - `installments` number, required: Number of installments. - `currencyCode` string, nullable, required: Currency Code in ISO 4217 standard. - `provider` string, nullable, required: Provider name. - `isBillingAddressDifferent` boolean, nullable, required: Indicates whether the invoice address is different from the purchase delivery address. - `isRegexValid` boolean, nullable, required: Confirms that the [Regex](https://regexr.com/) rule is valid. - `isLuhnValid` boolean, nullable, required: Confirms that the [Luhn](https://en.wikipedia.org/wiki/Luhn_algorithm) rule is valid. - `fields` Fields1[], required: Field containing information and values ​​of payment parameters. - `name` string, required: Payment parameter name. - `value` string, required: Payment parameter value. - `sheets` string, nullable, required: Sheets information. - `originalPaymentId` string, nullable, required: Original payment identification, if applicable. ## Changes - **2026-04-20** `7f58d8045a19`: 2 info - api tag `Transaction process` added - api tag `Transaction Process` removed - **2026-04-13** `c3b5420d8f9c`: 2 breaking, 11 info - the `ConnectorResponses` response's property type changed from `array` to `object` for status `200` - the `connectorResponse` response's property type changed from `array` to `object` for status `200` - the `path` request parameter `paymentId` became optional - added the optional property `ConnectorResponses/Message` to the response with the `200` status - …9 more - **2025-03-24** `4d3143472317`: 37 info - added the optional property `nsu` to the response with the `200` status - added the required property `ConnectorResponses` to the response with the `200` status - added the required property `ShowConnectorResponses` to the response with the `200` status - added the required property `allowInstallments` to the response with the `200` status - …33 more - **2024-06-10** `aca4931fa22b`: 2 info - the endpoint scheme security `VtexIdclientAutCookie` was added to the API - the endpoint scheme security `appKey AND appToken` was added to the API - **2024-02-01** `e0f0940dcde8`: 1 breaking - the `items/` response's property type changed from no type to `object` for status `200` [Operation history](https://skmtc.dev/vtex/apis/payments-gateway-api/changes/api/pvt/transactions/:transactionId/payments/:paymentId/get.md) --- [API](https://skmtc.dev/vtex/apis/payments-gateway-api.md) - [All operations](https://skmtc.dev/vtex/apis/payments-gateway-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vtex/apis/payments-gateway-api/revisions/05de96df31e4?raw)