{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d8abe679-9edd-46f7-8232-31d79c257cf1","name":"Corporate Public API","description":"# **Retailcode API Documentation**\n\n## **Getting Started**\n\nTo integrate with Retailcode’s APIs, you must be a registered user.\n\n### **Registration & API Key Access**\n\n1. **Sign Up**: [Register here](https://corporate.retailcode.africa/sign-up) if you are not yet a user.\n    \n2. **Obtain API Keys** (if required by the service):\n    \n    - Log in to your Retailcode account.\n        \n    - Navigate to the **Verification** menu.\n        \n    - Select **API Keys and Webhooks**.\n        \n    - Click **Request to Go-Live** and follow the verification steps.\n        \n\n### **Going Live**\n\n- Before going live, you must complete User Acceptance Testing (UAT).\n    \n- Contact [products@retailcode.africa](https://products@retailcode.africa) for assistance.\n    \n\n---\n\n## **Testing Environment**\n\nUse the test numbers below to simulate API responses:\n\n| phone number | message | `Status` | HTTP status |\n| --- | --- | --- | --- |\n| 2348135686298 | Pending | 400 | 200 |\n| 2348135696298 | Pending | 400 | 200 |\n| 2348165940838 | Failed | 300 | 400 |\n| 2348166940838 | Failed | 300 | 400 |\n| 2348166940839 | Failed | No status | 500 |\n| 2348166940830 | Failed | No status | 502 |\n| Any other number | Success | 200 | 200 |\n\n---\n\n## **Status Codes & HTTP Responses**\n\n| message | `status` | HTTP status | **explanation / action** |\n| --- | --- | --- | --- |\n| Success | 200 | 200 | Value received |\n| Pending | 400 | 200 | Requery to get final state |\n| Failed | 300 | 400 | Value not received |\n| Bad Gateway | 502 | 502 | Requery to get final state |\n| Server Error | 500 | 500 | Requery to get final state |\n\n| **error_code** | **error_message** | **meaning** |\n| --- | --- | --- |\n| 301 | Invalid MSISDN | Recipient tried to purchase product from wrong network |\n| 302 | Chargeable VTU not found | No available VTU to fulfill request |\n| 303 | Insufficient Wallet Balance | Clients wallet balance is low |\n| 304 | \\[amount\\] is a high value transaction and can not be processed | Amount is higher than clients vending threshold |\n| 305 | VALIDATION FAILED | Request payload has invalid data e.g The customer msisdn is not valid when the customerMsisdn is not a valid Nigerian phone number |\n| 306 | The service is currently down, please try again later | The service being accessed is temporarily unavailable |\n| 307 | INVALID PRODUCT | The data bundle price has changed in the providers end. this requires a refetch |\n| 308 | INVALID PRICE | The amount in the data bundle payload is not the same as the price of the data bundle |\n| 310 | Topup or bundle activation failed | The amount in the data bundle payload is not the same as the price of the data bundle |\n\n#### **Requery Status**\n\n| **status** | **message** | **http status** |\n| --- | --- | --- |\n| 400 | PENDING | 200 |\n| 200 | SUCCESSFUL | 200 |\n| 300 | FAILED | 200 |\n| 300 | NOT FOUND | 200 |\n\n## **Requery Handling**\n\n**In the event of a PENDING transaction status, Retailcode supports two mechanisms to communicate the final status to the Client:**\n\n- **Webhook Notification:**\n    \n\nRetailcode can automatically send the final transaction status to a webhook URL configured by the Client on the Retailcode Dashboard.\n\n- **Manual Requery:**\n    \n\n**Alternatively, the client can manually invoke Retailcode’s Requery API to retrieve the final status of a pending transaction.**\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"15102361","team":1568086,"collectionId":"d8abe679-9edd-46f7-8232-31d79c257cf1","publishedId":"2sA3kSn3R1","public":true,"publicUrl":"https://documenter-api.postman.tech/view/15102361/2sA3kSn3R1","privateUrl":"https://go.postman.co/documentation/15102361-d8abe679-9edd-46f7-8232-31d79c257cf1","customColor":{"top-bar":"FFFFFF","right-sidebar":"FFFFFF","highlight":"173C21"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"RETAILCODE CORPORATE API is designed to facilitate seamless data and airtime vending services for businesses."},{"name":"title","value":"RETAILCODE CORPORATE API"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/44cf18b5-d125-4f9c-a9d8-19c6ed5c7db4/bmV3LWxvZ28tOGE1MDJkNmMgKDEpLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"212121","highlight":"173C21"}},{"name":"light","logo":"https://content.pstmn.io/7206379f-1380-41a9-91af-ee57a79215d0/c3Zndmlld2VyLXBuZy1vdXRwdXQucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"FFFFFF","highlight":"173C21"}}]}},"version":"8.10.1","publishDate":"2025-02-12T12:15:52.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"RETAILCODE CORPORATE API","description":"RETAILCODE CORPORATE API is designed to facilitate seamless data and airtime vending services for businesses."},"logos":{"logoLight":"https://content.pstmn.io/7206379f-1380-41a9-91af-ee57a79215d0/c3Zndmlld2VyLXBuZy1vdXRwdXQucG5n","logoDark":"https://content.pstmn.io/44cf18b5-d125-4f9c-a9d8-19c6ed5c7db4/bmV3LWxvZ28tOGE1MDJkNmMgKDEpLnBuZw=="}},"statusCode":200},"environments":[{"name":"Corporate Prod","id":"ad57f711-dab6-4a07-8ff6-3d6d2735523b","owner":"15102361","values":[{"key":"BASE_URL","value":"https://corporateprodapi.retailcode.com.ng","enabled":true},{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiMTA1NTE1YWI3MGE5MmMxYmQ1ZmVjOTUwOGQzYWIyMWU0MTcxNTk3NDk5NWI3MDc3ZTIzZjA3OTUzNzgzZmQ2MDg5MzhlZTgyZWRiYTM0OTEiLCJpYXQiOjE2NDY3NjQyODEuNDI5OTQ1LCJuYmYiOjE2NDY3NjQyODEuNDI5OTQ5LCJleHAiOjE5NTc4MDQyODEuMzI4Njk3LCJzdWIiOiIyODYiLCJzY29wZXMiOltdfQ.eREqerV-6mon4TAA2FCnykYiQTxJwfyKcMS4gmcPeJMYXPex49pHsz5rFgxNC_bOovq80X9O6tC9_hQwgpU6Y0hJW9eigguq38UjwL9_fAEgWXT5EFkZIRcfH0HmvD9QqKBSLB0tjvDZCEOXwIbi55dNgZVcyQgGVIphFAJGPAFMD43y0CgqkVftp50CeIAoIwnEf1vQMXzzVSGkWzI74cnlDA5R58DAZGCn_6IF3qMjJjCTvJYkvqGL1AjjRZvSnQ6f3IMDRyogI4QKULKx7sQDs2sEn98MzHb0ezK2pu62fiHOYjB9jOfNElqJQ4VamAysI_zrNlRflZNZr8DKRTBm9MFforge6HN1DI1Q7jbqvKxoPNvE4YLU2aBJAfmT0KlFUtLm4zO7JraOhLOWw-3_JZq9S0MO29jii7IhPcQDp64DM_i_bGwhcdbr0BlIm2QjHRaNxjdKEFZ4nAFeHB6K1VRu23FnBCbSfWkY6vJqbIIh3Pb4c7gfcyYqyoro0L_7o_m-drPSrhx0Z_gK4Y0RXD07bhr0N7rH6zXe0RV3SNCv8yy2heOAkmvwpDsO4wenEjdwKHshDMcg2eyNBu7zLtB83Q6p7LobJOgtaVqtcBmUIV3w-33egGEz0T9m01-l4HBSx7CpXdB1OA55rHCQIVGKaqCaHaiyIvXB_P8","enabled":true,"type":"secret"},{"key":"apiKey","value":"b1e434d318f6f2a2e1df2a9165cba0bac297a414","enabled":true,"type":"secret"},{"key":"customerMSISDN","value":"","enabled":true,"type":"default"},{"key":"amount","value":"","enabled":true,"type":"default"},{"key":"type","value":"","enabled":true,"type":"default"},{"key":"network","value":"","enabled":true,"type":"default"},{"key":"request_id","value":"","enabled":true,"type":"default"},{"key":"reference","value":"","enabled":true,"type":"default"},{"key":"long_random_number","value":"","enabled":true,"type":"any"}],"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/ed3877ff16fde25e31f5f7b5d6288dc9e33b412a6ad71b2da2802d1803979e25","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"},{"label":"Corporate Prod","value":"15102361-ad57f711-dab6-4a07-8ff6-3d6d2735523b"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA3kSn3R1"}