{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9d31f641-fd69-4d0f-ace6-3731ecf1350c","name":"Unify Data Public API (v1)","description":"# Unify Public API\n\nProfessional REST API for third-party integrators to purchase airtime, data, bills, and pins, and to reconcile transactions programmatically.\n\n**Base URL:** `https://api.unifyxpress.com/api/v1/public`\n\nThis collection covers **only** the public, versioned integrator surface (`/api/v1/public/*`). The mobile app's authenticated endpoints and internal endpoints are intentionally not documented here.\n\n---\n\n## Authentication\n\nEvery request must include your API key as a Bearer token:\n\n```\nAuthorization: Bearer <your_api_key>\n```\n\nKeys are issued from the dashboard (Settings → API Keys). The plaintext value is shown **once** at creation time — only its SHA-256 hash is stored, so it cannot be retrieved again. If lost, revoke it and create a new one.\n\nEach account has a default full-access (`*`) key and may create additional named, scoped keys.\n\n### Scopes\n\nA key's `scopes` array may contain literal route names or named groups:\n\n| Group | Grants |\n|---|---|\n| `read` | balance, transactions, all catalog endpoints |\n| `airtime` | `POST /services/airtime` |\n| `data` | `POST /services/data` |\n| `bills` | electricity & cable verify/purchase |\n| `exam-pins` | `POST /services/exam-pins` |\n| `recharge-pins` | `POST /services/recharge-pins` |\n| `*` | every route |\n\nA key with no explicit scopes is read-only (GET endpoints only).\n\n---\n\n## Rate limits\n\nThrottled per API key by tier:\n\n| Tier | Limit |\n|---|---|\n| standard (default) | 60 req/min |\n| premium | 300 req/min |\n| enterprise | 1000 req/min |\n\nExceeding the limit returns `429` with standard `X-RateLimit-*` headers.\n\n---\n\n## Response envelope\n\n**Success**\n```json\n{\n  \"success\": true,\n  \"message\": \"Operation successful\",\n  \"data\": { },\n  \"meta\": { \"timestamp\": \"2026-06-27T10:00:00+00:00\", \"request_id\": \"...\" }\n}\n```\n\n**Error**\n```json\n{\n  \"success\": false,\n  \"message\": \"Human-readable description\",\n  \"error_code\": \"MACHINE_READABLE_CODE\",\n  \"errors\": { \"field\": [\"Validation message\"] },\n  \"meta\": { \"timestamp\": \"...\", \"request_id\": \"...\" }\n}\n```\n\n`errors` is only present on `422 VALIDATION_ERROR` responses.\n\n### Error codes\n\n| Code | HTTP | Meaning |\n|---|---|---|\n| `INVALID_API_KEY` | 401 | Missing or unrecognized `Authorization` header |\n| `EXPIRED_API_KEY` | 401 | Key's `expires_at` has passed |\n| `REVOKED_API_KEY` | 401 | Key has been revoked |\n| `ACCOUNT_NOT_FOUND` | 401 | Owning account no longer exists |\n| `INSUFFICIENT_PERMISSIONS` | 403 | Key scopes don't cover this route |\n| `VALIDATION_ERROR` | 422 | Request body failed validation — see `errors` |\n| `IDEMPOTENCY_CONFLICT` | 409 | Same idempotency key reused with a different payload |\n| `IDEMPOTENCY_KEY_COLLISION` | 409 | Same idempotency key still processing |\n| `INVALID_PLAN` / `INVALID_EXAM_TYPE` | 400 | Catalog lookup failed |\n| `VERIFICATION_FAILED` | 400 | Meter/smartcard verification failed upstream |\n| `TRANSACTION_FAILED` | 400 | Purchase failed upstream (debit auto-refunded) |\n| `TRANSACTION_NOT_FOUND` | 404 | No transaction matches the reference for this account |\n| `INTERNAL_ERROR` | 500 | Unexpected server error |\n\n---\n\n## Idempotency\n\nEvery purchase endpoint is idempotent on a client-supplied key, so retried requests never double-charge.\n\nPreferred — a header (up to 128 chars of `[A-Za-z0-9_\\-.:]`):\n\n```\nIdempotency-Key: order-48213\n```\n\n`X-Idempotency-Key` is also accepted. If neither header is present, the body field `ref` is used instead. `ref` is required on every purchase endpoint regardless, for backward compatibility.\n\nReplaying the same key with an identical payload returns the original result. Replaying it with a different payload returns `409 IDEMPOTENCY_CONFLICT`.\n\n---\n\n## Completion webhooks\n\nA key with a configured `webhook_url` receives an HTTP `POST` whenever one of its transactions resolves.\n\n**Headers**\n```\nX-Webhook-Timestamp: 1735000000\nX-Webhook-Signature: <hex hmac-sha256>\n```\n\nThe signature is `HMAC-SHA256(\"{timestamp}.{raw_json_body}\", webhook_secret)`. Verify it before trusting the payload.\n\n**Payload**\n```json\n{\n  \"event\": \"transaction.success\",\n  \"transaction_reference\": \"TXN-ABC123\",\n  \"status\": \"SUCCESS\",\n  \"status_label\": \"Successful\",\n  \"amount_kobo\": 100000,\n  \"amount_naira\": 1000,\n  \"service_name\": \"Airtime\",\n  \"external_reference\": \"EXT-1\",\n  \"timestamp\": \"2026-06-27T10:00:00+00:00\"\n}\n```\n\n`event` is `transaction.success` or `transaction.failed`. Delivery is retried up to 5 times with backoff on any non-2xx/timeout. Your endpoint must be idempotent on `transaction_reference`.\n\n---\n\n## Getting started in Postman\n\n1. Set the `base_url` collection variable (defaults to `https://api.unify.com/api/v1/public`).\n2. Set the `api_key` collection variable to your key from the dashboard.\n3. Start with **Catalog → Get Networks** and **Account → Get Balance** to confirm auth works.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"42472303","team":23553071,"collectionId":"9d31f641-fd69-4d0f-ace6-3731ecf1350c","publishedId":"2sBY4LQ23t","public":true,"publicUrl":"https://documenter-api.postman.tech/view/42472303/2sBY4LQ23t","privateUrl":"https://go.postman.co/documentation/42472303-9d31f641-fd69-4d0f-ace6-3731ecf1350c","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Unify Data APi"}],"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.12.8","publishDate":"2026-07-09T09:43:54.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Unify Data APi","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/479490da49d0214ee0b306b783a1dd25e25a48c178c3dbc5a9fab8621685f759","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/2sBY4LQ23t"}