{ "item": [ { "name": "Health", "description": "Check API availability and status.\n\nUse this endpoint to verify the API is operational before making other requests.\n", "item": [ { "name": "Check API health status", "request": { "name": "Check API health status", "description": {}, "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "name": "API is healthy", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"API is healthy\"\n },\n \"data\": {\n \"status\": \"ok\",\n \"version\": \"1.0.0\",\n \"timestamp\": \"2026-01-01T00:00:00.000+01:00\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account", "description": "Manage your partner account and view wallet information.\n\n## Endpoints\n- **GET /account** - View account details\n- **GET /account/balance** - Check wallet balance\n- **GET /account/transactions** - List transaction history\n\n## Required Scopes\n- `read_balance` - For account and balance endpoints\n- `read_transactions` - For transaction endpoints\n", "item": [ { "name": "Get account details", "request": { "name": "Get account details", "description": {}, "url": { "path": [ "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Account details retrieved", "originalRequest": { "url": { "path": [ "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"Account details retrieved\"\n },\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"account\",\n \"attributes\": {\n \"name\": \"Bola Ahmed\",\n \"email\": \"test@rizpay.app\",\n \"business_name\": \"Acme Technologies Ltd\",\n \"role\": \"regular\",\n \"created_at\": \"2026-01-01T00:00:00.000+01:00\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unauthorized", "originalRequest": { "url": { "path": [ "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get wallet balance", "request": { "name": "Get wallet balance", "description": {}, "url": { "path": [ "account", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Balance retrieved", "originalRequest": { "url": { "path": [ "account", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"Balance retrieved\"\n },\n \"data\": {\n \"balance\": \"25750.00\",\n \"currency\": \"NGN\",\n \"updated_at\": \"2026-01-01T00:00:00.000+01:00\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List transactions", "request": { "name": "List transactions", "description": {}, "url": { "path": [ "account", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by status (pending, successful, failed, reversed)", "type": "text/plain" }, "key": "status", "value": "string" }, { "disabled": false, "description": { "content": "Filter by category (funding, purchase, withdrawal, transfer, commission, promo)", "type": "text/plain" }, "key": "category", "value": "string" }, { "disabled": false, "description": { "content": "Filter by external_reference", "type": "text/plain" }, "key": "reference", "value": "string" }, { "disabled": false, "description": { "content": "Filter transactions from this date (ISO8601)", "type": "text/plain" }, "key": "from", "value": "2020-01-01T00:00:00.000Z" }, { "disabled": false, "description": { "content": "Filter transactions to this date (ISO8601)", "type": "text/plain" }, "key": "to", "value": "2020-01-01T00:00:00.000Z" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Transactions listed", "originalRequest": { "url": { "path": [ "account", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by status (pending, successful, failed, reversed)", "type": "text/plain" }, "key": "status", "value": "string" }, { "disabled": false, "description": { "content": "Filter by category (funding, purchase, withdrawal, transfer, commission, promo)", "type": "text/plain" }, "key": "category", "value": "string" }, { "disabled": false, "description": { "content": "Filter by external_reference", "type": "text/plain" }, "key": "reference", "value": "string" }, { "disabled": false, "description": { "content": "Filter transactions from this date (ISO8601)", "type": "text/plain" }, "key": "from", "value": "2020-01-01T00:00:00.000Z" }, { "disabled": false, "description": { "content": "Filter transactions to this date (ISO8601)", "type": "text/plain" }, "key": "to", "value": "2020-01-01T00:00:00.000Z" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"Transactions retrieved\"\n },\n \"data\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"transaction\",\n \"attributes\": {\n \"amount\": \"15000.0\",\n \"currency\": \"NGN\",\n \"status\": \"pending\",\n \"category\": \"purchase\",\n \"description\": \"DSTV Compact Subscription\",\n \"reference\": \"STATIC-REFERENCE-0001\",\n \"external_reference\": null,\n \"product_type\": null,\n \"phone_number\": null,\n \"meter_number\": null,\n \"price\": {\n \"product_amount\": \"15000.00\",\n \"fee_amount\": \"0.00\",\n \"total_debit\": \"15000.00\",\n \"currency\": \"NGN\",\n \"basis\": \"fixed\"\n },\n \"created_at\": \"2026-01-01T00:00:00.000+01:00\",\n \"updated_at\": \"2026-01-01T00:00:00.000+01:00\"\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"transaction\",\n \"attributes\": {\n \"amount\": \"2500.0\",\n \"currency\": \"NGN\",\n \"status\": \"successful\",\n \"category\": \"purchase\",\n \"description\": \"GLO 1.5GB Data Plan - 08098765432\",\n \"reference\": \"STATIC-REFERENCE-0001\",\n \"external_reference\": null,\n \"product_type\": null,\n \"phone_number\": null,\n \"meter_number\": null,\n \"price\": {\n \"product_amount\": \"2500.00\",\n \"fee_amount\": \"0.00\",\n \"total_debit\": \"2500.00\",\n \"currency\": \"NGN\",\n \"basis\": \"fixed\"\n },\n \"created_at\": \"2026-01-01T00:00:00.000+01:00\",\n \"updated_at\": \"2026-01-01T00:00:00.000+01:00\"\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"transaction\",\n \"attributes\": {\n \"amount\": \"1000.0\",\n \"currency\": \"NGN\",\n \"status\": \"successful\",\n \"category\": \"purchase\",\n \"description\": \"MTN Airtime - 08012345678\",\n \"reference\": \"STATIC-REFERENCE-0001\",\n \"external_reference\": null,\n \"product_type\": null,\n \"phone_number\": null,\n \"meter_number\": null,\n \"price\": {\n \"product_amount\": \"1000.00\",\n \"fee_amount\": \"0.00\",\n \"total_debit\": \"1000.00\",\n \"currency\": \"NGN\",\n \"basis\": \"fixed\"\n },\n \"created_at\": \"2026-01-01T00:00:00.000+01:00\",\n \"updated_at\": \"2026-01-01T00:00:00.000+01:00\"\n }\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 1,\n \"total_count\": 3\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Invalid filter parameters", "originalRequest": { "url": { "path": [ "account", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by status (pending, successful, failed, reversed)", "type": "text/plain" }, "key": "status", "value": "string" }, { "disabled": false, "description": { "content": "Filter by category (funding, purchase, withdrawal, transfer, commission, promo)", "type": "text/plain" }, "key": "category", "value": "string" }, { "disabled": false, "description": { "content": "Filter by external_reference", "type": "text/plain" }, "key": "reference", "value": "string" }, { "disabled": false, "description": { "content": "Filter transactions from this date (ISO8601)", "type": "text/plain" }, "key": "from", "value": "2020-01-01T00:00:00.000Z" }, { "disabled": false, "description": { "content": "Filter transactions to this date (ISO8601)", "type": "text/plain" }, "key": "to", "value": "2020-01-01T00:00:00.000Z" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get transaction details", "request": { "name": "Get transaction details", "description": {}, "url": { "path": [ "account", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "id", "disabled": false, "description": { "content": "(Required) Transaction ID (with or without txn_ prefix) OR external_reference (16 chars: 10 digits + 6 alphanumeric)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Transaction retrieved by external_reference", "originalRequest": { "url": { "path": [ "account", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transaction ID (with or without txn_ prefix) OR external_reference (16 chars: 10 digits + 6 alphanumeric)", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"Transaction details retrieved\"\n },\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"transaction\",\n \"attributes\": {\n \"amount\": \"500.0\",\n \"currency\": \"NGN\",\n \"status\": \"successful\",\n \"category\": \"purchase\",\n \"description\": \"Airtel Airtime - 08055512345\",\n \"reference\": \"STATIC-REFERENCE-0001\",\n \"external_reference\": null,\n \"product_type\": null,\n \"phone_number\": null,\n \"meter_number\": null,\n \"price\": {\n \"product_amount\": \"500.00\",\n \"fee_amount\": \"0.00\",\n \"total_debit\": \"500.00\",\n \"currency\": \"NGN\",\n \"basis\": \"fixed\"\n },\n \"created_at\": \"2026-01-01T00:00:00.000+01:00\",\n \"updated_at\": \"2026-01-01T00:00:00.000+01:00\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Transaction not found", "originalRequest": { "url": { "path": [ "account", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transaction ID (with or without txn_ prefix) OR external_reference (16 chars: 10 digits + 6 alphanumeric)", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Products", "description": "Browse available bill payment products.\n\n## Categories\n- **Airtime** - Mobile top-up for MTN, Airtel, Glo, 9mobile\n- **Data Plans** - Data bundles (daily, weekly, monthly)\n- **Cable TV** - DSTV, GOTV, Startimes subscriptions\n- **Electricity** - Prepaid/postpaid meter payments\n\n## Required Scope\n- `view_products`\n", "item": [ { "name": "List product categories", "request": { "name": "List product categories", "description": {}, "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Product categories listed", "originalRequest": { "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"Product categories retrieved\"\n },\n \"data\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"product_category\",\n \"attributes\": {\n \"name\": \"Bola Ahmed\",\n \"description\": \"Mobile airtime top-up\",\n \"endpoint\": \"/api/partners/v1/products/airtimes\"\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"product_category\",\n \"attributes\": {\n \"name\": \"Bola Ahmed\",\n \"description\": \"Mobile data bundles\",\n \"endpoint\": \"/api/partners/v1/products/dataplans\"\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"product_category\",\n \"attributes\": {\n \"name\": \"Bola Ahmed\",\n \"description\": \"Cable TV subscriptions\",\n \"endpoint\": \"/api/partners/v1/products/cabletv\"\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"product_category\",\n \"attributes\": {\n \"name\": \"Bola Ahmed\",\n \"description\": \"Electricity bill payments\",\n \"endpoint\": \"/api/partners/v1/products/electricity\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List airtime products", "request": { "name": "List airtime products", "description": {}, "url": { "path": [ "products", "airtimes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by network (MTN, Airtel, Glo, 9mobile)", "type": "text/plain" }, "key": "network", "value": "string" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (default: 20, max: 100)", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Airtime products listed", "originalRequest": { "url": { "path": [ "products", "airtimes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by network (MTN, Airtel, Glo, 9mobile)", "type": "text/plain" }, "key": "network", "value": "string" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (default: 20, max: 100)", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"Airtime products retrieved\"\n },\n \"data\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"airtime\",\n \"attributes\": {\n \"display_name\": \"9MOBILE Airtime\",\n \"network\": \"9MOBILE\",\n \"min_amount\": \"50.0\",\n \"max_amount\": \"50000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"50.00\",\n \"max_amount\": \"50000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"airtime\",\n \"attributes\": {\n \"display_name\": \"MTN Airtime\",\n \"network\": \"MTN\",\n \"min_amount\": \"50.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"50.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"airtime\",\n \"attributes\": {\n \"display_name\": \"AIRTEL Airtime\",\n \"network\": \"AIRTEL\",\n \"min_amount\": \"50.0\",\n \"max_amount\": \"50000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"50.00\",\n \"max_amount\": \"50000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"airtime\",\n \"attributes\": {\n \"display_name\": \"GLO Airtime\",\n \"network\": \"GLO\",\n \"min_amount\": \"50.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"50.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"airtime\",\n \"attributes\": {\n \"display_name\": \"AIRTEL Airtime\",\n \"network\": \"AIRTEL\",\n \"min_amount\": \"50.0\",\n \"max_amount\": \"50000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"50.00\",\n \"max_amount\": \"50000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"airtime\",\n \"attributes\": {\n \"display_name\": \"9MOBILE Airtime\",\n \"network\": \"9MOBILE\",\n \"min_amount\": \"50.0\",\n \"max_amount\": \"50000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"50.00\",\n \"max_amount\": \"50000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"airtime\",\n \"attributes\": {\n \"display_name\": \"GLO Airtime\",\n \"network\": \"GLO\",\n \"min_amount\": \"50.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"50.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"airtime\",\n \"attributes\": {\n \"display_name\": \"MTN Airtime\",\n \"network\": \"MTN\",\n \"min_amount\": \"50.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"50.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 1,\n \"total_count\": 8\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List data plan products", "request": { "name": "List data plan products", "description": {}, "url": { "path": [ "products", "dataplans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "network", "value": "string" }, { "disabled": false, "description": { "content": "Filter by bundle type (daily, weekly, monthly)", "type": "text/plain" }, "key": "bundle_type", "value": "string" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (default: 20, max: 100)", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Data plans listed", "originalRequest": { "url": { "path": [ "products", "dataplans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "network", "value": "string" }, { "disabled": false, "description": { "content": "Filter by bundle type (daily, weekly, monthly)", "type": "text/plain" }, "key": "bundle_type", "value": "string" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (default: 20, max: 100)", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"Data plans retrieved\"\n },\n \"data\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"data_plan\",\n \"attributes\": {\n \"display_name\": \"MTN 1.5GB / 30 Days (SME)\",\n \"network\": \"MTN\",\n \"bundle_size\": \"1.5GB\",\n \"duration\": \"30 Days\",\n \"bundle_type\": \"SME\",\n \"price\": {\n \"amount\": \"292.00\",\n \"currency\": \"NGN\",\n \"basis\": \"fixed\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"data_plan\",\n \"attributes\": {\n \"display_name\": \"AIRTEL 500MB / 7 Days (GIFTING)\",\n \"network\": \"AIRTEL\",\n \"bundle_size\": \"500MB\",\n \"duration\": \"7 Days\",\n \"bundle_type\": \"GIFTING\",\n \"price\": {\n \"amount\": \"292.00\",\n \"currency\": \"NGN\",\n \"basis\": \"fixed\"\n }\n }\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 1,\n \"total_count\": 2\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List cable TV products", "request": { "name": "List cable TV products", "description": {}, "url": { "path": [ "products", "cabletv" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by provider (DSTV, GOTV, Startimes)", "type": "text/plain" }, "key": "provider", "value": "string" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (default: 20, max: 100)", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Cable TV products listed", "originalRequest": { "url": { "path": [ "products", "cabletv" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by provider (DSTV, GOTV, Startimes)", "type": "text/plain" }, "key": "provider", "value": "string" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (default: 20, max: 100)", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"Cable TV products retrieved\"\n },\n \"data\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"cable_tv\",\n \"attributes\": {\n \"display_name\": \"Compact\",\n \"service\": \"DSTV\",\n \"package\": \"Compact\",\n \"price\": {\n \"amount\": \"20992.00\",\n \"currency\": \"NGN\",\n \"basis\": \"fixed\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"cable_tv\",\n \"attributes\": {\n \"display_name\": \"GOtv Max\",\n \"service\": \"GOTV\",\n \"package\": \"GOtv Max\",\n \"price\": {\n \"amount\": \"15692.00\",\n \"currency\": \"NGN\",\n \"basis\": \"fixed\"\n }\n }\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 1,\n \"total_count\": 2\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List electricity products", "request": { "name": "List electricity products", "description": {}, "url": { "path": [ "products", "electricity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by electricity distributor", "type": "text/plain" }, "key": "distributor", "value": "string" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (default: 20, max: 100)", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Electricity products listed", "originalRequest": { "url": { "path": [ "products", "electricity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by electricity distributor", "type": "text/plain" }, "key": "distributor", "value": "string" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (default: 20, max: 100)", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"Electricity products retrieved\"\n },\n \"data\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"Ikeja Electric (PRE)\",\n \"distributor\": \"Ikeja Electric\",\n \"meter_type\": \"PRE\",\n \"min_amount\": \"500.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"500.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"Eko Electric (POST)\",\n \"distributor\": \"Eko Electric\",\n \"meter_type\": \"POST\",\n \"min_amount\": \"1000.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"1000.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"Benin Electricity - BEDC\",\n \"distributor\": \"Benin Electricity - BEDC\",\n \"meter_type\": null,\n \"min_amount\": \"500.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"500.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"Eko Electric Payment - EKEDC\",\n \"distributor\": \"Eko Electric Payment - EKEDC\",\n \"meter_type\": null,\n \"min_amount\": \"1000.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"1000.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"Enugu Electric - EEDC\",\n \"distributor\": \"Enugu Electric - EEDC\",\n \"meter_type\": null,\n \"min_amount\": \"500.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"500.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"IBEDC - Ibadan Electricity Distribution Company\",\n \"distributor\": \"IBEDC - Ibadan Electricity Distribution Company\",\n \"meter_type\": null,\n \"min_amount\": \"2000.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"2000.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"Ikeja Electric Payment - IKEDC\",\n \"distributor\": \"Ikeja Electric Payment - IKEDC\",\n \"meter_type\": null,\n \"min_amount\": \"100.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"100.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"Aba Electric Payment - ABEDC\",\n \"distributor\": \"Aba Electric Payment - ABEDC\",\n \"meter_type\": null,\n \"min_amount\": \"100.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"100.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"Kaduna Electric - KAEDCO\",\n \"distributor\": \"Kaduna Electric - KAEDCO\",\n \"meter_type\": null,\n \"min_amount\": \"1100.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"1100.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"KEDCO - Kano Electric\",\n \"distributor\": \"KEDCO - Kano Electric\",\n \"meter_type\": null,\n \"min_amount\": \"500.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"500.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"PHED - Port Harcourt Electric\",\n \"distributor\": \"PHED - Port Harcourt Electric\",\n \"meter_type\": null,\n \"min_amount\": \"200.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"200.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"Yola Electric Disco Payment - YEDC\",\n \"distributor\": \"Yola Electric Disco Payment - YEDC\",\n \"meter_type\": null,\n \"min_amount\": \"500.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"500.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"Jos Electric - JED\",\n \"distributor\": \"Jos Electric - JED\",\n \"meter_type\": null,\n \"min_amount\": \"1000.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"1000.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"electricity\",\n \"attributes\": {\n \"display_name\": \"Abuja Electricity Distribution Company- AEDC\",\n \"distributor\": \"Abuja Electricity Distribution Company- AEDC\",\n \"meter_type\": null,\n \"min_amount\": \"900.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"900.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 20,\n \"total_pages\": 1,\n \"total_count\": 14\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get product details", "request": { "name": "Get product details", "description": {}, "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "id", "disabled": false, "description": { "content": "(Required) Product ID (with or without prd_ prefix)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Product details retrieved", "originalRequest": { "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID (with or without prd_ prefix)", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"Product details retrieved\"\n },\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"airtime\",\n \"attributes\": {\n \"display_name\": \"MTN Airtime\",\n \"network\": \"MTN\",\n \"min_amount\": \"50.0\",\n \"max_amount\": \"100000.0\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"50.00\",\n \"max_amount\": \"100000.00\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Product not found", "originalRequest": { "url": { "path": [ "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product ID (with or without prd_ prefix)", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Purchases", "description": "Create and manage bill payment transactions.\n\n## Workflow\n1. **Verify** (optional) - Validate meter/decoder number before purchase\n2. **Create** - Submit purchase request\n3. **Query** - Check transaction status if pending\n\n## Required Scopes\n- `purchase_airtime` - For airtime purchases\n- `purchase_data` - For data plan purchases\n- `purchase_cable_tv` - For cable TV subscriptions\n- `purchase_electricity` - For electricity payments\n- `read_transactions` - For viewing purchase details\n", "item": [ { "name": "Verify meter/decoder before purchase", "request": { "name": "Verify meter/decoder before purchase", "description": {}, "url": { "path": [ "purchases", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"prd_ikedc_prepaid\",\n \"meter_number\": \"12345678901\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Verification successful", "originalRequest": { "url": { "path": [ "purchases", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"prd_ikedc_prepaid\",\n \"meter_number\": \"12345678901\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"Verification successful\"\n },\n \"data\": {\n \"verified\": true,\n \"product_id\": \"22222222-2222-2222-2222-222222222222\",\n \"product_type\": \"electricity\",\n \"price\": {\n \"currency\": \"NGN\",\n \"basis\": \"face_value\",\n \"min_amount\": \"1000.00\",\n \"max_amount\": \"100000.00\"\n },\n \"customer\": {\n \"meter_number\": \"45012345678\",\n \"meter_type\": null,\n \"customer_name\": \"Adebayo Johnson\",\n \"address\": \"15 Adeola Odeku Street, Victoria Island, Lagos\",\n \"distributor\": \"Ikeja Electric\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create a purchase", "request": { "name": "Create a purchase", "description": {}, "url": { "path": [ "purchases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"prd_mtn_airtime\",\n \"amount\": 1000,\n \"phone_number\": \"08012345678\",\n \"external_reference\": \"1736234400A1B2C3\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Purchase created", "originalRequest": { "url": { "path": [ "purchases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"prd_mtn_airtime\",\n \"amount\": 1000,\n \"phone_number\": \"08012345678\",\n \"external_reference\": \"1736234400A1B2C3\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 201,\n \"message\": \"Purchase created successfully\"\n },\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"transaction\",\n \"attributes\": {\n \"amount\": \"2000.0\",\n \"currency\": \"NGN\",\n \"status\": \"pending\",\n \"category\": \"purchase\",\n \"description\": \"MTN Airtime - 08012345678\",\n \"reference\": \"STATIC-REFERENCE-0001\",\n \"external_reference\": \"1780315200ABC123\",\n \"product_type\": null,\n \"phone_number\": null,\n \"meter_number\": null,\n \"price\": {\n \"product_amount\": \"2000.00\",\n \"fee_amount\": \"0.00\",\n \"total_debit\": \"2000.00\",\n \"currency\": \"NGN\",\n \"basis\": \"fixed\"\n },\n \"created_at\": \"2026-01-01T00:00:00.000+01:00\",\n \"updated_at\": \"2026-01-01T00:00:00.000+01:00\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "purchases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"prd_mtn_airtime\",\n \"amount\": 1000,\n \"phone_number\": \"08012345678\",\n \"external_reference\": \"1736234400A1B2C3\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get purchase details", "request": { "name": "Get purchase details", "description": {}, "url": { "path": [ "purchases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase ID (with or without txn_ prefix)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Purchase details retrieved", "originalRequest": { "url": { "path": [ "purchases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase ID (with or without txn_ prefix)", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"Purchase details retrieved\"\n },\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"transaction\",\n \"attributes\": {\n \"amount\": \"5000.0\",\n \"currency\": \"NGN\",\n \"status\": \"successful\",\n \"category\": \"purchase\",\n \"description\": \"DSTV Compact Plus Subscription\",\n \"reference\": \"STATIC-REFERENCE-0001\",\n \"external_reference\": \"1780315200ABC123\",\n \"product_type\": null,\n \"phone_number\": null,\n \"meter_number\": null,\n \"price\": {\n \"product_amount\": \"5000.00\",\n \"fee_amount\": \"0.00\",\n \"total_debit\": \"5000.00\",\n \"currency\": \"NGN\",\n \"basis\": \"fixed\"\n },\n \"created_at\": \"2026-01-01T00:00:00.000+01:00\",\n \"updated_at\": \"2026-01-01T00:00:00.000+01:00\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Requery transaction status from provider", "request": { "name": "Requery transaction status from provider", "description": {}, "url": { "path": [ "purchases", ":id", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "id", "disabled": false, "description": { "content": "(Required) Purchase ID (with or without txn_ prefix)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Query initiated", "originalRequest": { "url": { "path": [ "purchases", ":id", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase ID (with or without txn_ prefix)", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"code\": 200,\n \"message\": \"Purchase details retrieved\"\n },\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"transaction\",\n \"attributes\": {\n \"amount\": \"10000.0\",\n \"currency\": \"NGN\",\n \"status\": \"pending\",\n \"category\": \"purchase\",\n \"description\": \"IKEDC Electricity - 45012345678\",\n \"reference\": \"STATIC-REFERENCE-0001\",\n \"external_reference\": \"1780315200ABC123\",\n \"product_type\": null,\n \"phone_number\": null,\n \"meter_number\": null,\n \"price\": {\n \"product_amount\": \"10000.00\",\n \"fee_amount\": \"0.00\",\n \"total_debit\": \"10000.00\",\n \"currency\": \"NGN\",\n \"basis\": \"fixed\"\n },\n \"created_at\": \"2026-01-01T00:00:00.000+01:00\",\n \"updated_at\": \"2026-01-01T00:00:00.000+01:00\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Invalid status - only pending purchases can be requeried", "originalRequest": { "url": { "path": [ "purchases", ":id", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Purchase ID (with or without txn_ prefix)", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://my.rizpay.app/api/partners/v1" } ], "info": { "name": "RizPay API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The RizPay API enables businesses to integrate bill payment services into their applications.\n\n## Features\n- **Airtime**: Purchase airtime for MTN, Airtel, Glo, 9mobile\n- **Data Plans**: Buy data bundles for all networks\n- **Electricity**: Pay electricity bills for all Nigerian distributors\n- **Cable TV**: Subscribe to DSTV, GOTV, Startimes\n\n## Authentication\nAll requests require a Bearer token in the Authorization header:\n```\nAuthorization: Bearer sk_live_your_secret_key\n```\n\n## Rate Limiting\n- Standard: 60 requests/minute\n- Burst: 10 requests/10 seconds\nResponse headers include rate limit info.\n\n\nContact Support:\n Name: RizPay Support\n Email: support@rizpay.app", "type": "text/plain" } } }