{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7eb6cb17-d551-4ed0-9224-d17b4990f8f7","name":"Vanir API","description":"## Introduction\n\nWelcome to the Waza payouts API documentation. This API provides a suite of services designed for businesses who want to make local currency payouts to our supported countries. This API follows the RESTful HTTP design pattern, ensuring ease of use, scalability, and compatibility.\n\n## Authentication\n\nTo ensure that the requests made to our endpoints are both secure and authenticated, we use API key-based authentication. Every request made to this API requires an API key to be included in the request header (x-waza-key). Please contact us to have a sandbox account and API keys created for you.\n\n## Environments\n\n|  | **Base URL** |\n| --- | --- |\n| **Sandbox** | [https://api.sandbox.waza.co/payouts/v1](https://api.sandbox.waza.co/payouts/v1) |\n| Production | [https://api.waza.co/payouts/v1](https://api.waza.co/payouts/v1) |\n\n## API Endpoints\n\nFor detailed information on our API endpoints, request/response formats, status codes, and examples, please navigate to the respective sections in this documentation. All successful `2XX` responses are wrapped in a `data` object.\n\n## Errors\n\nErrors are an inevitable part of any system. At Waza, we believe in providing clear, actionable error feedback to help our customers diagnose and easily resolve issues. Our API follows standard HTTP error codes and provides a consistent error body format.\n\nWhen an error occurs, the API will return an error response in the following format:\n\n``` json\n{\n    \"error\": {\n        \"message\": \"Human-readable message detailing the error.\",\n        \"code\": \"Unique error code for reference and programmatic handling.\",\n        \"description\": \"Short description categorising the nature of the error.\",\n    }\n}\n\n ```\n\n- **message**: A user-friendly message explaining the error. This can be displayed directly to the end-users or used for debugging purposes.\n    \n- **code**: A unique error code that can be used for reference. If you're contacting support regarding an issue, providing this code can expedite the troubleshooting process. This is also useful for programmatically handling errors in your application.\n    \n- **description**: A brief description categorising the nature of the error.\n    \n- **field_errors (optional):** A list of failed validation when making resource changing requests, specifies the field and error message. Example below\n    \n\n``` json\n{\n    \"error\": {\n        \"message\": \"Invalid request in body\",\n        \"code\": \"400\",\n        \"description\": \"INVALID_REQUEST\",\n        \"field_errors\": [\n            {\n                \"field\": \"url\",\n                \"message\": \"URL must not be localhost or 127.0.0.1.\"\n            },\n            {\n                \"field\": \"enabled_events.0\",\n                \"message\": \"\\\"enabled_events[0]\\\" must be one of [transaction.created, transaction.processing, transaction.completed, transaction.failed]\"\n            },\n            {\n                \"field\": \"enabled_events.0\",\n                \"message\": \"\\\"enabled_events[0]\\\" is not allowed to be empty\"\n            }\n        ]\n    }\n}\n\n ```\n\n| HTTP Status | Error Code | Meaning |\n| --- | --- | --- |\n| 400 | `BAD_REQUEST` | The request was malformed or invalid. |\n| 401 | `UNAUTHORIZED` | The API key provided is invalid or has expired. |\n| 403 | `FORBIDDEN` | The authenticated user does not have access to the requested resource. |\n| 404 | `NOT_FOUND` | The requested resource could not be found. |\n| 409 | `CONFLICT` | The request could not be processed because of conflict in the request such as the requested resource is not in the expected state, or the result of processing the request would create a conflict within the resource.. |\n| 500 | `999` | An unknown error has occurred, this rarely happens. Please contact support if this persists.. |\n\n## Paginated Response Format\n\nResponses from paginated endpoints are structured as follows:\n\n``` json\n{\n    \"data\": {\n        \"items\": [],              // The actual data items for the current page\n        \"total_items\": 0,         // The total number of items across all pages\n        \"page\": 1,               // The current page number\n        \"limit\": 10,             // The number of items per page (page size)\n        \"total_pages\": 1          // The total number of pages available\n    }\n}\n\n ```\n\n#### Fields:\n\n- **items**: An array containing the actual data items for the current page.\n    \n- **total_items**: The total number of items across all pages.\n    \n- **page**: The current page number.\n    \n- **limit**: The number of items per page, also referred to as the page size.\n    \n- **total_pages**: The total number of pages available given the current page size.\n    \n\n#### Requesting Specific Pages and Page Sizes\n\nTo request a specific page or change the page size (limit), use the `page` and `limit` query parameters, respectively.\n\n- **page** (optional): Specifies which page number you want to retrieve. If not provided, defaults to the first page.\n    \n- **limit** (optional): Defines how many items you want to retrieve per page. If not provided, a default size (e.g., 10 items) is used.\n    \n\n#### Best Practices for Pagination\n\n1. **Navigating through Pages**: Begin with `page=1` and incrementally adjust the page number until the returned `total_pages` value is met.\n    \n2. **Tailoring Page Size**: If dealing with numerous minor entries or if bandwidth isn't a concern, consider amplifying the `limit`. In contrast, reduce the `limit` if data items are extensive or bandwidth is constrained.\n    \n3. **Managing Extensive Datasets**: Constantly monitor `total_items` and `total_pages`. With significantly large datasets in view, employ strategies like filtering or sorting to minimize the items you need to process.\n    \n\n## Support\n\nIf you have any queries or issues, our support team is always here to help. Reach out to us at `support@waza.co`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"24168656","team":4186730,"collectionId":"7eb6cb17-d551-4ed0-9224-d17b4990f8f7","publishedId":"2s9Xy3trSK","public":true,"publicUrl":"https://documenter-api.postman.tech/view/24168656/2s9Xy3trSK","privateUrl":"https://go.postman.co/documentation/24168656-7eb6cb17-d551-4ed0-9224-d17b4990f8f7","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-08-11T23:01:49.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"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/f859101208dccb6e56df8b14f50c3c5c8e3961acc3ed55d11e7da6b8d138086b","favicon":""},"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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s9Xy3trSK"}