---
title: "Retrieve payment transaction"
method: GET
path: "/api/oms/pvt/orders/{orderId}/payment-transaction"
tags: ["Payment"]
---

# Retrieve payment transaction

`GET /api/oms/pvt/orders/{orderId}/payment-transaction`

Retrieves transaction details by order ID. All events in the transaction will be registered in this call's response body. 

In scenarios of [order changes](https://developers.vtex.com/vtex-rest-api/reference/registerchange), it is possible to insert a [Partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe). The total value of the order will be updated after the insertion of the invoice, even when there is a [Partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenario. The updated value is settled by VTEX's Payment Gateway. The reimbursement for the shopper is automatic. 

>⚠️ At this time, this route does not support Fulfillment payment queries, only Marketplace orders. 

## 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** |
| --------------- | ----------------- | ----------------- |
| OMS | OMS access | **View order** |

You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):

| **Role** | **Resource** | 
| --------------- | ----------------- | 
| View order | View order |

>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or API keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

## Path parameters

- `orderId` string, required

## Headers

- `Accept` string, required
- `Content-Type` string, required

## Response `200`

OK

- GetPaymenttransaction
  - `status` string, required — Transaction status.
  - `isActive` boolean, required — If it is an active transaction (`true`) or not (`false`).
  - `transactionId` string, required — Transaction ID.
  - `merchantName` string, required — Transaction merchant's name.
  - `payments` Payment1[], required — Payments' details object.
    - `id` string, required — Payment ID.
    - `paymentSystem` string, required — Payment system ID.
    - `paymentSystemName` string, required — Payment system name.
    - `value` integer, required — Payment value.
    - `installments` integer, required — Payment Installments quantity.
    - `referenceValue` integer, required — Payment reference Value.
    - `cardHolder` string, nullable, required — Payment card holder.
    - `cardNumber` string, nullable, required — Payment card number.
    - `firstDigits` string, required — Payment card first digits.
    - `lastDigits` string, required — Payment card last digits.
    - `cvv2` string, nullable, required — Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions.
    - `expireMonth` string, nullable, required — Payment card expire month.
    - `expireYear` string, nullable, required — Payment card expire year.
    - `url` string, nullable, required — Payment URL.
    - `giftCardId` string, nullable, required — Gift Card ID.
    - `giftCardName` string, nullable, required — Gift Card name.
    - `giftCardCaption` string, nullable, required — Gift Card caption.
    - `redemptionCode` string, nullable, required — Code for the customer to use the Gift Card.
    - `group` string, required — It represents the payment method. For each method, it can have the following values: - **Credit card:** `creditCard` - **Debid card:** `debitCard` - **Bank invoice:** `bankInvoice` - **Promissory:** `promissory` - **Gift card:** `giftCard` - **Pix:** `instantPayment`.
    - `tid` string, required — Payment transaction ID.
    - `dueDate` string, nullable, required — Payment due date.
    - `connectorResponses` ConnectorResponses, required
      - `Tid` string, required — Connector transaction ID.
      - `ReturnCode` string, nullable, required — Connector return code.
      - `Message` string, nullable, required — Information about the connector's responses.
      - `authId` string, required — Connector authorization ID.

---

[API](https://skmtc.dev/vtex/apis/orders-api.md) · [All operations](https://skmtc.dev/vtex/apis/orders-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/orders-api/revisions/cb5fa08e400c/schema)