{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2e6d69f7-5b4d-4355-8513-b50c478bc3df","name":"Business API","description":"Welcome to the Vita Wallet Business API documentation! This comprehensive guide provides all the necessary information for developers to integrate Vita Wallet's powerful API into their applications seamlessly.\n\n## Overview\n\nThe Vita Wallet Business API offers a range of features and functionalities tailored to meet the diverse needs of businesses in the digital payments ecosystem. Our API empowers businesses to streamline their operations and deliver exceptional user experiences.\n\nConnect your business payments with LatAm and the world through our API to enjoy:\n\n- **Real-time payments:** Receive and send 100% automated payments 24/7, including weekends and holidays.\n    \n- **Screening and Alerts:** Every transaction is analyzed against restrictive lists to help minimize risks in your international payments, in compliance with AML regulations.\n    \n- **White Label Technology:** Customize the experience under your own brand.\n    \n\n## **About Our Solutions**\n\nWith a simple integration and dedicated technical support, you can centralize your financial operations and reduce costs for:\n\n- **Payins:** Securely receive payments from your customers in local currencies in LatAm and centralize your operation in USD. (Check for our available countries.)\n    \n- **Payouts:** Send payments to 50+ countries with the best FX rates and accreditation times of up to 1 business day.\n    \n\n## Getting Started\n\n- Register and verify a Test account on our platform.\n    \n- Generate API Credentials in the platform.\n    \n- Perform test payments.\n    \n\n## Creating a Test Account\n\n1. **Initial Access**\n    \n    - Go to the Vita Wallet Test or Sandbox environment at: [https://stage.vitawallet.io/](https://stage.vitawallet.io/)\n        \n    - Register a BUSINESS account with your email address and a secure password that includes uppercase letters, lowercase letters, numbers, and a symbol.\n        \n2. **Email Verification**\n    \n    - You will receive an email with a 6-digit confirmation PIN.\n        \n    - Enter the PIN on the registration page to validate your email address.\n        \n3. **Account Verification**\n    \n    - Once your email is confirmed, complete the verification form with the required information. Note that this information does not need to be real.\n        \n    - Select the \"Verify\" option and contact your assigned support representative to request the verification of your Vita Test account and enable API configurations.\n        \n\n<img src=\"https://content.pstmn.io/b017bb26-6a0a-4552-873f-887f8033acc2/dmVyaWZpY2FjacOzbiBlbXByZXNhLnBuZw==\">\n\n## Generating API Credentials\n\nOnce your Vita Test account is enabled, you can manage the credentials needed to integrate your application with our API from the **Integrations** section in the main menu of our platform.\n\n### **API Credential Details**\n\n| **Credential Type** | **Description** |\n| --- | --- |\n| **API Key** | Required to authenticate requests to our API. |\n| **Secret Key** | Used to generate authorization for requests. |\n| **IP Addresses** | List of valid IPs to establish secure connections from your application. |\n\n### **Types of Credentials**\n\n1. **Sandbox Credentials:**\n    \n    - Allow you to simulate transactions without affecting real accounts.\n        \n    - Use them to perform integration tests in a secure environment.\n        \n2. **Production Credentials:**\n    \n    - Required to process real payments in the production environment.\n        \n\n### **How to Obtain Your Credentials**\n\nThe process for obtaining credentials in both the test and production environments is the same:\n\n1. Access the **Integrations** section from your Vita Wallet account.\n    \n2. Click the button to send your credentials to the registered email address.\n    \n3. From the received email, access and manage your credentials as needed.\n    \n\n> **Note:** Successfully verifying and completing all connection tests in the Sandbox environment is an essential step before generating credentials for the production environment. \n  \n\n<img src=\"https://content.pstmn.io/96aa2dab-1c67-492e-93ae-a4d8c6277946/U29saWNpdGFyIGFjdGl2YWNpw7NuLnBuZw==\">\n\n<img src=\"https://content.pstmn.io/f45bb894-3410-45fc-952d-16c21a4f6a42/Y3JlZGVuY2lhbGVzIG9jdWx0YXMuanBn\">\n\n## Perform Test Payments\n\nIn this step, you'll ensure that your business case works correctly by conducting simulated transactions. These tests utilize the various endpoints specifically designed for your integration type, guaranteeing that flows and processes respond optimally.\n\n### **Testing Basic Endpoints**\n\nConnect the required functions in your system using the endpoints defined in the documentation:\n\n- Create and query payment types: Whether Payment Orders (Payins) or Withdrawals (Payouts).\n    \n- Validate webhooks: Set up an endpoint to receive notifications about transaction status changes.\n    \n- Handle common errors.\n    \n\n### **Test Certification Meeting**\n\nTo certify and finalize your integration process, you will need to request a meeting with our Technical Team to conduct real-time tests and ensure proper functionality.\n\nThis meeting is essential to guarantee an efficient flow in the production environment. Before requesting it, you must complete at least 10 tests for each endpoint you plan to use in the test environment.\n\n## Authentication\n\nTo manage authentication process Vita Wallet uses some keys and secrets. Please set your values in the Environment section for this collection. Also you can check the pre-request script to learn about how the signature and headers are setted.\n\n## Security\n\nMAC (Message Authentication Code), an algorithm that confirms that a given message comes from its sender and that the data in the message has not been altered.\n\nEvery request to Vita Business API must be signed using HMAC-SHA256 algorithm, and the signature's content included in the `Authorization` header as documented below. This header must have as a prefix the signature version and hash function used, which is currently V2-HMAC-SHA256.\n\n| Header | Type | Description |\n| --- | --- | --- |\n| x-date | String | ISO8601 Datetime with Timezone. For instance `2018-07-12T13:46:28.629Z` |\n| x-login | String | Business xLogin |\n| x-api-key | String | Business xTransKey |\n| Content-Type | String | application/json |\n| Authorization | String | `, Signature:` |\n\n### Authorization header example\n\n`Authorization: V2-HMAC-SHA256, Signature: 80ebe700c5db952bd4c60ae53fe1971ec6e4fe84dc0922b67eca6b3e18707260`\n\n### HAMC signatures generation examples in the most popular programming languages\n\n| Language | Code |\n| --- | --- |\n| Python | `signature = hmac.new(secretKey, x_login+x_date+sorted_request_body, hashlib.sha256).hexdigest()` |\n| Ruby | `signature = OpenSSL::HMAC.hexdigest('sha256', secret_key, \"#{x_login}#{x_date}#{sorted_request_body}\")` |\n| PHP | `$signature = hash_hmac(\"sha256\", \"$xLogin$xDate$sortedRequestBody\", $secretKey);` |\n\n> ℹ️ In the integrations section of the merchant's Vita Wallet account, you can find a button to request access credentials for Vita Business. We will send an email with the instructions. \n  \n> ℹ️ The request hash was joined into a single string of all key-value pairs, alphabetically sorted and concatenated without separators. If the request body is null, then the signature must be calculated without the request body.  \n`hash = { \"order\": \"xyz\", \"amount\": 400, \"statuses\": [ \"deposit\", \"payment\" ] }`  \n`sorted_request_body = hash.sort.join`  \n`# amount400orderxyzstatusesdeposit,payment # When the data contains an array object, then the string should to have the \",\" character` \n  \n\n## Integration Environments\n\nVita offers 2 environments to manage the integration:\n\n### **Stage or Sandbox**\n\nThis environment allows developers to initiate integration and test API connections. You can test each endpoint to ensure effective communication. Once integration is complete, certification tests are conducted to verify that implemented flows function correctly.\n\nBase URL: [https://api.stage.vitawallet.io/api/businesses](https://api.stage.vitawallet.io/api/businesses)\n\n### **Production**\n\nAfter certifying the connection in Stage, you proceed to connect in Production, completing the integration process and enabling the environment for real operations.\n\nBase URL: [https://api.vitawallet.io/api/businesses](https://api.vitawallet.io/api/businesses)\n\n## Error codes\n\nFeel safe to receive standard errors from our API, if you see something wrong please let us know and we will work to fix it right away.\n\n| Description | Range |\n| --- | --- |\n| Syntax and parameter existence validation | 3xx |\n| Resource existence | 4xx |\n| Business logic and server errors validations | 5xx |\n\n> ℹ️ Keep in mind that Vita Business will return the HTTP status code 422 \\[UNPROCESSABLE ENTITY\\] whenever it cannot process the request, however the api returns an error code with the corresponding message of what happened in the response body. \n  \n\n``` json\n{\n    code: 500,\n    message: \"An error has occurred, please try again later\"\n}\n\n ```\n\n### Syntax and parameter existence validation\n\n| Description | Code |\n| --- | --- |\n| Invalid \\[header\\] header, \\[description\\] | 300 |\n| \\[header\\] header was not found | 301 |\n| Signature version was not found | 302 |\n| Invalid signature | 303 |\n| Parameter \\[parameter\\] not found | 304 |\n| Invalid \\[parameter\\], \\[description\\] | 305 |\n\n### Resource existence\n\n| Description | Code |\n| --- | --- |\n| \\[resource\\] was not found | 404 |\n\n### Business logic and server errors validations\n\n| Description | Code |\n| --- | --- |\n| An error has occurred, please try again later | 500 |\n| Invalid IP address | 501 |\n| Business \\[parameter\\] is not supported | 502 |\n| \\[parameter\\] is used | 503 |\n| Invalid amount, minimum amount of X CLP | 507 |\n| Insufficient balance business | 509 |\n| Insufficient balance wallet | 510 |\n| Invalid bank_code, bank does not belong to the selected country | 578 |\n| Invalid account_bank, incorrect account size | 579 |\n\n## Reference\n\nFor more information please visit our [site](https://vitawallet.gitbook.io/vita-business-documentation/).\n\n## Do You Have Questions or Need Help?\n\nOur dedicated support team is here to assist you. Contact us through our support channels, and we'll be happy to guide you through your integration.\n\n- Email: [empresas@vitawallet.io](https://mailto:empresas@vitawallet.io)\n    \n- WhatsApp: [+56949705364](https://api.whatsapp.com/send?phone=56949705364)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"34535760","team":6047878,"collectionId":"2e6d69f7-5b4d-4355-8513-b50c478bc3df","publishedId":"2sBXVmeTv6","public":true,"publicUrl":"https://docs.vitawallet.io","privateUrl":"https://go.postman.co/documentation/34535760-2e6d69f7-5b4d-4355-8513-b50c478bc3df","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/d2ebfb1c-af72-4e9d-9483-04c74f8631ab/dml0YV9sb2dvLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/d2ebfb1c-af72-4e9d-9483-04c74f8631ab/dml0YV9sb2dvLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2026-01-26T13:42:05.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/d2ebfb1c-af72-4e9d-9483-04c74f8631ab/dml0YV9sb2dvLnBuZw==","logoDark":"https://content.pstmn.io/d2ebfb1c-af72-4e9d-9483-04c74f8631ab/dml0YV9sb2dvLnBuZw=="}},"statusCode":200},"environments":[{"name":"Business API","id":"0902ac0d-81ba-496d-adae-758107af6e14","owner":"31434588","values":[{"key":"x_login","value":"","enabled":true,"type":"secret"},{"key":"x_trans_key","value":"","enabled":true,"type":"secret"},{"key":"secret","value":"","enabled":true,"type":"secret"},{"key":"base_url","value":"","enabled":true,"type":"default"},{"key":"uid","value":"","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/1646e1f1ad79ea74bce519df73b301b24f7debd6b5d4e4555ede3fec97ae2cc9","favicon":"https://vitawallet.io/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Business API","value":"31434588-0902ac0d-81ba-496d-adae-758107af6e14"}],"canonicalUrl":"https://docs.vitawallet.io/view/metadata/2sBXVmeTv6"}