{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Transactions API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Transactions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex List all gift card transactions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/giftcards/:giftCardId/transactions",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardId",
                "value": "",
                "type": "path",
                "description": "Gift card identification."
              }
            ]
          },
          "docs": "Returns the IDs of all transactions performed in a gift card provider for a specific gift card.\r\n\r\n> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed."
        },
        {
          "info": {
            "name": "VTex Create a gift card transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/giftcards/:giftCardId/transactions",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardId",
                "value": "",
                "type": "path",
                "description": "Gift card identification."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a transaction (credit or debit) for a gift card in a gift card provider and authorizes the item reservation.\r\n\r\n> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed."
        },
        {
          "info": {
            "name": "VTex Get a gift card transaction by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/giftcards/:giftCardId/transactions/:transactionId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardId",
                "value": "",
                "type": "path",
                "description": "Gift card identification."
              },
              {
                "name": "transactionId",
                "value": "",
                "type": "path",
                "description": "Transaction identification."
              }
            ]
          },
          "docs": "Returns a specific transaction for a gift card from a gift card provider.\r\n\r\n> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed."
        },
        {
          "info": {
            "name": "VTex Get a gift card transaction authorization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/giftcards/:giftCardId/transactions/:transactionId/authorization",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardId",
                "value": "",
                "type": "path",
                "description": "Gift card identification."
              },
              {
                "name": "transactionId",
                "value": "",
                "type": "path",
                "description": "Transaction identification."
              }
            ]
          },
          "docs": "Returns information about a gift card transaction authorization from a gift card provider.\r\n\r\n> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed."
        },
        {
          "info": {
            "name": "VTex List all gift card transactions cancellations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/giftcards/:giftCardId/transactions/:transactionId/cancellations",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardId",
                "value": "",
                "type": "path",
                "description": "Gift card identification."
              },
              {
                "name": "transactionId",
                "value": "",
                "type": "path",
                "description": "Transaction identification."
              }
            ]
          },
          "docs": "Returns all transactions cancelled for a specific gift card from a gift card provider.\r\n\r\n> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed."
        },
        {
          "info": {
            "name": "VTex Cancel a gift card transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/giftcards/:giftCardId/transactions/:transactionId/cancellations",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardId",
                "value": "",
                "type": "path",
                "description": "Gift card identification."
              },
              {
                "name": "transactionId",
                "value": "",
                "type": "path",
                "description": "Transaction identification."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This request can be used to:\r\n\r\n1. Cancel a transaction for a specific gift card in a gift card provider.\r\n\r\n2. Cancel an item's reservation or create a refund.\r\n\r\n> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed."
        },
        {
          "info": {
            "name": "VTex List all gift card transactions settlements",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/giftcards/:giftCardId/transactions/:tId/settlements",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardId",
                "value": "",
                "type": "path",
                "description": "Gift card identification."
              },
              {
                "name": "tId",
                "value": "",
                "type": "path",
                "description": "Transaction ID generated by the provider. It is different from the `transactionId` generated by VTEX."
              }
            ]
          },
          "docs": "Returns all transactions settlements for a specific gift card from a gift card provider.\r\n\r\n> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed."
        },
        {
          "info": {
            "name": "VTex Settle a gift card transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/giftcards/:giftCardId/transactions/:tId/settlements",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardId",
                "value": "",
                "type": "path",
                "description": "Gift card identification."
              },
              {
                "name": "tId",
                "value": "",
                "type": "path",
                "description": "Transaction ID generated by the provider. It is different from the `transactionId` generated by VTEX."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a transaction settlement for a specific gift card from a gift card provider.\r\n\r\n> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed."
        }
      ]
    }
  ],
  "bundled": true
}