Welcome to the Payspot Nigeria API documentation! This guide provides a comprehensive overview of how to integrate with Payspot's services programmatically using our robust API. Our API empowers you to seamlessly accept payments, manage transactions, and access valuable account information, all within your applications.
\nOur base url is https://payspotng.com/api
If you encounter any challenges while integrating with the Payspot Nigeria API, or have any questions, feel free to reach out to our friendly support team via whatsapp chat. We're here to assist you!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Welcome","slug":"welcome"}],"owner":"11861303","collectionId":"d5890e41-0199-4ac4-80eb-611eb0f807b0","publishedId":"2sAYQfEV6Y","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-24T23:47:01.000Z"},"item":[{"name":"Authentication","item":[],"id":"ef0bcf6d-3dc4-4127-8cd4-3430dc5f163b","description":"Payspot Nigeria employs token-based authentication to ensure secure access to its API resources. To interact with protected endpoints, you'll need to include a valid access token within your request headers.
\nObtaining an Access Token
\nBefore you start making API requests, you must acquire an access token. To do this, send a POST request to the following endpoint:
\nEndpoint: https://payspotng.com/api/auth/login
Request Method: POST
Request Parameters:
• email (string, required): Your email address.
• password (string, required): Your account password.
• expire (integer, optional): Expiration days for which the token will be valid. Default is 7 days
Example Request
\n{\n \"email\": \"user@example.com\",\n \"password\": \"password123\",\n \"expire\": 360\n}\n\nExample Response
\n{\n \"status\": true,\n \"data\": {\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"expiration_date\": \"Dec. 25, 2023 at 20:55\"\n },\n \"message\": \"Token generated successfully\",\n \"status_code\": 200\n}\n\nUsing the Access Token
\nOnce you've obtained a valid access token, include it within the Authorization header of your subsequent API requests using the Bearer token scheme. Here's the format:
\nAuthorization: Bearer <your_access_token_here>\n\nRetrieve details pertaining to your Payspot Nigeria account.
\nEndpoint:
\nhttps://payspotng.com/api/user/info\n\nRequest Method:
\nGET\n\nRequest Parameters:
\nHeaders:
\nExample Request (using cURL):
\ncurl -X GET \\\n https://payspotng.com/api/user/info \\\n -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'\n\nExample Response:
\n{\n \"status\": \"success\",\n \"data\": {\n \"basic\": {\n \"firstname\": \"OGDesigns\",\n \"lastname\": \"Inc.\",\n \"email\": \"noreply@payspotng.com\",\n \"package\": \"premium\"\n },\n \"wallets\": {\n \"naira_balance\": \"735.75\",\n \"referral_balance\": \"123\"\n },\n \"dedicated_accounts\": {\n \"moniepoint_account\": \"0123456789\",\n \"wema_account\": null\n }\n },\n \"status_code\": 200\n}\n\nGet Airtime
\nRetrieve available airtime top-up options for various networks.
\nEndpoint:
\nhttps://payspotng.com/api/product/airtime\n\nRequest Method:
\nGET\n\nHeader:
\nBuy Airtime
\nPurchase airtime for a recipient's phone number.
\nEndpoint:
\nhttps://payspotng.com/api/product/airtime\n\nRequest Method:
\nPOST\n\nParameters:
\nnetwork (string, required): The network provider's ID.
\nrecipient (integer, required): The recipient's phone number.
\namount (integer, required): The top-up amount.
\nHeader:
\nGet Data Plans
\nRetrieve a list of available data plans for various networks.
\nEndpoint:
\nhttps://payspotng.com/api/product/data\n\nRequest Method:
\nGET\n\nHeader:
\nBuy Data
\nPurchase an internet data plan for a recipient's phone number.
\nEndpoint:
\nhttps://payspotng.com/api/product/data\n\nRequest Method:
\nPOST\n\nParameters:
\nplan_id (integer, required): The unique ID of the desired data plan.
\nrecipient (integer, required): The recipient's phone number.
\nHeader:
\nGet TV Packages
\nRetrieve a list of available cable TV subscription packages.
\nEndpoint:
\nhttps://payspotng.com/api/product/cabletv\n\nRequest Method:
\nGET\n\nHeader:
\nPay Cable TV
\nPay for a cable TV subscription for a customer.
\nEndpoint:
\nhttps://payspotng.com/api/product/cabletv\n\nRequest Method:
\nPOST\n\nParameters:
\npackage_id (string, required): The unique ID of the cable TV package.
\nuid (integer, required): The unique subscriber ID.
\nHeader:
\nEffortlessly confirm user accounts before processing transactions, ensuring reliability and preventing unauthorized charges.
\nValidate Account
\nEndpoint:
\nhttps://payspotng.com/api/validate/product\n\nRequest Method:
\nPOST\n\nParameters:
\nproduct (string, required): The expected value should be one of the following:
\n\"cabletv\": To validate a cable TV product.
\"ebill\": To validate an electricity bill product.
type (string, required): A required parameter for ebill products.
\n\"ebill\": Expecting either \"prepaid\" or \"postpaid\".provider (string, required): A required parameter for ebill and cabletv products.
\nFor \"ebill\": Expecting one of the following: \"ikeja\", \"eko\", \"kano\", \"portharcourt\", \"jos\", \"ibadan\", \"kaduna\", \"abuja\", \"enugu\", \"benin\", or \"aba\".
For \"cabletv\": Expected value should be either \"startimes\", \"gotv\", or \"dstv\".
uid (integer, required): The unique subscriber ID to be validated for the selected product.
\nHeader:
\nPayspot Nigeria API offers a comprehensive suite of services designed to streamline integration and interaction with various products. Whether you need to recharge airtime, subscribe to internet data plans, pay for cable TV subscriptions, or settle utility bills, Payspot Nigeria has you covered.
\n","_postman_id":"d7f1268b-e6cc-42dc-90fc-1d0b109bea3f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"d5890e41-0199-4ac4-80eb-611eb0f807b0","id":"d5890e41-0199-4ac4-80eb-611eb0f807b0","name":"Payspot Nigeria API Documentation","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"868c2570-98cf-44b6-934a-a2bf96a550b4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"20e840d4-ccd5-46b5-aa93-6488f68e44f2","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://payspotng.com/api"},{"key":"email","value":"","type":"string"},{"key":"password","value":"","type":"string"}]}