{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account API", "version": "1.0" }, "items": [ { "info": { "name": "Account", "type": "folder" }, "items": [ { "info": { "name": "VTex Search all accounts", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "from", "value": "", "type": "query", "description": "Indicates the starting position of the credit customer account to be searched in the account list. Example, value `1` indicates that the first account in the list will be returned." }, { "name": "to", "value": "", "type": "query", "description": "Indicates the final position of the credit customer account to be searched in the account list. Example, if the value of `from` is equal to `1` and `to` is `40`, information from 40 accounts will be displayed in the response body of the request." }, { "name": "status", "value": "", "type": "query", "description": "Indicates the status of the accounts to be searched for." }, { "name": "email", "value": "", "type": "query", "description": "Indicates the email registered to the account to be searched." } ] }, "docs": "Retrieves a list of all [customer credit accounts](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU) in the store.\r\n\r\n>ℹ️ You can use the queries below (individually or combined) to obtain a more accurate search result. If your store has more than 20 customer credit accounts and you do not use any queries in the call, only the first 20 account records will appear in the response body.\r\n\r\n>ℹ️ Query params can be used individually or co" }, { "info": { "name": "VTex Open an account", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Opens a [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU) on your store.\r\n\r\n>⚠️ This request should only be used if you do not have an account yet registered. If you already have an account (open or closed) and want to create or modify an account, go to [Open or Change Account](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-accountId-) endpoint.\r\n\r\n## Permi" }, { "info": { "name": "VTex Retrieve an account by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." } ] }, "docs": "Retrieves a [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU) by the credit account identification.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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 successfu" }, { "info": { "name": "VTex Update account information", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates information on a [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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. Ot" }, { "info": { "name": "VTex Close an account", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Closes a [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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 wil" }, { "info": { "name": "VTex Get account statements", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId/statements", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." } ] }, "docs": "Retrieves the [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU) statements.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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. Ot" }, { "info": { "name": "VTex Change credit limit of an account", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId/creditlimit", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Increases or decreases the credit limit of a [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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 " }, { "info": { "name": "VTex Decrease balance of an account", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId/statements/:statementId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." }, { "name": "statementId", "value": "", "type": "path", "description": "Statement identification. This is the same `transactionId` value obtained from the [Account statements](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/accounts/-creditAccountId-) endpoint response body." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a debit value updating the account balance.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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 Create or update settlement", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId/transactions/:transactionId/settlement", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." }, { "name": "transactionId", "value": "", "type": "path", "description": "Pre-authorization identification." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an invoice or update its value for an order placed in the store that used customer credit as a payment method.\r\n\r\n>ℹ️ If payment for the order is made in installments, you can create an invoice for each installment. The first invoice will be due in 30 days, and subsequent invoices will be due 30 days after the previous invoice.\r\n\r\n.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one " }, { "info": { "name": "VTex Create a pre-authorization", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId/transactions", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Pre-Authorization. Also known as authorization hold, card authorization or pre-auth, pre-authorization is the practice of holding this balance as unavailable until either the merchant clears the transaction, also called settlement, or the hold *falls off*.\r\n\r\nThis operation does not appear in statements, but the available balance will be updated.\r\n\r\nThe result of this operation is generating a `transactionId` (pre-authorization identification) to use in a settlement.\r\n\r\n## Permissions\r" }, { "info": { "name": "VTex Update a pre-authorization", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId/transactions/:transactionId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." }, { "name": "transactionId", "value": "", "type": "path", "description": "Pre-authorization identification." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates information for a specific pre-authorization request.\r\n\r\n>⚠️ This call can only be used for pre-authorizations that have not yet been captured or canceled.\r\n\r\nAlso known as authorization hold, card authorization or pre-auth, pre-authorization is the practice of holding this balance as unavailable until either the merchant clears the transaction, also called settlement, or the hold *falls off*.\r\n\r\nThis operation does not appear in statements but the available balance will be updated.\r\n\r\n#" }, { "info": { "name": "VTex Cancel a pre-authorization", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId/transactions/:transactionId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." }, { "name": "transactionId", "value": "", "type": "path", "description": "Pre-authorization identification." } ] }, "docs": "Cancels a pre-authorization created by the [Create a Pre-Authorization](https://developers.vtex.com/docs/api-reference/customer-credit-api#post-/api/creditcontrol/accounts/-creditAccountId-/transaction) endpoint. \r\n\r\n>⚠️ The pre-authorization can only be deleted by this endpoint if it was created with the `settled` field set to `false` previously.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at lea" }, { "info": { "name": "VTex Add an account holder", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId/holders", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new account holder to the [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU). This new user can share the account's credit limit with users already registered on the account.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tu" }, { "info": { "name": "VTex Delete an account holder", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId/holders/:holderId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." }, { "name": "holderId", "value": "", "type": "path", "description": "Holder identification." } ] }, "docs": "Deletes an account holder from the [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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 r" }, { "info": { "name": "VTex Change tolerance of an account", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId/tolerance", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the credit tolerance amount to increase the credit limit on a [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) t" }, { "info": { "name": "VTex Partially or totally refund a settlement", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/creditcontrol/accounts/:creditAccountId/transactions/:transactionId/refunds", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "creditAccountId", "value": "", "type": "path", "description": "Credit account identification." }, { "name": "transactionId", "value": "", "type": "path", "description": "Pre-authorization identification." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Refunds a value from an already settled transaction.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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 Get information about account", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/vlm/account" }, "docs": "Retrieves information from an account, such as company and sponsor user details, stores, and appTokens.\n\r\n\rThis endpoint only accepts requests from the host list designated for that store. If you want to try this request from this portal, be sure to add it to the list. Learn how to add hosts to the list in [How to manage accounts](https://help.vtex.com/en/tutorial/how-to-manage-accounts--tutorials_6285#). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides" } ] } ], "bundled": true }