v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-202547455.8 KB

Transaction process

Get payment details

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 must have at least one of the appropriate License Manager resources 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 for this resource list. You must create a custom 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.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/pvt/transactions/{transactionId}/payments/{paymentId}

Path parameters

transactionIdstring required

Example:A3BDE325F76B4B758B398D900DF06150

Transaction identification.

paymentIdstring

Example:B2E754DCD7304D22866CB6F221CF0FEB

Payment identification.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

idstring required

Payment identification.

paymentSystemnumber required

Payment system identification.

paymentSystemNamestring required

Payment system name.

merchantNamestring nullable required

Merchant name.

groupstring required

Payment group name.

userProfileIdstring nullable required

Unique ID associated with the customer profile.

isCustomboolean required

Indicates whether it is custom.

allowInstallmentsboolean required

Indicates whether the payment method allows installments.

requiresAuthenticationboolean required

Indicates whether it is necessary to log in to make the payment.

allowIssuerboolean required

Indicates whether it is possible to identify the name of the bank responsible for issuing the card.

allowNotificationboolean required

Indicates the possibility of payment notification (used by bank invoices and notes payable).

isAvailableboolean required

Indicates whether the payment method is available for use.

descriptionstring nullable required

Description of the payment method.

authorizationDatestring nullable required

Payment authorization date.

tidstring nullable required

Provider's unique identifier for the transaction.

nsustring nullable

Provider's unique sequential number for the transaction.

returnCodestring nullable required

Connector return code.

returnMessagestring nullable required

Connector return message.

statusstring required

Payment status.

connectorstring nullable required

Connector name.

ShowConnectorResponsesboolean required

Indicates whether to display connector responses.

valuenumber required

Payment value.

installmentsInterestRatenumber required

The interest rate.

installmentsValuenumber required

The value of each installment.

referenceValuenumber required

Value amount of the payment without interest applied. This value is the same as the {valuefield wheninstallmentsInterestRate` is 0.0.

installmentsnumber required

Number of installments.

currencyCodestring nullable required

Currency Code in ISO 4217 standard.

providerstring nullable required

Provider name.

isBillingAddressDifferentboolean nullable required

Indicates whether the invoice address is different from the purchase delivery address.

isRegexValidboolean nullable required

Confirms that the Regex rule is valid.

isLuhnValidboolean nullable required

Confirms that the Luhn rule is valid.

sheetsstring nullable required

Sheets information.

originalPaymentIdstring nullable required

Original payment identification, if applicable.