{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8705524a-23d2-4e9c-8014-b3945559d712","name":"API Documentation","description":"# API Reference\n\nWelcome to the Breeze Airtime API documentation. This section provides detailed information about all available API endpoints, their request/response formats, and usage examples.\n\n## Base URL\n\nAll API requests should be made to:\n\n```\nhttps://intelligent-stage-54dba42e73b2.herokuapp.com/v1/login\n\n ```\n\n## Authentication\n\nAll API requests require authentication using an API key. Include your API key in the request headers:\n\n```\nAuthorization: Bearer YOUR_API_KEY\n\n ```\n\n## Available Endpoints\n\nThe API provides the following main endpoints:\n\n- **Transactions**: Manage airtime transactions\n    \n    - Buy Airtime ( sync & async)\n        \n    - Get Transaction Status\n        \n    - Get Transaction Reports\n        \n    - Trigger Email Reports\n        \n\n## Response Format\n\nAll API responses are returned in JSON format and include the following structure:\n\n``` json\n{\n  \"status\": \"success\",\n  \"data\": {\n    // Response data\n  },\n  \"message\": \"Operation successful\"\n}\n\n ```\n\n## Error Handling\n\nThe API uses standard HTTP status codes to indicate the success or failure of requests. Error responses include detailed information about what went wrong.\n\nHTTP 200 OK is our Standard Response . In Addition to that , also check the airtime response code .\n\n**Success = \"00\"****Failed = \"01\"****Pending = \"02\"**\n\n| **Error code** | **Common causes** |\n| --- | --- |\n| 400 - Bad Request | Invalid Parameter e.g network, amount |\n| 422- Unprocessable Entity | Duplicate requestID |\n| 401 - Unauthorized | invalid or Expired Tokens |\n| 404 - Not Found | Transaction not found. |\n| 403 - Forbidden | IP not Whitelisted or User Credentials not enable for the API Operation |\n| 500 - Internal Server Error | Proccessing error, these transactions need to be requeried. |\n| 502 - Service unavailable | service temporarily unavailable, please try again |\n\n## IP Whitelisting for Production\n\nVending Request are accepted in Production only from permitted IPs. So you will need to give us all your Production IPs where your request will be coming from prior to go-live.\n\n## Reporting & Reconciliation\n\nAutomated reports are sent at end of day covering transactions from 00.00.00. to 11.59.59 of the previous day.\n\nIf the transaction count is greater , they will be downloaded from our Client Portal. Reports are available T+1.  \nPlease email [support@breezegpt.io](https://mailto:support@breezegpt.io) to request dashboard access.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"3445094","team":3274703,"collectionId":"8705524a-23d2-4e9c-8014-b3945559d712","publishedId":"2sB2x3nYYB","public":true,"publicUrl":"https://airtimedocs.breezegpt.io","privateUrl":"https://go.postman.co/documentation/3445094-8705524a-23d2-4e9c-8014-b3945559d712","customColor":{"top-bar":"1E1B2E","right-sidebar":"1D1F33","highlight":"7C4DFF"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/61bcb73f-0992-46ec-9285-4c271d426862/bG9nby5jNmE0YjdhYWMxODRkYTE0MGRkYjU0NTBmNzdhZDc0YS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/61bcb73f-0992-46ec-9285-4c271d426862/bG9nby5jNmE0YjdhYWMxODRkYTE0MGRkYjU0NTBmNzdhZDc0YS5wbmc=","colors":{"top-bar":"1E1B2E","right-sidebar":"1D1F33","highlight":"7C4DFF"}}]}},"version":"8.10.0","publishDate":"2025-06-08T22:33:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/61bcb73f-0992-46ec-9285-4c271d426862/bG9nby5jNmE0YjdhYWMxODRkYTE0MGRkYjU0NTBmNzdhZDc0YS5wbmc=","logoDark":"https://content.pstmn.io/61bcb73f-0992-46ec-9285-4c271d426862/bG9nby5jNmE0YjdhYWMxODRkYTE0MGRkYjU0NTBmNzdhZDc0YS5wbmc="}},"statusCode":200},"environments":[{"name":"Staging","id":"4f8efbb5-0ec6-406b-b05f-bccf288227ed","owner":"3445094","values":[{"key":"token","value":"","enabled":true,"type":"default"},{"key":"baseUrl","value":"localhost:3007/api/v1","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/320d9cff81607e1e8aab43bfd7cc47f43294c80bc10a409299d2feb098bf5ebc","favicon":"https://breezegpt.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":"Staging","value":"3445094-4f8efbb5-0ec6-406b-b05f-bccf288227ed"}],"canonicalUrl":"https://airtimedocs.breezegpt.io/view/metadata/2sB2x3nYYB"}