Retrieve 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, it is possible to insert a Partial invoice. The total value of the order will be updated after the insertion of the invoice, even when there is a Partial invoice 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 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:

You can create a custom role with that resource or use one of the following predefined roles:

❗ Assigning a predefined role to users or API keys usually grants permission to multiple License Manager resources. 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. To learn more about machine authentication at VTEX, see Authentication overview.

{
  "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": "200",
        "Message": "logMessage",
        "authId": "170852"
      }
    }
  ]
}