get https://{accountName}.{environment}.com.br/api/oms/pvt/orders//payment-transaction
Retrievew transaction details by order ID.
Learn more about Transaction Details in VTEX Help
Request object has the following properties:
Attribute | Type | Description |
---|---|---|
orderId | string | Order Id |
Response object has the following properties:
Attribute | Type | Description |
---|---|---|
status | string | Transaction Status |
isActive | boolean | If is a active transaction |
transactionId | string | Transaction Id |
merchantName | string | Transaction Merchant Name |
payments | object | Payments details object |
id | string | Payment ID |
paymentSystem | string | Payment System Id |
paymentSystemName | string | Payment Sytem Name |
value | integer | Payment Value |
installments | integer | Payment Installments Quantity |
referenceValue | integer | Payment Reference Value |
cardHolder | string | Payment Card Holder |
cardNumber | string | Payment Card Number |
firstDigits | string | Payment Card First Digits |
lastDigits | string | Payment Card Last Digits |
cvv2 | string | ??? |
expireMonth | string | Payment Card expire Month |
expireYear | string | Payment Card expire Year |
url | string | Payment URL |
giftCardId | string | Gift Card Id |
giftCardName | string | Gift Card Name |
giftCardCaption | string | Gift Card Caption |
authId | string | Connector Authorization Id |
group | string | Payment Group. It represents the payment method. For each method, it can have the following values:
|
tid | string | Payment Transaction Id |
dueDate | string | Payment Due Date |
connectorResponses | string | Order Id |
Tid | string | Connector Transaction Id |
ReturnCode | string | Connector Return Code |
Message | string | Order Id |
authId | string | Connector Authorization Id |
Request body example
curl --location --request GET 'https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}/payment-transaction' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' \
--header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}'
Response body example
{
"status": "Finished",
"isActive": true,
"transactionId": "CB452D77E7D04099A4DB0479087B1D2C",
"merchantName": "LUXSTORE",
"payments": [
{
"id": "721CBE1090324D12ABE301FE33DE775A",
"paymentSystem": "4",
"paymentSystemName": "Mastercard",
"value": 10150,
"installments": 1,
"referenceValue": 10150,
"cardHolder": null,
"cardNumber": null,
"firstDigits": "412341",
"lastDigits": "4123",
"cvv2": null,
"expireMonth": null,
"expireYear": null,
"url": null,
"giftCardId": null,
"giftCardName": null,
"giftCardCaption": null,
"redemptionCode": null,
"group": "creditCard",
"tid": "101770752",
"dueDate": null,
"connectorResponses": {
"Tid": "101770752",
"ReturnCode": null,
"Message": null,
"authId": "170852"
}
}
]
}