Payscribe builds, launch, and embeds innovative payment products across Africa, leveraging contemporary financial infrastructure. Our integration enables businesses to scale financial services, facilitate local and international payouts, collect customer payments, create virtual accounts, issue virtual cards, and empower them to expand their economic reach and grow their customer base.
\nTo start using Payscribe API, you need to:
\nSign up for a a test account on the Sandbox and once done you can proceed to going live Payscribe account
\nObtain your API key
\nTest all endpoints with sandbox keys
\nSatisfied with the integration? Proceed with your UAT and once done go live
\nReceive payments from customers
\nIssue USD Card
\nPurchase airtime (local and international)
\nPurchase internet data (local and international)
\nCreate savings for your customers
\nPay electricity bills (prepaid and postpaid)
\nPay cable subscription (GOTV, DSTV, Startimes)
\nPay internet data (Spectranet, Ntel, etc.
\nFund betting wallet (bet9ja, 1xbet, sportybet)
\nSend bulk SMS
\nPay educational voucher (JAMB, NECO, etc.)
\nPrint recharge cards (MTN, GLO, AIRTEL, 9MOBILE): api/payscribe/recharge/ print
\nConvert excess airtime to cash
\nFund transport wallet (Cowry Pay)
\nReceive payments
\nMake financial verifications
\nAPI Request and Response
\nAPI requests should be made in JSON format
\nAPI responses will be in JSON format
\nUse your API key as Bearer in the header of each request
\nSecurity
\nOur API uses SSL encryption to ensure secure transactions
\nUse HTTPS protocol to make requests
\nRate limit
\nPayscribe allows up to 60 API requests/sec. When you go beyond that cap, you will get an HTTP error code of 429.{\"message\": \"API rate limit exceeded\" }
Support
\nWe are dedicated to assisting you with any inquiries regarding code or
other aspects. We have so many tutorials to get you started. Explore our documentation, kindly contact us on Twitter with a friendly 👋 , contact our support team.
Non-breaking changes
\nPayscribe regularly introduces backward-compatible changes to our API to provide additional product features and capabilities. Non-breaking changes may be introduced without prior warning to users of the Payscribe
API. Examples of non-breaking changes would be:
New API endpoints
\nAdditional new optional API request fields/parameters for existing endpoints
\nAdditional new optional HTTP headers in API requests for existing endpoints
\nAdditional new fields in API response for existing endpoints
\nAdditional HTTP headers in API response for existing endpoints
\nModification of text field values, for instance in error messages
\nIntroduction of new transaction statuses within a status class
\nIntroduction of new required fields linked to specific payers (list of required fields for a given payer is available by API, client
implementation should rely on API response to define whether a field is mandatory)
Increasing length of existing text fields in API requests
\nAdding new fields in callback endpoints
\nThe client implementation should be designed with the above in mind, so that non-breaking changes do not adversely affect the implementation.
\nA breaking change refers to a change that requires an application
update to continue working with the API. Examples of breaking changes
would be:
Removing or renaming an API endpoint
\nChanging the accepted values for an API request fields
\nAdding new mandatory field to an API request body, outside of information required for processing a transaction
\nChange in an API response structure (renaming of fields)
\nWhenever possible, a new major version will be introduced if a
breaking change is introduced. In the event that a breaking change is
unavoidable and a new major version in not possible (e.g., change in regulation, compliance) Payscribe will contact clients in advance to ensure there is sufficient time to update the client’s application.
How to Get started
\nCreate an account on Payscribe and complete your KYC, this literally should take less than 5 minutes. You will also have access the sandbox web app, where you can have a full understanding of your integration and Payscribe ecosystem
\nAfter then your profile setting page on payscribe.ng to get the token.
\nIf you will be needing technical support to integrate the API or more requests, kindly use the Contact form sending us a mail in respect to your request, and we would be glad to work with you
\nAt Developers Hub you will find useful resources such as tutorials and SDKs for your choice of language.
\nBe conscious of the Token, replace it with the token you generated on your profile page
\n200 = Success
\n201 = Transaction Pending - Reverify using Payscribe trans_id or the ref passed
\n400 = Bad Request, Something missing in your body request
\n401 = User not authenticated
\n403 = Forbidden request, Contact Support
\n404 = Page Not found
\n405 = Duplicate Transaction
\n406 = Missing Required Information, Please check that you have provided all mandatory information
\n407 = Invalid product code/token
\n408 = Result Not Found
\n409 = Invalid Amount to process. Transaction Limit
\n410 = Insufficient money in your wallet
\n434 = General Operator Side Error, Transaction Failed
\n435 = General Database Error, Transaction Failed
\n5xx = Some server-side error
\nPlease if you have any challenge/suggestion with the API kindly send us a mail hello@payscribe.ng
\nUse webhooks to get notified about transaction events that happen in your Payscribe account.
\nWhat is a Webhook
\nA WebHook is an HTTP callback: an HTTP POST that occurs when something happens; a simple event-notification via HTTP POST. A web application implementing WebHooks will POST a message to a URL when certain things happen.
\nIn Payscribe you can setup webhooks that would let us notify you anytime events. Please note that you will find webhooks folder in each section of your integration.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7369921","collectionId":"ee255f43-2394-447b-b30e-17ddd0e799fb","publishedId":"2sA3e1Bpuc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-07T16:36:20.000Z"},"item":[{"name":"Bills Payments API","item":[{"name":"Cable TV Subscription","item":[{"name":"Fetch Bouquets","id":"cd2c0aad-3831-47da-b3d9-1ca68a0b9ecc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":""},"url":"https://sandbox.payscribe.ng/api/v1/bouquets?service=dstv","description":"Fetch the bouquet plan for later use. You can save the bouquet id.
\nPlease note: once there is an update in the pricing of these service providers it may require that you fetch this bouquets plan again.
\n","urlObject":{"host":["https://sandbox.payscribe.ng/api/v1/bouquets"],"query":[{"key":"service","value":"dstv"}],"variable":[]}},"response":[{"id":"d513edfe-ffde-4ee8-bdaa-b1b98c8e326b","name":"Showmax - Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://sandbox.payscribe.ng/api/v1//bouquets/?service=dstvshowmax","host":["https://sandbox.payscribe.ng/api/v1/"],"path":["bouquets",""],"query":[{"key":"service","value":"dstvshowmax"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.1.29"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"access-control-allow-origin","value":"http://localhost:3000"},{"key":"content-length","value":"2322"},{"key":"date","value":"Tue, 25 Jun 2024 10:34:39 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"DSTVSHOWMAX lookup successfully.\",\n \"message\": {\n \"details\": [\n {\n \"id\": \"U2RzQlhnZE5QYUFDcnViYVNvSDN5QT09\",\n \"name\": \"Showmax for 1 month - 1\",\n \"alias\": \"full_1\",\n \"amount\": 2900,\n \"priceOptions\": []\n },\n {\n \"id\": \"OEUzZTZBZTJLSFFTQUNOT0FoZm55Zz09\",\n \"name\": \"Showmax Mobile for 1 month - 1\",\n \"alias\": \"mobile_only_1\",\n \"amount\": 1200,\n \"priceOptions\": []\n },\n {\n \"id\": \"VU5HbFBCVDJibmJwNE1lc0hvRDRRQT09\",\n \"name\": \"Showmax Mobile for 3 months - 3\",\n \"alias\": \"mobile_only_3\",\n \"amount\": 2499,\n \"priceOptions\": []\n },\n {\n \"id\": \"K1pUaDVVQy9aNXNMeXpHODdGM3hvUT09\",\n \"name\": \"Showmax Pro Mobile for 1 month - 1\",\n \"alias\": \"sports_mobile_only_1\",\n \"amount\": 3200,\n \"priceOptions\": []\n },\n {\n \"id\": \"TCtOMkphY1RDQzNDckN6a2RzSUtQZz09\",\n \"name\": \"Showmax Mobile for 6 months - 6\",\n \"alias\": \"mobile_only_6\",\n \"amount\": 4299,\n \"priceOptions\": []\n },\n {\n \"id\": \"YmJjTzEzQkFVK3plZmNLOXlQcWRpUT09\",\n \"name\": \"Showmax for 3 months - 3\",\n \"alias\": \"full_3\",\n \"amount\": 5999,\n \"priceOptions\": []\n },\n {\n \"id\": \"SzBDU082dGF5TStmdExGU0hodVJPdz09\",\n \"name\": \"Showmax Pro for 1 month - 1\",\n \"alias\": \"sports_full_1\",\n \"amount\": 6300,\n \"priceOptions\": []\n },\n {\n \"id\": \"VUp4dy9JV0JRb2c0a0RGbGVTZWhXZz09\",\n \"name\": \"Showmax Mobile for 12 months - 12\",\n \"alias\": \"mobile_only_12\",\n \"amount\": 7200,\n \"priceOptions\": []\n },\n {\n \"id\": \"M3kwLzVGakt1Y2pMMTBhRTgybUFJUT09\",\n \"name\": \"Showmax Pro Mobile for 3 months - 3\",\n \"alias\": \"sports_mobile_only_3\",\n \"amount\": 9600,\n \"priceOptions\": []\n },\n {\n \"id\": \"ZlRmQjhJT3UrU1dLb0kxOVpPTjB5QT09\",\n \"name\": \"Showmax for 6 months - 6\",\n \"alias\": \"full_6\",\n \"amount\": 10400,\n \"priceOptions\": []\n },\n {\n \"id\": \"NXFCUzlZeTF0cEJ3STI4U0UwL2VRUT09\",\n \"name\": \"Showmax for 12 months - 12\",\n \"alias\": \"full_12:\",\n \"amount\": 17400,\n \"priceOptions\": []\n },\n {\n \"id\": \"TXhRQVNIdHEybDJMY1o0cGhNaldXUT09\",\n \"name\": \"Showmax Pro for 3 months - 3\",\n \"alias\": \"sports_full_3\",\n \"amount\": 18900,\n \"priceOptions\": []\n },\n {\n \"id\": \"Nk1RWmoxYjNsTEFrT0U2L25nekpUdz09\",\n \"name\": \"Showmax Pro Mobile for 6 months - 6\",\n \"alias\": \"sports_mobile_only_6\",\n \"amount\": 19200,\n \"priceOptions\": []\n },\n {\n \"id\": \"MXdMV25MOXFLREYzVitzTUFVZEFqUT09\",\n \"name\": \"Showmax Pro for 6 months - 6\",\n \"alias\": \"sports_full_6\",\n \"amount\": 37800,\n \"priceOptions\": []\n },\n {\n \"id\": \"S3EwM1VwaGJYODhZMWpMMVA5M0VxZz09\",\n \"name\": \"Showmax Pro Mobile for 12 months - 12\",\n \"alias\": \"sports_mobile_only_12\",\n \"amount\": 38400,\n \"priceOptions\": []\n },\n {\n \"id\": \"QzlyaWJqT0piYmYzSytNQnhQTmxCQT09\",\n \"name\": \"Showmax Pro for 12 months - 12\",\n \"alias\": \"sports_full_12\",\n \"amount\": 75600,\n \"priceOptions\": []\n }\n ]\n },\n \"status_code\": 200\n}"},{"id":"041419d0-c4b4-407e-ab41-466c4f9e1967","name":"Startimes - Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://sandbox.payscribe.ng/api/v1//bouquets/?service=startimes","host":["https://sandbox.payscribe.ng/api/v1/"],"path":["bouquets",""],"query":[{"key":"service","value":"startimes"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.1.29"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"access-control-allow-origin","value":"http://localhost:3000"},{"key":"content-length","value":"2536"},{"key":"date","value":"Tue, 25 Jun 2024 10:35:20 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"STARTIMES lookup successfully.\",\n \"message\": {\n \"details\": [\n {\n \"id\": \"RS9qbHVnZzVNc3pKRzlieFdickluQT09\",\n \"name\": \"Basic (Antenna) - Weekly\",\n \"alias\": \"basicweek\",\n \"amount\": 1100,\n \"priceOptions\": []\n },\n {\n \"id\": \"RzVQUjVNUm40SVlLWnJBMmpjZlVNUT09\",\n \"name\": \"Nova (Dish) - Weekly\",\n \"alias\": \"novadishweek\",\n \"amount\": 600,\n \"priceOptions\": []\n },\n {\n \"id\": \"aUFnUDQ0TVJsWXd1eFdIVzBHYkxQZz09\",\n \"name\": \"Basic (Dish) - Weekly\",\n \"alias\": \"smartweek\",\n \"amount\": 1400,\n \"priceOptions\": []\n },\n {\n \"id\": \"TVRqdk5yYU1kdGpBa3ordzJsemdBQT09\",\n \"name\": \"Super (Dish) - Monthly\",\n \"alias\": \"super\",\n \"amount\": 8200,\n \"priceOptions\": []\n },\n {\n \"id\": \"aUJSaVVNMy9uWENLengwdWZtUHhvUT09\",\n \"name\": \"Super (Dish) - Weekly\",\n \"alias\": \"superweek\",\n \"amount\": 2800,\n \"priceOptions\": []\n },\n {\n \"id\": \"cEJVVjVyK05LY1hKMk5aOXluYXFhQT09\",\n \"name\": \"Classic (Antenna) - Weekly\",\n \"alias\": \"classicweek\",\n \"amount\": 1700,\n \"priceOptions\": []\n },\n {\n \"id\": \"YkhCeHlZeHFqRTkvdFdTRi94dTY4UT09\",\n \"name\": \"Nova (Antenna) - Weekly\",\n \"alias\": \"novaweek\",\n \"amount\": 500,\n \"priceOptions\": []\n },\n {\n \"id\": \"enNMNzZZV01OMXFwbERFZUFxZk4wZz09\",\n \"name\": \"Basic (Dish) - Monthly\",\n \"alias\": \"smart\",\n \"amount\": 4200,\n \"priceOptions\": []\n },\n {\n \"id\": \"T3NHTGkvMFJpTEh0NDhBQlJOQm44QT09\",\n \"name\": \"Nova (Antenna) - Monthly\",\n \"alias\": \"nova\",\n \"amount\": 1700,\n \"priceOptions\": []\n },\n {\n \"id\": \"b3hkOGFtaFBZMzE4dXFkNm8wTDRDUT09\",\n \"name\": \"Basic (Antenna) - Monthly\",\n \"alias\": \"basic\",\n \"amount\": 3300,\n \"priceOptions\": []\n },\n {\n \"id\": \"c09icm1XOGpqclUwbStxRTRLYWwvdz09\",\n \"name\": \"Super (Antenna) - Monthly\",\n \"alias\": \"super-antenna\",\n \"amount\": 8000,\n \"priceOptions\": []\n },\n {\n \"id\": \"UkM5THhGRTk1bUVtUWJSOFY5SmZXQT09\",\n \"name\": \"Super (Antenna) - Weekly\",\n \"alias\": \"superweek-antenna\",\n \"amount\": 2700,\n \"priceOptions\": []\n },\n {\n \"id\": \"QTA0SmdHMEZoUWZxMDBpNDlSc0xlQT09\",\n \"name\": \"Startimes Chinese (Dish) - Monthly\",\n \"alias\": \"chinese\",\n \"amount\": 16000,\n \"priceOptions\": []\n },\n {\n \"id\": \"c2ZjNlY2eGdGeFdqMTdrVDZRb3JWUT09\",\n \"name\": \"Nova (Dish) - Monthly\",\n \"alias\": \"novadish\",\n \"amount\": 1700,\n \"priceOptions\": []\n },\n {\n \"id\": \"ZFBNNUtMZUdwK1VEcXYxSlZlUGtrdz09\",\n \"name\": \"Classic (Antenna) - Monthly\",\n \"alias\": \"classic\",\n \"amount\": 5000,\n \"priceOptions\": []\n },\n {\n \"id\": \"M2ttTE9IaXUvRmZpcWpjeDAxUGRaUT09\",\n \"name\": \"Global (Dish) - Weekly\",\n \"alias\": \"global-dish-weekly\",\n \"amount\": 6000,\n \"priceOptions\": []\n },\n {\n \"id\": \"d1VQMVU4N1hsdnNsdWIvT25jQzlqQT09\",\n \"name\": \"Classic (Dish) - Monthly\",\n \"alias\": \"special\",\n \"amount\": 6200,\n \"priceOptions\": []\n },\n {\n \"id\": \"c0NmMGtRa0p6ZUlZUlhicmZZVlprZz09\",\n \"name\": \"Global (Dish) - Monthly\",\n \"alias\": \"global-dish\",\n \"amount\": 17000,\n \"priceOptions\": []\n },\n {\n \"id\": \"bDlUSmFpaUgzZkdDZ1Uzbld0QnVwQT09\",\n \"name\": \"Classic (Dish) - Weekly\",\n \"alias\": \"specialweek\",\n \"amount\": 2100,\n \"priceOptions\": []\n }\n ]\n },\n \"status_code\": 200\n}"},{"id":"696ffe0a-45b3-4893-bd99-782fcf106e14","name":"Gotv - success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://sandbox.payscribe.ng/api/v1//bouquets/?service=gotv","host":["https://sandbox.payscribe.ng/api/v1/"],"path":["bouquets",""],"query":[{"key":"service","value":"gotv"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.1.29"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"access-control-allow-origin","value":"http://localhost:3000"},{"key":"content-length","value":"1054"},{"key":"date","value":"Tue, 25 Jun 2024 10:36:04 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"GOTV lookup successfully.\",\n \"message\": {\n \"details\": [\n {\n \"id\": \"RGExckQyT1Zwc0hXMjI3UXhqMS9LZz09\",\n \"name\": \"GOtv Smallie - yearly\",\n \"alias\": \"GOLTANL\",\n \"amount\": 12300,\n \"priceOptions\": []\n },\n {\n \"id\": \"cnMyZUpYcGhLSUV1eWllOGhmTzF0dz09\",\n \"name\": \"GOtv Jolli Bouquet\",\n \"alias\": \"GOTVNJ2\",\n \"amount\": 4850,\n \"priceOptions\": []\n },\n {\n \"id\": \"UUwra1dKRWJpaWQxUEZPTW9YUDQ0QT09\",\n \"name\": \"GOtv Max\",\n \"alias\": \"GOTVMAX\",\n \"amount\": 7200,\n \"priceOptions\": []\n },\n {\n \"id\": \"T2NKUzNkY1ZVakIyNGJSVjRHZGpNUT09\",\n \"name\": \"GOtv Jinja Bouquet\",\n \"alias\": \"GOTVNJ1\",\n \"amount\": 3300,\n \"priceOptions\": []\n },\n {\n \"id\": \"dVhXUnpsenZhcTBWSmhwQWZUMHY1dz09\",\n \"name\": \"GOtv Supa\",\n \"alias\": \"GOTVSUPA\",\n \"amount\": 9600,\n \"priceOptions\": []\n },\n {\n \"id\": \"WWdHcERRS05zMmpBYUEvNHhteEpWdz09\",\n \"name\": \"GOtv Smallie - monthly\",\n \"alias\": \"GOHAN\",\n \"amount\": 1575,\n \"priceOptions\": []\n },\n {\n \"id\": \"NWZBN1ZUSkJadG0xY3BKZEEwNWpoQT09\",\n \"name\": \"GOtv Smallie - quarterly\",\n \"alias\": \"GOLITE\",\n \"amount\": 4175,\n \"priceOptions\": []\n },\n {\n \"id\": \"aldhSXorLzgwVVdydzFSZFdkcWtZdz09\",\n \"name\": \"GOtv Supa Plus\",\n \"alias\": \"GOTVSUPAPLUS\",\n \"amount\": 15700,\n \"priceOptions\": []\n }\n ]\n },\n \"status_code\": 200\n}"},{"id":"64e47959-a361-4aab-ac95-4b863dee48f1","name":"Dstv - Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://sandbox.payscribe.ng/api/v1//bouquets/?service=dstv","host":["https://sandbox.payscribe.ng/api/v1/"],"path":["bouquets",""],"query":[{"key":"service","value":"dstv"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.1.29"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"access-control-allow-origin","value":"http://localhost:3000"},{"key":"content-length","value":"7246"},{"key":"date","value":"Tue, 25 Jun 2024 10:36:48 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"DSTV lookup successfully.\",\n \"message\": {\n \"details\": [\n {\n \"id\": \"a3pTUkk3Y2pJM3E5VTIxajdwbWVTQT09\",\n \"name\": \"DStv Yanga Bouquet E36 + HDPVR/XtraView\",\n \"alias\": \"NNJ1E36\",\n \"amount\": 10100,\n \"priceOptions\": []\n },\n {\n \"id\": \"cklmYzI3RzY2aVQ3L0xjMTM1Qkd3Zz09\",\n \"name\": \"DStv Yanga Bouquet E36\",\n \"alias\": \"NNJ1E36\",\n \"amount\": 5100,\n \"priceOptions\": []\n },\n {\n \"id\": \"R3dzU3BGdFdENzVqWVB2QnhqRjl1Zz09\",\n \"name\": \"DStv Premium Asia + HDPVR/XtraView\",\n \"alias\": \"PRWASIE36\",\n \"amount\": 47000,\n \"priceOptions\": []\n },\n {\n \"id\": \"ejFuT2FSTXErSzMwT0JVNnlVbElQZz09\",\n \"name\": \"DStv Premium Asia\",\n \"alias\": \"PRWASIE36\",\n \"amount\": 42000,\n \"priceOptions\": []\n },\n {\n \"id\": \"amRMUDBOa05pYkV1VXNiMmpqUmFnZz09\",\n \"name\": \"Padi + HDPVR/XtraView\",\n \"alias\": \"NLTESE36\",\n \"amount\": 8600,\n \"priceOptions\": []\n },\n {\n \"id\": \"RWpqNXRDckJTNHVpeUN3QU11dlM2QT09\",\n \"name\": \"Padi\",\n \"alias\": \"NLTESE36\",\n \"amount\": 3600,\n \"priceOptions\": []\n },\n {\n \"id\": \"NU1QaVhpMG1PWlUzT2pvK2pBQVVYQT09\",\n \"name\": \"DStv Confam Bouquet E36 + HDPVR/XtraView\",\n \"alias\": \"NNJ2E36\",\n \"amount\": 14300,\n \"priceOptions\": []\n },\n {\n \"id\": \"TnpRK0N5Z2hwbElEa0srdjJXQnBUdz09\",\n \"name\": \"DStv Confam Bouquet E36\",\n \"alias\": \"NNJ2E36\",\n \"amount\": 9300,\n \"priceOptions\": []\n },\n {\n \"id\": \"STc5enQvSVBab2RXR1J0ZU80bkhrQT09\",\n \"name\": \"DStv Premium + HDPVR/XtraView\",\n \"alias\": \"PRWE36\",\n \"amount\": 42000,\n \"priceOptions\": []\n },\n {\n \"id\": \"TnNSdkxhdVdmMG1SUTBaajVIOGhYQT09\",\n \"name\": \"DStv Premium\",\n \"alias\": \"PRWE36\",\n \"amount\": 37000,\n \"priceOptions\": []\n },\n {\n \"id\": \"cTRIZmpEQldTelhoZFdhYmd4UkhGdz09\",\n \"name\": \"DStv Premium French + HDPVR/XtraView\",\n \"alias\": \"PRWFRNSE36\",\n \"amount\": 62500,\n \"priceOptions\": []\n },\n {\n \"id\": \"VFFnRWo1MWRPTGpoZWZNU3Ric2lvQT09\",\n \"name\": \"DStv Premium French\",\n \"alias\": \"PRWFRNSE36\",\n \"amount\": 57500,\n \"priceOptions\": []\n },\n {\n \"id\": \"RDJhb0xweVR6VjNLY0kyT2hhWkVsQT09\",\n \"name\": \"DStv Compact + HDPVR/XtraView\",\n \"alias\": \"COMPE36\",\n \"amount\": 20700,\n \"priceOptions\": []\n },\n {\n \"id\": \"WDdqUUgrMVBtaFVOL0p2Wk01dm5SUT09\",\n \"name\": \"DStv Compact\",\n \"alias\": \"COMPE36\",\n \"amount\": 15700,\n \"priceOptions\": []\n },\n {\n \"id\": \"Z0llZkdQOVlFUGFFMGhGd3g1OVE5QT09\",\n \"name\": \"Asian Bouqet + HDPVR/XtraView\",\n \"alias\": \"ASIAE36\",\n \"amount\": 17400,\n \"priceOptions\": []\n },\n {\n \"id\": \"ZFVYMi9lTmY0Vy96QVFsRlJiK0ZhUT09\",\n \"name\": \"Asian Bouqet\",\n \"alias\": \"ASIAE36\",\n \"amount\": 12400,\n \"priceOptions\": []\n },\n {\n \"id\": \"RjBGeHE2bkRSUkNTVUZCRUlGblNhdz09\",\n \"name\": \"DStv Compact Plus + HDPVR/XtraView\",\n \"alias\": \"COMPLE36\",\n \"amount\": 30000,\n \"priceOptions\": []\n },\n {\n \"id\": \"VmFrcm9tQW9JcHNmTFJhS093VFE5QT09\",\n \"name\": \"DStv Compact Plus\",\n \"alias\": \"COMPLE36\",\n \"amount\": 25000,\n \"priceOptions\": []\n },\n {\n \"id\": \"YWtpVUt0UGdDazFCeTFaTHRxMnZpZz09\",\n \"name\": \"DStv Premium W/Afr + French Bonus Bouquet E36 + Showmax + HDPVR/XtraView\",\n \"alias\": \"SHOWPRWFRNSE36\",\n \"amount\": 62500,\n \"priceOptions\": []\n },\n {\n \"id\": \"Z1lqTlErQUI2MDZvdVh5MHRlMCtPZz09\",\n \"name\": \"DStv Premium W/Afr + French Bonus Bouquet E36 + Showmax\",\n \"alias\": \"SHOWPRWFRNSE36\",\n \"amount\": 57500,\n \"priceOptions\": []\n },\n {\n \"id\": \"ZUlqdmMvVHRJTlJ4Nk5DejhIRldxUT09\",\n \"name\": \"ASIAE36 - Asian Bouquet E36 + Showmax + HDPVR/XtraView\",\n \"alias\": \"SHOWASIAE36\",\n \"amount\": 19900,\n \"priceOptions\": []\n },\n {\n \"id\": \"akU3bW9vbW5qYzFmaVU1YTV0T1lGQT09\",\n \"name\": \"ASIAE36 - Asian Bouquet E36 + Showmax\",\n \"alias\": \"SHOWASIAE36\",\n \"amount\": 14900,\n \"priceOptions\": []\n },\n {\n \"id\": \"dUxqVDJ4VG9UWXFHRDJ5RXA1NFRYdz09\",\n \"name\": \"DStv Padi Bouquet E36 + Showmax + HDPVR/XtraView\",\n \"alias\": \"SHOWNLTESE36\",\n \"amount\": 11100,\n \"priceOptions\": []\n },\n {\n \"id\": \"YmZ2ZnNLK0owRHdQWTd2N0p2UDRKdz09\",\n \"name\": \"DStv Padi Bouquet E36 + Showmax\",\n \"alias\": \"SHOWNLTESE36\",\n \"amount\": 6100,\n \"priceOptions\": []\n },\n {\n \"id\": \"Z3ZhUkEyaDV5clpyaWpxNzdGZGt6QT09\",\n \"name\": \"PRWASIE36-Premium W/Afr E36 + ASIAE36 + Showmax + HDPVR/XtraView\",\n \"alias\": \"SHOWPRWASIE36\",\n \"amount\": 32500,\n \"priceOptions\": []\n },\n {\n \"id\": \"Q2hQZUN3emthcVFjMTJVQTZJZnhEQT09\",\n \"name\": \"PRWASIE36-Premium W/Afr E36 + ASIAE36 + Showmax\",\n \"alias\": \"SHOWPRWASIE36\",\n \"amount\": 27500,\n \"priceOptions\": []\n },\n {\n \"id\": \"dVFGRVdXNW9FMllSblluM29aVDRzQT09\",\n \"name\": \"DStv Compact Bouquet E36 + Showmax + HDPVR/XtraView\",\n \"alias\": \"SHOWCOMPE36\",\n \"amount\": 22150,\n \"priceOptions\": []\n },\n {\n \"id\": \"bzNqS04yWngyd0k4UHB6T1FQRHFRQT09\",\n \"name\": \"DStv Compact Bouquet E36 + Showmax\",\n \"alias\": \"SHOWCOMPE36\",\n \"amount\": 17150,\n \"priceOptions\": []\n },\n {\n \"id\": \"T3JETjIrWlJMM1hBekFNbjArR2pSUT09\",\n \"name\": \"DStv Prestige + HDPVR/XtraView\",\n \"alias\": \"PRESTIGENGE36\",\n \"amount\": 855000,\n \"priceOptions\": []\n },\n {\n \"id\": \"aXdOZGE0VmE3eGFITjRZbGd6SElDUT09\",\n \"name\": \"DStv Prestige\",\n \"alias\": \"PRESTIGENGE36\",\n \"amount\": 850000,\n \"priceOptions\": []\n },\n {\n \"id\": \"K3FGMG5wS0x0eXVuSkMyUXdJcm1JQT09\",\n \"name\": \"DStv Comfam Bouquet E36 + Showmax + HDPVR/XtraView\",\n \"alias\": \"SHOWNNJ2E36\",\n \"amount\": 15750,\n \"priceOptions\": []\n },\n {\n \"id\": \"dVdUZGJwMzRJT1NyaGt3em8xaEV5dz09\",\n \"name\": \"DStv Comfam Bouquet E36 + Showmax\",\n \"alias\": \"SHOWNNJ2E36\",\n \"amount\": 10750,\n \"priceOptions\": []\n },\n {\n \"id\": \"REhGTEh6N0pFU0pLNm5JZmk0THZRdz09\",\n \"name\": \"DStv Compact Plus Bouquet E36 + Showmax + HDPVR/XtraView\",\n \"alias\": \"SHOWCOMPLE36\",\n \"amount\": 31450,\n \"priceOptions\": []\n },\n {\n \"id\": \"SXQwM00xUlFLOTVmUk9HaENtT1M2QT09\",\n \"name\": \"DStv Compact Plus Bouquet E36 + Showmax\",\n \"alias\": \"SHOWCOMPLE36\",\n \"amount\": 26450,\n \"priceOptions\": []\n },\n {\n \"id\": \"eXpQNHNUVzkvZm5QOWdZYUtubGMzQT09\",\n \"name\": \"DStv Comfam Streaming Subscription + HDPVR/XtraView\",\n \"alias\": \"COMFAMOTT\",\n \"amount\": 14300,\n \"priceOptions\": []\n },\n {\n \"id\": \"K2lCZkY3eXBNQWxLZTcva1Q5WHJJQT09\",\n \"name\": \"DStv Comfam Streaming Subscription\",\n \"alias\": \"COMFAMOTT\",\n \"amount\": 9300,\n \"priceOptions\": []\n },\n {\n \"id\": \"SWpBMUVqdStoL2dIeFREeUhwYlJMUT09\",\n \"name\": \"DStv Yanga Bouquet E36 + Showmax + HDPVR/XtraView\",\n \"alias\": \"SHOWNNJ1E36\",\n \"amount\": 11550,\n \"priceOptions\": []\n },\n {\n \"id\": \"YXdibXNSUGJIdmhUR0I5QmhOSUhuZz09\",\n \"name\": \"DStv Yanga Bouquet E36 + Showmax\",\n \"alias\": \"SHOWNNJ1E36\",\n \"amount\": 6550,\n \"priceOptions\": []\n },\n {\n \"id\": \"bFlnejdybXBOaVhKNlBPNjN4OVF2dz09\",\n \"name\": \"DStv Premium W/Afr E36 + Showmax + HDPVR/XtraView\",\n \"alias\": \"SHOWPRWE36\",\n \"amount\": 42000,\n \"priceOptions\": []\n },\n {\n \"id\": \"aUZnR3VEOEpPUEV0UmJUOW54R2s1QT09\",\n \"name\": \"DStv Premium W/Afr E36 + Showmax\",\n \"alias\": \"SHOWPRWE36\",\n \"amount\": 37000,\n \"priceOptions\": []\n },\n {\n \"id\": \"ZVBTMGN5K0xoYzRtSG1KL1FjVjhqZz09\",\n \"name\": \"GWALLE36 - Great Wall Standalone Bouquet E36 + Showmax + HDPVR/XtraView\",\n \"alias\": \"SHOWGWALLE36\",\n \"amount\": 9950,\n \"priceOptions\": []\n },\n {\n \"id\": \"K2U2dU1Wd0NuSnMrYmpkNUNKTEhIQT09\",\n \"name\": \"GWALLE36 - Great Wall Standalone Bouquet E36 + Showmax\",\n \"alias\": \"SHOWGWALLE36\",\n \"amount\": 4950,\n \"priceOptions\": []\n },\n {\n \"id\": \"V3BoSmMrWmJoRFJpdUZ0NXBjdGNMZz09\",\n \"name\": \"DStv Compact Streaming Subscription + HDPVR/XtraView\",\n \"alias\": \"COMPOTT\",\n \"amount\": 20700,\n \"priceOptions\": []\n },\n {\n \"id\": \"RUwxbUZlSDd2L0FmVmxNN0lVd1JaZz09\",\n \"name\": \"DStv Compact Streaming Subscription\",\n \"alias\": \"COMPOTT\",\n \"amount\": 15700,\n \"priceOptions\": []\n },\n {\n \"id\": \"Z25oZnhqNkRLcDVDZ2d5Z3ZUa0NhZz09\",\n \"name\": \"DStv Compact Plus Streaming Subscription + HDPVR/XtraView\",\n \"alias\": \"COMPLSOTT\",\n \"amount\": 30000,\n \"priceOptions\": []\n },\n {\n \"id\": \"U0E2L016b3JaYlN2cDVPOFVmc3REQT09\",\n \"name\": \"DStv Compact Plus Streaming Subscription\",\n \"alias\": \"COMPLSOTT\",\n \"amount\": 25000,\n \"priceOptions\": []\n },\n {\n \"id\": \"SXNCN2NzRExpRmxGcnN1ajk0SkpKUT09\",\n \"name\": \"DStv Yanga OTT Streaming Subscription + HDPVR/XtraView\",\n \"alias\": \"YANGAOTT\",\n \"amount\": 10100,\n \"priceOptions\": []\n },\n {\n \"id\": \"K1dGb3o5UmtlL0x4T0UzbnVyOTBTdz09\",\n \"name\": \"DStv Yanga OTT Streaming Subscription\",\n \"alias\": \"YANGAOTT\",\n \"amount\": 5100,\n \"priceOptions\": []\n },\n {\n \"id\": \"SDRRaEMzeWtsRUQ0SWlwNzNyLzByQT09\",\n \"name\": \"DStv Premium Streaming Subscription + HDPVR/XtraView\",\n \"alias\": \"PREMOTT\",\n \"amount\": 42000,\n \"priceOptions\": []\n },\n {\n \"id\": \"MzdXM2Y1VjRyYU4xN2tsNkxvS3ZSZz09\",\n \"name\": \"DStv Premium Streaming Subscription\",\n \"alias\": \"PREMOTT\",\n \"amount\": 37000,\n \"priceOptions\": []\n }\n ]\n },\n \"status_code\": 200\n}"}],"_postman_id":"cd2c0aad-3831-47da-b3d9-1ca68a0b9ecc"},{"name":"Validate smart card number","id":"b8628dac-bce1-4414-bd64-76bfd88bb159","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\n \"service\": \"dstv\",\n \"account\": \"8062415043\",\n \"month\": 1,\n \"plan_id\" : \"RDJhb0xweVR6VjNLY0kyT2hhWkVsQT09\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/multichoice/validate","description":"Cable subscriptions are groped as 'multichoice'
\nValidate smart card number to get bouquet and customer details before vending.
\nA Sample Response Below
\n{\n \"status\": true,\n \"message\": {\n \"description\": \"STARTIMES validation Successful.\",\n \"details\": {\n \"customer_name\": \"Danny\",\n \"info\": {\n \"outstandingBalance\": null,\n \"accountNumber\": \"01467449322\",\n \"currentBouquet\": null,\n \"currentBouquetPlan\": null\n }\n }\n },\n \"status_code\": 200\n}jj\n\nThis endpoint is used to make a payment for GOTV, DSTV, or Startimes services.
\n{ \"plan_id\": \"\", \"customer_name\": \"\", \"account\": \"\", \"service\": \"\", \"ref\": \"\", \"phone\": \"\", \"email\": \"\", \"month\": 1}
\nplan_id (required, String): ID retrieved when you fetch the bouquets.
customer_name (required, String): Customer name obtained during validation.
account (required, String): The smart card number. For Startimes, this is the phone number.
service (required, String): Service provider (gotv, dstv, startimes, or dstvshowmax).
month (optional, Int): Number of months for subscription (default is 1).
ref (required, String): Your reference ID. Accepts alphanumeric characters and hyphens.
email (optional, String): Your customer email ID. We fallback to your account email if not passed
phone (optional, String): Your customer phone number. We fallback to your business pgone number if not passed
This endpoint is used to make a topup for DSTV/GOTV
\nFor example, if your customer is currently on DStv Confam - NGN9,300 and wants to upgrade to DStv Compact Plus -NGN25,000 he/she can now add available amount to complete the DsTV Compact subscription.
\nCable subscription
\nStartimes, DSTV, GOTV, and DSTV
\n","_postman_id":"f55a06dc-853b-4ada-82f2-b6ab3b40d458"},{"name":"Internet Subscription - Ntel,Spectranet...","item":[{"name":"List Internet Services","id":"62439899-515f-4678-87fb-a14b517fca28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\n \"type\": \"smile\",\n \"account\": \"1906003293\"\n}\n"},"url":"https://sandbox.payscribe.ng/api/v1/internet/list","description":"This endpoint is used to get the active internet subscription and its associated ids.
\nThe response of this request can be documented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"title\": {\n \"type\": \"string\"\n },\n \"active\": {\n \"type\": \"boolean\"\n }\n }\n }\n }\n }\n },\n \"status_code\": {\n \"type\": \"integer\"\n }\n }\n}\n\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"active\": true\n }\n ]\n },\n \"status_code\": 0\n}\n\nGet Sepectranet pins plan
\n","urlObject":{"path":["spectranet","pins","plans"],"host":["https://sandbox.payscribe.ng/api/v1/internet"],"query":[],"variable":[]}},"response":[{"id":"0aeb8bfe-ffdb-4ebd-bd60-c209dd358fa7","name":"List Internet Services Copy","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":""},"url":"https://sandbox.payscribe.ng/api/v1/}internet/spectranet/pins/plans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 20 Dec 2024 18:28:10 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization, X-Requested-With"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=rW7VECXKh6yMOMO6klFGazMp4fIyNBCB5RzCJcZBDPPmo7BbIPWbEdceDhXAad%2BwCWfbOoK%2FJyylmGultL7kK6u1RygJBxke4216XCB0wAJdGCABwBZYVnbTIHXHXDaoU04A\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f51b0c86952cd95-LHR"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=146774&min_rtt=138702&rtt_var=54830&sent=57&recv=55&lost=0&retrans=0&sent_bytes=4625&recv_bytes=1103&delivery_rate=28769&cwnd=255&unsent_bytes=0&cid=81c79ec3c4a9cc10&ts=58733&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Spectranet pins plans fetched\",\n \"message\": {\n \"details\": [\n {\n \"id\": \"PSPLAN_1274\",\n \"title\": \"SpecPlan_10000\",\n \"amount\": 10000\n },\n {\n \"id\": \"PSPLAN_1273\",\n \"title\": \"SpecPlan_7000\",\n \"amount\": 7000\n },\n {\n \"id\": \"PSPLAN_1272\",\n \"title\": \"SpecPlan_5000\",\n \"amount\": 5000\n },\n {\n \"id\": \"PSPLAN_1271\",\n \"title\": \"SpecPlan_1000\",\n \"amount\": 1000\n },\n {\n \"id\": \"PSPLAN_1270\",\n \"title\": \"SpecPlan_500\",\n \"amount\": 500\n }\n ]\n },\n \"status_code\": 200\n}"}],"_postman_id":"e22e946f-ca28-4652-8133-e141336cb3ca"},{"name":"Purchase Spectranet Pins","id":"13457852-b36a-4dc0-8cb4-e1e90d834094","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\n \"plan_id\": \"PSPLAN_1270\",\n \"qty\" : 1,\n \"ref\": \"d386a431-2282-4917-b911-333d563e2510\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/internet/spectranet/pins/vend","description":"This endpoint allows you to validate user's smart card and before purchasing a plan.
\nSample Response Below\narray(3) { [\"status\"]=> bool(true) [\"message\"]=> array(2) { [\"description\"]=> string(23) \" Validation Successful.\" [\"details\"]=> array(2) { [\"customer_name\"]=> string(18) \"Chika Mercy Nwaode\" [\"productCode\"]=> string(853) \"D7770DA3362C75F98353A54E6B0068AD91CB545F|eyJzZXJ2aWNlIjoic21pbGUiLCJjaGFubmVsIjoiQjJCIiwidHlwZSI6ImFjY291bnQiLCJhY2NvdW50IjoiMTUxMDAwMDkxOCIsImF1dGgiOnsiaXNzIjoiaXRleHZhcyIsInN1YiI6IjkxNjE4NjM1Iiwid2FsbGV0IjoiOTE2MTg2MzUiLCJ0ZXJtaW5hbCI6IjkxNjE4NjM1IiwidXNlcm5hbWUiOiJwaGlsbzR1MmNAZ21haWwuY29tIiwiaWRlbnRpZmllciI6Inplcm9uZXMiLCJrZXkiOiJhZTQ3YWI5NGMwZTIwNjUwYjMyODk2YjRhMzcxZDU2NiIsInZlbmRUeXBlIjoiQjJCIiwibW9kZSI6ImxpdmUiLCJlbWFpbCI6InBoaWxvNHUyY0BnbWFpbC5jb20iLCJmdWxsTmFtZSI6IlNva295YSBQaGlsaXAiLCJvcmdhbmlzYXRpb25Db2RlIjoiMDAxMDExMzIiLCJpYXQiOjE2Mzg3MDI5MzYsImV4cCI6MTYzODcxMDEzNn0sImVudmlyb25tZW50IjoibGl2ZSIsInN0YXJ0VGltZSI6MTYzODcwMjkzNy42Mzc5MTgsImVycm9yIjpmYWxzZSwibWVzc2FnZSI6IkN1c3RvbWVyIEZvdW5kIiwiY3VzdG9tZXJOYW1lIjoiQ2hpa2EgTWVyY3kgTndhb2RlICIsInJlc3BvbnNlQ29kZSI6IjAwIiwiZGVzY3JpcHRpb24iOiJDdXN0b21lciBWYWxpZGF0aW9uIFN1Y2Nlc3NmdWwifQ==\" } } [\"status_code\"]=> int(200) } \n\nInternet Subscription for Ntel, Spectranet...
\n","_postman_id":"88de290e-764d-42eb-aa7d-4cb35b2748fe"},{"name":"Data Bundle","item":[{"name":"Data Lookup","id":"73b792d2-0b46-4b4e-b798-58c9bb6aa7d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":""},"url":"https://sandbox.payscribe.ng/api/v1/data/lookup?network=airtel","description":"This endpoint retrieves data plans for a specific network.
\nnetwork (optional, String): This parameter specifies the network for which you want to lookup data plans. Accepted values are mtn, airtime, glo, or 9mobile, dstvshowmax
category (optional: String): Some network providers have different categories of data plan, the most common one are gifting, awoof, corporate, and sme. You can filter by passing the category you want
\nTo vend for ntel, spectranet, and other networks, please refer to the /internet page.
\nThe response will have a status code of 200 and a content type of application/json. The response body will contain the following fields:
\nstatus (Boolean): Indicates the status of the response.
description (String): Provides a description of the response.
message (Object): Contains details about the data plans for the specified network, including network name, title, network code, check balance, logo URL, and plans.
details (Array): Contains information about the network, including its name, title, code, balance check, logo URL, and available plans.
network_name (String): Name of the network.
title (String): Title of the network.
network_code (String): Code of the network.
check_balance (String): URL for checking balance.
logo_url (String): URL of the network's logo.
plans (Array): Contains details of the available data plans.
plan_code (String): Code of the plan.
name (String): Name of the plan.
alias (String): Alias of the plan.
amount (String): Amount of the plan.
Example Response Body:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": [\n {\n \"network_name\": \"\",\n \"title\": \"\",\n \"network_code\": \"\",\n \"check_balance\": \"\",\n \"logo_url\": \"\",\n \"plans\": [\n {\n \"plan_code\": \"\",\n \"name\": \"\",\n \"alias\": \"\",\n \"amount\": \"\"\n }\n ]\n }\n ]\n },\n \"status_code\": 0\n}\n\nPurchase data for Glo, Mtn, Airtel, 9mobile, DSTVsHOWMAX
\nIt is advisable to access the BASE_URL/data/lookup to get the updated plan_id and amount before vending for data.
recipient (required, String or Array of string): The phone number(s) you are sending the data to.
network (required, String): The network provider (mtn, glo, airtel, 9mobile, smile, dstvshowmax).
plan (required, String): The plan ID as seen when you did lookup.
ref (optional, String): Your transaction reference. Alphanumeric.
If vending for ntel, spectranet, etc., please check the /internet page.
\nThe response is in JSON format and follows the schema:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"processed\": [\n {\n \"number\": \"\",\n \"amount\": 0,\n \"id\": \"\",\n \"response\": \"\"\n }\n ],\n \"transaction_status\": \"\",\n \"amount\": 0,\n \"total_charge\": 0,\n \"discount\": 0,\n \"trans_id\": \"\",\n \"created_at\": \"\"\n }\n },\n \"status_code\": 0\n}\n\nData purchase - MTN, GLO, AIRTEL, 9MOBILE, SMILE AND
\n","_postman_id":"1baaa81d-f23f-423f-a895-15c2cbddd289"},{"name":"ePins (WAEC, NECO, UTME)...","item":[{"name":"Get Available ePins","id":"11094206-4305-4955-8cda-771a3b2d2b20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"url":"https://sandbox.payscribe.ng/api/v1/epins","description":"It is necessary to call this endpoint in other to check the availability of pins
\n","urlObject":{"host":["https://sandbox.payscribe.ng/api/v1/epins"],"query":[],"variable":[]}},"response":[{"id":"d72dc36d-add0-4d63-ad18-cfed826290e6","name":"Get Available ePins","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"url":"https://sandbox.payscribe.ng/api/v1/epins"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.1.29"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"access-control-allow-origin","value":"http://localhost:3000"},{"key":"content-length","value":"482"},{"key":"date","value":"Tue, 25 Jun 2024 20:45:50 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Epins lookup successfully.\",\n \"message\": {\n \"details\": [\n {\n \"name\": \"Educational Voucher\",\n \"collection\": [\n {\n \"id\": \"de\",\n \"name\": \"JAMB DE\",\n \"amount\": 6200,\n \"available\": 20\n },\n {\n \"id\": \"utme_mock\",\n \"name\": \"JAMB UTME MOCK\",\n \"amount\": 7700,\n \"available\": 20\n },\n {\n \"id\": \"utme\",\n \"name\": \"JAMB UTME\",\n \"amount\": 6200,\n \"available\": 20\n },\n {\n \"id\": \"neco\",\n \"name\": \"NECO Result Checker\",\n \"amount\": 1200,\n \"available\": 20\n },\n {\n \"id\": \"waec\",\n \"name\": \"WAEC Result Checker\",\n \"amount\": 3750,\n \"available\": 20\n }\n ]\n }\n ]\n },\n \"status_code\": 200\n}"}],"_postman_id":"11094206-4305-4955-8cda-771a3b2d2b20"},{"name":"Purchase ePin","id":"eec9a488-d7aa-4541-aab2-32f1e16b5986","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\n \"qty\": 1,\n \"id\": \"neco\",\n \"ref\": \"c6c428a2-7c75-4f42-81e3-cc5e148ff890\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/epins/vend","description":"Please note that some account and phone number is required when you are vending JAMB.
\n","urlObject":{"path":["vend"],"host":["https://sandbox.payscribe.ng/api/v1/epins"],"query":[],"variable":[]}},"response":[{"id":"b410d95f-4df5-475c-b7ae-027d8732290c","name":"Purchase ePin Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\n \"qty\": 1,\n \"id\": \"neco\",\n \"ref\": \"3f79f15e-43a8-4bd8-861a-d2e4a8279578\"\n}"},"url":"https://sandbox.payscribe.ng/api/v1/epins/vend"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.1.29"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"set-cookie","value":"ci_session=9pss02hcb84e205n32ds9872l96i4lgv; expires=Wed, 26-Jun-2024 12:39:08 GMT; Max-Age=7200; path=/; HttpOnly; SameSite=Lax; secure"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"access-control-allow-origin","value":"http://localhost:3000"},{"key":"content-length","value":"355"},{"key":"date","value":"Wed, 26 Jun 2024 10:39:10 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"ePin transaction successful\",\n \"message\": {\n \"details\": {\n \"trans_id\": \"41167f9a-4b80-4cb3-a10a-fe96b4596d15\",\n \"ref\": \"abd8ddfb-c285-4a9f-954e-56eb4fbb6b08\",\n \"qty\": 1,\n \"amount\": 1200,\n \"discount\": 0,\n \"total_charge\": 1200,\n \"title\": \"NECO Result Checker\",\n \"epins\": [\n {\n \"name\": \"NECO Result Checker\",\n \"pin\": \"979916271859\",\n \"serial\": \"\"\n }\n ]\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"eec9a488-d7aa-4541-aab2-32f1e16b5986"},{"name":"Jamb User Lookup","id":"91738d68-8e12-4779-9ddd-2e31defd37e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\n \"id\": 3,\n \"account\": \"9610729153\"\n}"},"url":"https://sandbox.payscribe.ng/api/v1//epins/jamb/user/lookup","description":"Lookup JAMB user details.
\n","urlObject":{"path":["epins","jamb","user","lookup"],"host":["https://sandbox.payscribe.ng/api/v1/"],"query":[],"variable":[]}},"response":[],"_postman_id":"91738d68-8e12-4779-9ddd-2e31defd37e9"},{"name":"Retrieve ePin","id":"d0b93d4a-e7ec-4908-847b-332609d66a8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"url":"https://sandbox.payscribe.ng/api/v1//epins/retrieve?trans_id=41167f9a-4b80-4cb3-a10a-fe96b4596d15","description":"You can fetch all generated ePins for a particular transaction using the transaction ID that we sent to you when you puchase.
\n","urlObject":{"path":["epins","retrieve"],"host":["https://sandbox.payscribe.ng/api/v1/"],"query":[{"key":"trans_id","value":"41167f9a-4b80-4cb3-a10a-fe96b4596d15"}],"variable":[]}},"response":[{"id":"6b1f9ab9-08f0-458e-ae7e-4c77ccff854a","name":"Retrieve ePin Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1//epins/retrieve?trans_id=41167f9a-4b80-4cb3-a10a-fe96b4596d15","host":["https://sandbox.payscribe.ng/api/v1/"],"path":["epins","retrieve"],"query":[{"key":"trans_id","value":"41167f9a-4b80-4cb3-a10a-fe96b4596d15"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.1.29"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"set-cookie","value":"ci_session=5p4qhlinpc55v924o8j41v38mmisljev; expires=Wed, 26-Jun-2024 14:15:30 GMT; Max-Age=7200; path=/; HttpOnly; SameSite=Lax; secure"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"access-control-allow-origin","value":"http://localhost:3000"},{"key":"content-length","value":"302"},{"key":"date","value":"Wed, 26 Jun 2024 12:15:32 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"ePin Fetched successful\",\n \"message\": {\n \"details\": {\n \"trans_id\": \"41167f9a-4b80-4cb3-a10a-fe96b4596d15\",\n \"ref\": \"abd8ddfb-c285-4a9f-954e-56eb4f\",\n \"qty\": 1,\n \"amount\": 1200,\n \"total_charge\": 1200,\n \"epins\": [\n {\n \"name\": \"NECO Result Checker\",\n \"pin\": \"979916271859\",\n \"serial\": \"\"\n }\n ]\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"d0b93d4a-e7ec-4908-847b-332609d66a8b"}],"id":"46c06681-3ab9-47a5-92b8-6366bbd35f6a","description":"ePins are educational vouchers such as WAEC, NECO, JAMB...
\n","_postman_id":"46c06681-3ab9-47a5-92b8-6366bbd35f6a"},{"name":"Airtime to Wallet","item":[{"name":"Airtime to wallet lookup","id":"d6d6b122-311c-456c-bd06-018170c628db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":""},"url":"https://sandbox.payscribe.ng/api/v1/airtime_to_wallet","description":"You need to get the available networks and our current rate before sending the airtime
\nPlease note that the wallet will only be credited when the airtime is received.
\n","urlObject":{"host":["https://sandbox.payscribe.ng/api/v1/airtime_to_wallet"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6d6b122-311c-456c-bd06-018170c628db"},{"name":"Process Airtime to Wallet","id":"fcd730a5-edd6-4702-9e03-0f41c6f420d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_live_b9a258625363b2a3863e45053da267134152cd5606029bcfe1a39e71e1f72c3c"}],"body":{"mode":"raw","raw":"{\n\t\"network\": \"mtn\",\n\t\"amount\" : \"1000\",\n\t\"phone_number\" : \"07038067493\",\n\t\"from\" : \"08169254598\",\n \"ref\": \"my-system-transaction-id\"\n}"},"url":"https://sandbox.payscribe.ng/api/v1/airtime_to_wallet/vend","description":"Airtime to wallet.
\nYour wallet will be credited once airtime is received
\nParameters
\nAirtime to wallet - Convert your excess airtime to wallet
\nPLEASE THIS ENDPOINTS IS CURRENTLY UNDERGOING MAINTENANCE. CHECK BACK LATER.
\n","_postman_id":"8d6c908d-838c-4ca3-a2cc-98765baf401b"},{"name":"Pay Electricity Bills","item":[{"name":"Validate Electricity","id":"2af899cd-1704-4137-acef-0d846f98a3fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\n\t\"meter_number\": \"0101340757\",\n\t\"meter_type\" : \"postpaid\",\n\t\"amount\" : \"30000\",\n\t\"service\" : \"ikedc\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/electricity/validate","description":"Validate electricity to get customer details
\nSample Response
\n{\n \"status\": true,\n \"message\": {\n \"description\": \"IKEDC validation Successful.\",\n \"details\": {\n \"customer_name\": \"TESTMETER1\",\n \"address\": \"ABULE - EGBA BU ABULE\",\n \"arrears\": 1500,\n \"can_vend\": true,\n \"product_code\": \"emN3eDVGOFRwa1ZYU2NtbW9FQTBsRko2MmlZK3NmNDkyQ3krR0JwaHNMMEE1VHlNcVZrQ1NRRXEzYlp4R3hpaA==\"\n }\n },\n \"status_code\": 200\n}\n\nMake payment
\n\n\nPlease take note, the details response may be more than these keys. It will contain lots of information when you go live.
\n
\n\nAlso take note of the status code; in rare cases you may have 201, i.e pending. You are requied to reverify the transaction after few minutes.
\n
\n\nAnd for Postpaid, you will not get any information in the details key.
\n
SAMPLE RESPONSE
\n{\n \"status\": true,\n \"message\": {\n \"description\": \"IKEDC Payment Successful.\",\n \"details\": {\n \"service\": \"IKEDC Electricity Payment\",\n \"name\": \"WILLIAMS OMOLAJA A\",\n \"token\": \"Success: Successful, CreditToken:20407750462183362839\",\n \"detail\": \"6 TOWOLAWI ST IKORODU (Arrears: 0.00)\",\n \"meter_type\": \"prepaid\",\n \"amount\": \"100\",\n \"ref\": \"|PS6ja16687661465807uBx\",\n \"trans_id\": \"PS6ja16687661465807uBx\"\n }\n },\n \"status_code\": 200\n}\n\nIn rare cases the transaction status may fall into 201 - Pending.
\nPlease you are advised to make a requery of the transaction, and this can ONLY be done once in a minute.
Request
\n\nThe trans_id can either be the generated transaction id that was generated by Payscribe or the ref you passed to us when creating the transaction.
\n
Method: GET
\nURL: https://sandbox.payscribe.ng/api/v1//requery/?trans_id=dd866390-5226-4392-9283-3d4af5321034
Our API covers the following electricity distribution in Nigeria.
Ikeja (ikedc) API endpoint, Eko (ekedc) API endpoint, Ibadan (ibedc) API endpoint, Abuja (aedc) endpoint, Porthacourt (phedc) API endpoint, Kaduna (kedco) API endpoint, Enugu (eedc) API endpoint.
When calling the electricity API, kindly make use of the service short name as the endpoint For example to validate for Ikeja electricity, the short name is ikedc.
\nPlease note, we keep adding more discos, all you have to do is to use the short name even if you don't find it on this list.
\nIKEDC Covers the following cities in Lagos
\nAbule Egba, Akowonjo, Ikeja, Ikorodu, Oshodi and Shomolu
\n*EKEDC Covers the following:*
\nSouthern Lagos State (Ojo, Festac, Ijora, Mushin (also covers Orile
areas), Apapa, Lekki (also covers Ibeju areas), Lagos Island (also
covers Ajele areas) & part of Ogun State (Agbara)
*AEDC Covers the following*
\nFederal Capital Territory, Niger State, Kogi State, and Nassarawa State.
\n*EEDC Covers*
\nfive(5) states in the South East geo-political Zone, namely: Abia, Anambra, Ebonyi, Enugu and Imo State.
\n*IBEDC Covers*
\nlargest franchise area in Nigeria, made up of Oyo, Ogun, Osun, Kwara and parts of Niger, Ekiti and Kogi States.
\n*PHED Covers*
\nAkwa Ibom, Bayelsa, Cross Rivers, Rivers, and parts of Delta States in Nigeria's industrial south-south zone.
\n","_postman_id":"45ece1ed-ce09-43d6-a790-370a9fce9ea8"},{"name":"Bulk SMS","item":[{"name":"Send Bulk SMS","id":"45034823-7dc9-411a-bbff-2e3f4139d8e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\n\t\"to\": \"08169254598\",\n\t\"message\" : \"Hello Payscribe! Thank you.\",\n \"ref\": \"dee54f15-6e8f-4265-9a10-a8448bbba35f\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/sms","description":"Send Bulk SMS
\nPlease note that SMS does not deliver to MTN within 9PM to 8AM
\n","urlObject":{"host":["https://sandbox.payscribe.ng/api/v1/sms"],"query":[],"variable":[]}},"response":[{"id":"16fc524c-2393-4f25-977b-60c2544eca8d","name":"Send Bulk SMS - Single Number","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\n\t\"to\": \"08169254598\",\n\t\"message\" : \"Hello Payscribe!\",\n \"ref\": \"5d2a40ca-b57f-49d1-8f9b-52c13d449214\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/sms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 24 Nov 2024 07:17:07 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=KP5PId3Z1LwIigQxLA3phW0FPTmy%2Bxl%2FATM5NQhD0YHnpJewDTSqxf7cQ7QTLmnSIOquaLFUpDlf%2BPOkD%2ByibBHoKQTA%2BL1UwrbeTO7qn1akEHQn1hlm9Vr5skMG015UiY9K2fgJgQ%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8e779e088d8f94d2-LHR"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=149591&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2812&recv_bytes=1112&delivery_rate=38767&cwnd=252&unsent_bytes=0&cid=b1b8fbf5bda60567&ts=1428&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Order received. Transaction in progress.\",\n \"message\": {\n \"details\": {\n \"processed\": [\n {\n \"message_id\": \"Pscribe\",\n \"recipient\": \"+2348169254598\",\n \"message\": \"Hello Payscribe!\",\n \"created_at\": \"2024-11-24 07:17:07\",\n \"status\": \"success\",\n \"page\": 1\n }\n ],\n \"transaction_status\": \"processing\",\n \"ref\": \"5593f2d8-959b-468b-bac6-3d3f8ef0ee49\",\n \"product\": \"sms\",\n \"amount\": 3.5,\n \"total_charge\": 3.5,\n \"discount\": 0,\n \"trans_id\": \"46cee824-14b8-48c1-9edb-cc57911ee35a\",\n \"created_at\": \"2024-11-24 07:17:07\"\n }\n },\n \"status_code\": 200\n}"},{"id":"446f3c71-3339-4956-b4b3-08d2680b7731","name":"Send Bulk SMS - Multiple numbers","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\n\t\"to\": [\"08169254598\", \"08169254598\"],\n\t\"message\" : \"Hello Payscribe!\",\n \"ref\": \"9f10e376-c9b5-44c3-a079-c6f10e1de00b\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/sms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 24 Nov 2024 07:18:30 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ci_session=1f2f0c36c6a5201268554f4b51ea1e2c1f556b28; expires=Sun, 24-Nov-2024 09:18:29 GMT; Max-Age=7200; path=/; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=%2F3KTCfWZh02NlrjutR0sDQLQhRiB9KVo8eVJlVYl1ypvMVQbsufkan%2B5yIMqYqHbAHRrvW2OiTlc%2F4x9SJMUAA5%2Fca3KdeBpryUKJ1WUrUutIwGtMcIjgDu5dosp0ALHIeIi7aYeWA%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8e77a00f3f9e6525-LHR"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=178018&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2811&recv_bytes=1129&delivery_rate=37046&cwnd=252&unsent_bytes=0&cid=973d16a57f435080&ts=1257&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Order received. Transaction in progress.\",\n \"message\": {\n \"details\": {\n \"processed\": [\n {\n \"message_id\": \"Pscribe\",\n \"recipient\": \"+2348169254598\",\n \"message\": \"Hello Payscribe!\",\n \"created_at\": \"2024-11-24 07:18:30\",\n \"status\": \"success\",\n \"page\": 1\n },\n {\n \"message_id\": \"Pscribe\",\n \"recipient\": \"+2348169254598\",\n \"message\": \"Hello Payscribe!\",\n \"created_at\": \"2024-11-24 07:18:30\",\n \"status\": \"success\",\n \"page\": 1\n }\n ],\n \"transaction_status\": \"processing\",\n \"ref\": \"f05ad267-d22e-4887-9a46-b13f88b193e2\",\n \"product\": \"sms\",\n \"amount\": 3.5,\n \"total_charge\": 7,\n \"discount\": 0,\n \"trans_id\": \"f5774453-d1f4-48f2-85b1-f77fe087cb3a\",\n \"created_at\": \"2024-11-24 07:18:30\"\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"45034823-7dc9-411a-bbff-2e3f4139d8e2"}],"id":"c66e4b2d-bef5-46f1-af7b-013e370c2f03","description":"Send Bulk SMS Endpoint
\n","_postman_id":"c66e4b2d-bef5-46f1-af7b-013e370c2f03"},{"name":"Fund Bet Wallet","item":[{"name":"Betting Service Provider List","id":"ea628c6b-6e57-4ce6-aef7-43c796f61160","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1/betting/list","description":"The HTTP GET request retrieves the list of available Gaming and Sport service providers from the specified base URL.
\nThe response for this request is a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"title\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n },\n \"status_code\": {\n \"type\": \"integer\"\n }\n }\n}\n\nLookup user details before vending.
\nThe response for this request can be represented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"account\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"status_code\": {\n \"type\": \"integer\"\n }\n }\n}\nAdd funds to user wallet based on the validated account ID.
\nbet_id (String, required): The bet ID obtained from validation.
\ncustomer_id (String, required): The valid User ID.
\ncustomer_name (String, required): The customer name obtained during validation.
\namount (Int, required): Minimum of NGN100, and maximum of NGN50,000./ transaction
\nref (String, required): Your transaction ID.
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"trans_id\": \"\",\n \"ref\": \"\",\n \"account\": \"\",\n \"bet_id\": \"\",\n \"created_at\": \"\"\n }\n },\n \"status_code\": 0\n}\n\nFund betting wallet.
\n","_postman_id":"cc127141-0447-41c6-a80b-9ea56a9e4f97"},{"name":"Airtime","item":[{"name":"Vend Airtime","id":"987f6bb2-4bc8-4455-9212-3f478a229789","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"network\": \"mtn\",\n \"amount\": 10,\n \"recipient\": \"08169254598\",\n \"ported\": false,\n \"ref\": \"ffd20222-8c46-431c-a7cb-c35348748e1b\"\n}"},"url":"https://sandbox.payscribe.ng/api/v1/airtime","description":"Purchase airtime (Glo, Mtn, Airtel, 9mobile)
\n","urlObject":{"host":["https://sandbox.payscribe.ng/api/v1/airtime"],"query":[],"variable":[]}},"response":[{"id":"c54481db-7cad-44a1-8f91-a7b930e5b047","name":"Vend Airtime - Single Purchase","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"network\": \"mtn\",\n \"amount\": 50,\n \"recipient\": \"08169254598\",\n \"ported\": false,\n \"ref\": \"my-system-transaction-id\"\n}"},"url":"https://sandbox.payscribe.ng/api/v1/airtime"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.1.29"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"access-control-allow-origin","value":"http://localhost:3000"},{"key":"content-length","value":"387"},{"key":"date","value":"Mon, 24 Jun 2024 20:27:13 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Order received. Transaction in progress.\",\n \"message\": {\n \"details\": {\n \"processed\": [\n {\n \"number\": \"08169254598\",\n \"amount\": 50,\n \"id\": \"b4363c05-a067-42b1-bfe7-deb895e162f0\",\n \"response\": \"\"\n }\n ],\n \"transaction_status\": \"processing\",\n \"amount\": 50,\n \"total_charge\": 50,\n \"discount\": 1.5,\n \"trans_id\": \"b4363c05-a067-42b1-bfe7-deb895e162f0\",\n \"created_at\": \"2024-06-24 20:27:13\"\n }\n },\n \"status_code\": 200\n}"},{"id":"bdd10351-ec97-4bfd-bec3-f1ee006f7c48","name":"Vend Airtime - Bulk Purchase","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"network\": \"mtn\",\n \"amount\": 50,\n \"recipient\": [\"08169254598\", \"08169254598\"],\n \"ported\": false,\n \"ref\": \"my-system-transaction-id-bulk\"\n}"},"url":"https://sandbox.payscribe.ng/api/v1/airtime"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.1.29"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"access-control-allow-origin","value":"http://localhost:3000"},{"key":"content-length","value":"481"},{"key":"date","value":"Mon, 24 Jun 2024 20:32:25 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Order received. Transaction in progress.\",\n \"message\": {\n \"details\": {\n \"processed\": [\n {\n \"number\": \"08169254598\",\n \"amount\": 50,\n \"id\": \"06fe72aa-efdc-4e12-8b72-4b6711fe3171\",\n \"response\": \"\"\n },\n {\n \"number\": \"08169254598\",\n \"amount\": 50,\n \"id\": \"06fe72aa-efdc-4e12-8b72-4b6711fe3171\",\n \"response\": \"\"\n }\n ],\n \"transaction_status\": \"processing\",\n \"amount\": 50,\n \"total_charge\": 100,\n \"discount\": 3,\n \"trans_id\": \"06fe72aa-efdc-4e12-8b72-4b6711fe3171\",\n \"created_at\": \"2024-06-24 20:32:25\"\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"987f6bb2-4bc8-4455-9212-3f478a229789"}],"id":"6b2ac403-2230-4ce1-b4c5-6c8f48ee89c1","description":"Here you will find endpoints on how to purchase Nigeria airtime. - MTN, Airtel, Glo, and 9mobile
\n","_postman_id":"6b2ac403-2230-4ce1-b4c5-6c8f48ee89c1"},{"name":"International Airtime/Data & Bills","item":[{"name":"Get International Bills countries","id":"95c0eb27-e1c9-4be6-aac9-ebaf42f3c7f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1/international-bills/countries","description":"The first step in vending any international bills is to get the country.
Please note, it is advisable that you save this response on the first all, to avoid API call limit on your account.
International bills providers
\nGet the providers of the country
\n","urlObject":{"path":["providers"],"host":["https://sandbox.payscribe.ng/api/v1/international-bills"],"query":[{"key":"iso","value":"GH"}],"variable":[]}},"response":[{"id":"4a737105-9a9c-4243-b3a3-9e0136b4fdcc","name":"Get International Bills Providers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1/international-bills/providers?iso=AF","host":["https://sandbox.payscribe.ng/api/v1/international-bills"],"path":["providers"],"query":[{"key":"iso","value":"AF"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.1.29"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"access-control-allow-origin","value":"http://localhost:3000"},{"key":"content-length","value":"936"},{"key":"date","value":"Thu, 27 Jun 2024 06:43:39 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Fetched successfully.\",\n \"message\": {\n \"details\": [\n {\n \"code\": \"RHAF\",\n \"name\": \"Roshan Afghanistan\",\n \"phone_regex\": \"^930?([0-9]{9})$\",\n \"logo_url\": \"https://app.payscribe.ng/assets/img/logos/RHAF.png\"\n },\n {\n \"code\": \"MTAF\",\n \"name\": \"MTN Afghanistan\",\n \"phone_regex\": \"^930?([0-9]{9})$\",\n \"logo_url\": \"https://app.payscribe.ng/assets/img/logos/MTAF.png\"\n },\n {\n \"code\": \"ETAF\",\n \"name\": \"Etisalat Afghanistan\",\n \"phone_regex\": \"^930?([0-9]{9})$\",\n \"logo_url\": \"https://app.payscribe.ng/assets/img/logos/ETAF.png\"\n },\n {\n \"code\": \"AWAF\",\n \"name\": \"AWCC Afghanistan\",\n \"phone_regex\": \"^930?([0-9]{9})$\",\n \"logo_url\": \"https://app.payscribe.ng/assets/img/logos/AWAF.png\"\n },\n {\n \"code\": \"AQAF\",\n \"name\": \"Salaam Afghanistan\",\n \"phone_regex\": \"^930?([0-9]{9})$\",\n \"logo_url\": \"https://app.payscribe.ng/assets/img/logos/AQAF.png\"\n },\n {\n \"code\": \"37AF\",\n \"name\": \"Afghan Telecom\",\n \"phone_regex\": \"^930?(20[0-9]{7})$\",\n \"logo_url\": \"https://app.payscribe.ng/assets/img/logos/37AF.png\"\n }\n ]\n },\n \"status_code\": 200\n}"}],"_postman_id":"8c4814ef-38ab-48b4-8323-9e83c988f587"},{"name":"Get International Bills Products","id":"91d07029-a866-4c7a-a93e-2e13b517ca4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1/international-bills/products?iso=GH&code=MTGH","description":"International bills products
\nGet the products of the respective country and provider
\nExplanation on the response you will get
\n","urlObject":{"path":["products"],"host":["https://sandbox.payscribe.ng/api/v1/international-bills"],"query":[{"key":"iso","value":"GH"},{"key":"code","value":"MTGH"}],"variable":[]}},"response":[{"id":"5ef84216-fec7-4462-a125-fbac42e1314e","name":"Get International Bills Products","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1/international-bills/products?iso=GH&code=MTGH","host":["https://sandbox.payscribe.ng/api/v1/international-bills"],"path":["products"],"query":[{"key":"iso","value":"GH"},{"key":"code","value":"MTGH"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Nov 2024 13:03:30 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization, X-Requested-With"},{"key":"Set-Cookie","value":"ci_session=6a7c5a9d48c6564aeac5aebacc00d8972f897dc0; expires=Fri, 29-Nov-2024 15:03:30 GMT; Max-Age=7200; path=/; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=dHYZiEG9gou2Yz1BSjL%2F4JKUoSAnEtiGeFH1UTXRqtZDpteGFIJksZQ1fgs6Uru09pdTNc4kbl94Bc0e5fpxFQclT8J9su5BJ9GLBLSJW9ENxKOgIqzRQDm%2BeHSBEgtyUoIM\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8ea2cc5528de6fa0-CDG"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=138813&min_rtt=102137&rtt_var=60242&sent=5&recv=7&lost=0&retrans=0&sent_bytes=2811&recv_bytes=760&delivery_rate=41113&cwnd=252&unsent_bytes=0&cid=a9f9c65a7232a1cb&ts=811&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Products variation fetched successfully.\",\n \"message\": {\n \"details\": [\n {\n \"sku\": \"GH_MT_TopUp\",\n \"uat\": \"233000000000\",\n \"country_iso\": \"GH\",\n \"provider_code\": \"MTGH\",\n \"display_text\": \"GHS 1.20-573.04\",\n \"min_send\": \"0.11\",\n \"max_send\": \"52.73\",\n \"min_receive\": \"1.2\",\n \"max_receive\": \"573.0\",\n \"receive_currency\": \"GHS\",\n \"send_currency\": \"USD\",\n \"lookup_required\": \"0\",\n \"vend_type\": \"range\",\n \"current_rate\": 1837.5\n }\n ]\n },\n \"status_code\": 200\n}"}],"_postman_id":"91d07029-a866-4c7a-a93e-2e13b517ca4d"},{"name":"Get Estimate Rate","id":"0e5c503a-9ec1-46a7-8a86-86a71866df08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer pk_live_key_ungkvvMePYxWoVqxGsqGTaSzvIvHL10","type":"text"},{"key":"Content-Type","value":"application/jsops_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1/international-bills/rate?iso=GH&sku=GH_MT_TopUp&amount=1.2","description":"International Estimate Rate
\nUse this endpoint to calculate how much we will charge from your wallet.
\nExplanation on the response you will get
\n","urlObject":{"path":["rate"],"host":["https://sandbox.payscribe.ng/api/v1/international-bills"],"query":[{"key":"iso","value":"GH"},{"key":"sku","value":"GH_MT_TopUp"},{"key":"amount","value":"1.2"}],"variable":[]}},"response":[{"id":"d428e318-4800-472b-9f8d-9fc4849c6ad8","name":"Get Estimate Rate","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1/international-bills/rate?iso=GH&sku=GH_MT_TopUp&amount=1.2","host":["https://sandbox.payscribe.ng/api/v1/international-bills"],"path":["rate"],"query":[{"key":"iso","value":"GH"},{"key":"sku","value":"GH_MT_TopUp"},{"key":"amount","value":"1.2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 18 Dec 2024 12:58:13 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=BWPuCjWDrfak6do64G4zeq4d4Er4XPGmkH%2BDpfjEZ%2FN2H3tSpWAkaNifIJ60aNP8rdwTbBnyVHhDGSdHT9LOnEfVAiQJOw8LWWv%2BbJ3tymeqcDWw%2FYzi0IOLdYfG3MOUm60U\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f3f52ac7ca7bebc-LHR"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=130874&min_rtt=130091&rtt_var=50351&sent=5&recv=5&lost=0&retrans=0&sent_bytes=2811&recv_bytes=773&delivery_rate=30361&cwnd=252&unsent_bytes=0&cid=2277aa707940b180&ts=2788&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": {\n \"description\": \"Rate lookup successfully.\",\n \"details\": {\n \"usd_rate\": 1778.589999999999918145476840436458587646484375, // 1 USD in NGN, You can use this to mockup how much you would charge your customer in NGN\n \"send_value\": 0.11000000000000000055511151231257827021181583404541015625,\n \"send_currency\": \"USD\",\n \"receive_value\": 1.1999999999999999555910790149937383830547332763671875,\n \"receive_currency\": \"GHS\"\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"0e5c503a-9ec1-46a7-8a86-86a71866df08"},{"name":"Vend International Bills","id":"93683047-5d0f-40c6-af5d-1473e4d16a65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"iso\": \"GH\",\r\n \"provider_code\": \"MTGH\",\r\n \"sku\": \"GH_MT_TopUp\",\r\n \"amount\": \"1.5\",\r\n \"account\": \"233547011800\",\r\n \"debit_currency\": \"ngn\", // This is optional. Default is USD\r\n \"ref\": \"5d252bc8-db86-45a2-9a6d-6e6ac2c1f214\"\r\n}"},"url":"https://sandbox.payscribe.ng/api/v1/international-bills/vend","description":"International Estimate Rate
\nUse this endpoint to process International bills
\n","urlObject":{"path":["vend"],"host":["https://sandbox.payscribe.ng/api/v1/international-bills"],"query":[],"variable":[]}},"response":[{"id":"6f2a3bf6-78b4-4945-93d4-e0dd1ac38164","name":"Vend International Bills","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"iso\": \"GH\",\r\n \"provider_code\": \"MTGH\",\r\n \"sku\": \"GH_MT_TopUp\",\r\n \"amount\": \"1.5\",\r\n \"account\": \"233547011800\",\r\n \"debit_currency\": \"ngn\", // This is optional. Default is USD\r\n \"ref\": \"59553f9e-5c03-4d54-8fb8-38215a846a09\"\r\n}"},"url":"https://sandbox.payscribe.ng/api/v1/international-bills/vend"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 18 Dec 2024 13:40:59 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization, X-Requested-With"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=L8HRzlsoTByIWXdYVqLOdoXIpfaP3oJO6KoOxmFz8TF9QY5Lrv4VeTRcZ%2BtYEVhLCvvs5JWKfkPbtWYVFVE%2BHorqc6eK0ic2snRphKoQnj3xOPsQ00NRuAWmc4k%2BXHITmXyZ\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8f3f911129301aff-AMS"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=140973&min_rtt=140226&rtt_var=54080&sent=5&recv=5&lost=0&retrans=0&sent_bytes=2810&recv_bytes=975&delivery_rate=28315&cwnd=252&unsent_bytes=0&cid=89a1632d3f8a8c0a&ts=12545&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Order received. Transaction successful. Usually takes less than 5 min\",\n \"message\": {\n \"details\": {\n \"processed\": 233547011800,\n \"transaction_status\": \"success\",\n \"amount\": 231.21670000000000300133251585066318511962890625,\n \"total_charge\": 231.219999999999998863131622783839702606201171875,\n \"discount\": 0,\n \"trans_id\": \"6369e2c2-1117-4b26-bc77-9abab758da0c\",\n \"datetime\": \"2024-12-18 14:40:59\",\n \"account\": 233547011800,\n \"country\": \"GH\",\n \"currency\": \"GHS\",\n \"sent\": \"0.13 USD\",\n \"receive\": \"1.41 GHS\"\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"93683047-5d0f-40c6-af5d-1473e4d16a65"}],"id":"2e339e10-93b5-4a14-b130-bd81be224ba3","description":"Here you will find endpoints on how to purchase airtime, internet data or pay bills in over 100+ countries.
\nPlease note that all transactions on this are charged in USD. you can check the current dollar rate for any amount you're vending using the /get estimate rate endpoint.
\n","_postman_id":"2e339e10-93b5-4a14-b130-bd81be224ba3"},{"name":"Bills Payment Webhook","item":[],"id":"15534a00-61ca-459c-a51e-33df49ec7dff","description":"Webhooks are used so that anytime an event occurs on your account, your application can be notified with instant, real-time notifications by Payscribe.
\nYou need to update your Test/Live webhook if you've not already done this.
\nLogin to your account (sandbox/live)
\nGo to your API Settings / Webhook.
\nIn the webhook URL field, enter your webhook URL.
\nPlease note,
\nThe webhook URL must be accessible.
\nAlways verify that you have not given customers value by implementing transaction checker to avoid double transactions.
\nSending WEBHOOK from our server IP: 162.254.34.78
\nHere is the flow - suggestion
\nGet the payload from Payscribe
\nSanitize the payload
\nVerify that this is not a duplicate webhook/transaction
\nIn most cases, Payscribe would send you two webhook payload for bills payment
\nWhen the transaction was initiated - bills.created
\nWhen the transaction status changed - bills.status, either from processing , pending to success or fail. Please note that, you won't get this second webhook for transactions that the transaction status has already come out to be success.
\nFirst Webhook Sent Sample Structure.
\n{
\"event_id\": \"e7b04d83-9d8f-40d5-afd3-69dc9958857c\",
\"event_type\": \"bills.created\",
\"processed\": [
{
\"number\": \"08143894199\",
\"amount\": 150,
\"id\": \"e7b04d83-9d8f-40d5-afd3-69dc9958857c\",
\"response\": \"\"
}
],
\"transaction_status\": \"processing\",
\"ref\": \"2025021514421ENDURANCEKS\",
\"category\": \"airtime\",
\"product\": \"mtn\",
\"amount\": 150,
\"total_charge\": 145.5,
\"discount\": 4.5,
\"trans_id\": \"e7b04d83-9d8f-40d5-afd3-69dc9958857c\",
\"created_at\": \"2025-02-15 14:04:27\"
}
Second Webhook Sent When Transaction Was Successful.
\n{
\"event_id\": \"e7b04d83-9d8f-40d5-afd3-69dc9958857c\",
\"event_type\": \"bills.status\",
\"processed\": [
{
\"number\": \"08143894199\",
\"amount\": 150,
\"id\": \"e7b04d83-9d8f-40d5-afd3-69dc9958857c\",
\"response\": \"\"
}
],
\"transaction_status\": \"success\",
\"ref\": \"2025021514421ENDURANCEKS\",
\"category\": \"airtime\",
\"product\": \"mtn\",
\"amount\": 150,
\"total_charge\": 145.5,
\"discount\": 4.5,
\"trans_id\": \"e7b04d83-9d8f-40d5-afd3-69dc9958857c\",
\"created_at\": \"2025-02-15 14:04:27\",
\"updated_at\": \"2025-02-15 14:04:39\",
\"remark\": \"You have topped up N150.00 to 2348143894199. \"
}
Leverage on Payscribe's local and international bills payments. In this section, you will have access to Airtime top-up - local and cross-border airtime ( Over 100+ countries, and 200+ service providers). Pay cable subscriptions, top-up electricity (prepaid and postpaid ). And so many...
\n","_postman_id":"338fee08-e88f-4014-b4fc-346fdb175d6f"},{"name":"My Account API.","item":[{"name":"Fetch Account Balances","id":"7c89a9fe-adaf-4f27-a58c-0d8dca8689a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/my-account/balances","description":"This endpoint is used to retrieve the account balances.
\nThis request does not require a request body.
\nstatus (boolean): Indicates the status of the response.
\ndescription (string): Provides additional information about the response.
\nmessage (object):
\nid (string): The ID associated with the account balance.
\ncurrency (string): The currency type.
\ncollection (number): The collection amount.
\navailable_balance (number): The available balance.
\naccount (string): The account details.
\ndetails (string): Additional details.
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": [\n {\n \"id\": \"\",\n \"currency\": \"\",\n \"collection\": 0,\n \"available_balance\": 0,\n \"account\": \"\",\n \"details\": \"\"\n }\n ]\n },\n \"status_code\": 0\n}\n\nThis example returned a 200 status code.
\n","urlObject":{"path":["balances"],"host":["https://sandbox.payscribe.ng/api/v1/my-account"],"query":[],"variable":[]}},"response":[{"id":"90b7cd44-4446-4534-a9b4-e43faf4d9395","name":"Fetch Account Balance","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990my-account/balances"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 28 Aug 2024 09:51:25 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Account balance fetched successfully.\",\n \"message\": {\n \"details\": [\n {\n \"id\": \"dytGVjE0QVhYUVZvSFhKVm5ZZ2kwQT09\",\n \"currency\": \"USD\",\n \"collection\": 0,\n \"available_balance\": 1,\n \"ledger\": 0,\n \"account\": [],\n \"details\": []\n },\n {\n \"id\": \"RTAva3dQTUFVT1RES01UYXNCcEtNdz09\",\n \"currency\": \"NGN\",\n \"collection\": 0,\n \"available_balance\": 40149.3499999999985448084771633148193359375,\n \"ledger\": 0,\n \"account\": [\n {\n \"bank\": \"Providus Bank\",\n \"account\": \"9984974765\"\n },\n {\n \"bank\": \"9 Payment Service Bank (9PSB)\",\n \"account\": \"5300009289\"\n }\n ],\n \"details\": []\n }\n ]\n },\n \"status_code\": 200\n}"}],"_postman_id":"7c89a9fe-adaf-4f27-a58c-0d8dca8689a7"}],"id":"82060ff4-6626-4648-9862-aa9263f9f6bb","description":"We are making it easy for you to have access to your account data without much need to always login to Payscribe web portal.
\nWith this endpoints you will be able to call your balances, chargebacks, settlements, refunds, analytics and lots more.
\n","_postman_id":"82060ff4-6626-4648-9862-aa9263f9f6bb"},{"name":"Payout API","item":[{"name":"Payout Endpoints","item":[{"name":"Bank List","id":"1f0bb2c1-7d75-454b-af05-0f50412d1667","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1/payouts/bank/list","description":"This endpoint retrieves the list of banks with their sort codes.
\nMethod: GET
\nURL: https://sandbox.payscribe.ng/api/v1/payouts/bank/list
country (optional, String): The country code. Defaults to NGN, the only available country code at the moment.Status: 200
\nContent-Type: application/json
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": [\n {\n \"code\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"status_code\": 0\n}\n\nThe response body includes a status field indicating the success status, a message field containing bank details such as code and name, and a status_code field for additional status information.
account: the account number you want to validate
\nbank: the bank sort code.
\nRequest Body
\n{\n \"account\": \"\",\n \"bank\": \"\"\n}\n\nResponse
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"account_number\": {\n \"type\": \"string\"\n },\n \"account_name\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"status_code\": {\n \"type\": \"integer\"\n }\n }\n}\n\nThis endpoint makes an HTTP GET request to retrieve the transaction fee for a specified amount and country.
\nThe response will be in JSON format with the following structure:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"amount\": 0,\n \"currency\": \"\",\n \"fee\": 0\n }\n },\n \"status_code\": 0\n}\n\nstatus (boolean): Indicates the success or failure of the request.
description (string): Additional information about the response.
message (object): Contains details about the transaction fee.
amount (number): The amount specified in the request.
currency (string): The currency for the transaction.
fee (number): The transaction fee charged.
Make transfer from your Payscribe wallet to bank
\nRequest Body
\namount: String (required) - The amount you are sending
\nbank: String (required) - The bank code you're sending to.
\naccount: String (required) - The recipient account number
\ncurrency: String (optional) - The currency of the transaction: Default is NGN
\nnarration: String (required) - Description of the transaction
\nref: String (required) - Reference for the transaction
\nResponse
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"trans_id\": {\n \"type\": \"string\"\n },\n \"ref\": {\n \"type\": \"string\"\n },\n \"amount\": {\n \"type\": \"number\"\n },\n \"fee\": {\n \"type\": \"number\"\n },\n \"total\": {\n \"type\": \"number\"\n },\n \"beneficiary\": {\n \"type\": \"object\",\n \"properties\": {\n \"bank\": {\n \"type\": \"string\"\n },\n \"account_number\": {\n \"type\": \"string\"\n },\n \"account_name\": {\n \"type\": \"string\"\n }\n }\n },\n \"currency\": {\n \"type\": \"string\"\n },\n \"narration\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"created_at\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"status_code\": {\n \"type\": \"number\"\n }\n }\n}\n\nThis endpoint is used to verify the status of a bank transfer by providing the transaction ID or your reference id in the URL path.
\nMethod: GET
\nURL: https://sandbox.payscribe.ng/api/v1/payouts/verify/63bdb0ea-9ffe-4542-aafc-dfd242fb6f58
The response will include the following fields:
\nstatus (boolean): Indicates the status of the verification.
description (string): Provides additional information about the verification status.
message (object): Contains details about the transaction, including:
trans_id (string): The transaction ID.
ref (string): The reference ID.
status (string): The status of the transaction.
created_at (string): The timestamp of the transaction creation.
bank_code (string): The bank code.
bank_name (string): The name of the bank.
account_name (string): The name of the account holder.
account_number (string): The account number.
currency (string): The currency used in the transaction.
status_code (integer): Indicates the status code of the response.
{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"trans_id\": \"\",\n \"ref\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"account_name\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\"\n }\n },\n \"status_code\": 0\n}\n\nThis example response indicates a successful verification with a status code of 200.
\n","urlObject":{"path":["verify","63bdb0ea-9ffe-4542-aafc-dfd242fb6f58"],"host":["https://sandbox.payscribe.ng/api/v1/payouts"],"query":[],"variable":[]}},"response":[{"id":"5d5d0c7a-150d-44da-a6e7-a75e3e06a4c0","name":"Verify Transfer","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1/payouts/verify/63bdb0ea-9ffe-4542-aafc-dfd242fb6f58"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 Jul 2024 20:43:37 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ci_session=76b3c7211e30a6741209a9214f479aa5f8e94370; expires=Wed, 17-Jul-2024 22:43:37 GMT; Max-Age=7200; path=/; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Transaction fetched\",\n \"message\": {\n \"details\": {\n \"trans_id\": \"63bdb0ea-9ffe-4542-aafc-dfd242fb6f58\",\n \"ref\": \"3831c2dc-b913-4e15-9347-79ce76\",\n \"status\": \"success\",\n \"created_at\": \"2024-07-17 16:57:42\",\n \"bank_code\": \"058\",\n \"bank_name\": \"Guaranty Trust Bank\",\n \"account_name\": \"SOKOYA ADENIJI PHILIP\",\n \"account_number\": \"0151820365\",\n \"currency\": \"ngn\"\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"f30bc93e-c8e8-4a04-93f1-d762ee25c242"}],"id":"3d1025a3-baf2-4079-9882-674737021cee","_postman_id":"3d1025a3-baf2-4079-9882-674737021cee","description":""},{"name":"Payout Webhooks","item":[],"id":"c988334a-d35b-4c38-80cc-a81b6c5dcd85","description":"Webhooks are used so that anytime an event occurs on your account, your application can be notified with instant, real-time notifications by Payscribe.
\nYou need to update your Test/Live webhook if you've not already done this.
\nLogin to your account (sandbox/live)
\nGo to your API Settings / Webhook.
\nIn the webhook URL field, enter your webhook URL.
\nPlease note,
\nThe webhook URL must be accessible.
\nAlways verify that you have not given customers value by implementing transaction checker to avoid double transactions.
\nSending WEBHOOK from our server IP: 162.254.34.78
\nHere is the flow - suggestion
\nGet the payload from Payscribe
\nSanitize the payload
\nVerify that this is not a duplicate webhook/transaction
\nSample Webhook Payload
\n{
\"event_id\": \"98a3a521-7bba-4303-b17c-6c361bc11638\",
\"event_type\": \"payouts.created\",
\"trans_id\": \"98a3a521-7bba-4303-b17c-6c361bc11638\",
\"ref\": \"c56a5c13-5bcb-407e-bc7d-f9a116dc8650\",
\"session_id\": \"090286250214220531592526426915\",
\"amount\": 136000,
\"fee\": 50,
\"total\": 136100,
\"beneficiary\": {
\"bank\": \"000023\",
\"bank_name\": \"PROVIDUS BANK\",
\"account_number\": \"5400956085\",
\"account_name\": \"My Account Name\"
},
\"currency\": \"ngn\",
\"narration\": \"Vcc\",
\"status\": \"success\",
\"created_at\": \"2025-02-14 23:05:33\"
}
Welcome to Payout API. This API allows you to send money from your Payscribe wallet to local commercial bank.
\n\n\n","_postman_id":"bdc595a6-3fe4-4bca-a450-1aca9208651c"},{"name":"Customers","item":[{"name":"Endpoints","item":[{"name":"Create Customer - Tier 0","event":[{"listen":"test","script":{"id":"a3049519-6ade-46ce-a571-37ac582a88fe","exec":["pm.test(\"Response status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Response is an object with status, message and status_code properties\", function () {\r"," pm.expect(pm.response.json()).to.be.an('object').that.has.all.keys('status', 'message', 'status_code');\r","});\r","\r","pm.test(\"Message description is a string\", function () {\r"," pm.expect(pm.response.json().message.description).to.be.a('string');\r","});\r","\r","pm.test(\"Message details is an object with specific properties\", function () {\r"," pm.expect(pm.response.json().message.details).to.be.an('object').that.has.all.keys('customer_id', 'first_name', 'last_name', 'email', 'phone', 'country', 'tier', 'date_created');\r","});\r","\r","pm.test(\"Status code is a number\", function () {\r"," pm.expect(pm.response.json().status_code).to.be.a('number');\r","});"],"type":"text/javascript","packages":{}}}],"id":"fa1fcd80-692f-4136-9b37-e6517485533f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"first_name\": \"Ford\",\r\n \"last_name\": \"Hagenes\",\r\n \"phone\": \"2347038067493\",\r\n \"email\": \"Marcelina_Kub62@example.net\",\r\n \"country\": \"NG\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/customers/create","description":"Please note that you must whitelist your IP address to have access to this service.
\n
This endpoint allows the creation of a new customer within the Payscribe ecosystem.
\nPlease note and save the customer_id in the response. This will be used in all out services.
\nStatus: 200
\nContent-Type: application/json
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"customer_id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"country\": \"\",\n \"tier\": 0,\n \"created_at\": \"\"\n }\n },\n \"status_code\": 0\n}\n\nThis endpoint is used to upgrade a customer to tier 1 in order to access services like Collections.
\ncustomer_id (String, required): The customer ID generated during customer creation.
dob (String, required): Customer date of birth in YYYY-MM-DD format. Some services are only valid for customers aged 18 years and above.
address (Object, required): Customer address object.
address.street (String, required): Valid customer street address. Only alphanumeric characters, dots, and commas are accepted.
address.city (String, required): The city of the customer's address.
address.state (String, required): The state of the customer's address.
address.country (String, required): The ISO country code, e.g., NG for Nigeria.
address.postal_code (String, required): The postal code of the customer's address.
identification_type (String, required): The type of government-issued identification, e.g., BVN for Nigeria.
identification_number (String, required): The identification number issued by a governing body, e.g., BVN for Nigeria.
photo (String, optional): The URL of the customer's photo.
\n\nPlease it is important you pass in a valid address, as this may be used as billing address when creating card
\n
{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"customer_id\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"status_code\": {\n \"type\": \"integer\"\n }\n }\n}\n\nThis endpoint is used to upgrade a customer to tier 2 in order to process services like Collections.
\ncustomer_id (String, required): The customer id that was generated when creating the customer.
identity (Object, required): An object of the customer identity.
type (String, required): Governmental identity type. For example, NIN, PASSPORT, VIN.
number (String, required): The identity number.
country (String, required): Country ISO where the identity was issued.
image (String, required): A clear image of the identity.
The response will be in JSON format with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"customer_id\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"status_code\": {\n \"type\": \"integer\"\n }\n }\n}\n\nThis endpoint allows you to create a customer, providing access to card creation and other services.
\nfirst_name (String, required): Customer's first name.last_name (String, required): Customer's last name.phone (String, required): Customer's phone number, with the country code prepended.email (String, required): Customer's email address.dob (String, required): Customer's date of birth in YYYY-MM-DD format.country (String, required): The customer's country code.address (Object, required): Customer's address object.street (String, required): Valid address of the customer (special characters not accepted).city (String, required): Address city.state (String, required): The address state.country (String, required): The country ISO for the address.postal_code (String, required): The address postal code.identification_type (String, required): The type of identification issued by a governing body (e.g., BVN for Nigeria).identification_number (String, required): An identification number issued by a governing body.photo (String, required): The customer's valid photo URL (must be accessible).identity (Object, required): Identity object.type (String, required): Governmental ID type (e.g., NIN, PASSPORT, VIN for Nigerians).number (String, required): The valid identity number.country (String, required): The country ISO where the identity was issued.image (String, required): The identity image URL.status (Boolean): Indicates the status of the request.description (String): Additional description of the response.message (Object): Details of the customer created.customer_id (String): The ID of the customer created.first_name (String): Customer's first name.last_name (String): Customer's last name.email (String): Customer's email address.phone (String): Customer's phone number.country (String): The customer's country.tier (Number): The tier of the customer.created_at (String): The date and time when the customer was created.status_code (Number): The status code of the response.Example Response:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"customer_id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"country\": \"\",\n \"tier\": 0,\n \"created_at\": \"\"\n }\n },\n \"status_code\": 0\n}\nThe response for this request can be represented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"customer_id\": {\n \"type\": \"string\"\n },\n \"first_name\": {\n \"type\": \"string\"\n },\n \"last_name\": {\n \"type\": \"string\"\n },\n \"phone\": {\n \"type\": \"string\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"dob\": {\n \"type\": \"string\"\n },\n \"identification_number\": {\n \"type\": [\"string\", \"null\"]\n },\n \"identity\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\"\n },\n \"number\": {\n \"type\": \"string\"\n },\n \"country\": {\n \"type\": \"string\"\n },\n \"image\": {\n \"type\": \"string\"\n }\n }\n },\n \"address\": {\n \"type\": \"object\",\n \"properties\": {\n \"street\": {\n \"type\": \"string\"\n },\n \"city\": {\n \"type\": \"string\"\n },\n \"state\": {\n \"type\": \"string\"\n },\n \"country\": {\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"type\": \"string\"\n }\n }\n },\n \"access\": {\n \"type\": \"object\",\n \"properties\": {\n \"can_create_card\": {\n \"type\": \"boolean\"\n },\n \"can_create_account\": {\n \"type\": \"boolean\"\n },\n \"can_save\": {\n \"type\": \"boolean\"\n }\n }\n },\n \"accounts\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"account\": {\n \"type\": \"string\"\n },\n \"currency\": {\n \"type\": \"string\"\n },\n \"bank\": {\n \"type\": \"string\"\n },\n \"account_type\": {\n \"type\": \"string\"\n },\n \"created_at\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n }\n }\n }\n },\n \"country\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"created_at\": {\n \"type\": \"string\"\n },\n \"updated_at\": {\n \"type\": \"string\"\n }\n }\n },\n \"status_code\": {\n \"type\": \"integer\"\n }\n }\n }\n }\n}\n\nThe response for this request can be represented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"customer_id\": {\n \"type\": \"string\"\n },\n \"first_name\": {\n \"type\": \"string\"\n },\n \"last_name\": {\n \"type\": \"string\"\n },\n \"phone\": {\n \"type\": \"string\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"dob\": {\n \"type\": \"string\"\n },\n \"identification_number\": {\n \"type\": [\"string\", \"null\"]\n },\n \"identity\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\"\n },\n \"number\": {\n \"type\": \"string\"\n },\n \"country\": {\n \"type\": \"string\"\n },\n \"image\": {\n \"type\": \"string\"\n }\n }\n },\n \"address\": {\n \"type\": \"object\",\n \"properties\": {\n \"street\": {\n \"type\": \"string\"\n },\n \"city\": {\n \"type\": \"string\"\n },\n \"state\": {\n \"type\": \"string\"\n },\n \"country\": {\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"type\": \"string\"\n }\n }\n },\n \"access\": {\n \"type\": \"object\",\n \"properties\": {\n \"can_create_card\": {\n \"type\": \"boolean\"\n },\n \"can_create_account\": {\n \"type\": \"boolean\"\n },\n \"can_save\": {\n \"type\": \"boolean\"\n }\n }\n },\n \"accounts\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"account\": {\n \"type\": \"string\"\n },\n \"currency\": {\n \"type\": \"string\"\n },\n \"bank\": {\n \"type\": \"string\"\n },\n \"account_type\": {\n \"type\": \"string\"\n },\n \"created_at\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n }\n }\n }\n },\n \"country\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"created_at\": {\n \"type\": \"string\"\n },\n \"updated_at\": {\n \"type\": \"string\"\n }\n }\n },\n \"status_code\": {\n \"type\": \"integer\"\n }\n }\n }\n }\n}\n\nThis endpoint allows you to add or remove a customer from the blacklist.
\ncustomer_id (String, required): The unique customer ID generated during customer creation.
blacklist (Boolean, required): Set to 1 to whitelist the customer, or 0 to blacklist the customer.
The response will contain the following fields:
\nstatus (Boolean): Indicates the status of the operation.
description (String): A description of the response.
message (Object): Details of the operation, including the customer_id.
status_code (Number): The status code of the response.
Request Body:
\n{\n \"customer_id\": \"**********\",\n \"blacklist\": true\n}\n\nResponse:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"customer_id\": \"**********\"\n }\n },\n \"status_code\": 0\n}\n\nThis endpoint allows you to fetch transactions for a specific customer.
\nstart_date (string, optional): The start date for filtering transactions.
\nend_date (string, optional): The end date for filtering transactions.
\nExample:
\n{\n \"start_date\": \"\",\n \"end_date\": \"\"\n}\n\nstatus (boolean): Indicates the status of the request.
\ndescription (string): A description of the response.
\nmessage (object): Details of the transactions.
\ntotal_count (number): Total count of transactions.
\ntransactions (array): Array of transaction details.
\ntrans_id (string): The ID of the transaction.
\nreference (string, null): The reference of the transaction.
\namount (string): The amount of the transaction.
\nfee (string): The fee of the transaction.
\ncurrency (string): The currency of the transaction.
\nservice (string): The service of the transaction.
\nservice_id (string): The ID of the service.
\ncreated_at (string): The creation date of the transaction.
\nstatus (string): The status of the transaction.
\nExample Response:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"total_count\": 0,\n \"transactions\": [\n {\n \"trans_id\": \"\",\n \"reference\": null,\n \"amount\": \"\",\n \"fee\": \"\",\n \"currency\": \"\",\n \"service\": \"\",\n \"service_id\": \"\",\n \"created_at\": \"\",\n \"status\": \"\"\n }\n ]\n }\n },\n \"status_code\": 0\n}\n\nThis endpoint retrieves a list of customers with optional filtering parameters. You can specify the page number, page size, start date, end date, and search criteria to get more accurate data.
\nThe response will be in JSON format with the following structure:
\nstatus (boolean): Indicates the status of the request.
\ndescription (string): Additional information about the response.
\nmessage (object): Details of the response message.
\ncustomers (array): An array of customer objects with their details.
\ncustomer_id (string): The unique identifier of the customer.
\nname (string): The name of the customer.
\nemail (string): The email address of the customer.
\nstatus (string): The status of the customer.
\ntotal (number): Total number of customers.
\npage (number): Current page number.
\npage_size (number): Number of customers per page.
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"customers\": [\n {\n \"customer_id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"\"\n }\n ],\n \"total\": 0,\n \"page\": 0,\n \"page_size\": 0\n }\n },\n \"status_code\": 0\n}\n\nCustomer Creation We hook Structure
\n{
\"customer_id\": \"873acf29-3f80-4464-b357-2081e4143c83\",
\"name\": \"Segun Sobowale .\",
\"email\": \"malom9iso290@yahoo.com\",
\"phone\": \"07029966679\",
\"country\": \"ng\",
\"address\": \"[]\",
\"identity\": \"[]\",
\"created_at\": \"2025-02-15 13:50:55\",
\"identification_type\": null,
\"identification_number\": null,
\"status\": \"active\",
\"event_id\": \"873acf29-3f89-4464-b357-2081e4143c83\",
\"event_type\": \"customers.created\"
}
Customer's Update Structure
\n{
\"event_id\": \"c5b511d1-b05d-4c43-a4d3-4469b1169097\",
\"event_type\": \"customers.update\",
\"customer_id\": \"873acf29-3f89-4064-b357-2081e4143c83\",
\"email\": \"malshhalo290@yahoo.com\",
\"status\": \"active\",
\"updated_at\": \"2025-02-15 13:50:55\"
}
This resource endpoints helps in creating and managing your customers. Its required for wallet account creation, card issue ...
\n","_postman_id":"487f88cb-8a60-499a-8280-b2df382d828c"},{"name":"Collections","item":[{"name":"Wallet System API","item":[{"name":"Create Order","id":"44cb1776-837f-46ff-8369-3c1999ed710e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\" : \"sokoyaphilip\",\r\n \"pin\": \"0522\",\r\n \"title\": \"Payment for 2 sneakers\",\r\n \"description\": \"Payment description...\",\r\n \"amount\": \"350.00\",\r\n \"currency\": \"ngn\",\r\n \"ref\": \"c8f00726-e76b-4648-9718-a64034112505\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/collections/wallet/create-order","description":"This endpoint is used to create a new order for wallet payment.
\nThe purpose of this request is to initiate a wallet payment order for a specific user.
\nThe request should include the following parameters in the raw request body:
\nusername: The username of the user initiating the payment, (payscribe email, or payscribe tag)
pin: The user's PIN for authentication
title: The title or purpose of the payment
description: A brief description of the payment, this is optional.
amount: The amount to be paid
currency: The currency in which the payment is to be made (e.g., \"ngn\" for Nigerian Naira, or USD )
ref: A unique reference for the transaction, such as a UUID
The response will have the following structure:
\nstatus: Indicates the success or failure of the request
description: Additional information about the status
message: Details of the order including ID, amount, creation and expiry timestamps, and user information
status_code: A code indicating the status of the request
{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"id\": \"\",\n \"amount\": 0,\n \"created_at\": \"\",\n \"expiry_at\": \"\",\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"username\": \"\",\n \"can_pay\": true\n }\n },\n \"status_code\": 0\n }\n}\n\nThis endpoint allows you to initiate a wallet payment using the Payscribe tag of the customer.
\nid (String, required): The creare order ID that was generated.
otp (String, required): The one-time password for verification.
Upon successful execution, the response will have a status code of 200 and a JSON object with the following structure:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"id\": \"\",\n \"ref\": \"\",\n \"amount\": 0,\n \"fee\": 0,\n \"customer\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currency\": \"\",\n \"created_at\": \"\"\n }\n },\n \"status_code\": 0\n}\n\nThe request requires appropriate authentication credentials to authorize the wallet payment transaction.
\n{\n \"payscribe\": \"sample_payscribe_tag\",\n \"amount\": 100,\n \"pin\": 1234,\n \"product\": \"Sample Product\",\n \"remark\": \"Sample Description\"\n}\n\nReceive Paymsnt using Payscribe Wallet-as-a-service.
\nThis endpoints allows you to receive payment from your customers that already has an account with Payscribe..
\n","_postman_id":"c3601c05-30a4-40af-8092-751255e47395"},{"name":"NGN Virtual Accounts","item":[{"name":"Create a Permanent Virtual Account","id":"850fe057-d73f-4f75-a28a-9e9380404243","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"account_type\": \"static\",\r\n \"currency\": \"NGN\",\r\n \"customer_id\": \"99a36c8b-c091-48af-8491-66048274cdfc\",\r\n \"bank\": [\"palmpay\"] // [\"9psb\", \"palmpay\"], [\"9psb\"]\r\n // \"identity_type\": \"nin\" // or bvn required for palmpay\r\n // \"identity_number\": \"2233990011\" // required for palmpay\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/collections/virtual-accounts/create","description":"This endpoint is used to create a virtual account.
\nMethod: POST
\nURL: https://sandbox.payscribe.ng/api/v1//collections/virtual-accounts/create
Body:
\naccount_type (string, required): The type of account to be created. Default is static
currency (string, optional): The currency for the virtual account. Default is NGN
customer (string, required): The customer id for whom the virtual account is being created.
bank (array, required): An array of banks associated with the virtual account.
bvn (string, optional): This is ONLY required when you are creating Palmpay virtual account, and the customer is in tier 0
\nThe endpoint makes an HTTP GET request to retrieve details of a virtual account with the provided ID. The response is a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"customer\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n },\n \"account\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"account_number\": {\n \"type\": \"string\"\n },\n \"account_name\": {\n \"type\": \"string\"\n },\n \"bank_name\": {\n \"type\": \"string\"\n },\n \"bank_code\": {\n \"type\": \"string\"\n },\n \"currency\": {\n \"type\": \"string\"\n },\n \"account_type\": {\n \"type\": \"string\"\n }\n }\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"created_at\": {\n \"type\": \"string\"\n },\n \"updated_at\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"status_code\": {\n \"type\": \"number\"\n }\n }\n}\n\nThis endpoint is used to deactivate a virtual account.
\nRequest Body
\naccount: (string) The account to be deactivated.Response
\nstatus: (boolean) Indicates the status of the deactivation.
description: (string) Description of the deactivation status.
message: (object) Details of the deactivation.
details: (object) Additional details of the deactivation.id: (string) The ID of the deactivated account.
account: (string) The deactivated account.
status: (string) The status of the deactivation.
updated_at: (string) The timestamp when the deactivation was updated.
Example Response:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"id\": \"\",\n \"account\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\"\n }\n },\n \"status_code\": 0\n}\n\nThis endpoint is used to activate a virtual account.
\naccount (string, required): The virtual account to be activated.The response is in JSON format and follows the schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"account\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"updated_at\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"status_code\": {\n \"type\": \"integer\"\n }\n }\n}\n\nThis endpoint allows you to create a dynamic virtual account.
\naccount_type (string, required): The type of the account.
ref (string, required): Reference for the account.
currency (string, required): The currency of the account.
order (object, required): Details of the order.
amount (number, required): The amount of the order.
amount_type (string, required): Type of the amount. This can be EXACT or ANY
- EXACT means that user must send in the exact amount else it should reject.
- ANY means user can either send exact, below or above the amount field
description (string, required): Description of the order.
expiry (object, required): Expiry details.
duration (number, required): Duration of the expiry.
duration_type (string, required): Type of the duration. which can only be hours or minute
customer (object, required): Customer details.
name (string, required): Name of the customer.
email (string, required): Email of the customer.
phone (string, required): Phone number of the customer.
The response is a JSON object with the following properties:
\nstatus (boolean): Indicates the status of the request.
description (string): Description of the response.
message (object): Details of the response message.
details (object): Details of the virtual account.customer (object): Customer details.
name (string): Name of the customer.
email (string): Email of the customer.
phone (string): Phone number of the customer.
account (array): Array of account details.
id (string): ID of the account.
account_number (string): Account number.
account_name (string): Account name.
bank_name (string): Name of the bank.
bank_code (string): Bank code.
currency (string): Currency of the account.
account_type (string): Type of the account.
expiry (number): Expiry details.
expiry_date (string): Expiry date of the account.
status (string): Status of the account.
created_at (string): Creation date of the account.
updated_at (string): Last update date of the account.
status_code (number): Status code of the response.
{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"account\": [\n {\n \"id\": \"\",\n \"account_number\": \"\",\n \"account_name\": \"\",\n \"bank_name\": \"\",\n \"bank_code\": \"\",\n \"currency\": \"\",\n \"account_type\": \"\"\n }\n ],\n \"expiry\": 0,\n \"expiry_date\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n },\n \"status_code\": 0\n}\n\nThis endpoint is used to confirm a payment for a virtual account.
\ntrans_id (string): The transaction ID.
session_id (string): The session ID.
amount (number): The amount of the payment.
account_number (string): The virtual account number.
Please note that transaction_hash always comes with a successful transaction.
\nAnd you can verify it using the SHA512. See the webhook structure below
\n","urlObject":{"path":["virtual-accounts","confirm-payment"],"host":["https://sandbox.payscribe.ng/api/v1/collections"],"query":[],"variable":[]}},"response":[{"id":"572069e7-3239-4cda-9fbe-f671b3cbec40","name":"Verify Payment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"trans_id\": \"\",\r\n \"session_id\": \"100004240805170152117622486170\",\r\n \"amount\": 100,\r\n \"account_number\": \"5300000011\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/collections/virtual-accounts/confirm-payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 05 Aug 2024 17:54:26 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ci_session=594042cc35b5156d5c744b09a8676d0aa27f9708; expires=Mon, 05-Aug-2024 19:54:26 GMT; Max-Age=7200; path=/; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Confirm payment!\",\n \"message\": {\n \"details\": {\n \"trans_id\": \"d0cf89fe-e204-479a-946d-5889617b7780\",\n \"amount\": 100,\n \"fee\": 1,\n \"currency\": \"NGN\",\n \"transaction\": {\n \"session_id\": \"100004240805170152117622486170\",\n \"date\": \"2024-08-05T18:02:04\",\n \"bank_name\": \"Paycom(opay)\",\n \"sender_account\": \"07038067493\",\n \"sender_name\": \"ADENIJI PHILIP SOKOYA\",\n \"amount\": 100,\n \"currency\": \"NGN\",\n \"description\": \"Transfer from ADENIJI PHILIP SOKOYA\"\n },\n \"account\": {\n \"name\": \"Zerones Technology/Test Account\",\n \"number\": \"5300000011\",\n \"bank\": \"9psb\",\n \"account_type\": \"static\"\n },\n \"customer\": {\n \"name\": \"Test Account\",\n \"email\": \"test@gmail.com\",\n \"phone\": \"08070994845\"\n },\n \"transaction_hash\": \"4\"\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"3507ba22-f448-45c4-b66f-d241be6887a1"},{"name":"Simulate a Transaction","event":[{"listen":"test","script":{"id":"6cb96a8a-ad0e-4ac6-9515-27c7eb21a1df","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"f53b0e20-1de1-4e5b-86e8-2c8be37b2825","exec":["// Import CryptoJS library\r","\r","if (typeof CryptoJS === 'undefined') {\r"," pm.sendRequest(\"https://cdnjs.cloudflare.com/ajax/libs/crypto-js/3.1.9-1/crypto-js.js\", function (err, res) {\r"," eval(res.text());\r"," });\r","}\r","\r","// Log the raw request body for debugging\r","console.log(\"requestBody :: \", pm.request.body.raw);\r","\r","// Parse the request body to extract the necessary fields\r","var req = JSON.parse(pm.request.body.raw);\r","\r","// Retrieve the private key from collection variables\r","const secretKey = pm.collectionVariables.get('secretKey');\r","\r","console.log( secretKey )\r","\r","// Extract relevant fields from the parsed request body\r","const debitAccount = req.sender_account_number; // Sender Account Nmber\r","const creditAccount = req.account; // The Virtual Account number\r","const bankCode = req.bank; // The Sender bank code\r","const amount = req.amount; // Amount that was sent, format to 2 Decimal Places\r","const reference = req.ref; // this is the transaction id we're sending to you\r","\r","// Construct the message to be hashed\r","const message = secretKey + debitAccount + creditAccount + bankCode + amount + reference;\r","\r","// Log the message for debugging\r","console.log(\"Message to be hashed: \", message);\r","\r","// Compute the SHA-512 hash of the message\r","var sha512Hash = CryptoJS.SHA512(message).toString().toUpperCase();\r","\r","// Log the computed hash for debugging\r","console.log(\"Sha512 Hash :: \", sha512Hash);\r","\r","// Set the computed hash as a collection variable\r","pm.collectionVariables.set('hash', sha512Hash);"],"type":"text/javascript","packages":{}}}],"id":"ca71f0d9-a888-49aa-9cb2-8b83bdb30116","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ref\": \"77a51291-ea94-4cbb-aae2-695b9e9f3118\",\r\n \"amount\": \"4500.00\",\r\n \"description\": \"A test transfer from Clara Schmidt II\",\r\n \"currency\": \"NGN\",\r\n \"account\": \"4804760006\",\r\n \"name\": \"Viola Weber\",\r\n \"bank\": \"120001\",\r\n \"sender_account_number\": \"1100000309\",\r\n \"sender_name\": \"Elmer O'Conner\",\r\n \"hash\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/collections/virtual-accounts/simulate-transfer","description":"This endpoint is used to simulate a transfer for virtual accounts. - Static account
\nref (string, required): Reference for the transfer.
amount (string, required): Amount to be transferred.
description (string, required): Description of the transfer.
currency (string, required): Currency of the transfer.
account (string, required): Account details for the transfer.
name (string, required): Name of the account holder.
bank (string, required): Bank sort code for the transfer.
sender_account_number (string, required): Sender's account number.
sender_name (string, required): Sender's name.
hash (string, required): Hash for the transfer. Ensure you have updated your test secret key on the collection variables. Also check the pre-script for this endpoint.
The response is in JSON format and follows the schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"trans_id\": {\n \"type\": \"string\"\n },\n \"ref\": {\n \"type\": \"string\"\n },\n \"amount\": {\n \"type\": \"string\"\n },\n \"fee\": {\n \"type\": \"number\"\n },\n \"currency\": {\n \"type\": \"string\"\n },\n \"transaction\": {\n \"type\": \"object\",\n \"properties\": {\n \"session_id\": {\n \"type\": \"string\"\n },\n \"date\": {\n \"type\": \"string\"\n },\n \"bank_name\": {\n \"type\": \"string\"\n },\n \"sender_account\": {\n \"type\": \"string\"\n },\n \"sender_name\": {\n \"type\": \"string\"\n },\n \"amount\": {\n \"type\": \"string\"\n },\n \"currency\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n }\n }\n },\n \"customer\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"number\": {\n \"type\": \"string\"\n },\n \"bank\": {\n \"type\": \"string\"\n },\n \"account_type\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"status_code\": {\n \"type\": \"number\"\n }\n }\n }\n }\n}\n\nVirtual accounts is a unique account information consisting of account number and bank , which allows Payscribe busineses to receive payments from customers via bank transfer. Currently Payscribe ONLY support NGN virtual accounts.
\n\n\nPlease note: Virtual accounts does not store any monetary value like regular bank account number. It is only a means for your customers to pay you for a service and in return they must use the service(s) they pay you for on your platform. The payment gets settled in your account NGN Collection balance.
\n
Also, Payscribe does not store keep track of the money sent to the virtual account. The money is sent to your Payscribe collection balance once received.
There are basically two types of virtual account numner.
\n1. Temporary Virtual Accounts: This is also known as the dynamic account, and it is used to receive one-off payments. A typical use-case is when a customer is at the check-out point, you can generate this account with an expiry time for the customer to complete the transaction.
\nPlease note that the virtual account becomes inactive (Not to be used once the time set as expired).
\n2. Permanet Virtual Accounts: Also known as the static virtual account number. This does not have an expiry date/time and can be assigned to your customer for wallet funding on your app/website. Which also subsequent wallets funding for that customer.
\n**Requirements
\n**To create a permanent Virtual account, you need to create customer by calling the create customer endpoint, upgrade the customer to tier 1. You can also create customer on the fly, while creating the account.
\nSupported Banks
\n","_postman_id":"fb9ce7d3-aa32-424f-aaf5-f7e7a7e75a90"},{"name":"Collection Webhook","item":[],"id":"0a9a0886-a86a-4311-8284-7eb1dc3421f6","description":"Webhooks are used so that anytime an event occurs on your account, your application can be notified with instant, real-time notifications by Payscribe.
\nYou need to update your Test/Live webhook if you've not already done this.
\nLogin to your account (sandbox/live)
\nGo to your API Settings / Webhook.
\nIn the webhook URL field, enter your webhook URL.
\nPlease note,
\nThe webhook URL must be accessible.
\nAlways verify that you have not given customers value by implementing transaction checker to avoid double transactions.
\nSending WEBHOOK from our server IP: 162.254.34.78
\nHere is the flow - suggestion
\nGet the payload from Payscribe
\nSanitize the payload
\nVerify that the transaction_hash is valid
\nVerify that the payload IP address matches Payscribe Server IP Address
\nVerify that the hash combination matches the incoming hash
\nVerify that this is not a duplicate webhook/transaction
\n$combination = YOUR_PAYSCRIBE_SECRET_KEY . SENDER_ACCOUNT_NUMBER. CUSTOMER_VIRTUAL_ACCOUNT_NUMBER . BANK_CODE . ORDER_AMOUNT . TRANS_ID ;
\nIn PHP you would hash like this
\n$hash = hash( 'SHA512', $combination );
$hashUpperCase = strtoupper( $hash ) ;
SAMPLE WEBHOOK FOR SUCCESSFUL PAYMENT
\n{
\"event_id\": \"1cc5f7ee-d1a0-4fb5-bfb7-0f3782e2bb24\",
\"event_type\": \"accounts.payment.status\",
\"trans_id\": \"1cc5f7ee-d1a0-4fb5-bfb7-0f3782e2bb24\",
\"amount\": 200,
\"fee\": 1.3,
\"currency\": \"ngn\",
\"transaction\": {
\"session_id\": \"100004250215130321127287889689\",
\"date\": \"2025-02-15 14:03:48\",
\"amount\": 200,
\"currency\": \"NGN\",
\"narration\": \"Transfer from ABUBAKAR\",
\"bank_name\": \"Paycom(opay)\",
\"bank_code\": \"100004\",
\"sender_account\": \"7098664934\",
\"sender_name\": \"ABUBAKAR\"
},
\"customer\": {
\"id\": \"b0a2630e-6c9c-4395-8b7d-d89c0bda8f20\",
\"name\": \"MY BIZ/ SHMUSDEEN\",
\"number\": \"5309026275\",
\"bank\": \"psb\",
\"account_id\": \"226edad7-8ac3-498d-ba93-e0e843473cf2\",
\"account_type\": \"static\"
},
\"created_at\": \"2025-02-15 14:03:48\",
\"transaction_hash\": \"64959E9CD96E5DA0983B899E504C7555CD3A2ADCF972F498685A7A69262D97535DB8978E4E531E68EA806D173611A9D5D3A4B079BAB7E30984F9323A90D686\"
}
Welcome to Collection API. Receive payment from your customer with no stress.
\nYou can check out a basic PHP integration for this here
\n","_postman_id":"72185857-ba5f-42c7-910c-e9b2ab40bf87"},{"name":"FX & Conversions","item":[{"name":"Live Fx Rate","event":[{"listen":"test","script":{"id":"1e2400be-2a23-412b-a609-ceaffa9c30ca","exec":["var responseJSON = pm.response.json();","","// Test the response body structure and values","pm.test(\"Response body structure is valid\", function () {"," pm.expect(responseJSON).to.be.an('object').that.has.property('currency_pair');"," pm.expect(responseJSON.currency_pair).to.be.an('object').that.has.property('from');"," pm.expect(responseJSON.currency_pair).to.be.an('object').that.has.property('to');"," pm.expect(responseJSON.currency_pair).to.be.an('object').that.has.property('rate');","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"619e855e-abee-46f4-b3a0-974f635ba5b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/fx/rates","description":"This endpoint allows you to retrieve the details of a currency pair.
\nMethod: GET
Endpoint: https://sandbox.payscribe.ng/api/v1//currency_pair
Query Parameters:
\nfrom: The currency code to convert from (e.g. NGN)
to: The currency code to convert to (e.g. USD)
The response will include the details of the currency pair, such as the exchange rate and other relevant information.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"rate\": {\n \"type\": \"number\"\n },\n \"currency_from\": {\n \"type\": \"string\"\n },\n \"currency_to\": {\n \"type\": \"string\"\n },\n \"rate_token\": {\n \"type\": \"string\"\n },\n \"created_at\": {\n \"type\": \"string\"\n },\n \"expiry_at\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"status_code\": {\n \"type\": \"number\"\n }\n }\n}\n\nThis endpoint allows you to retrieve the details of a currency pair.
\nMethod: GET
Endpoint: https://sandbox.payscribe.ng/api/v1//currency_pair
Query Parameters:
\nfrom: The currency code to convert from (e.g. NGN)
to: The currency code to convert to (e.g. USD)
The response will include the details of the currency pair, such as the exchange rate and other relevant information.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"rate\": {\n \"type\": \"number\"\n },\n \"currency_from\": {\n \"type\": \"string\"\n },\n \"currency_to\": {\n \"type\": \"string\"\n },\n \"rate_token\": {\n \"type\": \"string\"\n },\n \"created_at\": {\n \"type\": \"string\"\n },\n \"expiry_at\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"status_code\": {\n \"type\": \"number\"\n }\n }\n}\n\nThis endpoint allows you to create a currency exchange quote between two currencies. It is typically used to determine the exchange rate and the amount the recipient will receive before initiating a currency conversion or transfer.
\nUse this endpoint to obtain a real-time quote for converting a specified amount from one currency to another. The quote includes the exchange rate, calculated amounts, fees, and validity period.
\nPOST https://sandbox.payscribe.ng/api/v1/currency-pair
This endpoint requires Bearer Token authentication. Include the following header in your request:
\nAuthorization: Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990\nSend a JSON object in the request body with the following fields:
\nExample:
\n{\n \"from\": \"NGN\",\n \"to\": \"USD\",\n \"amount\": 5000\n}\nA successful response returns HTTP 200 and a JSON object with the quote details.
\nResponse Structure:
\n{\n \"status\": true,\n \"description\": \"Quote created successfully.\",\n \"message\": {\n \"details\": {\n \"quote_id\": 109,\n \"from\": \"NGN\",\n \"to\": \"USD\",\n \"rate\": 0.0006358815225547176,\n \"rate_mid\": 0.0006358815225547176,\n \"amount_from\": 5000,\n \"amount_to\": 3.169869392773588,\n \"fee\": {\n \"abs\": 0,\n \"pct\": 0.3,\n \"total\": 0.00953822\n },\n \"spread_bps\": 0,\n \"side\": null,\n \"created_at\": \"2025-10-18 10:42:20\",\n \"expires_at\": \"2025-10-18 10:43:20\",\n \"sig\": \"...\"\n }\n },\n \"status_code\": 200\n}\nstatus: Indicates if the request was successful.description: Message describing the result.message.details: Contains the quote details:quote_id: Unique identifier for the quote.from: Source currency code.to: Target currency code.rate: Exchange rate applied.rate_mid: Mid-market rate at the time of quote.amount_from: Amount in source currency.amount_to: Amount in target currency after conversion.fee: Object with absolute (abs), percentage (pct), and total (total) fee values.spread_bps: Spread in basis points.side: Transaction side (if applicable).created_at: Quote creation timestamp.expires_at: Quote expiration timestamp.sig: Signature for quote integrity verification.expires_at timestamp.rate and fee before proceeding with a transaction.For more details, refer to the Welcome to Payscribe API.
\n","urlObject":{"host":["https://sandbox.payscribe.ng/api/v1/currency-pair"],"query":[],"variable":[]}},"response":[{"id":"51a24d26-2330-45c8-a3b5-d4fa24c5c6fc","name":"Create Quoute - Currency Pair","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\n \"from\": \"NGN\",\n \"to\": \"USD\",\n \"amount\": 5000\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/currency-pair"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Sat, 18 Oct 2025 09:42:20 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization, X-Requested-With"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=RL%2B28At6befjc93WoV5RBQFV9lbxuQ5nSGOB0%2FfyGpiz7IJ3IVBUBls0KziN1f1EXmffLT5ijno%2FecwgLhcy2naA1gvWWeQAMYi9nvr0\"}]}"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Set-Cookie","value":"ci_session=6e935691d57d681587a8075b620abea95f985d8c; HttpOnly; SameSite=Lax; Path=/; Max-Age=7200; Expires=Sat, 18 Oct 2025 11:42:20 GMT"},{"key":"CF-RAY","value":"990715c95d0db128-MAN"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Quote created successfully.\",\n \"message\": {\n \"details\": {\n \"quote_id\": 109,\n \"from\": \"NGN\",\n \"to\": \"USD\",\n \"rate\": 0.00063588152255471762884508901692015570006333291530609130859375,\n \"rate_mid\": 0.00063588152255471762884508901692015570006333291530609130859375,\n \"amount_from\": 5000,\n \"amount_to\": 3.169869392773588145928442827425897121429443359375,\n \"fee\": {\n \"abs\": 0,\n \"pct\": 0.299999999999999988897769753748434595763683319091796875,\n \"total\": 0.00953822000000000003172573315168847329914569854736328125\n },\n \"spread_bps\": 0,\n \"side\": null,\n \"created_at\": \"2025-10-18 10:42:20\",\n \"expires_at\": \"2025-10-18 10:43:20\",\n \"sig\": \"14ed1244dbf4e51e5863dfa110bd23f0c35ab4c86c564b0cf34ef5a626c7c478\"\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"3b91ab67-e88d-494d-93e9-8315841daf7e"},{"name":"Execute A Quote","event":[{"listen":"test","script":{"id":"1e2400be-2a23-412b-a609-ceaffa9c30ca","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"eca3f68e-8f9a-4e36-ab5d-55ea3d11befa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\r\n \"quote_id\": 7919,\r\n \"sig\": \"5c0d1096f31c074af3159cc9ab0a176305a74c385c45e0a24d9ef02e3bf678c1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/execute-quote","description":"This request executes a currency conversion quote previously created via the Payscribe API. It finalizes the conversion transaction based on the provided quote details.
\nUse this endpoint to confirm and execute a currency conversion using a valid quote. Upon success, a conversion transaction is created and its details are returned.
\nAuthorization: Bearer <API_KEY><API_KEY> with your valid Payscribe API key.Send a raw JSON object with the following parameters:
\nquote_id (integer, required): The unique identifier of the quote to execute.sig (string, required): A cryptographic signature validating the request. This is typically generated based on your integration with Payscribe's security requirements.Example:
\n{\n \"quote_id\": 110,\n \"sig\": \"0f79353c2e27e659119de496e7f02134d44807d8...\"\n}\nA successful execution returns HTTP status 200 and a JSON body with the following structure:
{\n \"status\": true,\n \"description\": \"Conversion created successfully.\",\n \"message\": {\n \"details\": {\n \"trans_id\": \"30ef97d5-c9b3-4aff-918e-eba6ed1c6811\",\n \"quote_id\": 110,\n \"from\": \"NGN\",\n \"to\": \"USD\",\n \"rate\": \"0.000635881523\",\n \"amount_from\": \"5000.00000000\",\n \"amount_to\": \"3.16986939\",\n \"created_at\": \"2025-10-18 11:12:12\",\n \"sig\": \"0f79353c2e27e659119de496e7f02134d44807d8...\"\n }\n },\n \"status_code\": 200\n}\ntrans_id: Unique transaction identifier for the conversion.quote_id: The quote ID that was executed.from: Source currency code.to: Target currency code.rate: Conversion rate applied.amount_from: Amount in the source currency.amount_to: Amount in the target currency.created_at: Timestamp of the conversion creation.sig: Signature for response validation.sig parameter is generated according to Payscribe's security documentation.For more details, refer to the Payscribe API documentation or contact support.
\n","urlObject":{"host":["https://sandbox.payscribe.ng/api/v1/execute-quote"],"query":[],"variable":[]}},"response":[{"id":"29a6ed62-e206-4c8e-8d59-cc1ce788b14e","name":"Execute a quote fail","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\r\n \"quote_id\": 109,\r\n \"sig\": \"14ed1244dbf4e51e5863dfa110bd23f0c35ab4c86c564b0cf34ef5a626c7c478\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/execute-quote"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Sat, 18 Oct 2025 10:09:24 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization, X-Requested-With"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=FFMhsuTq0QAE%2BAyMXaReks5sCN6Q%2F9Xkkl5Q8InKqxO1gUpCrI%2FkF2R7oZ%2BrHtq7pDZk9uJHM4%2FM6XkRPIbA2fWrCt9Cpb24T4ErmOttHKc%3D\"}]}"},{"key":"Set-Cookie","value":"ci_session=401333556d2156ffa8007be26640fbf88237fcfe; HttpOnly; SameSite=Lax; Path=/; Max-Age=7200; Expires=Sat, 18 Oct 2025 12:09:23 GMT"},{"key":"CF-RAY","value":"99073d6b0a84ccaa-MAN"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"description\": \"Quote expired.\",\n \"status_code\": 400\n}"},{"id":"dd804720-0f9c-4dc0-805c-9895e871f975","name":"Quote successful","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\r\n \"quote_id\": 7919,\r\n \"sig\": \"5c0d1096f31c074af3159cc9ab0a176305a74c385c45e0a24d9ef02e3bf678c1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/execute-quote"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"date","value":"Sun, 05 Apr 2026 15:05:27 GMT"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"server","value":"cloudflare"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate, no-cache"},{"key":"pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"access-control-allow-headers","value":"Origin, Content-Type, Authorization, X-Requested-With"},{"key":"x-csrf-name","value":"csrf_test_name"},{"key":"x-csrf-token","value":"82bd065e16998d0c218b196508a0f673"},{"key":"vary","value":"Authorization,User-Agent"},{"key":"report-to","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=nEQOpZeHvsCg57M6mIqdLqqL%2FfjaXF4c7rvd2jyZVughzdwJsx3V252yceaTxKO4md0zSxyv8LvsR5%2BYB7AdwUzEyHTx85xXb3drWnyBKD8xZSXo6XOvjAmsyY0jXwhgrwG1\"}]}"},{"key":"nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"content-encoding","value":"br"},{"key":"cf-ray","value":"9e79737a0ec1a5d0-MAN"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Conversion created successfully.\",\n \"message\": {\n \"details\": {\n \"trans_id\": \"ac2dc93b-d3b6-4a1b-8a91-6fac8f61e7ff\",\n \"quote_id\": 7919,\n \"from\": \"NGN\",\n \"to\": \"USD\",\n \"rate\": \"0.000714285714\",\n \"amount_from\": \"5000.00000000\",\n \"amount_to\": \"3.56071428\",\n \"created_at\": \"2026-04-05 16:05:27\",\n \"sig\": \"5c0d1096f31c074af3159cc9ab0a176305a74c385c45e0a24d9ef02e3bf678c1\"\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"eca3f68e-8f9a-4e36-ab5d-55ea3d11befa"},{"name":"Verify Conversion","id":"3e233767-2c60-46c4-889a-79ba5e38ec8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1/verify-conversion/28f77f04-7f5b-4d58-a46a-c70e40558ccf","description":"This HTTP GET request is used to verify a specific conversion with the provided ID. The request should be sent to https://sandbox.payscribe.ng/api/v1//verify-conversion/41b717b7-9105-40b7-8324-28478f2f065f.
\nNo request body is required for this request.
\nStatus: 200
\nContent-Type: application/json
\nThe response will include a JSON object with the following structure:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"trans_id\": \"\",\n \"ref\": \"\",\n \"amount_from\": 0,\n \"amount_to\": 0,\n \"currency_from\": \"\",\n \"currency_to\": \"\",\n \"rate\": 0,\n \"created_at\": \"\",\n \"status\": \"\"\n }\n },\n \"status_code\": 0\n}\n\nThe response provides information about the status of the conversion verification along with details such as transaction ID, reference, amounts, currencies, exchange rate, creation timestamp, and status code.
\n","urlObject":{"path":["28f77f04-7f5b-4d58-a46a-c70e40558ccf"],"host":["https://sandbox.payscribe.ng/api/v1/verify-conversion"],"query":[],"variable":[]}},"response":[{"id":"7da87854-6522-4e1d-b07b-89d300d5a90d","name":"Verify Conversion","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1//verify-conversion/41b717b7-9105-40b7-8324-28478f2f065f"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 04 Jul 2024 16:30:58 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:3000"},{"key":"Vary","value":"Authorization,Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"264"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Currency conversion successful.\",\n \"message\": {\n \"details\": {\n \"trans_id\": \"41b717b7-9105-40b7-8324-28478f2f065f\",\n \"ref\": \"f5644ae8-2071-40a0-9aa2-284994\",\n \"amount_from\": 5000,\n \"amount_to\": 3.01400000000000023447910280083306133747100830078125,\n \"currency_from\": \"ngn\",\n \"currency_to\": \"usd\",\n \"rate\": 0,\n \"created_at\": \"2024-07-04 16:31:00\",\n \"status\": \"success\"\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"3e233767-2c60-46c4-889a-79ba5e38ec8a"}],"id":"d08f87dd-150e-421a-82a7-aa1034083cdf","description":"You will find all resources that you need to convert from one currency to another with no need to login to your Payscribe dashboard.
\n","_postman_id":"d08f87dd-150e-421a-82a7-aa1034083cdf"},{"name":"Card Issueing","item":[{"name":"Card Endpoints","item":[{"name":"Create a Card","id":"7638cf0b-96bd-4126-b426-17e6ecdf8433","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"body":{"mode":"raw","raw":"{\r\n \"customer_id\": \"3cb6cf73-1d21-4b97-8d34-29858fa9a77f\",\r\n \"currency\": \"USD\",\r\n \"brand\": \"VISA\",\r\n \"amount\": 1,\r\n \"type\": \"virtual\",\r\n \"ref\": \"bc8257cd-c494-44b5-9fd1-dec41bf3c3ac\"\r\n // For contactless card, pass the contactless as true, and you can pass the optional card_limits objects\r\n \r\n // \"contactless\": true,\r\n // \"card_limits\": {\r\n // \"daily_limit\" : 10,\r\n // \"transaction_limit\": 20\r\n // }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/cards/create","description":"This endpoint allows you to create a card for a specific user.
\ncustomer_id (String, required): The customer id that was generated when creating the customer.
currency (String, optional): The card currency. The default and available option is USD.
brand (String, required): VISA or MASTERCARD.
amount (Decimal, required): The amount you want to top up on the card. The minimum amount is 1.
type (String, optional): Card type, which can be virtual or physical. The default is virtual.
{\n \"status\": true,\n \"message\": {\n \"description\": \"\",\n \"details\": {\n \"trans_id\": \"\",\n \"card\": {\n \"id\": \"\",\n \"card_type\": \"\",\n \"currency\": \"\",\n \"brand\": \"\",\n \"name\": \"\",\n \"first_six\": \"\",\n \"last_four\": \"\",\n \"masked\": \"\",\n \"number\": \"\",\n \"expiry\": \"\",\n \"ccv\": \"\",\n \"billing\": {\n \"address\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"customer\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"status_code\": 0\n }\n}\n\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\"type\": \"boolean\"},\n \"message\": {\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\"type\": \"string\"},\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"trans_id\": {\"type\": \"string\"},\n \"card\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"card_type\": {\"type\": \"string\"},\n \"currency\": {\"type\": \"string\"},\n \"brand\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"first_six\": {\"type\": \"string\"},\n \"last_four\": {\"type\": \"string\"},\n \"masked\": {\"type\": \"string\"},\n \"number\": {\"type\": \"string\"},\n \"expiry\": {\"type\": \"string\"},\n \"ccv\": {\"type\": \"string\"},\n \"billing\": {\n \"type\": \"object\",\n \"properties\": {\n \"address\": {\"type\": \"string\"},\n \"state\": {\"type\": \"string\"},\n \"city\": {\"type\": \"string\"},\n \"postal_code\": {\"type\": \"string\"},\n \"country\": {\"type\": \"string\"}\n }\n },\n \"created_at\": {\"type\": \"string\"},\n \"updated_at\": {\"type\": \"string\"}\n }\n },\n \"customer\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n },\n \"status_code\": {\"type\": \"integer\"}\n }\n }\n }\n }\n }\n}\n\nThis endpoint allows you to top up an existing card.
\namount (required, Number): The amount you want to top up.ref (optional, String): Your system transaction ID for reference.status (Boolean): Indicates the status of the request.description (String): Additional description, if any.message (Object): Details of the transaction, including transaction ID, customer information, card details, currency, previous balance, current balance, reference ID, action, and creation timestamp.status_code (Number): Status code of the response.{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"trans_id\": \"\",\n \"customer\": {\n \"id\": \"\"\n },\n \"card\": {\n \"id\": \"\",\n \"first_six\": \"\",\n \"last_four\": \"\",\n \"brand\": \"\",\n \"prev_balance\": 0,\n \"balance\": 0\n },\n \"currency\": \"\",\n \"prev_balance\": 0,\n \"balance\": 0,\n \"ref_id\": \"\",\n \"action\": \"\",\n \"created_at\": \"\"\n }\n },\n \"status_code\": 0\n}\nThis endpoint allows you to withdraw a specified amount from a card.
\namount (number) - The amount to be withdrawn from the card balance.
ref (string) - A reference for the withdrawal transaction.
status (boolean) - Indicates the status of the withdrawal request.
description (string) - Additional description, if any.
message (object) - Details of the transaction, including transaction ID, customer details, card details, currency, action, and timestamps.
status_code (number) - The status code of the response.
This endpoint allows you to retrieve the details of a specific card by providing the card ID in the URL.
\nThis request does not require a request body.
\nstatus (boolean): Indicates the status of the response.
description (string): Provides additional information about the response.
message (object): Contains the details of the card.
details (object): Includes the following card details:id (string): The unique identifier of the card.
currency (string): The currency associated with the card.
card_type (string): The type of the card.
brand (string): The brand of the card.
first_six (string): The first six digits of the card number.
last_four (string): The last four digits of the card number.
masked (string): The masked card number.
card_number (string): The full card number.
expiry (string): The expiry date of the card.
ccv (string): The CCV (Card Verification Value) of the card.
balance (number): The balance associated with the card.
status (string): The status of the card.
billing (object): Contains the billing address details.
address (string): The address associated with the card.
country (string): The country in the billing address.
state (string): The state in the billing address.
city (string): The city in the billing address.
postal_code (string): The postal code in the billing address.
created_at (string): The date and time when the card was created.
updated_at (string): The date and time when the card was last updated.
terminate (boolean): Indicates if the card is terminated.
terminate_date (string): The date when the card was terminated.
customer (object): Contains the details of the customer associated with the card.
id (string): The unique identifier of the customer.
name (string): The name of the customer.
{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"id\": \"\",\n \"currency\": \"\",\n \"card_type\": \"\",\n \"brand\": \"\",\n \"first_six\": \"\",\n \"last_four\": \"\",\n \"masked\": \"\",\n \"card_number\": \"\",\n \"expiry\": \"\",\n \"ccv\": \"\",\n \"balance\": 0,\n \"status\": \"\",\n \"billing\": {\n \"address\": \"\",\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal_code\": \"\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"terminate\": true,\n \"terminate_date\": null,\n \"customer\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n },\n \"status_code\": 0\n}\n\nSome BINs (Bank Identification Numbers) are being
decommissioned, requiring the replacement of cards associated with those BINs before termination. This endpoint facilitates the seamless
transition by:
Replacing the old card with a new one.
\nTransferring the balance from the old card to the new one
\nTerminating the old card.
\nAllowing users to continue transacting with the new card.
\nTo replace a card that belongs to a decommissioned BIN, send a PATCH request to the above endpoint with the card_id of the old card in the request payload.
Some BINs (Bank Identification Numbers) are being
decommissioned, requiring the replacement of cards associated with those BINs before termination. This endpoint facilitates the seamless
transition by:
Replacing the old card with a new one.
\nTransferring the balance from the old card to the new one
\nTerminating the old card.
\nAllowing users to continue transacting with the new card.
\nTo replace a card that belongs to a decommissioned BIN, send a PATCH request to the above endpoint with the card_id of the old card in the request payload.
This resouce allows you to get a card transaction.
\n","urlObject":{"path":["f7598f47-9f7a-414f-b690-af744d03d55f","transactions"],"host":["https://sandbox.payscribe.ng/api/v1/cards"],"query":[{"key":"start_date","value":"2024-07-01"},{"key":"end_date","value":"2024-07-30"},{"key":"page_size","value":"20"},{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"baf8fe11-a467-442b-be07-e0a4ee4c4a1f","name":"Get a card Transaction","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://sandbox.payscribe.ng/api/v1//cards/8b6e5a08-153c-4b9d-9989-ce80032f87e4/transactions?start_date=2023-01-23&end_date=2024-03-30&page_size=20&page=1","host":["https://sandbox.payscribe.ng/api/v1/"],"path":["cards","8b6e5a08-153c-4b9d-9989-ce80032f87e4","transactions"],"query":[{"key":"start_date","value":"2023-01-23"},{"key":"end_date","value":"2024-03-30"},{"key":"page_size","value":"20"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.1.26"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"630"},{"key":"date","value":"Sat, 13 Jan 2024 10:53:08 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": {\n \"description\": \"Transactions fetched successfully.\",\n \"details\": {\n \"transactions\": [\n {\n \"trans_id\": \"PSh4L17051431886010mJo\",\n \"currency\": \"usd\",\n \"amount\": 56,\n \"status\": \"success\",\n \"description\": \"Udemy Premium Course subscription\",\n \"remark\": \"56|USD|UDEMY|US|Approved or completed successfully\",\n \"created_at\": \"2024-01-13 10:53:08\"\n },\n {\n \"trans_id\": \"PSglp17051431887630zre\",\n \"currency\": \"usd\",\n \"amount\": 1200,\n \"status\": \"success\",\n \"description\": \"NAMECHEAP Hosting\",\n \"remark\": \"1200|USD|NAMECHEAP|US|Approved or completed successfully\",\n \"created_at\": \"2024-01-13 10:53:08\"\n }\n ],\n \"meta\": {\n \"page\": \"1\",\n \"page_size\": \"20\",\n \"total\": 2\n }\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"a6cd106b-ab19-4a8b-8250-cae53ba0d9b5"},{"name":"Freeze Card","id":"72b5a551-dc67-472a-a031-b77f1953d1aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ref\": \"4dc7d149-49c0-43a8-a4c0-4909221688b4\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1//cards/cdaa128b-e591-4efc-830f-185a2973f865/freeze","description":"This endpoint is used to freeze a specific card identified by the card ID in the URL.
\nref (string, required): Reference for the freeze action.status (boolean): Indicates the status of the freeze action.
description (string): Description of the freeze action.
message (object): Details of the freeze action including transaction ID, reference, customer ID, card details, currency, action, and creation timestamp.
status_code (integer): Status code of the response.
Example response:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"trans_id\": \"\",\n \"ref\": \"\",\n \"customer\": {\n \"id\": \"\"\n },\n \"card\": {\n \"id\": \"\",\n \"first_six\": \"\",\n \"last_four\": \"\",\n \"prev_balance\": 0,\n \"balance\": 0\n },\n \"currency\": \"\",\n \"action\": \"\",\n \"created_at\": \"\"\n }\n },\n \"status_code\": 0\n}\n\nThis resource allows you to unfreeze a card.
\n","urlObject":{"path":["558b6d65-48f1-4309-8fd4-c48ff07494b6","unfreeze"],"host":["https://sandbox.payscribe.ng/api/v1/cards"],"query":[],"variable":[]}},"response":[{"id":"b343a528-2db5-45a2-bf2e-2b59ff01fe1e","name":"Unfreeze Card","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1//cards/8b6e5a08-153c-4b9d-9989-ce80032f87e4/unfreeze"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/8.1.26"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"88"},{"key":"date","value":"Sat, 13 Jan 2024 11:07:37 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": {\n \"description\": \"Card updated successfully.\"\n },\n \"status_code\": 200\n}"}],"_postman_id":"bd29406f-7a35-49d5-a0c4-edc0726e4cf8"},{"name":"Terminate Card","id":"20a3408e-e230-414a-91f9-8bd9dc72b1d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ref\": \"bbb0f629-cbfc-4dd3-98e3-1ba73076245a\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/cards/8b6e5a08-153c-4b9d-9989-ce80032f87e4/terminate","description":"This resource allows you to terminate a card. Please note that the action can not be reversed. Once a card is terminated you will not be able to use it again.
\n","urlObject":{"path":["8b6e5a08-153c-4b9d-9989-ce80032f87e4","terminate"],"host":["https://sandbox.payscribe.ng/api/v1/cards"],"query":[],"variable":[]}},"response":[],"_postman_id":"20a3408e-e230-414a-91f9-8bd9dc72b1d6"}],"id":"c88bf9f3-49df-412a-befd-cd235102e53e","_postman_id":"c88bf9f3-49df-412a-befd-cd235102e53e","description":""},{"name":"Card Webhook","item":[],"id":"6353cb82-807c-48f9-a371-13a1250ed08a","description":"Below are sample webhook response you will get for card issuing.
\nCard creation webhook - Successful
\n{\n \"event\": \"issuing.created.successful\",\n \"trans_id\": \"8b6e5a08-153c-4b9d-9989-ce80032f8931\",\n \"card\" : {\n \"id\" : \"2b6e5a08-4020k-4b9d-9989-ce80032f87e4\",\n \"card_type\" : \"virtual\",\n \"currency\" : \"USD\",\n \"brand\" : \"visa\",\n \"name\" : \"Sokoya Philip\",\n \"first_six\" : \"1234567\",\n \"last_four\" : \"1234\",\n \"masked\" : \"123456 **** **** 1234\",\n \"number\" : \"123456234556781234\",\n \"expiry\": \"12/30\",\n \"ccv\" : \"123\",\n \"billing\" : {\n \"address\": \"No 8 Ikeja road, Adetokunbo street\",\n \"state\": \"Lagos\",\n \"city\": \"Ikeja\",\n \"postal_code\": \"123456\",\n \"country\": \"NG\"\n },\n \"created_at\" : \"2024-01-11 04:19:02\",\n \"updated_at\" : \"2024-01-11 04:19:02\"\n },\n \"customer\" : {\n \"id\": \"98225a08-4020k-4b9d-9989-ce80032f87e4\",\n \"name\": \"name\"\n }\n}\n\nCard creation webhook - Failed
\n{\n \"event\": \"card.created.failed\",\n \"description\": \"You don't have sufficient money to create the card, please top-up\"\n}\n\n**
Transaction event webhook ( Card topup, withdraw)**
{\n \"trans_id\": \"82d0dc2e-e9fd-4bc6-85f9-869a01a032ec\",\n \"ref\": \"8e39c385-626a-48e8-9a45-b27a35c0c0d4\",\n \"customer\": {\n \"id\": \"8a55af1f-de56-43b0-abb9-ac44c5215428\"\n },\n \"card\": {\n \"id\": \"be811e1c-a811-4d75-9768-b2eed9e0f195\",\n \"first_six\": \"404038\",\n \"last_four\": \"4391\",\n \"brand\": \"VISA\",\n \"prev_balance\": 7,\n \"balance\": 6\n },\n \"currency\": \"USD\",\n \"prev_balance\": 0,\n \"balance\": 1,\n \"ref_id\": \"8e39c385-626a-48e8-9a45-b27a35c0c0d4\",\n \"action\": \"withdraw\", // or topup\n \"created_at\": \"2024-08-18 10:40:45\",\n \"event_id\": \"82d0dc2e-e9fd-4bc6-85f9-869a01a032ec\",\n \"event_type\": \"cards.adjusted.withdraw\"\n}\n\n**
Card freeze, unfreeze or terminate**
{\n \"trans_id\": \"94ecfda1-9396-4038-8503-3e6294439d8e\",\n \"ref\": \"c838232b-d75c-4a5a-af49-9a9807241d5e\",\n \"customer\": {\n \"id\": \"8a55af1f-de56-43b0-abb9-ac44c5215428\"\n },\n \"card\": {\n \"id\": \"be811e1c-a811-4d75-9768-b2eed9e0f195\",\n \"first_six\": \"404038\",\n \"last_four\": \"4391\",\n \"prev_balance\": 7,\n \"balance\": 7\n },\n \"currency\": \"usd\",\n \"action\": \"freeze\" // unfreeze || terminate,\n \"created_at\": \"2024-08-18 10:37:09\",\n \"event_id\": \"94ecfda1-9396-4038-8503-3e6294439d8e\",\n \"event_type\": \"cards.adjusted.freeze\" // .unfreeze || .terminate\n}\n\n**
Card Decline**
{\n \"trans_id\": \"f5b88f7e-1230-45e0-acfe-b11329be09ee\",\n \"customer\": {\n \"id\": \"5c09e478-f5f7-4d20-b8a3-bd4b2bfa8a60\"\n },\n \"card\": {\n \"id\": \"92f8fc5a-2c27-45c1-b9da-cccfa1123a15\",\n \"first_six\": \"404038\",\n \"last_four\": \"1533\",\n \"prev_balance\": \"0.43\",\n \"balance\": \"0.43\"\n },\n \"acceptor_name\": \"FACEBK *J8VM3947X2\",\n \"auth_currency\": \"USD\",\n \"auth_country\": \"IE\",\n \"reason\": \"No sufficient funds\",\n \"created_at\": \"2024-08-22 03:53:37\",\n \"event_id\": \"f5b88f7e-1230-45e0-acfe-b11329be09ee\",\n \"event_type\": \"cards.auth.declined\"\n}\n\nKindly lookout for the event on the above webhook.
\n","_postman_id":"6353cb82-807c-48f9-a371-13a1250ed08a"}],"id":"706e3a66-63ce-452b-a035-1f31e33bba0f","description":"This folder contains the core APIs for issuing and managing cards to your customers -both individuals and businesses. All issued cards are virtual by design, but they can either be:
\nVirtual Card: A basic virtual card, not enabled for contactless payment methods.
\nContactless Virtual Card: A full-featured virtual card that supports contactless payment channels like Apple Pay, Google Pay, and other tokenization services.
\nThese endpoints allow you to issue cards across various use cases while enabling control, flexibility, and digital accessibility.
\nComparison Between Virtual Card Vs Contactless Virtual Card
\nPlease note that we currently suppport USD Card.
\nHow Card Issuing Works
\nCreate customer if not already existing.
\nEnroll customer to Tier 2 Or use the Create Customer - Full endpoint to avoid upgrading customer.
\nCreate a new card, select between virtual and contact virtual card
\nConfigure controls such as daily or transaction limits
\nWhitelist or blacklist MCCs to manage card usage
\nWhere Can the Card be used?
\nPayscribe Virtual card works on mostly US merchants, if you encounter any issue or need more clarity please contact hello@payscribe.co
\nRestricted MCCs
\nThere are several merchant sites where the cards may be
rejected. They are denoted using a category code known as MCC - Merchant
Category Code
All cards issued via these endpoints are virtual in form.
\nContactless Virtual Cards support advanced digital wallet integrations (e.g., Apple Pay, Google Pay).
\nContactless Cards are available on Mastercard and Visa cards.
\nNGN cards (currently not available) do not support contactless functionality.
\nReloadability depends on user needs; use the Lite Card endpoint to issue cards that are for one-time use.
\nThe choice between issuing a Virtual Card or a Contactless Virtual Card is determined by the payload parameters. Be sure to carefully configure the payload according to the desired card experience.
\nOur KYC API is pretty basic, and this is for you as a merchant to validate your customer before providing financial services to them.
\n","_postman_id":"1199901a-5e25-43f7-b624-fe6a2763d4df"},{"name":"Savings API","item":[{"name":"Get Savings Plan","id":"bf09bec0-b903-4d53-abee-40400a393bbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.payscribe.ng/api/v1//savings/plans","description":"Fetch the savings plan in other to create a saving
\n","urlObject":{"path":["savings","plans"],"host":["https://sandbox.payscribe.ng/api/v1/"],"query":[],"variable":[]}},"response":[],"_postman_id":"bf09bec0-b903-4d53-abee-40400a393bbf"},{"name":"Create Savings","id":"d0d9287b-e919-48cd-8007-295a8612ff13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"plan_id\": \"sj8sjsksks7\",\r\n \"target_amount\": 500000,\r\n \"target_title\": \"Get a new house\",\r\n \"category\": \"9sjjs1js18ss\"\r\n}\r\n"},"url":"https://sandbox.payscribe.ng/api/v1//savings/create","description":"Create savings right on your application.
\nPlease you need to fetch the savings plan id if you don't have that already
\nPlease note:
\nIf you had selected \"Fixed\" Saving, this savings will deduct the savings from your wallet immediately and lock it till your payback date.
\nWhile the \"Target\" Savings allows you to save as low as NGN40 every day, weekly, or monthly and its withdrawable any day, anytime . Also note that you can always topup the target saving anytime.
\nFor target savings you can also pass the below parameters
\n","urlObject":{"path":["savings","create"],"host":["https://sandbox.payscribe.ng/api/v1/"],"query":[],"variable":[]}},"response":[],"_postman_id":"d0d9287b-e919-48cd-8007-295a8612ff13"},{"name":"Topup Target Savings","id":"53fb2530-180f-45f4-8240-a798b909acd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"plan_id\": \"sj8sjsksks7\",\r\n \"target_amount\": 500000,\r\n \"target_title\": \"Get a new house\",\r\n \"category\": \"9sjjs1js18ss\"\r\n}\r\n"},"url":"https://sandbox.payscribe.ng/api/v1//savings/topup","description":"Topup Target balance to meet up your Target.
\nPlease note this money will be deducted from your Payscribe main wallet to your target saving balance
\n","urlObject":{"path":["savings","topup"],"host":["https://sandbox.payscribe.ng/api/v1/"],"query":[],"variable":[]}},"response":[],"_postman_id":"53fb2530-180f-45f4-8240-a798b909acd4"},{"name":"Fetch All Savings","id":"9b2834ce-c36b-45c8-a968-668abce1a203","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.payscribe.ng/api/v1//savings/","description":"Retrieve all your savings target, you can also retrieve a specific saving by passing the saving_id
\n","urlObject":{"path":["savings",""],"host":["https://sandbox.payscribe.ng/api/v1/"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b2834ce-c36b-45c8-a968-668abce1a203"}],"id":"f44e66f7-b1e4-43c9-b215-c908f2ca96fa","description":"Payscribe allows you to integrate savings into your application with interest Per Annum.
\n*HOW IT WORKS*
\nCreate a saving plan (either finxed or target saving) using the /create endpoint.
Payscribe automatically deduct the amount you set from your main wallet to your saving wallet and lock it until the payback date (matured date), this is base on what you set via the API endpoint or a default setting. You will always get notification about this.
Please note, you can always break target even before its matured.
\nOnce the Savings mature, Payscribe automatically sends the money and the interest accued to your Payscribe Wallet.
\nSTILL HAVE QUESTIONS
\nPlease reach out to us ( hello@payscribe.ng ), we would be glad to respond.
\n\n\n","_postman_id":"f44e66f7-b1e4-43c9-b215-c908f2ca96fa"},{"name":"Misc APIs","item":[{"name":"Blacklist","item":[{"name":"List Blacklist","id":"f59e6c22-f226-4d59-904e-65ea8e0c5f7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1//misc/blacklists/lists","description":"To access this service endpoints please send a mail in this regards to <strong>hello@payscribe.ng</strong>
\n
By default 100 blacklist details will be fetched, but you can fetch for more using the below params.
\n","urlObject":{"path":["misc","blacklists","lists"],"host":["https://sandbox.payscribe.ng/api/v1/"],"query":[],"variable":[]}},"response":[{"id":"05ac7208-a368-41a2-b079-b8cd7f26d934","name":"List Blacklist","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1//misc/blacklists/lists"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/7.3.33"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"set-cookie","value":"ci_session=59590ae90d406ca39e055655ea9bd779116f3665; expires=Mon, 27-Mar-2023 18:02:09 GMT; Max-Age=7200; path=/; HttpOnly; secure"},{"key":"content-type","value":"application/json"},{"key":"transfer-encoding","value":"chunked"},{"key":"date","value":"Mon, 27 Mar 2023 16:02:09 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": {\n \"description\": \"65 Result out of 65 Blacklist fetched\",\n \"details\": [\n {\n \"blacklist\": \"07040171614\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The penetrator try to use multiple device login\",\n \"comment\": \"\",\n \"date_added\": \"Sunday, March 26th, 2023\"\n },\n {\n \"blacklist\": \"08034900068\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use multiple device login.\",\n \"comment\": \"Avoid multiple login\",\n \"date_added\": \"Sunday, March 26th, 2023\"\n },\n {\n \"blacklist\": \"08130295477\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The penetrator try to use multiple device login\",\n \"comment\": \"Avoid multiple login\",\n \"date_added\": \"Sunday, March 26th, 2023\"\n },\n {\n \"blacklist\": \"07037341034\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08102348850\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"07086622134\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"07063317472\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08136883682\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08108911133\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08136883682\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08134352212\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"07033593315\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08033604080\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"07037341034\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"0805352714609080572739\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08067787654\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08033604080\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"07032663352\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"07033593315\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08134352214\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08036641304\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08147054906\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"09122108056\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08108472290\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"09133137179\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"07061857480\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"09160044034\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"09160165061\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"07047714053\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08142915827\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08037879109\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"09169604484\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"07040964155\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08132865506\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08133822791\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"07063012438\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08103429372\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08135618548\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08135062340\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"07069396871\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08161654301\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"09136771258\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"07041733311\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08161654302\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"09160955817\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08140268701\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08161654388\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08039379277\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08161654388\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"bakareh42@gmail.com\",\n \"blacklist_type\": \"email\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"greenrhoda8@gmail.com\",\n \"blacklist_type\": \"email\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"myself6040@gmail.com\",\n \"blacklist_type\": \"email\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"omoyabayo@gmail.com\",\n \"blacklist_type\": \"email\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"kankent4@gmail.com\",\n \"blacklist_type\": \"email\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"m.yself6040@gmail.com\",\n \"blacklist_type\": \"email\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"oluwafikayomi095@gmail.com\",\n \"blacklist_type\": \"email\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"dollavolla88@gmail.com\",\n \"blacklist_type\": \"email\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"olamilekanolarewaju042@gmail.com\",\n \"blacklist_type\": \"email\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"comment\": \"Avoid multiple login in different devices or tab. Also avoid the same transactions within 5minutes\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"marypowell4190@gmail.com\",\n \"blacklist_type\": \"email\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"1. Avoid multiple login in different devices or tab. 2. avoid the same transactions within 5minutes. 3. Avoid any minus ( - ) transactions\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08032502904\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"1. Avoid multiple login in different devices or tab. 2. avoid the same transactions within 5minutes. 3. Avoid any minus ( - ) transactions\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"07040171614\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"1. Avoid multiple login in different devices or tab. 2. avoid the same transactions within 5minutes. 3. Avoid any minus ( - ) transactions\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08034900068\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"1. Avoid multiple login in different devices or tab. 2. avoid the same transactions within 5minutes. 3. Avoid any minus ( - ) transactions\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08130295477\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"1. Avoid multiple login in different devices or tab. 2. avoid the same transactions within 5minutes. 3. Avoid any minus ( - ) transactions\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08079228224\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"1. Avoid multiple login in different devices or tab. 2. avoid the same transactions within 5minutes. 3. Avoid any minus ( - ) transactions\",\n \"date_added\": \"Monday, March 27th, 2023\"\n },\n {\n \"blacklist\": \"08102348850\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"comment\": \"1. Avoid multiple login in different devices or tab. 2. avoid the same transactions within 5minutes. 3. Avoid any minus ( - ) transactions\",\n \"date_added\": \"Monday, March 27th, 2023\"\n }\n ]\n },\n \"status_code\": 200\n}"}],"_postman_id":"f59e6c22-f226-4d59-904e-65ea8e0c5f7d"},{"name":"Lookup Blacklist","id":"1379b094-1687-4486-928e-4319d32e2d68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"08102348850\"\r\n}"},"url":"https://sandbox.payscribe.ng/api/v1//misc/blacklists/lookup","description":"Lookup a suspected blacklist, Please note, this can either be by ip, ip, name, phone, account_number. email
\n","urlObject":{"path":["misc","blacklists","lookup"],"host":["https://sandbox.payscribe.ng/api/v1/"],"query":[],"variable":[]}},"response":[{"id":"4d47631e-bff5-47c4-a730-3abcd8fe7010","name":"Lookup Blacklist","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"08102348850\"\r\n}"},"url":"https://sandbox.payscribe.ng/api/v1//misc/blacklists/lookup"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"keep-alive","value":"timeout=5, max=100"},{"key":"x-powered-by","value":"PHP/7.3.33"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"758"},{"key":"date","value":"Mon, 27 Mar 2023 16:06:30 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": {\n \"description\": \"2 matched the search query.\",\n \"details\": [\n {\n \"blacklist\": \"08102348850\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time.\",\n \"note\": \"Avoid multiple login in different devices or tab\",\n \"date_added\": \"2023-03-27 16:06:30\"\n },\n {\n \"blacklist\": \"08102348850\",\n \"blacklist_type\": \"phone\",\n \"issue\": \"The perpetrator try to use login to multiple device at the same time, in other to process a transaction twice at the same time\",\n \"note\": \"1. Avoid multiple login in different devices or tab. 2. avoid the same transactions within 5minutes. 3. Avoid any minus ( - ) transactions\",\n \"date_added\": \"2023-03-27 16:06:30\"\n }\n ]\n },\n \"status_code\": 200\n}"}],"_postman_id":"1379b094-1687-4486-928e-4319d32e2d68"},{"name":"Add Blacklist","id":"55b1baf8-2d23-44f2-a602-f2ca20d87f94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"08039379277\",\r\n \"title_type\": \"phone\",\r\n \"issue\": \"Please state the issue that made you tag this a blacklist\",\r\n \"note\": \"Give details on how you probably solved it, or any other remark that may help others\"\r\n}"},"url":"https://sandbox.payscribe.ng/api/v1//misc/blacklists/add","description":"This is subjected to review before it will be available to the public.
\n","urlObject":{"path":["misc","blacklists","add"],"host":["https://sandbox.payscribe.ng/api/v1/"],"query":[],"variable":[]}},"response":[],"_postman_id":"55b1baf8-2d23-44f2-a602-f2ca20d87f94"}],"id":"cc9b866d-d537-4a93-8ee4-59a1438f728c","description":"We call this folder \"Blacklist\".
\nIn building a financial services application, you will likely come across Scammers, Fraudsters. Yes! Payscribe has been there, and we are proud to say that we take security VERY serions and dare.
\nUse Case
1. You can check if user account/phone number is on blacklist before giving value,
2. Check if user email, name is on blacklist while onboarding
Please you may take this blacklist details serious, Every blacklist details truly means they are scammers, fraudster
\nThis endpoints is a work in progress, and the idea came from Sokoya Philip Linkedin Post
\nIf you think there is a better way we can improve this, please send us a mail at hello@payscribe.ng. We are working closely to curbing the rate of scammers, and fraudsters and not hoarding the informations in the journey.
\n","_postman_id":"cc9b866d-d537-4a93-8ee4-59a1438f728c"},{"name":"Fetch Services","id":"bdbfece5-fb23-4383-85de-dd92d8c7bd8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1//misc/services?group_by=betting","description":"Get list of available services.
\nYou can also group the services by passing the group_by as a GET method
\n","urlObject":{"path":["misc","services"],"host":["https://sandbox.payscribe.ng/api/v1/"],"query":[{"key":"group_by","value":"betting"}],"variable":[]}},"response":[{"id":"b39c1c57-c02c-4191-89d1-e3f08c68640c","name":"Fetch Services","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1//misc/services?group_by=data","host":["https://sandbox.payscribe.ng/api/v1/"],"path":["misc","services"],"query":[{"key":"group_by","value":"data"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 22 Oct 2024 15:15:05 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Service looked up successfully!\",\n \"message\": {\n \"details\": [\n {\n \"id\": \"dstvshowmax\",\n \"title\": \"DSTV Showmax\",\n \"slug\": \"dstv-showmax\",\n \"category\": \"data\",\n \"active\": true,\n \"logo_url\": \"https://res.cloudinary.com/philo001/image/upload/payscribe/sm0frlc2xqyniurmx4hv.png\"\n },\n {\n \"id\": \"smile\",\n \"title\": \"Smile Internet\",\n \"slug\": \"smile-internet\",\n \"category\": \"data\",\n \"active\": true,\n \"logo_url\": \"https://res.cloudinary.com/philo001/image/upload/payscribe/ppeejj4wzh0kuqdlkrmt.png\"\n },\n {\n \"id\": \"9mobile\",\n \"title\": \"9mobile Data\",\n \"slug\": \"9mobile-data\",\n \"category\": \"data\",\n \"active\": true,\n \"logo_url\": \"https://res.cloudinary.com/philo001/image/upload/payscribe/qxwxfvr02sifutehgijg.png\"\n },\n {\n \"id\": \"airtel\",\n \"title\": \"Airtel Data\",\n \"slug\": \"airtel-data\",\n \"category\": \"data\",\n \"active\": true,\n \"logo_url\": \"https://res.cloudinary.com/philo001/image/upload/payscribe/bfkyynv8ekiqrwognnmn.png\"\n },\n {\n \"id\": \"glo\",\n \"title\": \"Glo Data\",\n \"slug\": \"glo-data\",\n \"category\": \"data\",\n \"active\": true,\n \"logo_url\": \"https://res.cloudinary.com/philo001/image/upload/payscribe/rtjf3obllyodehfafwnl.png\"\n },\n {\n \"id\": \"mtn\",\n \"title\": \"MTN Data\",\n \"slug\": \"mtn-data\",\n \"category\": \"data\",\n \"active\": true,\n \"logo_url\": \"https://res.cloudinary.com/philo001/image/upload/payscribe/pkpssop8pmetck3v02el.png\"\n }\n ]\n },\n \"status_code\": 200\n}"}],"_postman_id":"bdbfece5-fb23-4383-85de-dd92d8c7bd8a"}],"id":"20416698-4852-49bf-a644-b177ad502da2","description":"Miscellaneous - Some API references that you can power your project on.
\n","_postman_id":"20416698-4852-49bf-a644-b177ad502da2"},{"name":"Stablecoin (NEW)","item":[{"name":"Get available currencies","id":"0cacc4a4-eb91-4c46-96a0-2d410ec17a79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/stable/addresses/currencies","description":"Retrieves a list of supported currencies and their associated blockchain networks for wallet address generation. This endpoint returns details for each currency, including the available networks, required confirmation counts, and minimum transaction amounts. Use this endpoint to determine which currencies and networks are available for wallet operations. The response includes a status indicator, a description, and an array of currency details with network-specific information.
\n","urlObject":{"path":["addresses","currencies"],"host":["https://sandbox.payscribe.ng/api/v1/stable"],"query":[],"variable":[]}},"response":[{"id":"4fbd06c2-bb20-4696-ae78-30e592e21e6e","name":"Get available currencies","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/stable/addresses/currencies"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Sun, 26 Oct 2025 15:38:01 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization, X-Requested-With"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=2HuKRESIMhsR%2FiAEQHYv8eLUZ%2FeJCJUJcyudAKBEBqaFVc0xUoqlZdjzotbFvZzhBlh7AsQik3jBqn7voboAmjNsafAJQaRuuyIKMS5tjXo%3D\"}]}"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"CF-RAY","value":"994b09cf495c6aaa-MAN"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Wallet currencies retrieved\",\n \"message\": {\n \"details\": [\n {\n \"currency\": \"USDT\",\n \"networks\": [\n {\n \"network\": \"Arbitrum One\",\n \"chain\": \"ARB\",\n \"confirms\": 3,\n \"min_amount\": 0.0002999999999999999737189393389513725196593441069126129150390625\n },\n {\n \"network\": \"Avalanche C-Chain\",\n \"chain\": \"AVAXC\",\n \"confirms\": 12,\n \"min_amount\": 0.1000000000000000055511151231257827021181583404541015625\n },\n {\n \"network\": \"Base\",\n \"chain\": \"BASE\",\n \"confirms\": 3,\n \"min_amount\": 0.0002999999999999999737189393389513725196593441069126129150390625\n },\n {\n \"network\": \"BNB Smart Chain\",\n \"chain\": \"BEP20\",\n \"confirms\": 3,\n \"min_amount\": 0.00200000000000000004163336342344337026588618755340576171875\n },\n {\n \"network\": \"Ethereum\",\n \"chain\": \"ERC20\",\n \"confirms\": 3,\n \"min_amount\": 0.00200000000000000004163336342344337026588618755340576171875\n },\n {\n \"network\": \"Optimism\",\n \"chain\": \"OP\",\n \"confirms\": 3,\n \"min_amount\": 0.0002999999999999999737189393389513725196593441069126129150390625\n },\n {\n \"network\": \"Polygon\",\n \"chain\": \"POL\",\n \"confirms\": 3,\n \"min_amount\": 0.1000000000000000055511151231257827021181583404541015625\n },\n {\n \"network\": \"Solana\",\n \"chain\": \"SOL\",\n \"confirms\": 31,\n \"min_amount\": 0.01000000000000000020816681711721685132943093776702880859375\n },\n {\n \"network\": \"The Open Network\",\n \"chain\": \"TON\",\n \"confirms\": 3,\n \"min_amount\": 0.01000000000000000020816681711721685132943093776702880859375\n },\n {\n \"network\": \"Tron\",\n \"chain\": \"TRC20\",\n \"confirms\": 20,\n \"min_amount\": 5\n }\n ]\n },\n {\n \"currency\": \"BTC\",\n \"networks\": [\n {\n \"network\": \"Bitcoin\",\n \"chain\": \"BTC\",\n \"confirms\": 3,\n \"min_amount\": 0.000100000000000000004792173602385929598312941379845142364501953125\n }\n ]\n },\n {\n \"currency\": \"USDC\",\n \"networks\": [\n {\n \"network\": \"Arbitrum One\",\n \"chain\": \"ARB\",\n \"confirms\": 3,\n \"min_amount\": 0.0002999999999999999737189393389513725196593441069126129150390625\n },\n {\n \"network\": \"Base\",\n \"chain\": \"BASE\",\n \"confirms\": 3,\n \"min_amount\": 0.0002999999999999999737189393389513725196593441069126129150390625\n },\n {\n \"network\": \"BNB Smart Chain\",\n \"chain\": \"BEP20\",\n \"confirms\": 3,\n \"min_amount\": 0.00200000000000000004163336342344337026588618755340576171875\n },\n {\n \"network\": \"Ethereum\",\n \"chain\": \"ERC20\",\n \"confirms\": 3,\n \"min_amount\": 0.00200000000000000004163336342344337026588618755340576171875\n },\n {\n \"network\": \"Optimism\",\n \"chain\": \"OP\",\n \"confirms\": 3,\n \"min_amount\": 0.0002999999999999999737189393389513725196593441069126129150390625\n },\n {\n \"network\": \"Polygon\",\n \"chain\": \"POL\",\n \"confirms\": 3,\n \"min_amount\": 0.1000000000000000055511151231257827021181583404541015625\n },\n {\n \"network\": \"Solana\",\n \"chain\": \"SOL\",\n \"confirms\": 31,\n \"min_amount\": 0.01000000000000000020816681711721685132943093776702880859375\n }\n ]\n }\n ]\n },\n \"status_code\": 200\n}"}],"_postman_id":"0cacc4a4-eb91-4c46-96a0-2d410ec17a79"},{"name":"Generate Address","id":"5a352798-3aba-4b46-9307-d18f7f7fe1cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\n \"currency\" : \"USDT\",\n \"network\" : \"Tron\",\n \"chain\" : \"TRC20\",\n \"label\" : \"Tomiwa USDT\",\n \"customer_id\": \"e240bf54-8e46-4936-bdca-ca1c366e91db\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/stable/address/create","description":"This endpoint allows you to create a stable address for cryptocurrency transactions. It is specifically designed to handle requests for creating addresses in various cryptocurrency networks.
\nhttps://sandbox.payscribe.ng/api/v1/stable/address/createThe request should be sent in JSON format with the following parameters:
\nUpon a successful request, the server will respond with a JSON object containing the following structure:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"id\": 0,\n \"currency\": \"\",\n \"network\": \"\",\n \"chain\": \"\",\n \"address\": \"\",\n \"memo_tag\": null,\n \"is_primary\": true,\n \"created_at\": \"\",\n \"off_ramp_methods\": [\"\"],\n \"limits\": {\n \"daily_quote\": 0,\n \"monthly_quote\": 0\n }\n }\n },\n \"status_code\": 0\n}\n\nA successful response will have a status code of 200.
\nThe message.details object will contain information about the created address, including its unique ID, currency, network, and other relevant details.
Ensure that all mandatory parameters are included in the request to avoid errors.
\nThis endpoint is essential for users looking to generate stable addresses for their cryptocurrency transactions in a seamless manner.
\n","urlObject":{"path":["address","create"],"host":["https://sandbox.payscribe.ng/api/v1/stable"],"query":[],"variable":[]}},"response":[{"id":"1bba0e2f-fd02-4adf-b2b7-a711e2ea77b2","name":"Generate Address","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"{\n \"currency\" : \"USDT\",\n \"network\" : \"Tron\",\n \"chain\" : \"TRC20\",\n \"label\" : \"Tomiwa USDT\",\n \"customer_id\": \"e240bf54-8e46-4936-bdca-ca1c366e91db\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/stable/address/create"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 10 Oct 2025 05:24:52 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization, X-Requested-With"},{"key":"Vary","value":"Authorization,User-Agent"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=SU5DjTKPlh%2BUAwJU3yys%2BEN%2B4GKFsPbdjGifVW3R2IhtSm3hppkpSyx7BYl7%2FnVvR%2FWFVnrP0TYtDkm7TWdOqHtVcD2mmTMLGNipKaWT\"}]}"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"CF-RAY","value":"98c3b19b2df4d200-MAN"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Stablecoin address created\",\n \"message\": {\n \"details\": {\n \"id\": 33,\n \"currency\": \"USDT\",\n \"network\": \"Tron\",\n \"chain\": \"TRC20\",\n \"address\": \"TCM54ye2QdSGBzpNuKaPD6UH2zSFcznZ7Z\",\n \"memo_tag\": null,\n \"is_primary\": false,\n \"created_at\": \"2025-10-10 06:24:52\",\n \"off_ramp_methods\": [\n \"bank\",\n \"crypto\"\n ],\n \"limits\": {\n \"daily_quote\": 5000000,\n \"monthly_quote\": 20000000\n }\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"5a352798-3aba-4b46-9307-d18f7f7fe1cf"},{"name":"Get Wallet","id":"50643b52-6ab8-42cd-9d70-4a49286a18f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/stable/addresses/33","description":"This endpoint retrieves the details of a specific address associated with a user. The request is made using the GET method and requires the unique identifier of the address in the URL.
To fetch the details of an address, send a GET request to the endpoint:
GET https://sandbox.payscribe.ng/api/v1/stable/addresses/{address_id}\n\nWhere {address_id} is the unique identifier of the address you want to retrieve.
A successful response will return a JSON object with the following structure:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"id\": 0,\n \"user_id\": null,\n \"customer_id\": \"\",\n \"currency\": \"\",\n \"network\": \"\",\n \"chain\": \"\",\n \"address\": \"\",\n \"memo_tag\": null,\n \"label\": \"\",\n \"tracking_id\": \"\",\n \"provider\": \"\",\n \"is_primary\": true,\n \"status\": \"\",\n \"created_at\": \"\"\n }\n },\n \"status_code\": 0\n}\n\nstatus: Indicates the success of the request (boolean).
\ndescription: Additional information about the response (string).
\nmessage: Contains the details of the address.
\ndetails:
\nid: Unique identifier for the address (integer).
\nuser_id: Identifier for the user associated with the address (nullable).
\ncustomer_id: Identifier for the customer (string).
\ncurrency: Currency type associated with the address (string).
\nnetwork: Network type (string).
\nchain: Blockchain chain information (string).
\naddress: The actual address (string).
\nmemo_tag: Optional memo tag (nullable).
\nlabel: Label for the address (string).
\ntracking_id: Tracking identifier (string).
\nprovider: Provider information (string).
\nis_primary: Indicates if this is the primary address (boolean).
\nstatus: Current status of the address (string).
\ncreated_at: Timestamp of when the address was created (string).
\nstatus_code: Code representing the status of the response (integer).
\nEnsure that the address_id is valid to receive the correct address details.
The response may vary based on the address status and associated user data.
\nThis endpoint retrieves the details of addresses associated with a user. The request is made using the GET method to the specified endpoint.
To fetch the details of addresses, send a GET request to the endpoint:
GET https://sandbox.payscribe.ng/api/v1/stable/addresses\n\nA successful response will return a JSON object with the following structure:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": [\n [\n {\n \"id\": 0,\n \"user_id\": null,\n \"customer_id\": \"\",\n \"currency\": \"\",\n \"network\": \"\",\n \"chain\": \"\",\n \"address\": \"\",\n \"memo_tag\": null,\n \"label\": \"\",\n \"tracking_id\": \"\",\n \"is_primary\": true,\n \"status\": \"\",\n \"created_at\": \"\"\n }\n ]\n ]\n },\n \"status_code\": 0\n}\n\nstatus: Indicates the success of the request (boolean).
\ndescription: Additional information about the response (string).
\nmessage: Contains the details of the addresses.
\ndetails: An array of address details, where each address detail includes:
\nid: Unique identifier for the address (integer).
\nuser_id: Identifier for the user associated with the address (nullable).
\ncustomer_id: Identifier for the customer (string).
\ncurrency: Currency type associated with the address (string).
\nnetwork: Network type (string).
\nchain: Blockchain chain information (string).
\naddress: The actual address (string).
\nmemo_tag: Optional memo tag (nullable).
\nlabel: Label for the address (string).
\ntracking_id: Tracking identifier (string).
\nis_primary: Indicates if this is the primary address (boolean).
\nstatus: Current status of the address (string).
\ncreated_at: Timestamp of when the address was created (string).
\nstatus_code: Code representing the status of the response (integer).
\nEnsure that the request is made to the correct endpoint to retrieve the address details.
\nThe response may vary based on the addresses associated with the user.
\nThis endpoint retrieves the details of a specific address associated with a user. The request is made using the GET method and requires the unique identifier of the address in the URL.
To fetch the details of an address, send a GET request to the endpoint:
GET https://sandbox.payscribe.ng/api/v1/stable/addresses/{address_id}\n\nWhere {address_id} is the unique identifier of the address you want to retrieve.
A successful response will return a JSON object with the following structure:
\n{\n \"status\": true,\n \"description\": \"\",\n \"message\": {\n \"details\": {\n \"id\": 0,\n \"user_id\": null,\n \"customer_id\": \"\",\n \"currency\": \"\",\n \"network\": \"\",\n \"chain\": \"\",\n \"address\": \"\",\n \"memo_tag\": null,\n \"label\": \"\",\n \"tracking_id\": \"\",\n \"provider\": \"\",\n \"is_primary\": true,\n \"status\": \"\",\n \"created_at\": \"\"\n }\n },\n \"status_code\": 0\n}\n\nstatus: Indicates the success of the request (boolean).
\ndescription: Additional information about the response (string).
\nmessage: Contains the details of the address.
\ndetails:
\nid: Unique identifier for the address (integer).
\nuser_id: Identifier for the user associated with the address (nullable).
\ncustomer_id: Identifier for the customer (string).
\ncurrency: Currency type associated with the address (string).
\nnetwork: Network type (string).
\nchain: Blockchain chain information (string).
\naddress: The actual address (string).
\nmemo_tag: Optional memo tag (nullable).
\nlabel: Label for the address (string).
\ntracking_id: Tracking identifier (string).
\nprovider: Provider information (string).
\nis_primary: Indicates if this is the primary address (boolean).
\nstatus: Current status of the address (string).
\ncreated_at: Timestamp of when the address was created (string).
\nstatus_code: Code representing the status of the response (integer).
\nEnsure that the address_id is valid to receive the correct address details.
The response may vary based on the address status and associated user data.
\nCreate a unique stablecoin deposit address for your customers.
\n","_postman_id":"44f0edd0-77c6-4a77-8bde-98522ab3ee6e"},{"name":"Get Transaction Report","id":"da1879df-b77f-45eb-83e8-c3b383ec8496","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990"}],"url":"https://sandbox.payscribe.ng/api/v1/requery/?trans_id=e03e20b0-b815-4a46-b945-87e3d47e4ba1","description":"Get a transaction report.
\nThe transaction id that was seen when you initiated the transaction or the ref_id you passed when calling the endpoint.
\n","urlObject":{"path":[""],"host":["https://sandbox.payscribe.ng/api/v1/requery"],"query":[{"key":"trans_id","value":"e03e20b0-b815-4a46-b945-87e3d47e4ba1"}],"variable":[]}},"response":[],"_postman_id":"da1879df-b77f-45eb-83e8-c3b383ec8496"}],"event":[{"listen":"prerequest","script":{"id":"65b313a3-cdf1-4df4-a023-701b7eaac7b3","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"4d2b8d7a-a3d7-4ddf-b415-b80c47325186","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"BASE_URL","value":"https://sandbox.payscribe.ng/api/v1/","type":"string"},{"key":"API Token","value":"ps_pk_test_5fJUELCWRxbYyqE0mylVlfeekNK9iY0990","type":"string"},{"key":"secretKey","value":"ps_sk_test_xgLVdcRGydkhVgBNjhxu5kYo45I","type":"string"},{"key":"hash","value":""}]}