{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Transaction API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Transaction",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex Create GiftCard in GiftCard Provider",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/giftcardproviders/:giftCardProviderId/giftcards",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardProviderId",
                "value": "",
                "type": "path",
                "description": "Gift card provider identification."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a gift card in a gift card provider.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r\n| **Produc"
        },
        {
          "info": {
            "name": "VTex Get GiftCard from GiftCard Provider",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/giftcardproviders/:giftCardProviderId/giftcards/_search",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "REST-Range",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardProviderId",
                "value": "",
                "type": "path",
                "description": "Gift card provider identification."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Returns all gift cards from a gift card provider according to the filters.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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 fo"
        },
        {
          "info": {
            "name": "VTex Get GiftCard from GiftCard Provider by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardProviderId",
                "value": "",
                "type": "path",
                "description": "Gift card provider identification."
              },
              {
                "name": "giftCardId",
                "value": "",
                "type": "path",
                "description": "Gift card identification."
              }
            ]
          },
          "docs": "Returns a specific gift card from a gift card provider.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r"
        },
        {
          "info": {
            "name": "VTex List All GiftCard Transactions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardProviderId",
                "value": "",
                "type": "path",
                "description": "Gift card provider identification."
              },
              {
                "name": "giftCardId",
                "value": "",
                "type": "path",
                "description": "Gift card identification."
              }
            ]
          },
          "docs": "Returns the IDs of all transactions performed on a gift card.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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 endpoi"
        },
        {
          "info": {
            "name": "VTex Create GiftCard Transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardProviderId",
                "value": "",
                "type": "path",
                "description": "Gift card provider identification."
              },
              {
                "name": "giftCardId",
                "value": "",
                "type": "path",
                "description": "Gift card identification."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a transaction (credit or debit) to a gift card.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r"
        },
        {
          "info": {
            "name": "VTex Get GiftCard Transaction by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions/:transactionId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardProviderId",
                "value": "",
                "type": "path",
                "description": "Gift card provider identification."
              },
              {
                "name": "giftCardId",
                "value": "",
                "type": "path",
                "description": "Gift card identification."
              },
              {
                "name": "transactionId",
                "value": "",
                "type": "path",
                "description": "Transaction identification."
              }
            ]
          },
          "docs": "Returns a specific transaction from a gift card.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r\n| **Pr"
        },
        {
          "info": {
            "name": "VTex Get GiftCard Transaction Authorization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions/:tId/authorization",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardProviderId",
                "value": "",
                "type": "path",
                "description": "Gift card provider identification."
              },
              {
                "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 information about a gift card transaction authorization. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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 en"
        },
        {
          "info": {
            "name": "VTex List All GiftCard Transactions Settlements",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions/:tId/settlements",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardProviderId",
                "value": "",
                "type": "path",
                "description": "Gift card provider identification."
              },
              {
                "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.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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 endpo"
        },
        {
          "info": {
            "name": "VTex Settle GiftCard Transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions/:tId/settlements",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardProviderId",
                "value": "",
                "type": "path",
                "description": "Gift card provider identification."
              },
              {
                "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.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:"
        },
        {
          "info": {
            "name": "VTex List All GiftCard Transactions Cancellations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions/:tId/cancellations",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardProviderId",
                "value": "",
                "type": "path",
                "description": "Gift card provider identification."
              },
              {
                "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 cancelled for a specific gift card.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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 endpoin"
        },
        {
          "info": {
            "name": "VTex Cancel GiftCard Transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions/:tId/cancellations",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "giftCardProviderId",
                "value": "",
                "type": "path",
                "description": "Gift card provider identification."
              },
              {
                "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 cancellation transaction to a gift card.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r\n| **"
        },
        {
          "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 on a gift card.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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 endpoi"
        },
        {
          "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) to a gift card and authorize the item reservation.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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 applica"
        },
        {
          "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.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r\n| **Pro"
        },
        {
          "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.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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 end"
        },
        {
          "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.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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 endpoin"
        },
        {
          "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.\r\n\r\n2. Cancel an item's reservation or create a refund.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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 "
        },
        {
          "info": {
            "name": "VTex List all gift card transactions settlements",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/giftcards/:giftCardId/transactions/:transactionId/settlements",
            "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 settlements for a specific gift card.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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 endpo"
        },
        {
          "info": {
            "name": "VTex Settle a gift card transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/giftcards/:giftCardId/transactions/:transactionId/settlements",
            "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": "Creates a transaction settlement for a specific gift card.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:"
        }
      ]
    }
  ],
  "bundled": true
}