{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api2.mylightmobile.com" } ], "info": { "name": "mylightmobile API Documentation", "_postman_id": "491b705d-2e75-4818-a561-57bf9b2a3526", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Authentication", "description": "", "item": [ { "name": "POST api\/customer\/check-email", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/check-email", "query": [], "raw": "{{baseUrl}}\/api\/customer\/check-email" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\"}" }, "description": "This endpoint checks whether a customer account exists with the provided email address." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Customer already exists with this email.\",\n \"data\": {\n \"exists\": true\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"success\": false,\n \"message\": \"Customer not exists with this email.\",\n \"data\": {\n \"exists\": false\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Validation errors\",\n \"data\": {\n \"email\": [\"The email field is required.\"]\n }\n}", "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "POST api\/login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/login", "query": [], "raw": "{{baseUrl}}\/api\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"cassie52@example.net\",\"password\":\"password\"}" }, "description": "This endpoint allows you to fetch your access token..", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Login Successful\",\n \"data\": {\n \"token\": \"xyzAbc374672346\",\n \"name\": \"Cassie\",\n \"address\": \"Gujarat \",\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"success\": false,\n \"message\": \"Invalid Login\",\n \"data\": []\n}", "name": "" } ] }, { "name": "POST api\/contact\/send-email", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contact\/send-email", "query": [], "raw": "{{baseUrl}}\/api\/contact\/send-email" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"John Doe\",\"email\":\"john@example.com\",\"phone\":\"9876543210\",\"message\":\"I need help with my order.\"}" }, "description": "This endpoint allows users to submit a contact form" }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": true,\n \"message\": \"Contact form submitted successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"9876543210\",\n \"message\": \"I need help with my order.\",\n \"created_at\": \"2025-01-01T10:00:00.000000Z\",\n \"updated_at\": \"2025-01-01T10:00:00.000000Z\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Validation errors\",\n \"data\": {\n \"email\": [\"The email field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"status\": false,\n \"message\": \"Something went wrong.\",\n \"error\": \"Server error message\"\n}", "name": "" } ] }, { "name": "GET api\/brands", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/brands", "query": [], "raw": "{{baseUrl}}\/api\/brands" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This Endpoint Allows you to fetch the brands" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"status_code\":401,\"success\":false,\"message\":\"Unauthenticated.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/brand\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/brand\/:id", "query": [], "raw": "{{baseUrl}}\/api\/brand\/:id", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the brand." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This Endpoint Allows you to fetch the brand detail using the id." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"status_code\":401,\"success\":false,\"message\":\"Unauthenticated.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/nmi-data\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/nmi-data\/:id", "query": [], "raw": "{{baseUrl}}\/api\/nmi-data\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "Brand ID." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves the NMI tokenization key and gateway type for a specific brand." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"NMI Token fetched successfully\",\n \"data\": {\n \"id\": 5,\n \"gateway\": \"nmi\",\n \"nmi_tokenization\": \"your-tokenization-key\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Brand not found\",\n \"data\": null\n}", "name": "" } ] }, { "name": "GET api\/activation\/plans\/{brand_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activation\/plans\/:brand_id", "query": [], "raw": "{{baseUrl}}\/api\/activation\/plans\/:brand_id", "variable": [ { "id": "brand_id", "key": "brand_id", "value": "564", "description": "The ID of the brand." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This Endpoint allows you to fetch plans brand wise" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"status_code\":401,\"success\":false,\"message\":\"Unauthenticated.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/activation\/plans-by-mdn\/{mdn}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activation\/plans-by-mdn\/:mdn", "query": [], "raw": "{{baseUrl}}\/api\/activation\/plans-by-mdn\/:mdn", "variable": [ { "id": "mdn", "key": "mdn", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This Endpoint allows you to fetch the plans of the mdn" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"status_code\":401,\"success\":false,\"message\":\"Unauthenticated.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/refill\/plans\/{brand_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/refill\/plans\/:brand_id", "query": [], "raw": "{{baseUrl}}\/api\/refill\/plans\/:brand_id", "variable": [ { "id": "brand_id", "key": "brand_id", "value": "564", "description": "The ID of the brand." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This Endpoint allows you to fetch the refill plans based on the brand id" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"status_code\":401,\"success\":false,\"message\":\"Unauthenticated.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/activation\/plan\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activation\/plan\/:id", "query": [], "raw": "{{baseUrl}}\/api\/activation\/plan\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the plan." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This Endpoint allows you to fetch the activation plan details" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"status_code\":401,\"success\":false,\"message\":\"Unauthenticated.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/refill\/plan\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/refill\/plan\/:id", "query": [], "raw": "{{baseUrl}}\/api\/refill\/plan\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the plan." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This Endpoint allows you to fetch the refill plan details" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"status_code\":401,\"success\":false,\"message\":\"Unauthenticated.\",\"data\":null}", "name": "" } ] }, { "name": "POST api\/activate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activation", "query": [], "raw": "{{baseUrl}}\/api\/activation" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"brand_id\":5,\"plan_id\":12,\"imei\":\"13744917136806\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john@example.com\",\"address\":\"architecto\",\"city\":\"architecto\",\"state\":\"architecto\",\"zipcode\":\"hwaykc\",\"sim_type\":\"physical\",\"source\":\"m\",\"month\":1,\"autopay\":true,\"partnerTransactionId\":\"architecto\",\"addon_plans\":[\"architecto\"],\"sim_no\":\"8901120200000000000\",\"taxResponsePublic_id\":\"architecto\"}" }, "description": "This endpoint is used to activate a new SIM for a customer." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Activation request submitted successfully\",\n \"data\": {\n \"transaction_id\": \"uuid\",\n \"status\": \"processing\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\"\n}", "name": "" } ] }, { "name": "GET api\/activation-calculation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activation-calculation", "query": [], "raw": "{{baseUrl}}\/api\/activation-calculation" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"plan_id\":4326.41688,\"month\":\"1\"}" }, "description": "This Endpoint is used to calculate activation-related values for a specific plan based on the selected duration (month)." }, "response": [] }, { "name": "POST api\/refill", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/refill", "query": [], "raw": "{{baseUrl}}\/api\/refill" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mdn\":\"bngzmi\",\"plan_id\":16,\"amount\":4326.41688}" }, "description": "This Endpoint allows you to perform refill\/reacharge" }, "response": [] }, { "name": "POST api\/refill-with-card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/refill-with-card", "query": [], "raw": "{{baseUrl}}\/api\/refill-with-card" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mdn\":\"9876543210\",\"plan_id\":10,\"amount\":4326.41688,\"brand_id\":5,\"payment_intent_id\":\"pi_123456\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john@example.com\",\"address\":\"123 Main St\",\"city\":\"New York\",\"state\":\"NY\",\"zip_code\":\"10001\",\"taxResponsePublic_id\":\"architecto\"}" }, "description": "This endpoint allows customers to recharge\/refill their plan using a card via Stripe payment." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Refill completed successfully.\",\n \"data\": {\n \"transaction_id\": \"uuid\",\n \"status\": \"success\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Stripe key not found.\"\n}", "name": "" }, { "header": [], "code": 409, "body": "{\n \"success\": false,\n \"message\": \"This payment has already been processed.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Payment intent not found or invalid.\"\n}", "name": "" } ] }, { "name": "POST api\/portin", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/portin", "query": [], "raw": "{{baseUrl}}\/api\/portin" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"brand_id\":5,\"plan_id\":10,\"imei\":\"822569775449171\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john@example.com\",\"address\":\"123 Main St\",\"city\":\"New York\",\"state\":\"NY\",\"zipcode\":4326.41688,\"sim_type\":\"esim\",\"mdn\":\"9876543210\",\"account_number\":\"architecto\",\"account_password\":\"architecto\",\"authorizer_first_name\":\"architecto\",\"authorizer_last_name\":\"architecto\",\"authorizer_address\":\"architecto\",\"authorizer_city\":\"architecto\",\"authorizer_state\":\"architecto\",\"authorizer_zipcode\":4326.41688,\"phone\":\"1374491716806\",\"taxResponsePublic_id\":\"architecto\",\"sim_no\":\"8901122334455\",\"pin\":\"architecto\",\"zip_code\":\"10001\"}" }, "description": "This endpoint creates a port-in request without processing payment." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Port-in request created successfully.\",\n \"data\": {\n \"transaction_id\": \"uuid\",\n \"status\": \"pending\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Validation error\"\n}", "name": "" } ] }, { "name": "POST api\/portin-with-card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/portin-with-card", "query": [], "raw": "{{baseUrl}}\/api\/portin-with-card" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"brand_id\":5,\"plan_id\":10,\"imei\":\"822569775449171\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john@example.com\",\"address\":\"123 Main St\",\"city\":\"New York\",\"state\":\"NY\",\"zipcode\":4326.41688,\"sim_type\":\"esim\",\"mdn\":\"9876543210\",\"account_number\":\"architecto\",\"account_password\":\"architecto\",\"authorizer_first_name\":\"architecto\",\"authorizer_last_name\":\"architecto\",\"authorizer_address\":\"architecto\",\"authorizer_city\":\"architecto\",\"authorizer_state\":\"architecto\",\"authorizer_zipcode\":4326.41688,\"phone\":\"1374491716806\",\"taxResponsePublic_id\":\"c90237e9-ced5-3af6-88ea-84aeaa148878\",\"sim_no\":\"8901122334455\",\"pin\":\"architecto\",\"payment_intent_id\":\"pi_123456\",\"zip_code\":\"10001\",\"coupon_code\":\"SAVE10\",\"autopay\":true}" }, "description": "This endpoint handles porting a number into the system using card payment (Stripe)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Port-in request created successfully.\",\n \"data\": {\n \"transaction_id\": \"uuid\",\n \"status\": \"pending\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Stripe key not found.\"\n}", "name": "" }, { "header": [], "code": 409, "body": "{\n \"success\": false,\n \"message\": \"This payment has already been processed.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Payment intent not found or invalid.\"\n}", "name": "" } ] }, { "name": "POST api\/simswap", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/simswap", "query": [], "raw": "{{baseUrl}}\/api\/simswap" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"brand_id\":1,\"mdn\":\"9876543210\",\"sim_no\":\"890112233445566\"}" }, "description": "This endpoint allows swapping an existing SIM with a new SIM" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Sim Swap request sent successfully.\",\n \"data\": {\n \"status\": \"success\",\n \"reference_id\": \"abc123\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"customer is not active\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"mdn not found in the system\"\n}", "name": "" } ] }, { "name": "POST api\/number-change", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/number-change", "query": [], "raw": "{{baseUrl}}\/api\/number-change" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"brand_id\":1,\"mdn\":\"9876543210\",\"zip_code\":\"10001\"}" }, "description": "This endpoint allows changing the phone number (MDN) of an active customer.\n\nChange customer phone number." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Number Change request sent successfully.\",\n \"data\": {\n \"status\": \"success\",\n \"reference_id\": \"abc123\"\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"success\": false,\n \"message\": \"customer is not active\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"no customer found with provided mdn\"\n}", "name": "" } ] }, { "name": "POST api\/helix\/suspend", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/helix\/suspend", "query": [], "raw": "{{baseUrl}}\/api\/helix\/suspend" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"brand_id\":1,\"mdns\":\"4534213423\"}" }, "description": "This endpoint allows you to suspend your mdn." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Suspended Successfully\",\n\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"success\": false,\n \"message\": \"Mdn Not Found\",\n \"data\": []\n}", "name": "" } ] }, { "name": "POST api\/helix\/deactivate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/helix\/deactivate", "query": [], "raw": "{{baseUrl}}\/api\/helix\/deactivate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "POST api\/helix\/restore", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/helix\/restore", "query": [], "raw": "{{baseUrl}}\/api\/helix\/restore" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mdn\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/nmi\/activate-with-card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/nmi\/activate-with-card", "query": [], "raw": "{{baseUrl}}\/api\/nmi\/activate-with-card" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"brand_id\":5,\"plan_id\":12,\"imei\":\"13744917136806\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john@example.com\",\"address\":\"123 Main St\",\"city\":\"New York\",\"state\":\"NY\",\"zipcode\":\"hwaykc\",\"sim_type\":\"physical\",\"source\":\"m\",\"month\":16,\"autopay\":true,\"partnerTransactionId\":\"u\",\"addon_plans\":[\"architecto\"],\"sim_no\":\"890123456789\",\"payment_token\":\"architecto\",\"payment_intent_id\":\"architecto\",\"phone\":\"9876543210\",\"zip_code\":\"10001\",\"coupon_code\":\"SAVE10\",\"total_price\":120.5}" }, "description": "This endpoint processes SIM activation with card payment." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Activation completed successfully.\",\n \"data\": {\n \"transaction_id\": \"uuid\",\n \"status\": \"success\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Payment Failed Reason - Insufficient funds\"\n}", "name": "" }, { "header": [], "code": 409, "body": "{\n \"success\": false,\n \"message\": \"This payment has already been processed.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Payment intent not found or invalid.\"\n}", "name": "" } ] }, { "name": "GET api\/transaction\/{public_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction\/:public_id", "query": [], "raw": "{{baseUrl}}\/api\/transaction\/:public_id", "variable": [ { "id": "public_id", "key": "public_id", "value": "architecto", "description": "The ID of the public." }, { "id": "id", "key": "id", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "Transaction public UUID." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves detailed information about a transaction using its public transaction ID.." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"\",\n \"data\": {\n \"id\": 1,\n \"transaction_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"plan_id\": 12,\n \"plan\": {\n \"id\": 12,\n \"plan_name\": \"Unlimited Plan\",\n \"description\": \"Unlimited calls & data\",\n \"price\": 30\n },\n \"brand_id\": 1,\n \"brand\": {\n \"id\": 1,\n \"name\": \"BrandX\"\n },\n \"month\": 12,\n \"price\": 30,\n \"sim_type\": \"esim\",\n \"sim_no\": \"890123456789\",\n \"status\": \"success\",\n \"mdn\": \"9876543210\",\n \"total_price\": 330,\n \"totalTaxRate\": 5.5,\n \"coupon_code\": \"SAVE10\",\n \"addon_plans_price\": 10,\n \"activationcode\": \"LPA:1$code\",\n \"activation_date\": \"2025-01-01\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Transaction not found\",\n \"data\": null\n}", "name": "" } ] }, { "name": "POST api\/esim\/qr", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/esim\/qr", "query": [], "raw": "{{baseUrl}}\/api\/esim\/qr" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"brand_id\":1,\"sim_no\":\"8901234567890123456\\n\\n---\"}" }, "description": "This endpoint retrieves the eSIM QR code using a SIM number and brand ID." }, "response": [ { "header": [], "code": 200, "body": "(Binary PNG image response)", "name": "Success (PNG Image)" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"brand_id field is required\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"No transaction found.\",\n \"data\": null\n}", "name": "" } ] }, { "name": "GET api\/esim\/qr\/{public_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/esim\/qr\/:public_id", "query": [], "raw": "{{baseUrl}}\/api\/esim\/qr\/:public_id", "variable": [ { "id": "public_id", "key": "public_id", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "Transaction public UUID." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"public_id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"}" }, "description": "This endpoint retrieves the eSIM QR code for a given transaction" }, "response": [ { "header": [], "code": 200, "body": "(Binary PNG Image Response)", "name": "Brand 16 - QR Image" }, { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"eSIM QR code fetched successfully.\",\n \"data\": {\n \"qr_code\": \"base64-or-url\",\n \"activation_code\": \"LPA:1$example$code\"\n }\n}", "name": "External Provider Success" }, { "header": [], "code": 200, "body": "{\n \"success\": false,\n \"message\": \"Qr Code Not Fetched.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"No transaction found.\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Invalid public_id format. Must be UUID.\",\n \"errors\": {\n \"public_id\": [\"The public id must be a valid UUID.\"]\n }\n}", "name": "" } ] }, { "name": "POST api\/coupon-referral-code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/coupon-referral-code", "query": [], "raw": "{{baseUrl}}\/api\/coupon-referral-code" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"brand_id\":1,\"plan_id\":12,\"month\":12,\"taxResponsePublic_id\":\"tx_12345\",\"coupon_code\":\"SAVE10\",\"addon_plans\":[\"architecto\"]}" }, "description": "This endpoint validates and applies a coupon code (and optional add-ons) to calculate the final payable amount for a selected plan." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Code Found Successfully\",\n \"data\": {\n \"coupon\": {\n \"success\": true,\n \"coupon_id\": 1,\n \"coupon_amount\": 10,\n \"amount_type\": \"fixed\",\n \"total_discount_price\": 90\n },\n \"referral\": null,\n \"final_price\": 95.5\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Code Found Successfully\",\n \"data\": {\n \"coupon\": null,\n \"referral\": null,\n \"final_price\": 120\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"brand_id field is required\",\n \"data\": null\n}", "name": "" } ] }, { "name": "POST api\/helix\/send-ota\/{mdn}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/helix\/send-ota\/:mdn", "query": [], "raw": "{{baseUrl}}\/api\/helix\/send-ota\/:mdn", "variable": [ { "id": "mdn", "key": "mdn", "value": "9876543210", "description": "Mobile number associated with the device." } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": null, "description": "This endpoint sends an OTA (Over-The-Air) configuration message to a device based on the provided mobile number (MDN)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"OTA sent successfully.\"\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"success\": false,\n \"message\": \"Failed to send OTA.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"data\": null,\n \"message\": \"Transaction not found.\"\n}", "name": "" } ] }, { "name": "POST api\/device\/check-imei", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/device\/check-imei", "query": [], "raw": "{{baseUrl}}\/api\/device\/check-imei" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"imei\":\"123456789012345\",\"brand_id\":1}" }, "description": "This endpoint checks whether a device (based on IMEI number) is eligible for activation under a specific brand." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"IMEI check completed.\",\n \"data\": {\n \"imei\": \"123456789012345\",\n \"brand_id\": 1,\n \"aggregator\": \"nexus\",\n \"sim_support\": {\n \"physical_sim\": true,\n \"esim\": false\n }\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"success\": false,\n \"message\": \"IMEI not eligible or not found.\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Aggregator not supported for IMEI check.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Brand not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Error during IMEI check: Something went wrong\"\n}", "name": "" } ] }, { "name": "GET api\/activation\/addon-plans\/{brand_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activation\/addon-plans\/:brand_id", "query": [], "raw": "{{baseUrl}}\/api\/activation\/addon-plans\/:brand_id", "variable": [ { "id": "brand_id", "key": "brand_id", "value": "1", "description": "optional The ID of the brand." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": null, "description": "This endpoint returns a list of active addon plans for a specific brand.\n\nAddon plans are typically used as additional services or top-ups that customers can purchase along with their main plan." }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": 1,\n \"plan_type\": \"addon\",\n \"sku\": \"ADDON001\",\n \"plan_name\": \"1GB Data Addon\",\n \"description\": \"Extra 1GB high-speed data\",\n \"price\": \"10.00\",\n \"m1_spiff\": \"1.00\",\n \"m2_spiff\": \"1.50\",\n \"m3_spiff\": \"2.00\",\n \"m6_spiff\": \"3.00\",\n \"m9_spiff\": \"4.00\",\n \"m12_spiff\": \"5.00\",\n \"processing_fees\": \"0.50\",\n \"brand_id\": 1\n }\n]", "name": "" } ] }, { "name": "POST api\/customer\/login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/login", "query": [], "raw": "{{baseUrl}}\/api\/customer\/login" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\",\"password\":\"secret123\"}" }, "description": "This endpoint authenticates a customer using email and password." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Login successful.\",\n \"data\": {\n \"customer\": {\n \"id\": 1,\n \"email\": \"john@example.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n },\n \"token\": {\n \"access_token\": \"1|abcxyz...\",\n \"token_type\": \"Bearer\"\n }\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Invalid credentials.\",\n \"data\": {\n \"customer\": null\n }\n}", "name": "" } ] }, { "name": "POST api\/customer\/register", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/register", "query": [], "raw": "{{baseUrl}}\/api\/customer\/register" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john@example.com\",\"password\":\"secret123\",\"gender\":\"male\",\"phone\":\"9876543210\"}" }, "description": "This endpoint registers a new customer account using basic details." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Customer registered successfully.\",\n \"data\": {\n \"customer\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\",\n \"gender\": \"male\",\n \"phone\": \"9876543210\",\n \"created_at\": \"2025-01-01T10:00:00.000000Z\",\n \"updated_at\": \"2025-01-01T10:00:00.000000Z\"\n }\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Email already exists.\",\n \"data\": {\n \"customer\": null\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"email\": [\"The email has already been taken.\"]\n }\n}", "name": "" } ] }, { "name": "POST api\/customer\/send-otp", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/send-otp", "query": [], "raw": "{{baseUrl}}\/api\/customer\/send-otp" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\",\"mdn\":\"9876543210\",\"brand_id\":1}" }, "description": "This endpoint generates and sends a One-Time Password (OTP) to a customer via email or mobile number (MDN).\n\nOTP is valid for 5 minutes.\n\nSend OTP to customer via email or mobile number." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"OTP sent successfully.\",\n \"data\": {\n \"customer\": {\n \"email\": \"john@example.com\",\n \"mdn\": \"9876543210\"\n }\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"No customer found for the provided information.\",\n \"data\": {\n \"customer\": null\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Email or MDN is required\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Failed to send OTP. Please try again later.\",\n \"data\": {\n \"customer\": null\n }\n}", "name": "" } ] }, { "name": "POST api\/customer\/verify-otp", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/verify-otp", "query": [], "raw": "{{baseUrl}}\/api\/customer\/verify-otp" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\",\"mdn\":\"9876543210\",\"otp\":\"123456\",\"brand_id\":16}" }, "description": "This endpoint verifies a One-Time Password (OTP) sent to a customer via email or mobile number (MDN). Upon successful verification,\nit authenticates the customer and returns an access token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"OTP verified successfully.\",\n \"data\": {\n \"customer\": {\n \"id\": 1,\n \"email\": \"john@example.com\",\n \"mdn\": \"9876543210\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1995-05-10\",\n \"address\": \"New York\"\n },\n \"token\": {\n \"access_token\": \"1|abcxyz...\",\n \"token_type\": \"Bearer\"\n }\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Invalid OTP. Please try again.\",\n \"data\": {\n \"customer\": null\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"OTP expired. Please request a new one.\",\n \"data\": {\n \"customer\": null\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"No OTP found for this customer.\",\n \"data\": {\n \"customer\": null\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Customer record not found after OTP verification.\",\n \"data\": {\n \"customer\": null\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Either email or MDN is required.\",\n \"data\": {\n \"customer\": null\n }\n}", "name": "" } ] }, { "name": "GET api\/customer\/cards", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/cards", "query": [ { "key": "brand_id", "value": "1", "description": "The brand ID to filter cards.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/customer\/cards?brand_id=1" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all saved payment cards for the authenticated customer based on the provided brand.\n\nAuthentication:\nThis API requires authentication using a **Customer Bearer Token**." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Cards retrieved successfully.\",\n \"data\": [\n {\n \"id\": 1,\n \"customer_id\": 10,\n \"brand_id\": 1,\n \"last_four\": \"4242\",\n \"expiry_month\": \"12\",\n \"expiry_year\": \"2028\",\n \"is_default\": 1,\n \"created_at\": \"2026-04-18 12:00:00\",\n \"updated_at\": \"2026-04-18 12:30:00\"\n },\n {\n \"id\": 2,\n \"customer_id\": 10,\n \"brand_id\": 1,\n \"last_four\": \"1111\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"2027\",\n \"is_default\": 0,\n \"created_at\": \"2026-03-01 10:00:00\",\n \"updated_at\": \"2026-03-01 10:00:00\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"brand_id is required.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" } ] }, { "name": "POST api\/customer\/cards", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/cards", "query": [], "raw": "{{baseUrl}}\/api\/customer\/cards" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"card_name\":\"b\",\"card_type\":\"n\",\"name\":\"John Doe\",\"email\":\"john@example.com\",\"phone_number\":\"1234567890\",\"country_code\":\"pwlvqw\",\"address\":\"r\",\"city\":\"s\",\"state\":\"i\",\"zip_code\":\"tcpscqldzsnrwtuj\",\"card_number\":\"architecto\",\"payment_method_id\":\"pm_123456789\",\"brand_id\":1,\"is_default\":\"0\",\"stripe_customer_id\":\"cus_ABC123\"}" }, "description": "This endpoint allows an authenticated customer to add a new payment card using Stripe.\n\nAuthentication:\nThis API requires authentication using a **Customer Bearer Token**." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Card added successfully.\",\n \"data\": {\n \"card\": {\n \"id\": 1,\n \"customer_id\": 10,\n \"brand_id\": 1,\n \"last_four\": \"4242\",\n \"expiry_month\": \"12\",\n \"expiry_year\": \"2028\",\n \"created_at\": \"2026-04-18 12:00:00\"\n },\n \"stripe_customer_id\": \"cus_ABC123\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"payment_method_id\": [\"The payment method id field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Failed to add card\"\n}", "name": "" } ] }, { "name": "Get api\/customer\/cards", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/cards\/:id", "query": [], "raw": "{{baseUrl}}\/api\/customer\/cards\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the card." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves details of a specific saved card for the authenticated customer.\n\nAuthentication:\nThis API requires authentication using a **Customer Bearer Token**." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Card retrieved successfully.\",\n \"data\": {\n \"id\": 1,\n \"customer_id\": 10,\n \"brand_id\": 1,\n \"last_four\": \"1111\",\n \"expiry_month\": \"12\",\n \"expiry_year\": \"2028\",\n \"is_default\": 1,\n \"created_at\": \"2026-04-18 12:00:00\",\n \"updated_at\": \"2026-04-18 12:30:00\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Card not found.\"\n}", "name": "" } ] }, { "name": "PUT\/PATCH api\/customer\/cards\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/cards\/:id", "query": [], "raw": "{{baseUrl}}\/api\/customer\/cards\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the card to update." } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"brand_id\":1,\"is_default\":1}" }, "description": "This endpoint allows an authenticated customer to update a saved card,\n\nAuthentication:\nThis API requires authentication using a **Customer Bearer Token**." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Card updated successfully.\",\n \"data\": {\n \"id\": 1,\n \"customer_id\": 10,\n \"brand_id\": 1,\n \"last_four\": \"1111\",\n \"expiry_month\": \"12\",\n \"expiry_year\": \"2028\",\n \"is_default\": 1,\n \"created_at\": \"2026-04-18 12:00:00\",\n \"updated_at\": \"2026-04-18 12:30:00\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"brand_id is required.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Card not found.\"\n}", "name": "" } ] }, { "name": "DELETE api\/customer\/cards\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/cards\/:id", "query": [], "raw": "{{baseUrl}}\/api\/customer\/cards\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the card to delete." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": null, "description": "This endpoint allows an authenticated customer to delete one of their saved payment cards.\n\nAuthentication:\nThis API requires authentication using a **Customer Bearer Token**." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Card deleted successfully.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Card not found.\"\n}", "name": "" } ] }, { "name": "GET api\/customer\/profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/profile", "query": [], "raw": "{{baseUrl}}\/api\/customer\/profile" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves the profile details of the authenticated customer.\n\n\ud83d\udd10 Authentication:\nThis API requires authentication using a **Customer Bearer Token**." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Profile fetch successfully.\",\n \"data\": {\n \"id\": 10,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"1234567890\",\n \"dob\": \"1995-05-20\",\n \"created_at\": \"2026-01-01 10:00:00\",\n \"updated_at\": \"2026-04-18 12:00:00\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" } ] }, { "name": "PUT api\/customer\/profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/profile", "query": [], "raw": "{{baseUrl}}\/api\/customer\/profile" }, "method": "PUT", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"address\":\"g\",\"city\":\"z\",\"state\":\"m\",\"zip_code\":\"iyvdljnikhwaykcm\",\"date_of_birth\":\"1995-05-20\",\"gender\":\"male\",\"password\":\"secret123\",\"email\":\"john@example.com\",\"phone\":\"1234567890\"}" }, "description": "This endpoint allows an authenticated customer to update their profile details.\nOnly the provided fields will be updated (partial update supported).\n\n\ud83d\udd10 Authentication:\nThis API requires authentication using a **Customer Bearer Token**." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Profile updated successfully.\",\n \"data\": {\n \"id\": 10,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"1234567890\",\n \"dob\": \"1995-05-20\",\n \"created_at\": \"2026-01-01 10:00:00\",\n \"updated_at\": \"2026-04-18 12:00:00\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"email\": [\"The email has already been taken.\"]\n }\n}", "name": "" } ] }, { "name": "GET api\/customer\/orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/orders", "query": [], "raw": "{{baseUrl}}\/api\/customer\/orders" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a paginated list of orders (transactions)\nfor the authenticated customer.\n\nAuthentication:\nThis API requires authentication using a **Customer Bearer Token**." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Orders fetched successfully.\",\n \"data\": [\n {\n \"transaction_id\": \"PUB123456\",\n \"mdn\": \"1234567890\",\n \"sim_no\": \"SIM123456\",\n \"sim_type\": \"physical\",\n \"status\": \"success\",\n \"price\": \"50.00\",\n \"total_price\": \"55.00\",\n \"type\": \"activation\",\n \"plan_id\": 5,\n \"plan_details\": {},\n \"customer_id\": 10,\n \"brand_id\": 1,\n \"created_at\": \"2026-04-01 10:00:00\",\n \"plan\": {\n \"id\": 5,\n \"plan_name\": \"Unlimited Plan\"\n },\n \"brands\": {\n \"id\": 1,\n \"name\": \"MyBrand\"\n }\n }\n ],\n \"pagination\": {\n \"total\": 25,\n \"per_page\": 10,\n \"current_page\": 1,\n \"last_page\": 3,\n \"next_page_url\": \"https:\/\/your-domain.com\/api\/customer\/orders?page=2\",\n \"prev_page_url\": null\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"No orders found.\",\n \"data\": [],\n \"pagination\": {\n \"total\": 0,\n \"per_page\": 10,\n \"current_page\": 1,\n \"last_page\": 1\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Error fetching orders\"\n}", "name": "" } ] }, { "name": "GET api\/customer\/orders\/{public_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/orders\/:public_id", "query": [], "raw": "{{baseUrl}}\/api\/customer\/orders\/:public_id", "variable": [ { "id": "public_id", "key": "public_id", "value": "PUB123456", "description": "The public ID of the transaction." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves the details of a specific order (transaction)\nfor the authenticated customer using the transaction's public ID.\n\nAuthentication:\nThis API requires authentication using a **Customer Bearer Token**." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Orders fetched successfully.\",\n \"data\": {\n \"transaction_id\": \"PUB123456\",\n \"mdn\": \"1234567890\",\n \"sim_no\": \"SIM123456789\",\n \"sim_type\": \"physical\",\n \"status\": \"success\",\n \"price\": \"50.00\",\n \"total_price\": \"55.00\",\n \"type\": \"activation\",\n \"plan_id\": 5,\n \"plan_details\": {\n \"plan_name\": \"Unlimited Plan\",\n \"data\": \"10GB\",\n \"validity\": \"30 days\"\n },\n \"created_at\": \"2026-04-01 10:00:00\"\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"success\": false,\n \"message\": \"No orders found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Error fetching orders\"\n}", "name": "" } ] }, { "name": "POST api\/customer\/usage\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/usage\/:id", "query": [], "raw": "{{baseUrl}}\/api\/customer\/usage\/:id", "variable": [ { "id": "id", "key": "id", "value": "PUB123456%0A%0A---", "description": "The public ID of the transaction." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves usage data (such as data, talk, and text usage)\nfor a specific transaction using its public ID.\n\nAuthentication:\nThis API requires authentication using a **Customer Bearer Token**.\n\nFetch usage details for a transaction." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"mdn\": \"1234567890\",\n \"data_used\": \"2.5GB\",\n \"data_remaining\": \"7.5GB\",\n \"talk_used\": \"120 mins\",\n \"text_used\": \"50\",\n \"plan\": \"Unlimited Plan\",\n \"expiry_date\": \"2026-04-30\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Transaction not found.\",\n \"data\": null\n}", "name": "" } ] }, { "name": "GET api\/customer\/autopays", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/autopays", "query": [ { "key": "brand_id", "value": "1", "description": "The ID of the brand.", "disabled": false }, { "key": "page", "value": "1", "description": "optional The page number for pagination.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/customer\/autopays?brand_id=1&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"brand_id\":16}" }, "description": "This endpoint retrieves a paginated list of autopay records for the authenticated customer.\nIt includes related transaction and plan details for each autopay.\n\nAuthentication:\nThis API requires authentication using a **Customer Bearer Token**.\n\nFetch all autopays for the logged-in customer by brand." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Autopays fetched successfully.\",\n \"data\": [\n {\n \"id\": 1,\n \"trans_id\": \"TXN123456\",\n \"status\": \"active\",\n \"brand_id\": 1,\n \"customer_id\": 10,\n \"refill_date\": \"2026-04-20\",\n \"plan_id\": 5,\n \"transaction\": {\n \"id\": 100,\n \"public_id\": \"PUB123\",\n \"status\": \"completed\",\n \"price\": \"50.00\",\n \"total_price\": \"55.00\",\n \"mdn\": \"1234567890\",\n \"created_at\": \"2026-04-01 10:00:00\"\n },\n \"plan\": {\n \"id\": 5,\n \"plan_name\": \"Unlimited Plan\"\n }\n }\n ],\n \"pagination\": {\n \"total\": 25,\n \"per_page\": 10,\n \"current_page\": 1,\n \"last_page\": 3,\n \"next_page_url\": \"https:\/\/your-domain.com\/api\/customer\/autopays?page=2\",\n \"prev_page_url\": null\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Error fetching autopays.\"\n}", "name": "" } ] }, { "name": "POST api\/customer\/autopays\/cancel\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer\/autopays\/cancel\/:id", "query": [], "raw": "{{baseUrl}}\/api\/customer\/autopays\/cancel\/:id", "variable": [ { "id": "id", "key": "id", "value": "TXN123456", "description": "The transaction ID of the autopay." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"brand_id\":1}" }, "description": "This endpoint allows a customer to cancel an active autopay request.\n\nAuthentication:\nThis API requires authentication using a **Customer Bearer Token**.\n\nCancel an existing autopay using transaction ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Autopay canceled successfully.\",\n \"data\": {\n \"trans_id\": \"TXN123456\",\n \"status\": \"disable\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Autopay not found.\"\n}", "name": "" }, { "header": [], "code": 409, "body": "{\n \"success\": false,\n \"message\": \"Autopay is already canceled.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Something went wrong while canceling the autopay.\"\n}", "name": "" } ] }, { "name": "POST api\/forgot-password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/forgot-password", "query": [], "raw": "{{baseUrl}}\/api\/forgot-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\"}" }, "description": "" }, "response": [] }, { "name": "GET api\/reset-password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reset-password", "query": [], "raw": "{{baseUrl}}\/api\/reset-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"test@example.com\",\"token\":\"abc123\",\"password\":\"secret123\",\"password_confirmation\":\"secret123\"}" }, "description": "This API requires authentication using a customer token.This Endpoint allows you to reset your password" }, "response": [] }, { "name": "GET api\/validate-reset-token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/validate-reset-token", "query": [], "raw": "{{baseUrl}}\/api\/validate-reset-token" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\",\"token\":\"architecto\"}" }, "description": "This API requires authentication using a customer token.This Endpoint validate your token" }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }