{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Payment API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Payment",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex Retrieve payment transaction",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/oms/pvt/orders/:orderId/payment-transaction",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "orderId",
                "value": "1172452900788-01",
                "type": "path",
                "description": "Order ID is a unique code that identifies an order."
              }
            ]
          },
          "docs": "Retrieves transaction details by order ID. All events in the transaction will be registered in this call's response body. \n\nIn 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/pedidos--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/"
        },
        {
          "info": {
            "name": "VTex Send payment notification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/oms/pvt/orders/:orderId/payments/:paymentId/payment-notification",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "orderId",
                "value": "1172452900788-01",
                "type": "path",
                "description": "Order ID is a unique code that identifies an order."
              },
              {
                "name": "paymentId",
                "value": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
                "type": "path",
                "description": "VTEX payment identifier."
              }
            ]
          },
          "docs": "Send a payment notification of a given order, by order ID.\n\r\n\r> The `Notify payment` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#)."
        },
        {
          "info": {
            "name": "VTex Send payment notification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/orders/pvt/document/:orderId/payment/:paymentId/notify-payment",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "orderId",
                "value": "",
                "type": "path",
                "description": "ID of the order."
              },
              {
                "name": "paymentId",
                "value": "",
                "type": "path",
                "description": "ID of the payment."
              }
            ]
          },
          "docs": "Send a payment notification of a given order, by order ID and payment ID.\n\r\n\r> The `Notify payment` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#).\n\r\n\r> Learn more about [Transaction Details](https://help.vtex.com/en/tutorial/how-to-view-the-or"
        }
      ]
    }
  ],
  "bundled": true
}