{"info":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","description":"

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.

Getting Started

To start using Payscribe API, you need to:

Sign up for a a test account on the Sandbox and once done you can proceed to going live Payscribe account
\n
Obtain your API key
\n
Test all endpoints with sandbox keys
\n
Satisfied with the integration? Proceed with your UAT and once done go live
\n

Receive payments from customers
\n
Issue USD Card
\n
Purchase airtime (local and international)
\n
Purchase internet data (local and international)
\n
Create savings for your customers
\n
Pay electricity bills (prepaid and postpaid)
\n
Pay cable subscription (GOTV, DSTV, Startimes)
\n
Pay internet data (Spectranet, Ntel, etc.
\n
Fund betting wallet (bet9ja, 1xbet, sportybet)
\n
Send bulk SMS
\n
Pay educational voucher (JAMB, NECO, etc.)
\n
Print recharge cards (MTN, GLO, AIRTEL, 9MOBILE): api/payscribe/recharge/ print
\n
Convert excess airtime to cash
\n
Fund transport wallet (Cowry Pay)
\n
Receive payments
\n
Make financial verifications
\n

API Request and Response

API requests should be made in JSON format
\n
API responses will be in JSON format
\n
Use your API key as Bearer in the header of each request
\n

Security

Our API uses SSL encryption to ensure secure transactions
\n
Use HTTPS protocol to make requests
\n

Rate limit

Payscribe 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

We 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 X (Formerly Twitter) with a friendly 👋 , contact our support team.

Non-breaking changes

Payscribe 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
\n
Additional new optional API request fields/parameters for existing endpoints
\n
Additional new optional HTTP headers in API requests for existing endpoints
\n
Additional new fields in API response for existing endpoints
\n
Additional HTTP headers in API response for existing endpoints
\n
Modification of text field values, for instance in error messages
\n
Introduction of new transaction statuses within a status class
\n
Introduction 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)
\n
Increasing length of existing text fields in API requests
\n
Adding new fields in callback endpoints
\n

The client implementation should be designed with the above in mind, so that non-breaking changes do not adversely affect the implementation.

Breaking changes

A 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
\n
Changing the accepted values for an API request fields
\n
Adding new mandatory field to an API request body, outside of information required for processing a transaction
\n
Change in an API response structure (renaming of fields)
\n

Whenever 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

Create 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

After then your profile setting page on payscribe.ng to get the token.

If 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

At Developers Hub you will find useful resources such as tutorials and SDKs for your choice of language.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Environment	Base URL
Sandbox (test mode)	https://sandbox.payscribe.ng/api/v1
Production (live mode)	https://api.payscribe.ng/api/v1

Be conscious of the Token, replace it with the token you generated on your profile page

Response code and message in response body

\n\n

200 = Success
\n
201 = Transaction Pending - Reverify using Payscribe trans_id or the ref passed
\n
400 = Bad Request, Something missing in your body request
\n
401 = User not authenticated
\n
403 = Forbidden request, Contact Support
\n
404 = Page Not found
\n
405 = Duplicate Transaction
\n
406 = Missing Required Information, Please check that you have provided all mandatory information
\n
407 = Invalid product code/token
\n
408 = Result Not Found
\n
409 = Invalid Amount to process. Transaction Limit
\n
410 = Insufficient money in your wallet
\n
434 = General Operator Side Error, Transaction Failed
\n
435 = General Database Error, Transaction Failed
\n
5xx = Some server-side error
\n

Please if you have any challenge/suggestion with the API kindly send us a mail hello@payscribe.ng

Events (Webhook)

\n\n

Use webhooks to get notified about transaction events that happen in your Payscribe account.

What is a Webhook

A 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.

In 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":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","publishedId":"2sBXitCSWK","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-04-10T15:47:07.000Z"},"item":[{"name":"Webhook Security & Signature Verification","item":[{"name":"Overview - Headers & Signing Algorithm","id":"b7dbb9d3-cdba-4328-8253-25649cb820ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}","description":"

Payscribe Webhook Security

Every webhook POST Payscribe sends to your endpoint includes four security headers.
You should validate all of them before trusting the payload.

Headers sent on every delivery

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Example value	Purpose
`X-Payscribe-Event-Id`	`3f8a2e1b-…`	Unique event UUID - use for idempotency
`X-Payscribe-Timestamp`	`1712745600`	Unix timestamp of delivery
`X-Payscribe-Signature`	`v1=4a3f…`	HMAC-SHA256 signature (see below)
`X-Payscribe-Event`	`invoice.paid`	Event type - route without parsing body
`Idempotency-Key`	`3f8a2e1b-…`	Same as Event-Id, for safe retries

How the signature is built

base      = timestamp + \".\" + event_id + \".\" + rawBody\nsignature = HMAC-SHA256(base, your_secret_key)\nheader    = \"v1=\" + hex(signature)\n\n

timestamp — the value from X-Payscribe-Timestamp
\n
event_id — the value from X-Payscribe-Event-Id
\n
rawBody — the exact raw bytes of the request body (do not parse then re-serialise)
\n
your_secret_key — your live or sandbox secret key from the Payscribe dashboard (sk_live_… / sk_test_…)
\n

Replay attack protection

Reject any webhook where:

abs(time() - X-Payscribe-Timestamp) > 300   // older than 5 minutes\n\n

Idempotency

Store the X-Payscribe-Event-Id in your database and skip processing if you've seen it before.
Payscribe retries failed deliveries with the same Event-Id, so this prevents double-processing.

Verifying the signature - PHP

function verifyPayscribeWebhook(string $secret): bool\n{\n    $eventId   = $_SERVER['HTTP_X_PAYSCRIBE_EVENT_ID']  ?? '';\n    $timestamp = $_SERVER['HTTP_X_PAYSCRIBE_TIMESTAMP'] ?? '';\n    $sigHeader = $_SERVER[&#x27;HTTP_X_PAYSCRIBE_SIGNATURE&#x27;] ?? &#x27;&#x27;;   // \"v1=<hex>\"\n    $rawBody   = file_get_contents('php://input');\n    // 1. Validate signature header format\n    if (!preg_match('/^v1=([0-9a-f]{64})$/', $sigHeader, $m)) {\n        http_response_code(400);\n        exit('Invalid signature header');\n    }\n    $givenSig = $m[1];\n    // 2. Reject stale timestamps (replay protection)\n    if (abs(time() - (int)$timestamp) > 300) {\n        http_response_code(401);\n        exit('Stale webhook — timestamp too old');\n    }\n    // 3. Recompute HMAC\n    $base = $timestamp . '.' . $eventId . '.' . $rawBody;\n    $calc = hash_hmac('sha256', $base, $secret);\n    // 4. Constant-time comparison\n    if (!hash_equals($calc, $givenSig)) {\n        http_response_code(401);\n        exit('Signature mismatch');\n    }\n    return true;\n}\n// Usage\n$secret = 'sk_live_your_secret_key';\nverifyPayscribeWebhook($secret);\n$event = json_decode(file_get_contents('php://input'), true);\n// Idempotency - skip if already processed\n$eventId = $event['event_id'];\n// if (alreadyProcessed($eventId)) { http_response_code(200); exit('duplicate'); }\nswitch ($event['event_type']) {\n    case 'bills.created':\n        // handle ...\n        break;\n    case 'cards.*':\n        // handle ...\n        break;\n    case 'invoice.paid':\n        // handle ...\n        break;\n    case 'payment_link.paid':\n        // handle ...\n        break;\n    case 'savings.contribution.success':\n        // handle ...\n        break;\n}\nhttp_response_code(200);\necho 'OK';\n\n

Verifying the signature — Node.js

const crypto = require('crypto');\nfunction verifyPayscribeWebhook(req, secret) {\n  const eventId   = req.headers['x-payscribe-event-id']  ?? '';\n  const timestamp = req.headers['x-payscribe-timestamp'] ?? '';\n  const sigHeader = req.headers[&#x27;x-payscribe-signature&#x27;] ?? &#x27;&#x27;; // \"v1=<hex>\"\n  // rawBody must be the raw Buffer/string - not req.body (already parsed)\n  const rawBody = req.rawBody; // set via express.raw() or similar\n  // 1. Validate header format\n  const match = sigHeader.match(/^v1=([0-9a-f]{64})$/);\n  if (!match) return false;\n  const givenSig = match[1];\n  // 2. Replay protection\n  if (Math.abs(Date.now() / 1000 - Number(timestamp)) > 300) return false;\n  // 3. Recompute HMAC\n  const base = `${timestamp}.${eventId}.${rawBody}`;\n  const calc = crypto.createHmac('sha256', secret).update(base).digest('hex');\n  // 4. Constant-time comparison\n  return crypto.timingSafeEqual(Buffer.from(calc), Buffer.from(givenSig));\n}\n// Express example\napp.post('/webhooks/payscribe',\n  express.raw({ type: 'application/json' }),\n  (req, res) => {\n    req.rawBody = req.body.toString('utf8');\n    if (!verifyPayscribeWebhook(req, process.env.PAYSCRIBE_SECRET)) {\n      return res.status(401).send('Signature verification failed');\n    }\n    const event = JSON.parse(req.rawBody);\n    switch (event.event_type) {\n      case 'bills.*':                /* handle */ break;\n      case 'cards.*':                /* handle */ break;\n      case 'invoice.paid':           /* handle */ break;\n      case 'payment_link.paid':      /* handle */ break;\n      case 'savings.withdrawal.success': /* handle */ break;\n    }\n    res.status(200).send('OK');\n  }\n);\n\n

Verifying the signature — Python

import hashlib, hmac, time\nfrom flask import Flask, request, abort\napp = Flask(__name__)\nPAYSCRIBE_SECRET = 'sk_live_your_secret_key'\ndef verify_payscribe_signature(secret: str) -> bool:\n    event_id   = request.headers.get('X-Payscribe-Event-Id', '')\n    timestamp  = request.headers.get('X-Payscribe-Timestamp', '')\n    sig_header = request.headers.get(&#x27;X-Payscribe-Signature&#x27;, &#x27;&#x27;)  # \"v1=<hex>\"\n    raw_body   = request.get_data(as_text=True)  # raw bytes as string\n    # 1. Validate header format\n    if not sig_header.startswith('v1=') or len(sig_header) != 67:\n        return False\n    given_sig = sig_header[3:]\n    # 2. Replay protection\n    try:\n        if abs(time.time() - int(timestamp)) > 300:\n            return False\n    except (ValueError, TypeError):\n        return False\n    # 3. Recompute HMAC\n    base = f\"{timestamp}.{event_id}.{raw_body}\"\n    calc = hmac.new(secret.encode(), base.encode(), hashlib.sha256).hexdigest()\n    # 4. Constant-time comparison\n    return hmac.compare_digest(calc, given_sig)\n@app.route('/webhooks/payscribe', methods=['POST'])\ndef webhook():\n    if not verify_payscribe_signature(PAYSCRIBE_SECRET):\n        abort(401, 'Signature verification failed')\n    event = request.get_json(force=True)\n    match event.get('event_type'):\n        case 'bills.*':\n            pass # handle\n        case 'cards.*':\n            pass # handle\n        case 'invoice.paid':\n            pass  # handle\n        case 'payment_link.paid':\n            pass  # handle\n        case 'savings.contribution.success':\n            pass  # handle\n    return 'OK', 200\n\n

Common mistakes to avoid

1. Parsing the body before verifying

Wrong - json.loads(request.body) then re-serialising will produce different bytes if key order changes.

Correct - Read the raw request body first, verify the signature, then parse.

2. Using `==` instead of a constant-time comparison

Wrong - calc == given_sig leaks timing information, enabling signature forgery.

Correct -hash_equals($calc, $givenSig) (PHP) / crypto.timingSafeEqual(...) (Node.js) / hmac.compare_digest(...) (Python).

3. Skipping the timestamp check

Wrong - Not validating the timestamp allows an attacker to replay a captured webhook indefinitely.

Correct - Reject any request where abs(now - timestamp) > 300.

4. Not implementing idempotency

Wrong - Processing the same event twice because Payscribe retried a delivery you didn't acknowledge in time.

Correct - Store X-Payscribe-Event-Id in a DB column with a UNIQUE constraint and skip duplicates.

5. Returning a non-2xx status on success

Payscribe considers any response outside 2xx a failure and will retry.
Always return HTTP 200 once you've accepted the event, even if your downstream processing is async.

How to verify Payscribe webhook signatures. Read this before implementing any webhook handler.

\n","_postman_id":"007bac66-92bd-4f4f-b992-b0e48b795290","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Bills Payments API","item":[{"name":"Cable TV Subscription","item":[{"name":"Fetch Bouquets","id":"71975305-de9f-49fd-befa-9c5ea759338f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"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.

Please note: once there is an update in the pricing of these service providers it may require that you fetch this bouquets plan again.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}},"urlObject":{"host":["https://sandbox.payscribe.ng/api/v1/bouquets"],"query":[{"key":"service","value":"dstv"}],"variable":[]}},"response":[{"id":"fe362e48-c616-4af4-a23f-95049c7f3587","name":"Showmax - Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"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":"e0e93af7-be69-4531-9325-80a4494eafff","name":"Startimes - Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"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":"26e9601a-f027-41d4-91c4-c16f1c02d973","name":"Gotv - success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"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":"fa35292d-ecb9-45e5-b304-6ff4d052f4a9","name":"Dstv - Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"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":"71975305-de9f-49fd-befa-9c5ea759338f"},{"name":"Validate smart card number","id":"b11c2176-0025-4ffc-bb80-db45d8795210","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"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'

Validate smart card number to get bouquet and customer details before vending.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
account	String	required	The smart card number
service	String	required	gotv or dstv or startimes or dstvshomax
month	Int	optional	Number of months you are subscribing for. Default to 1
plan_id	String	required	The id you got when you called the bouquets

A Sample Response Below

{\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\n

HTTP POST https://sandbox.payscribe.ng/api/v1/multichoice/vend

This endpoint is used to make a payment for GOTV, DSTV, or Startimes services.

Request Body

{ \"plan_id\": \"\", \"customer_name\": \"\", \"account\": \"\", \"service\": \"\", \"ref\": \"\", \"phone\": \"\", \"email\": \"\", \"month\": 1}

- `plan_id` (required, String): ID retrieved when you fetch the bouquets.\n- `customer_name` (required, String): Customer name obtained during validation.\n- `account` (required, String): The smart card number. For Startimes, this is the phone number.\n- `service` (required, String): Service provider (gotv, dstv, startimes, or dstvshowmax).\n- `month` (optional, Int): Number of months for subscription (default is 1).\n- `ref` (required, String): Your reference ID. Accepts alphanumeric characters and hyphens.\n- `email` (optional, String): Your customer email ID. We fallback to your account email if not passed\n- `phone` (optional, String): Your customer phone number. We fallback to your business pgone number if not passed\n\n

HTTP POST https://sandbox.payscribe.ng/api/v1/multichoice/topup

This endpoint is used to make a topup for DSTV/GOTV

For 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.

Request Body

{ \"amount\": \"10000\", \"customer_name\": \"\", \"account\": \"\", \"service\": \"\", \"ref\": \"\", \"phone\": \"\", \"email\": \"\", \"month\": 1}

Cable subscription

Startimes, DSTV, GOTV, and DSTV

\n","_postman_id":"f50a2b23-0107-4a81-82bb-11c900e28dc3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Internet Subscription - Ntel,Spectranet...","item":[{"name":"List Internet Services","id":"d0493892-75ca-47dd-8673-cad87755ffa0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"body":{"mode":"raw","raw":"{\n \"type\": \"smile\",\n \"account\": \"1906003293\"\n}\n"},"url":"https://sandbox.payscribe.ng/api/v1/internet/list","description":"

GET /internet/list

This endpoint is used to get the active internet subscription and its associated ids.

Response

The response of this request can be documented as a JSON schema:

{\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

Example Response

{\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\n

Get Sepectranet pins plan

This endpoint allows you to validate user's smart card and before purchasing a plan.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	description
account	String	required	The smart card number
type	String	required	The internet type ( spectranet or ntel )

Sample 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\n

Internet Subscription for Ntel, Spectranet...

\n","_postman_id":"247de6ac-4523-40c7-8e50-17bad6c2a8d9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Data Bundle","item":[{"name":"Data Lookup","id":"4506ddeb-ead4-4213-b0c6-98b246fbb5c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"body":{"mode":"raw","raw":""},"url":"https://sandbox.payscribe.ng/api/v1/data/lookup?network=airtel","description":"

GET /data/lookup

This endpoint retrieves data plans for a specific network.

Request Parameters

network (optional, String): This parameter specifies the network for which you want to lookup data plans. Accepted values are mtn, airtime, glo, or 9mobile, dstvshowmax
\n
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
\n

To vend for ntel, spectranet, and other networks, please refer to the /internet page.

Response

The response will have a status code of 200 and a content type of application/json. The response body will contain the following fields:

status (Boolean): Indicates the status of the response.
\n
description (String): Provides a description of the response.
\n
message (Object): Contains details about the data plans for the specified network, including network name, title, network code, check balance, logo URL, and plans.
\n
- details (Array): Contains information about the network, including its name, title, code, balance check, logo URL, and available plans.
  \n
  - network_name (String): Name of the network.
    \n
  - title (String): Title of the network.
    \n
  - network_code (String): Code of the network.
    \n
  - check_balance (String): URL for checking balance.
    \n
  - logo_url (String): URL of the network's logo.
    \n
  - plans (Array): Contains details of the available data plans.
    \n
    - plan_code (String): Code of the plan.
      \n
    - name (String): Name of the plan.
      \n
    - alias (String): Alias of the plan.
      \n
    - amount (String): Amount of the plan.
      \n
    \n
  \n
\n

Example Response Body:

{\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\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}},"urlObject":{"path":["lookup"],"host":["https://sandbox.payscribe.ng/api/v1/data"],"query":[{"key":"network","value":"airtel"}],"variable":[]}},"response":[{"id":"94a98d73-2548-491a-96c3-d40cd6d487ad","name":"Smile Plan Lookup Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1/data/lookup?network=smile","host":["https://sandbox.payscribe.ng/api/v1/data"],"path":["lookup"],"query":[{"key":"network","value":"smile"}]}},"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":"5089"},{"key":"date","value":"Mon, 24 Jun 2024 21:54:02 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"SMILE data plan lookup successfully.\",\n \"message\": {\n \"details\": [\n {\n \"network_name\": \"smile\",\n \"title\": \"Smile Internet\",\n \"network_code\": \"PSDATA_42\",\n \"check_balance\": \"\",\n \"logo_url\": \"https://res.cloudinary.com/philo001/image/upload/payscribe/ppeejj4wzh0kuqdlkrmt.png\",\n \"plans\": [\n {\n \"plan_code\": \"PSPLAN_587\",\n \"name\": \"70GB 365 - 365 days\",\n \"alias\": \"689\",\n \"amount\": \"35200.00\"\n },\n {\n \"plan_code\": \"PSPLAN_586\",\n \"name\": \"1GB FlexiWeekly - 7 days\",\n \"alias\": \"626\",\n \"amount\": \"550.00\"\n },\n {\n \"plan_code\": \"PSPLAN_585\",\n \"name\": \"2.5GB FlexiDaily - 2 days\",\n \"alias\": \"625\",\n \"amount\": \"550.00\"\n },\n {\n \"plan_code\": \"PSPLAN_584\",\n \"name\": \"160GB Jumbo - 90 days\",\n \"alias\": \"666\",\n \"amount\": \"37400.00\"\n },\n {\n \"plan_code\": \"PSPLAN_583\",\n \"name\": \"6.5GB Bigga - 30 days\",\n \"alias\": \"609\",\n \"amount\": \"2750.00\"\n },\n {\n \"plan_code\": \"PSPLAN_582\",\n \"name\": \"130GB Bigga - 30 days\",\n \"alias\": \"21780\",\n \"amount\": \"21780.00\"\n },\n {\n \"plan_code\": \"PSPLAN_581\",\n \"name\": \"SmileVoice ONLY 500 - 90 days\",\n \"alias\": \"6050\",\n \"amount\": \"6050.00\"\n },\n {\n \"plan_code\": \"PSPLAN_580\",\n \"name\": \"2GB Bigga - 30 days\",\n \"alias\": \"1320\",\n \"amount\": \"1320.00\"\n },\n {\n \"plan_code\": \"PSPLAN_579\",\n \"name\": \"SmileVoice ONLY 65 - 30 days\",\n \"alias\": \"600\",\n \"amount\": \"600.00\"\n },\n {\n \"plan_code\": \"PSPLAN_578\",\n \"name\": \"90GB Jumbo - 60 days\",\n \"alias\": \"22000\",\n \"amount\": \"22000.00\"\n },\n {\n \"plan_code\": \"PSPLAN_577\",\n \"name\": \"15GB 365 - 365 days\",\n \"alias\": \"9900\",\n \"amount\": \"9900.00\"\n },\n {\n \"plan_code\": \"PSPLAN_576\",\n \"name\": \"1GB FlexiWeekly - 7 days\",\n \"alias\": \"550\",\n \"amount\": \"550.00\"\n },\n {\n \"plan_code\": \"PSPLAN_575\",\n \"name\": \"2GB FlexiWeekly - 7 days\",\n \"alias\": \"1100\",\n \"amount\": \"1100.00\"\n },\n {\n \"plan_code\": \"PSPLAN_574\",\n \"name\": \"UnlimitedLite - 30 days\",\n \"alias\": \"13200\",\n \"amount\": \"13200.00\"\n },\n {\n \"plan_code\": \"PSPLAN_573\",\n \"name\": \"1TB 365 - 365 days\",\n \"alias\": \"132000\",\n \"amount\": \"132000.00\"\n },\n {\n \"plan_code\": \"PSPLAN_572\",\n \"name\": \"125GB 365 - 365 days\",\n \"alias\": \"55000\",\n \"amount\": \"55000.00\"\n },\n {\n \"plan_code\": \"PSPLAN_571\",\n \"name\": \"Freedom Mobile Plan - 30 days\",\n \"alias\": \"5000\",\n \"amount\": \"5000.00\"\n },\n {\n \"plan_code\": \"PSPLAN_570\",\n \"name\": \"200GB Jumbo - 120 days\",\n \"alias\": \"44000\",\n \"amount\": \"44000.00\"\n },\n {\n \"plan_code\": \"PSPLAN_569\",\n \"name\": \"SmileVoice ONLY 135 - 30 days\",\n \"alias\": \"1250\",\n \"amount\": \"1250.00\"\n },\n {\n \"plan_code\": \"PSPLAN_568\",\n \"name\": \"SmileVoice ONLY 175 - 90 days\",\n \"alias\": \"2400\",\n \"amount\": \"2400.00\"\n },\n {\n \"plan_code\": \"PSPLAN_567\",\n \"name\": \"100GB Bigga - 30 days\",\n \"alias\": \"19800\",\n \"amount\": \"19800.00\"\n },\n {\n \"plan_code\": \"PSPLAN_566\",\n \"name\": \"SmileVoice ONLY 150 - 60 days\",\n \"alias\": \"1800\",\n \"amount\": \"1800.00\"\n },\n {\n \"plan_code\": \"PSPLAN_565\",\n \"name\": \"20GB Bigga - 30 days\",\n \"alias\": \"5500\",\n \"amount\": \"5500.00\"\n },\n {\n \"plan_code\": \"PSPLAN_564\",\n \"name\": \"75GB Bigga - 30 days\",\n \"alias\": \"16500\",\n \"amount\": \"16500.00\"\n },\n {\n \"plan_code\": \"PSPLAN_563\",\n \"name\": \"15GB Bigga - 30 days\",\n \"alias\": \"4400\",\n \"amount\": \"4400.00\"\n },\n {\n \"plan_code\": \"PSPLAN_562\",\n \"name\": \"60GB Bigga - 30 days\",\n \"alias\": \"14850\",\n \"amount\": \"14850.00\"\n },\n {\n \"plan_code\": \"PSPLAN_561\",\n \"name\": \"6GB FlexiWeekly - 7 days\",\n \"alias\": \"1650\",\n \"amount\": \"1650.00\"\n },\n {\n \"plan_code\": \"PSPLAN_560\",\n \"name\": \"1.5GB Bigga - 30 days\",\n \"alias\": \"1100\",\n \"amount\": \"1100.00\"\n },\n {\n \"plan_code\": \"PSPLAN_559\",\n \"name\": \"Freedom 3Mbps - 30 days\",\n \"alias\": \"27500\",\n \"amount\": \"27500.00\"\n },\n {\n \"plan_code\": \"PSPLAN_558\",\n \"name\": \"6.5GB Bigga - 30 days\",\n \"alias\": \"2750\",\n \"amount\": \"2750.00\"\n },\n {\n \"plan_code\": \"PSPLAN_557\",\n \"name\": \"Freedom 6Mbps - 30 days\",\n \"alias\": \"33000\",\n \"amount\": \"33000.00\"\n },\n {\n \"plan_code\": \"PSPLAN_556\",\n \"name\": \"SmileVoice ONLY 450 - 60 days\",\n \"alias\": \"4850\",\n \"amount\": \"4850.00\"\n },\n {\n \"plan_code\": \"PSPLAN_555\",\n \"name\": \"10GB Bigga - 30 days\",\n \"alias\": \"3300\",\n \"amount\": \"3300.00\"\n },\n {\n \"plan_code\": \"PSPLAN_554\",\n \"name\": \"160GB Jumbo - 90 days\",\n \"alias\": \"37400\",\n \"amount\": \"37400.00\"\n },\n {\n \"plan_code\": \"PSPLAN_553\",\n \"name\": \"International SmileVoice ONLY 125 - 30 days\",\n \"alias\": \"1100\",\n \"amount\": \"1100.00\"\n },\n {\n \"plan_code\": \"PSPLAN_552\",\n \"name\": \"1GB FlexiDaily - 1 days\",\n \"alias\": \"330\",\n \"amount\": \"330.00\"\n },\n {\n \"plan_code\": \"PSPLAN_551\",\n \"name\": \"5GB Bigga - 30 days\",\n \"alias\": \"2200\",\n \"amount\": \"2200.00\"\n },\n {\n \"plan_code\": \"PSPLAN_550\",\n \"name\": \"UnlimitedEssential - 30 days\",\n \"alias\": \"19800\",\n \"amount\": \"19800.00\"\n },\n {\n \"plan_code\": \"PSPLAN_549\",\n \"name\": \"70GB 365 - 365 days\",\n \"alias\": \"35200\",\n \"amount\": \"35200.00\"\n },\n {\n \"plan_code\": \"PSPLAN_548\",\n \"name\": \"3GB Bigga - 30 days\",\n \"alias\": \"1650\",\n \"amount\": \"1650.00\"\n },\n {\n \"plan_code\": \"PSPLAN_547\",\n \"name\": \"Freedom BestEffort - 30 days\",\n \"alias\": \"44000\",\n \"amount\": \"44000.00\"\n },\n {\n \"plan_code\": \"PSPLAN_546\",\n \"name\": \"SmileVoice 30GB Bigga - 30 daysONLY 175 (New) - 90 days\",\n \"alias\": \"8800\",\n \"amount\": \"8800.00\"\n },\n {\n \"plan_code\": \"PSPLAN_545\",\n \"name\": \"International SmileVoice ONLY 60 - 7 days\",\n \"alias\": \"550\",\n \"amount\": \"550.00\"\n },\n {\n \"plan_code\": \"PSPLAN_544\",\n \"name\": \"200GB 365 - 365 days\",\n \"alias\": \"77000\",\n \"amount\": \"77000.00\"\n },\n {\n \"plan_code\": \"PSPLAN_543\",\n \"name\": \"35GB 365 - 365 days\",\n \"alias\": \"20900\",\n \"amount\": \"20900.00\"\n },\n {\n \"plan_code\": \"PSPLAN_542\",\n \"name\": \"500GB 365 - 365 days\",\n \"alias\": \"110000\",\n \"amount\": \"110000.00\"\n },\n {\n \"plan_code\": \"PSPLAN_541\",\n \"name\": \"40GB Bigga - 30 days\",\n \"alias\": \"11000\",\n \"amount\": \"11000.00\"\n },\n {\n \"plan_code\": \"PSPLAN_540\",\n \"name\": \"2.5GB FlexiDaily - 2 days\",\n \"alias\": \"550\",\n \"amount\": \"550.00\"\n },\n {\n \"plan_code\": \"PSPLAN_539\",\n \"name\": \"400GB Jumbo - 180 days\",\n \"alias\": \"55000\",\n \"amount\": \"55000.00\"\n },\n {\n \"plan_code\": \"PSPLAN_538\",\n \"name\": \"25GB Bigga - 30 days\",\n \"alias\": \"6600\",\n \"amount\": \"6600.00\"\n }\n ]\n }\n ]\n },\n \"status_code\": 200\n}"},{"id":"5d637a52-5410-4682-b7c0-38fa0bcde5c0","name":"Showmax Data Lookup","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1/data/lookup?network=dstvshowmax","host":["https://sandbox.payscribe.ng/api/v1/data"],"path":["lookup"],"query":[{"key":"network","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":"set-cookie","value":"ci_session=k1le4jec4obmrdf4o7uf0pup74h97hcf; expires=Mon, 01-Jul-2024 21:49:20 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":"2237"},{"key":"date","value":"Mon, 01 Jul 2024 19:49:20 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"DSTVSHOWMAX data plan lookup successfully.\",\n \"message\": {\n \"details\": [\n {\n \"network_name\": \"dstvshowmax\",\n \"title\": \"DSTV Showmax\",\n \"network_code\": \"PSDATA_51\",\n \"check_balance\": \"\",\n \"logo_url\": \"https://res.cloudinary.com/philo001/image/upload/payscribe/sm0frlc2xqyniurmx4hv.png\",\n \"plans\": [\n {\n \"plan_code\": \"PSPLAN_1267\",\n \"name\": \"Premier League (Mobile) for 6 months\",\n \"alias\": \"sports_only_6\",\n \"amount\": \"16500.00\"\n },\n {\n \"plan_code\": \"PSPLAN_384\",\n \"name\": \"Entertainment (All Devices) for 1 month\",\n \"alias\": \"full_1\",\n \"amount\": \"2500.00\"\n },\n {\n \"plan_code\": \"PSPLAN_383\",\n \"name\": \"Entertainment (Mobile) for 1 month\",\n \"alias\": \"mobile_only_1\",\n \"amount\": \"1200.00\"\n },\n {\n \"plan_code\": \"PSPLAN_381\",\n \"name\": \"Entertainment (Mobile) + PL (Mobile) for 1 month\",\n \"alias\": \"sports_mobile_only_1\",\n \"amount\": \"3200.00\"\n },\n {\n \"plan_code\": \"PSPLAN_379\",\n \"name\": \"Entertainment (All Devices) + PL (Mobile) Bundle for 1 month\",\n \"alias\": \"full_sports_mobile_only_1\",\n \"amount\": \"4600.00\"\n },\n {\n \"plan_code\": \"PSPLAN_378\",\n \"name\": \"Premier League (Mobile) for 1 month\",\n \"alias\": \"sports_only_1\",\n \"amount\": \"2900.00\"\n },\n {\n \"plan_code\": \"PSPLAN_377\",\n \"name\": \"Premier League (Mobile) for 3 months\",\n \"alias\": \"sports_only_3\",\n \"amount\": \"8700.00\"\n },\n {\n \"plan_code\": \"PSPLAN_376\",\n \"name\": \"Entertainment (Mobile) for 3 months\",\n \"alias\": \"mobile_only_3\",\n \"amount\": \"2800.00\"\n },\n {\n \"plan_code\": \"PSPLAN_375\",\n \"name\": \"Entertainment (All Devices) for 3 months\",\n \"alias\": \"full_3\",\n \"amount\": \"6000.00\"\n },\n {\n \"plan_code\": \"PSPLAN_374\",\n \"name\": \"Entertainment (Mobile) + PL (Mobile) Bundle for 3 months\",\n \"alias\": \"sports_mobile_only_3\",\n \"amount\": \"9600.00\"\n },\n {\n \"plan_code\": \"PSPLAN_373\",\n \"name\": \"Entertainment (All Devices) + PL (Mobile) Bundle for 3 months\",\n \"alias\": \"full_sports_mobile_only_3\",\n \"amount\": \"13800.00\"\n },\n {\n \"plan_code\": \"PSPLAN_372\",\n \"name\": \"Entertainment (Mobile) for 6 months\",\n \"alias\": \"mobile_only_6\",\n \"amount\": \"5000.00\"\n },\n {\n \"plan_code\": \"PSPLAN_371\",\n \"name\": \"Entertainment (All Devices) for 6 months\",\n \"alias\": \"full_6\",\n \"amount\": \"10500.00\"\n },\n {\n \"plan_code\": \"PSPLAN_370\",\n \"name\": \"Entertainment (All Devices) + PL (Mobile) Bundle for 6 months\",\n \"alias\": \"full_sports_mobile_only_6\",\n \"amount\": \"27600.00\"\n },\n {\n \"plan_code\": \"PSPLAN_369\",\n \"name\": \"Entertainment (Mobile) + PL (Mobile) Bundle for 6 months\",\n \"alias\": \"sports_mobile_only_6\",\n \"amount\": \"19200.00\"\n }\n ]\n }\n ]\n },\n \"status_code\": 200\n}"},{"id":"c8f3ea37-4f9e-446f-a1cb-edd1e254d84d","name":"Data Lookup Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1/data/lookup?network=mtn","host":["https://sandbox.payscribe.ng/api/v1/data"],"path":["lookup"],"query":[{"key":"network","value":"mtn"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Aug 2024 12:39:47 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=235f1e3883ec988e11d5afccaa899f40a5542f4d; expires=Fri, 09-Aug-2024 14:39:48 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\": \"MTN data plan lookup successfully.\",\n \"message\": {\n \"details\": [\n {\n \"network_name\": \"mtn\",\n \"title\": \"MTN Data\",\n \"network_code\": \"PSDATA_15\",\n \"check_balance\": \"\",\n \"logo_url\": \"https://res.cloudinary.com/philo001/image/upload/payscribe/pkpssop8pmetck3v02el.png\",\n \"plans\": [\n {\n \"plan_code\": \"PSPLAN_185\",\n \"name\": \"500MB - 30days val - GIFTING\",\n \"category\": \"gifting\",\n \"alias\": \"500MB_GIFTING\",\n \"amount\": 147.75\n },\n {\n \"plan_code\": \"PSPLAN_158\",\n \"name\": \"500MB 30 days Validity - SME\",\n \"category\": \"sme\",\n \"alias\": \"500MB_SME\",\n \"amount\": 147.75\n },\n {\n \"plan_code\": \"PSPLAN_537\",\n \"name\": \"500MB - 30days - CG\",\n \"category\": \"cg\",\n \"alias\": \"500MB_CG\",\n \"amount\": 157.599999999999994315658113919198513031005859375\n },\n {\n \"plan_code\": \"PSPLAN_177\",\n \"name\": \"1GB - 30days validity - SME\",\n \"category\": \"sme\",\n \"alias\": \"1GB_SME\",\n \"amount\": 265.94999999999998863131622783839702606201171875\n },\n {\n \"plan_code\": \"PSPLAN_531\",\n \"name\": \"1GB - 30 Days - CG\",\n \"category\": \"cg\",\n \"alias\": \"1GB_CG\",\n \"amount\": 275.80000000000001136868377216160297393798828125\n },\n {\n \"plan_code\": \"PSPLAN_58\",\n \"name\": \"1GB 30 days Validity - SME\",\n \"category\": \"sme\",\n \"alias\": \"1GB_SME\",\n \"amount\": 275.80000000000001136868377216160297393798828125\n },\n {\n \"plan_code\": \"PSPLAN_613\",\n \"name\": \"1GB Daily for Daily - Daily\",\n \"category\": \"sme\",\n \"alias\": \"1GB_DAILY_SME\",\n \"amount\": 350\n },\n {\n \"plan_code\": \"PSPLAN_178\",\n \"name\": \"2GB - 30days val. - SME\",\n \"category\": \"sme\",\n \"alias\": \"2GB_SME\",\n \"amount\": 531.8999999999999772626324556767940521240234375\n },\n {\n \"plan_code\": \"PSPLAN_532\",\n \"name\": \"2GB - 30 Days - CG\",\n \"category\": \"cg\",\n \"alias\": \"2GB_CG\",\n \"amount\": 551.6000000000000227373675443232059478759765625\n },\n {\n \"plan_code\": \"PSPLAN_59\",\n \"name\": \"2GB 30 days Validity - SME\",\n \"category\": \"sme\",\n \"alias\": \"2GB_SME\",\n \"amount\": 551.6000000000000227373675443232059478759765625\n },\n {\n \"plan_code\": \"PSPLAN_614\",\n \"name\": \"2.5GB 2Day Plan - 2Days\",\n \"category\": null,\n \"alias\": \"600_20_DIRECT\",\n \"amount\": 600\n },\n {\n \"plan_code\": \"PSPLAN_615\",\n \"name\": \"3GB for 2Days - 2Days\",\n \"category\": null,\n \"alias\": \"800_89_DIRECT\",\n \"amount\": 800\n },\n {\n \"plan_code\": \"PSPLAN_179\",\n \"name\": \"3GB - 30days val - SME\",\n \"category\": \"sme\",\n \"alias\": \"3GB_SME\",\n \"amount\": 797.8500000000000227373675443232059478759765625\n },\n {\n \"plan_code\": \"PSPLAN_533\",\n \"name\": \"3GB - 30 Days - CG\",\n \"category\": \"cg\",\n \"alias\": \"3GB_CG\",\n \"amount\": 827.3999999999999772626324556767940521240234375\n },\n {\n \"plan_code\": \"PSPLAN_163\",\n \"name\": \"3GB 30 days Validity - SME\",\n \"category\": \"sme\",\n \"alias\": \"3GB_SME\",\n \"amount\": 827.3999999999999772626324556767940521240234375\n },\n {\n \"plan_code\": \"PSPLAN_616\",\n \"name\": \"1.2GB Monthly Plan + FREE 2GB for YouTube for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"1000_DIRECT\",\n \"amount\": 1000\n },\n {\n \"plan_code\": \"PSPLAN_617\",\n \"name\": \"1.5GB+2.4GB YouTube Night for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"1200_DIRECT\",\n \"amount\": 1200\n },\n {\n \"plan_code\": \"PSPLAN_180\",\n \"name\": \"5GB - 30days val - SME\",\n \"category\": \"sme\",\n \"alias\": \"5GB_SME\",\n \"amount\": 1329.75\n },\n {\n \"plan_code\": \"PSPLAN_534\",\n \"name\": \"5GB - 30 days - CG\",\n \"category\": \"cg\",\n \"alias\": \"5GB_CG\",\n \"amount\": 1379\n },\n {\n \"plan_code\": \"PSPLAN_101\",\n \"name\": \"5GB 30 days Validity - SME\",\n \"category\": \"sme\",\n \"alias\": \"5GB_SME\",\n \"amount\": 1379\n },\n {\n \"plan_code\": \"PSPLAN_618\",\n \"name\": \"5GB for Weekly - Weekly\",\n \"category\": null,\n \"alias\": \"1500_DIRECT\",\n \"amount\": 1500\n },\n {\n \"plan_code\": \"PSPLAN_619\",\n \"name\": \"3GB+2GB YouTube Night+200MB YouTube Music for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"1600_DIRECT\",\n \"amount\": 1600\n },\n {\n \"plan_code\": \"PSPLAN_621\",\n \"name\": \"4GB+2GB YouTube Night+200MB YouTube Music for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"2000_DIRECT\",\n \"amount\": 2000\n },\n {\n \"plan_code\": \"PSPLAN_620\",\n \"name\": \"7GB for Weekly - Weekly\",\n \"category\": null,\n \"alias\": \"2000_DIRECT\",\n \"amount\": 2000\n },\n {\n \"plan_code\": \"PSPLAN_181\",\n \"name\": \"10GB - 30days val - SME\",\n \"category\": \"sme\",\n \"alias\": \"10GB_SME\",\n \"amount\": 2659.5\n },\n {\n \"plan_code\": \"PSPLAN_535\",\n \"name\": \"10GB - 30 Days - CG\",\n \"category\": \"cg\",\n \"alias\": \"10GB_CG\",\n \"amount\": 2758\n },\n {\n \"plan_code\": \"PSPLAN_159\",\n \"name\": \"10GB 30 days Validity - SME\",\n \"category\": \"sme\",\n \"alias\": \"10GB_SME\",\n \"amount\": 2758\n },\n {\n \"plan_code\": \"PSPLAN_622\",\n \"name\": \"6GB+2GB YouTube Night+200MB YouTube Music for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"3000_DIRECT\",\n \"amount\": 3000\n },\n {\n \"plan_code\": \"PSPLAN_624\",\n \"name\": \"10GB for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"3500_DIRECT\",\n \"amount\": 3500\n },\n {\n \"plan_code\": \"PSPLAN_623\",\n \"name\": \"11GB Monthly Plan for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"3500_DIRECT\",\n \"amount\": 3500\n },\n {\n \"plan_code\": \"PSPLAN_626\",\n \"name\": \"12GB+2GB YouTube Night for Montly - Monthly\",\n \"category\": null,\n \"alias\": \"4000_DIRECT\",\n \"amount\": 4000\n },\n {\n \"plan_code\": \"PSPLAN_625\",\n \"name\": \"13GB Monthly Plan for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"4000_DIRECT\",\n \"amount\": 4000\n },\n {\n \"plan_code\": \"PSPLAN_536\",\n \"name\": \"15GB - 30 days - CG\",\n \"category\": \"cg\",\n \"alias\": \"15GB_CG\",\n \"amount\": 4137\n },\n {\n \"plan_code\": \"PSPLAN_182\",\n \"name\": \"20GB - Gifting(30days validity)\",\n \"category\": \"gifting\",\n \"alias\": \"20GB_GIFTING\",\n \"amount\": 5122\n },\n {\n \"plan_code\": \"PSPLAN_628\",\n \"name\": \"22GB Monthly Plan for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"5500_DIRECT\",\n \"amount\": 5500\n },\n {\n \"plan_code\": \"PSPLAN_627\",\n \"name\": \"20GB+2GB YouTube Night+300MB YouTube Music for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"5500_DIRECT\",\n \"amount\": 5500\n },\n {\n \"plan_code\": \"PSPLAN_629\",\n \"name\": \"27GB Monthly Plan for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"6500_DIRECT\",\n \"amount\": 6500\n },\n {\n \"plan_code\": \"PSPLAN_183\",\n \"name\": \"40GB - 30days val - GIFTING\",\n \"category\": \"gifting\",\n \"alias\": \"40GB_GIFTING\",\n \"amount\": 10244\n },\n {\n \"plan_code\": \"PSPLAN_630\",\n \"name\": \"40GB Monthly Plan for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"11000_DIRECT\",\n \"amount\": 11000\n },\n {\n \"plan_code\": \"PSPLAN_631\",\n \"name\": \"75GB Monthly Plan for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"16000_DIRECT\",\n \"amount\": 16000\n },\n {\n \"plan_code\": \"PSPLAN_632\",\n \"name\": \"100GB for 60Days - 60Days\",\n \"category\": null,\n \"alias\": \"20000_DIRECT\",\n \"amount\": 20000\n },\n {\n \"plan_code\": \"PSPLAN_633\",\n \"name\": \"120GB Monthly Plan for Monthly - Monthly\",\n \"category\": null,\n \"alias\": \"22000_DIRECT\",\n \"amount\": 22000\n },\n {\n \"plan_code\": \"PSPLAN_634\",\n \"name\": \"160GB for 60Days - 60Days\",\n \"category\": null,\n \"alias\": \"30000_DIRECT\",\n \"amount\": 30000\n },\n {\n \"plan_code\": \"PSPLAN_635\",\n \"name\": \"400GB for 90Days - 90Days\",\n \"category\": null,\n \"alias\": \"50000_DIRECT\",\n \"amount\": 50000\n },\n {\n \"plan_code\": \"PSPLAN_636\",\n \"name\": \"600GB for 90Days - 90Days\",\n \"category\": null,\n \"alias\": \"75000_DIRECT\",\n \"amount\": 75000\n },\n {\n \"plan_code\": \"PSPLAN_637\",\n \"name\": \"400GB for 1Year - 1Year\",\n \"category\": null,\n \"alias\": \"120000_DIRECT\",\n \"amount\": 120000\n }\n ]\n }\n ]\n },\n \"status_code\": 200\n}"},{"id":"20b06455-7198-4905-881f-5b84e2717cb4","name":"Data Lookup Filter By Category","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1/data/lookup?network=airtel&category=awoof","host":["https://sandbox.payscribe.ng/api/v1/data"],"path":["lookup"],"query":[{"key":"network","value":"airtel"},{"key":"category","value":"awoof"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 08 Feb 2025 09:45:25 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=GDimsXH0%2FrNhE2Rtxj1qUkbSm8fVjSA5TGE%2FrVgVSBIFIWPTqnRH6en9Gxf57hO1Iq1wf4OT6yjuLcnVGQwtvWy85y3tr1ojrM3lL6GFYIrcudiB1lIB9jmYPh7M%2FSfUY3cq\"}],\"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":"90eaafcb5d59eb1a-MAN"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=11219&min_rtt=4839&rtt_var=11393&sent=88&recv=84&lost=0&retrans=0&sent_bytes=8366&recv_bytes=1935&delivery_rate=872072&cwnd=257&unsent_bytes=0&cid=6f0e70c943653345&ts=82214&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"AIRTEL data plan lookup successfully.\",\n \"message\": {\n \"details\": [\n {\n \"network_name\": \"airtel\",\n \"title\": \"Airtel Data\",\n \"network_code\": \"PSDATA_17\",\n \"check_balance\": \"\",\n \"logo_url\": \"https://res.cloudinary.com/philo001/image/upload/payscribe/bfkyynv8ekiqrwognnmn.png\",\n \"plans\": [\n {\n \"plan_code\": \"PSPLAN_1300\",\n \"name\": \"1GB - 7 Days - AWOOF\",\n \"category\": \"awoof\",\n \"alias\": \"airtel_1gb_7days_awoof\",\n \"amount\": 250,\n \"discount\": 1.5,\n \"discount_type\": \"percentage\",\n \"capped_at\": \"\"\n },\n {\n \"plan_code\": \"PSPLAN_1294\",\n \"name\": \"1GB - 2 Days - AWOOF\",\n \"category\": \"awoof\",\n \"alias\": \"1gb_2days_awoof\",\n \"amount\": 250,\n \"discount\": 1.5,\n \"discount_type\": \"percentage\",\n \"capped_at\": \"\"\n },\n {\n \"plan_code\": \"PSPLAN_1295\",\n \"name\": \"2GB - 2 Days - AWOOF\",\n \"category\": \"awoof\",\n \"alias\": \"2gb_2days_awoof\",\n \"amount\": 340,\n \"discount\": 1.5,\n \"discount_type\": \"percentage\",\n \"capped_at\": \"\"\n },\n {\n \"plan_code\": \"PSPLAN_1302\",\n \"name\": \"1.5GB - 7 Days - AWOOF\",\n \"category\": \"awoof\",\n \"alias\": \"airtel_1.5gb_7days_awoof\",\n \"amount\": 400,\n \"discount\": 1.5,\n \"discount_type\": \"percentage\",\n \"capped_at\": \"\"\n },\n {\n \"plan_code\": \"PSPLAN_1301\",\n \"name\": \"2GB - 14 Days - AWOOF\",\n \"category\": \"awoof\",\n \"alias\": \"airtel_2gb_14days_awoof\",\n \"amount\": 500,\n \"discount\": 1.5,\n \"discount_type\": \"percentage\",\n \"capped_at\": \"\"\n },\n {\n \"plan_code\": \"PSPLAN_1296\",\n \"name\": \"3GB - 7 Days - Awoof \",\n \"category\": \"awoof\",\n \"alias\": \"airtel_3gb_7days_awoof\",\n \"amount\": 560,\n \"discount\": 1.5,\n \"discount_type\": \"percentage\",\n \"capped_at\": \"\"\n },\n {\n \"plan_code\": \"PSPLAN_1297\",\n \"name\": \"4GB - 30 Days - AWOOF\",\n \"category\": \"awoof\",\n \"alias\": \"airtel_4gb_30days_awoof\",\n \"amount\": 1100,\n \"discount\": 1.5,\n \"discount_type\": \"percentage\",\n \"capped_at\": \"\"\n },\n {\n \"plan_code\": \"PSPLAN_1298\",\n \"name\": \"10GB - 30 Days - AWOOF\",\n \"category\": \"awoof\",\n \"alias\": \"airtel_10gb_30days_awoof\",\n \"amount\": 2200,\n \"discount\": 1.5,\n \"discount_type\": \"percentage\",\n \"capped_at\": \"\"\n },\n {\n \"plan_code\": \"PSPLAN_1299\",\n \"name\": \"15GB - 30 Days - AWOOF\",\n \"category\": \"awoof\",\n \"alias\": \"airtel_15gb_30days_awoof\",\n \"amount\": 3300,\n \"discount\": 1.5,\n \"discount_type\": \"percentage\",\n \"capped_at\": \"\"\n },\n {\n \"plan_code\": \"PSPLAN_1303\",\n \"name\": \"20GB - 30 Days - AWOOF\",\n \"category\": \"awoof\",\n \"alias\": \"airtel_20gb_30days_awoof\",\n \"amount\": 4950,\n \"discount\": 1.5,\n \"discount_type\": \"percentage\",\n \"capped_at\": \"\"\n },\n {\n \"plan_code\": \"PSPLAN_1304\",\n \"name\": \"40GB - 30 Days - Awoof\",\n \"category\": \"awoof\",\n \"alias\": \"airtel_40gb_30days_awoof\",\n \"amount\": 9900,\n \"discount\": 1.5,\n \"discount_type\": \"percentage\",\n \"capped_at\": \"\"\n }\n ]\n }\n ]\n },\n \"status_code\": 200\n}"}],"_postman_id":"4506ddeb-ead4-4213-b0c6-98b246fbb5c9"},{"name":"Data Vending","id":"5db8baef-57de-42bb-bf59-a55ce2341118","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"body":{"mode":"raw","raw":"{\n \"plan\": \"PSPLAN_177\",\n \"recipient\":[\"08169254598\", \"07038067493\"],\n \"network\": \"mtn\",\n \"ref\": \"32b3415a-af9f-4858-bd53-198d5ac74b8f\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/data/vend","description":"

HTTP POST /data/vend

Purchase data for Glo, Mtn, Airtel, 9mobile, DSTVsHOWMAX

It is advisable to access the BASE_URL/data/lookup to get the updated plan_id and amount before vending for data.

Request Body

recipient (required, String or Array of string): The phone number(s) you are sending the data to.
\n
network (required, String): The network provider (mtn, glo, airtel, 9mobile, smile, dstvshowmax).
\n
plan (required, String): The plan ID as seen when you did lookup.
\n
ref (optional, String): Your transaction reference. Alphanumeric.
\n

If vending for ntel, spectranet, etc., please check the /internet page.

Response

The response is in JSON format and follows the schema:

{\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\n

Data purchase - MTN, GLO, AIRTEL, 9MOBILE, SMILE AND

\n","_postman_id":"e2483982-2fd3-4f87-95d6-9b099f61bd72","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"ePins (WAEC, NECO, UTME)...","item":[{"name":"Get Available ePins","id":"52ebfc75-1cf8-45b4-a3e2-567488109dcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"url":"https://sandbox.payscribe.ng/api/v1/epins","description":"

It is necessary to call this endpoint in other to check the availability of pins

Please note that some account and phone number is required when you are vending JAMB.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
qty	Int	required	the quantity of pin you want to generate
id	String	required	the collection id as seen on the lookup ( when you called the BASE_URL/epins endpoint)
ref	String	optional	Your transaction reference. Alphanumeric
account	String	optional	User account number - This is ONLY applicable to JAMB
phone	String	optional	User phone number - This is ONLY applicable to JAMB

Lookup JAMB user details.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
id	String	required	the collection id as seen on the lookup ( when you called the BASE_URL/epins endpoint)
account	String	optional	The user account you want to fetch

You can fetch all generated ePins for a particular transaction using the transaction ID that we sent to you when you puchase.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	description
trans_id	String	required	The transaction ID we sent when you purchase

ePins are educational vouchers such as WAEC, NECO, JAMB...

\n","_postman_id":"01a23c53-b56a-4b93-8bfb-a989e1efa04a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Airtime to Wallet","item":[{"name":"Airtime to wallet lookup","id":"bc820e19-451e-4d7d-985f-49d2c7529060","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"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

Please note that the wallet will only be credited when the airtime is received.

Airtime to wallet.

Your wallet will be credited once airtime is received

Parameters

network(required): The network you are sending; mtn, glo, 9mobile, or airtel
phone_number(required): Our phone number you are sending the airtime to, Kindly hit airtime to wallet lookup to see the available network and the respective number
from (required): The phone number you are sending it from
amount(required): The amount you are sending. Minimum of NGN1000 And maximum of NGN20,000 per transaction
ref (optional): Your unique transaction ID

Airtime to wallet - Convert your excess airtime to wallet

PLEASE THIS ENDPOINTS IS CURRENTLY UNDERGOING MAINTENANCE. CHECK BACK LATER.

\n","_postman_id":"7fd9142f-c592-4009-9f87-52a7b9fc7362","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Pay Electricity Bills","item":[{"name":"Validate Electricity","id":"28deae9d-91f1-4ec2-a290-963787c65a4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"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

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
meter_number	String	required	The user smart card.
meter_type	String	required	prepaid or postpaid
amount	String	required	The amount you are trying to purchase. Min of NGN1,000
service	String	required	The disco short name: ikedc, ekedc, eedc, phedc, aedc, ibedc, kedco,jed, please see above for more details

Sample Response

{\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\n

Make payment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
meter_number	String	required	The user smart card.
meter_type	String	required	prepaid or postpaid
amount	String	required	The amount you are trying to purchase. Min of NGN1,000
service	String	required	The disco short name: ikedc, ekedc, eedc, phedc, aedc, ibedc, kedco,jed, please see above for more details
email	String	optional	Customer email ID
phone	String	optional	Customer phone number. Disco sometimes send SMS to the customer
customer_name	String	required	The customer name and the address you got when you did validation
ref	String	optional	Your reference ID

\n
Please take note, the details response may be more than these keys. It will contain lots of information when you go live.
\n

\n
Also 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
And for Postpaid, you will not get any information in the details key.
\n

SAMPLE RESPONSE

{\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\n

Requery Transaction

In rare cases the transaction status may fall into 201 - Pending.

Please you are advised to make a requery of the transaction, and this can ONLY be done once in a minute.
Request

\n
The 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
\n
URL: https://sandbox.payscribe.ng/api/v1//requery/?trans_id=dd866390-5226-4392-9283-3d4af5321034
\n

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.

Please 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.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Provider Name	Short name
Ikeja Electric	ikedc
Abuja Electric	aedc
Enugu Disco	eedc
Eko Electric	ekedc
Ibadan Electric	ibedc
Porthacourt Electric	phedc
Kaduna Disco	kaduna
Kano Disco	kano
Jos Disco	jed
Aba Disco	aba
Benin Disco	bedc

IKEDC Covers the following cities in Lagos

Abule Egba, Akowonjo, Ikeja, Ikorodu, Oshodi and Shomolu

*EKEDC Covers the following:*

Southern 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*

Federal Capital Territory, Niger State, Kogi State, and Nassarawa State.

*EEDC Covers*

five(5) states in the South East geo-political Zone, namely: Abia, Anambra, Ebonyi, Enugu and Imo State.

*IBEDC Covers*

largest franchise area in Nigeria, made up of Oyo, Ogun, Osun, Kwara and parts of Niger, Ekiti and Kogi States.

*PHED Covers*

Akwa Ibom, Bayelsa, Cross Rivers, Rivers, and parts of Delta States in Nigeria's industrial south-south zone.

\n","_postman_id":"572718e7-422e-43b2-a1a1-c6468cc73aae","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Bulk SMS","item":[{"name":"Send Bulk SMS","id":"1e6d1c04-08f6-4d7f-8210-fbb97a6b7207","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"body":{"mode":"raw","raw":"{\n\t\"to\": \"08169254598\",\n\t\"message\" : \"Hello Payscribe! Thank you.\",\n \"ref\": \"574d46d9-ce58-4f12-8867-d4653ac22547\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/sms","description":"

Send Bulk SMS

Please note that SMS does not deliver to MTN within 9PM to 8AM

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
message	String	required	160 Character for a page
to	String	required	The phone numbers you are sending to, separate with \",\" if you are sending to multiple numbers
sender_id	String	required	Must have been approved, please contact support, default is Pscribe

Send Bulk SMS Endpoint

\n","_postman_id":"a45665c4-b20e-480d-b4a9-4281bff36b27","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Fund Bet Wallet","item":[{"name":"Betting Service Provider List","id":"75ed2b2b-5ba9-45bd-a17e-a0da2641d3a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}","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.

Response

The response for this request is a JSON object with the following schema:

{\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\n

Request Description

Lookup user details before vending.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
bet_id	String	required	the betting ID
customer_id	String	required	The customer ID

Response

The response for this request can be represented as a JSON schema:

{\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}\n

HTTP POST /betting/vend

Add funds to user wallet based on the validated account ID.

Request Body

bet_id (String, required): The bet ID obtained from validation.
\n
customer_id (String, required): The valid User ID.
\n
customer_name (String, required): The customer name obtained during validation.
\n
amount (Int, required): Minimum of NGN100, and maximum of NGN50,000./ transaction
\n
ref (String, required): Your transaction ID.
\n

Response

{\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\n

Fund betting wallet.

\n","_postman_id":"1ceddc2b-dd4d-4858-b19f-7f0dc91b4c34","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Airtime","item":[{"name":"Vend Airtime","id":"829d969c-f6c5-46ec-984c-d527c9f2d078","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API Token}}"},{"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\": \"a9337bbd-5d76-48c0-ba2a-4b384f89ce30\"\n}"},"url":"https://sandbox.payscribe.ng/api/v1/airtime","description":"

Purchase airtime (Glo, Mtn, Airtel, 9mobile)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
network	String	required	The network you are vending; mtn, glo, 9mobile or airtel
amount	String	required	Minimum of NGN50
recipient	String	Array	required
ref	String	optional	Your transaction ID

Here you will find endpoints on how to purchase Nigeria airtime. - MTN, Airtel, Glo, and 9mobile

There are 2 strcture ways to buy bulk Airtime.

If you are buying airtme for multiple networks; this is the payload structure

[{phone, amount, provider, country?, reference?}\n\n

2. If you are buying to one single network, but on different recipients

phone[] + amount + provider \n\n

","_postman_id":"5e74ed3f-2247-4662-b59e-ac59cf667841","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"International Airtime/Data & Bills","item":[{"name":"Get International Bills countries","id":"0b112555-a4b4-4531-8ff6-0f39aa451670","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}","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

Get the providers of the country

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
iso	String	required	The country iso as seen when fetching th counties.

International bills products

Get the products of the respective country and provider

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
iso	String	required	The country iso as seen when fetching th counties.
code	String	required	The code as seen from the providers

Explanation on the response you will get

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description
sku	The product SKU, it will be required when you want to vend
uat	Use this uat as the account for testing.
country_iso	Returned back as passed when fetching the product
provider_code	The reference provider code
display_text	This can be interpreted as a label for the product
min_send	This is the minimum amount in USD that you can send
max_send	This is the maximum amount in USD that you can send
min_receive	The minimum amount that the recipient will receive, this is in the recipient currency value
max_receive	The maximum amount that the recipient will receive. This is equivalent to the recipient currency value
receive_currency	The recipient currency value
send_currency	Basically we are sending the value in USD
lookup_required	0 = false, 1 = true. Does the product require lookup. Applicable to electricity topup
vend_type	range
current_rate	The current USD to your account currency value (NGN)

International Estimate Rate

Use this endpoint to calculate how much we will charge from your wallet.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
iso	String	required	The country iso as seen when fetching th counties.
sku	String	required	The sku as seen from the providers
amount	String	required	The amount recipient is expected to receive

Explanation on the response you will get

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description
receive	This is the amount that the recipient is receiving
usd_rate	Current USD rate in NGN
amount	This is the USD equivalent that would be deducted from your USD wallet

International Estimate Rate

Use this endpoint to process International bills

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
iso	String	required	The country iso as seen when fetching th counties.
provider_code	String	required	The code as seen from the get products endpoint
sku	String	required	As seen from the get products endpoint
amount	String	required	The amount recipient is expected to receive
account	String	required	The recipient account (phone number).
ref	String	optional	Your systm transaction ID

Here you will find endpoints on how to purchase airtime, internet data or pay bills in over 100+ countries.

Please 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":"fa74c48a-0edf-4618-b62c-a0329e28988d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Bills Payment Webhook","item":[{"name":"Webhook Reference - bills.payment.success","id":"cd40e3fc-b2c2-48a9-8014-5117d08cb28e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://your-server.com/webhook","description":"

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: bills.payment.success

Security — Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n

Fired after electricity, cable TV, data, airtime, betting, or ePin payments complete successfully.

Payload shape

{\n  \"event\": \"bills.payment.success\",\n  \"trans_id\": \"uuid\",\n  \"ref\": \"your-ref\",\n  \"service\": \"dstv\",\n  \"amount\": 5000,\n  \"currency\": \"NGN\",\n  \"customer_id\": \"cust-uuid\",\n  \"status\": \"success\",\n  \"created_at\": \"2026-04-09T10:00:00Z\"\n}\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: bills.status

Security - Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n\n

Payload shape

{\n  \"event\": \"bills.status\",\n  \"trans_id\": \"uuid\",\n  \"ref\": \"your-ref\",\n  \"service\": \"electricity\",\n  \"amount\": 2000,\n  \"currency\": \"NGN\",\n  \"reason\": \"Operator error\",\n  \"status\": \"failed\",\n  \"created_at\": \"2026-04-09T10:01:00Z\"\n}\n\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Webhook events fired when a bills payment transaction changes state.

\n","_postman_id":"9db3f1a3-1e14-48b3-b33f-b566b93be6b3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}}],"id":"6e6e2f72-2dd2-46ce-bf6d-0e66fac18e4c","description":"

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":"6e6e2f72-2dd2-46ce-bf6d-0e66fac18e4c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"My Account API.","item":[{"name":"Fetch Account Balances","id":"01da48c5-6d01-4a3a-9dbd-92e27c59b995","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}","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":"

Fetch Account Balance

Description

This endpoint is used to retrieve the account balances.

Request Body

This request does not require a request body.

Response

status (boolean): Indicates the status of the response.
\n
description (string): Provides additional information about the response.
\n
message (object):
\n
- details (array):
  - id (string): The ID associated with the account balance.
    \n
  - currency (string): The currency type.
    \n
  - collection (number): The collection amount.
    \n
  - available_balance (number): The available balance.
    \n
  - account (string): The account details.
    \n
  - details (string): Additional details.
    \n
  \n
\n

Example

{\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\n

This example returned a 200 status code.

Get Business Profile

Description

Returns the core profile information for the authenticated business — useful for displaying account details in your app without requiring a separate login to the Payscribe dashboard.

Request

No body required.

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	integer	Internal business identifier
`name`	string	Registered business name
`email`	string	Primary contact email
`industry`	string	Business industry
`address`	string	Registered business address
`website`	string	Business website URL
`country_code`	string	ISO 3166-1 alpha-2 country code (e.g. `NG`)
`entity_type`	string	Legal entity type (e.g. `LLC`, `Sole Proprietor`)
`registration_number`	string	CAC or equivalent registration number
`status`	string	Account status: `active`, `suspended`, `pending`
`kyb_status`	string	KYB verification status: `approved`, `pending_review`, `incomplete`
`risk_level`	string	Risk classification assigned during onboarding
`created_at`	string	Account creation timestamp (ISO 8601)

Example Response

{\n  \"status\": true,\n  \"description\": \"Business profile fetched successfully.\",\n  \"message\": {\n    \"id\": 42,\n    \"name\": \"Acme Payments Ltd\",\n    \"email\": \"cfo@acme.co\",\n    \"industry\": \"Fintech\",\n    \"address\": \"12 Kofo Abayomi Street, Victoria Island, Lagos\",\n    \"website\": \"https://acme.co\",\n    \"country_code\": \"NG\",\n    \"entity_type\": \"Limited Liability Company\",\n    \"registration_number\": \"RC1234567\",\n    \"status\": \"active\",\n    \"kyb_status\": \"approved\",\n    \"risk_level\": \"low\",\n    \"created_at\": \"2024-01-15 09:22:00\"\n  },\n  \"status_code\": 200\n}\n

Get Wallet Ledger

Description

Returns a paginated, double-entry ledger of every movement on your Payscribe wallets. Each row represents a single credit or debit against a specific wallet account (available, collection, or due). This is the authoritative record for reconciliation.

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`currency`	string	No	Filter by currency code — `NGN`, `USD`, `USDT`, `USDC`, etc. Returns all currencies when omitted.
`direction`	string	No	`debit` or `credit`
`kind`	string	No	Movement category. Common values: `va_funding`, `payout`, `card_topup`, `card_withdraw`, `fee`, `refund`, `adjustment`, `crypto_settlement`, `collection_sweep`, `internal_fx`
`start_date`	string	No	`YYYY-MM-DD`
`end_date`	string	No	`YYYY-MM-DD`
`page`	integer	No	Defaults to `1`
`page_size`	integer	No	Defaults to `20`, max `100`

Response

Each entry in data describes a single ledger line:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
`id`	Ledger entry ID
`currency`	Wallet currency
`account`	Sub-account: `available`, `collection`, or `due`
`direction`	`credit` (money in) or `debit` (money out)
`amount`	Movement amount
`balance_before`	Wallet balance immediately before this movement
`balance_after`	Wallet balance immediately after
`kind`	Movement category
`description`	Human-readable note
`link_id`	UUID linking this entry to the originating transaction
`ref_id`	Your optional reference ID
`created_at`	Timestamp

Example Response

{\n  \"status\": true,\n  \"description\": \"Ledger fetched successfully.\",\n  \"message\": {\n    \"data\": [\n      {\n        \"id\": 1892,\n        \"currency\": \"NGN\",\n        \"account\": \"available\",\n        \"direction\": \"credit\",\n        \"amount\": 50000.00,\n        \"balance_before\": 12300.00,\n        \"balance_after\": 62300.00,\n        \"kind\": \"va_funding\",\n        \"description\": \"Inbound transfer from Acme Corp\",\n        \"link_id\": \"b3c4d5e6-…\",\n        \"ref_id\": null,\n        \"created_at\": \"2025-03-01 14:22:05\"\n      }\n    ],\n    \"pagination\": {\n      \"total\": 340,\n      \"page\": 1,\n      \"page_size\": 20,\n      \"pages\": 17\n    }\n  },\n  \"status_code\": 200\n}\n

Filter by currency - NGN, USD, USDT, etc. Leave blank for all.

\n","type":"text/plain"},"key":"currency","value":"NGN"},{"disabled":true,"description":{"content":"

debit or credit

\n","type":"text/plain"},"key":"direction","value":""},{"disabled":true,"description":{"content":"

Entry type: va_funding, payout, card_topup, fee, refund, adjustment…

\n","type":"text/plain"},"key":"kind","value":""},{"disabled":true,"description":{"content":"

YYYY-MM-DD - start of date range

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

YYYY-MM-DD - end of date range

\n","type":"text/plain"},"key":"end_date","value":""},{"key":"page","value":"1"},{"description":{"content":"

Max 100

\n","type":"text/plain"},"key":"page_size","value":"20"}],"variable":[]}},"response":[],"_postman_id":"da3092fb-c24e-4592-8b22-073af63ed3a0"},{"name":"List Transactions","id":"e8822ece-ed3e-4103-b1ad-572060c2a45a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1/my-account/transactions?page=1&page_size=20","description":"

List Transactions

Description

Returns a paginated list of all transactions processed under your business account, across every product — payouts, card top-ups, bill payments, virtual account credits, savings, invoices, and more.

Use the optional filters to narrow results by currency, status, product, or date range.

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`currency`	string	No	`ngn` or `usd`
`status`	string	No	`success`, `pending`, `failed`
`product`	string	No	Product category: `airtime`, `data`, `bills`, `cards`, `payout`, `invoice`, `savings`, `payment_link`, etc.
`start_date`	string	No	`YYYY-MM-DD`
`end_date`	string	No	`YYYY-MM-DD`
`page`	integer	No	Defaults to `1`
`page_size`	integer	No	Defaults to `20`, max `100`

Response

Each item in data:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
`trans_id`	Payscribe transaction UUID
`invoice_id`	Invoice reference, if applicable
`amount`	Transaction amount
`fee`	Fee charged
`currency`	Currency code
`status`	`success`, `pending`, or `failed`
`description`	Transaction description
`product`	Product category
`created_at`	Timestamp

Example Response

{\n  \"status\": true,\n  \"description\": \"Transactions fetched successfully.\",\n  \"message\": {\n    \"data\": [\n      {\n        \"trans_id\": \"e03e20b0-b815-4a46-b945-87e3d47e4ba1\",\n        \"invoice_id\": \"INV-2025-0042\",\n        \"amount\": 5000.00,\n        \"fee\": 15.00,\n        \"currency\": \"NGN\",\n        \"status\": \"success\",\n        \"description\": \"Airtime purchase — 08012345678\",\n        \"product\": \"airtime\",\n        \"created_at\": \"2025-03-10 11:05:33\"\n      }\n    ],\n    \"pagination\": {\n      \"total\": 1248,\n      \"page\": 1,\n      \"page_size\": 20,\n      \"pages\": 63\n    }\n  },\n  \"status_code\": 200\n}\n

NGN, USD - filter by transaction currency

\n","type":"text/plain"},"key":"currency","value":""},{"disabled":true,"description":{"content":"

success, pending, failed

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

airtime, data, bills, cards, payout, invoice, savings…

\n","type":"text/plain"},"key":"product","value":""},{"disabled":true,"description":{"content":"

YYYY-MM-DD

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

YYYY-MM-DD

\n","type":"text/plain"},"key":"end_date","value":""},{"key":"page","value":"1"},{"description":{"content":"

Max 100

\n","type":"text/plain"},"key":"page_size","value":"20"}],"variable":[]}},"response":[],"_postman_id":"e8822ece-ed3e-4103-b1ad-572060c2a45a"}],"id":"66967509-e8b0-42b6-a839-a31ca0b28332","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.

With these endpoints you can retrieve your business profile, review wallet balances, audit the full double-entry ledger, and browse all transactions — all from a single authenticated API call.

\n","_postman_id":"66967509-e8b0-42b6-a839-a31ca0b28332","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Payout API","item":[{"name":"Payout Endpoints","item":[{"name":"Bank List","id":"769c2b89-92cd-4527-824f-440c7a8110ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1/payouts/bank/list","description":"

Get Payout Bank List

This endpoint retrieves the list of banks with their sort codes.

Request

Method: GET
\n
URL: https://sandbox.payscribe.ng/api/v1/payouts/bank/list
\n

Query Parameters

country (optional, String): The country code. Defaults to NGN, the only available country code at the moment.

Response

Status: 200
\n
Content-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\n

The 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.

Validate account before initiating transfer

account: the account number you want to validate
\n
bank: the bank sort code.
\n

Request Body

{\n  \"account\": \"\",\n  \"bank\": \"\"\n}\n\n

Response

{\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\n

Get Payouts Fee

This endpoint makes an HTTP GET request to retrieve the transaction fee for a specified amount and country.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
amount	String	required	The amount you are sending
currency	String	optional	The currency (e.g., NGN for Nigeria)

Response

The response will be in JSON format with the following structure:

{\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\n

status (boolean): Indicates the success or failure of the request.
\n
description (string): Additional information about the response.
\n
message (object): Contains details about the transaction fee.
\n
- amount (number): The amount specified in the request.
  \n
- currency (string): The currency for the transaction.
  \n
- fee (number): The transaction fee charged.
  \n
\n

HTTP POST /payouts/transfer

Make transfer from your Payscribe wallet to bank

Request Body

amount: String (required) - The amount you are sending
\n
bank: String (required) - The bank code you're sending to.
\n
account: String (required) - The recipient account number
\n
currency: String (optional) - The currency of the transaction: Default is NGN
\n
narration: String (required) - Description of the transaction
\n
ref: String (required) - Reference for the transaction
\n

Response

{\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\n

Get Payout Verification

This endpoint is used to verify the status of a bank transfer by providing the transaction ID or your reference id in the URL path.

Request

Method: GET
\n
URL: https://sandbox.payscribe.ng/api/v1/payouts/verify/63bdb0ea-9ffe-4542-aafc-dfd242fb6f58
\n

Response

The response will include the following fields:

status (boolean): Indicates the status of the verification.
\n
description (string): Provides additional information about the verification status.
\n
message (object): Contains details about the transaction, including:
\n
- trans_id (string): The transaction ID.
  \n
- ref (string): The reference ID.
  \n
- status (string): The status of the transaction.
  \n
- created_at (string): The timestamp of the transaction creation.
  \n
- bank_code (string): The bank code.
  \n
- bank_name (string): The name of the bank.
  \n
- account_name (string): The name of the account holder.
  \n
- account_number (string): The account number.
  \n
- currency (string): The currency used in the transaction.
  \n
\n
status_code (integer): Indicates the status code of the response.
\n

Example 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\n

This example response indicates a successful verification with a status code of 200.

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: payouts.created

Security -Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n\n

Payload shape

{\n  \"event_id\": \"12f7965d-f7b5-4777-9137-10e8135bca6f\",\n  \"event_type\": \"payouts.created\",\n  \"ref\": \"732aa9ad-05ee-41d6-9286-85d325132525\",\n  \"trans_id\": \"12f7965d-f7b5-4777-9137-10e8135bca6f\",\n  \"session_id\": \"100033260410061728090161995886\",\n  \"amount\": 20000,\n  \"fee\": 100,\n  \"total\": 20100,\n  \"beneficiary\": {\n    \"bank\": \"100004\",\n    \"bank_name\": \"OPAY\",\n    \"account_number\": \"893955269\",\n    \"account_name\": \"OLANIKE ABIBAT OLABOOPO-IBRAHEEM\"\n  },\n  \"currency\": \"\",\n  \"narration\": \"payscribe\",\n  \"status\": \"success\",\n  \"created_at\": \"2026-04-10 07:17:29\"\n}\n\n

Responding -Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: payout.transfer.failed

Security - Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n\n

Payload shape

{\n  \"event_id\": \"abbd376c-4caf-4990-85bf-ca628a322532\",\n  \"event_type\": \"payouts.created\",\n  \"ref\": \"5b7b5655-5bc9-42a0-b83f-18a01f403f80\",\n  \"trans_id\": \"abbd376c-4caf-4990-85bf-ca628a322532\",\n  \"session_id\": \"100033260408175721478424795373\",\n  \"amount\": 14800,\n  \"fee\": 74,\n  \"total\": 14874,\n  \"beneficiary\": {\n    \"bank\": \"090405\",\n    \"bank_name\": \"MONIEPOINT MICROFINANCE BANK\",\n    \"account_number\": \"5242629963\",\n    \"account_name\": \"JONATHAN IZUCHUKWU NWOKPO\"\n  },\n  \"currency\": null,\n  \"narration\": \"Gift\",\n  \"status\": \"fail\",\n  \"created_at\": \"2026-04-08 18:57:22\"\n}\n\n

Responding - Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Webhook events fired when a bank transfer changes state.

\n","_postman_id":"162977a0-abba-4a7a-9641-277aee4c1240","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}}],"id":"4e854c5c-1c6c-4dd3-bdd5-cf7bd8a348b7","description":"

Welcome to Payout API. This API allows you to send money from your Payscribe wallet to local commercial bank.

\n
Please note that you must whitelist your IP address to have access to this service.
\n

\n","_postman_id":"4e854c5c-1c6c-4dd3-bdd5-cf7bd8a348b7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Customers","item":[{"name":"Endpoints","item":[{"name":"Create Customer - Tier 0","event":[{"listen":"test","script":{"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":{},"requests":{},"id":"4809d06b-0a6d-44e4-9af1-628379d539e8"}}],"id":"4606776e-4892-44f4-b667-ab1b88a7eb7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API Token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"first_name\": \"Jeremie\",\r\n \"last_name\": \"Jenkins\",\r\n \"phone\": \"234716973464\",\r\n \"email\": \"Edwina48@example.com\",\r\n \"country\": \"NG\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/customers/create","description":"

Create New Customer

This endpoint allows the creation of a new customer within the Payscribe ecosystem.

Please note and save the customer_id in the response. This will be used in all out services.

Request Body

Type: JSON

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
first_name	String	Required	The customer's first name
last_name	String	Required	The customer's last name
phone	String	Required	The customer's phone number (including country code)
email	String	Required	Customer's email ID
country	String	Optional	Customer's country ISO Code (default is NG)

Response

Status: 200
\n
Content-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\n

Update Customer Tier 1

This endpoint is used to upgrade a customer to tier 1 in order to access services like Collections.

Request Body

customer_id (String, required): The customer ID generated during customer creation.
\n
dob (String, required): Customer date of birth in YYYY-MM-DD format. Some services are only valid for customers aged 18 years and above.
\n
address (Object, required): Customer address object.
\n
- address.street (String, required): Valid customer street address. Only alphanumeric characters, dots, and commas are accepted.
  \n
- address.city (String, required): The city of the customer's address.
  \n
- address.state (String, required): The state of the customer's address.
  \n
- address.country (String, required): The ISO country code, e.g., NG for Nigeria.
  \n
- address.postal_code (String, required): The postal code of the customer's address.
  \n
\n
identification_type (String, required): The type of government-issued identification, e.g., BVN for Nigeria.
\n
identification_number (String, required): The identification number issued by a governing body, e.g., BVN for Nigeria.
\n
photo (String, optional): The URL of the customer's photo.
\n

\n
Please it is important you pass in a valid address, as this may be used as billing address when creating card
\n

Response Body

{\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\n

Update Customer Tier 2

This endpoint is used to upgrade a customer to tier 2 in order to process services like Collections.

Request Body

customer_id (String, required): The customer id that was generated when creating the customer.
\n
identity (Object, required): An object of the customer identity.
\n
- type (String, required): Governmental identity type. For example, NIN, PASSPORT, VIN.
  \n
- number (String, required): The identity number.
  \n
- country (String, required): Country ISO where the identity was issued.
  \n
- image (String, required): A clear image of the identity.
  \n
\n

Response

The response will be in JSON format with the following schema:

{\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\n

Create Full Customer

This endpoint allows you to create a customer, providing access to card creation and other services.

Request Body

first_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.
\n
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.
\n

Response

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.
\n
status_code (Number): The status code of the response.

Example Response:

{\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

Response

The response for this request can be represented as a JSON schema:

{\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\n

Response

The response for this request can be represented as a JSON schema:

{\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\n

Add or Remove Customer from Blacklist

This endpoint allows you to add or remove a customer from the blacklist.

Request Body

customer_id (String, required): The unique customer ID generated during customer creation.
\n
blacklist (Boolean, required): Set to 1 to whitelist the customer, or 0 to blacklist the customer.
\n

Response

The response will contain the following fields:

status (Boolean): Indicates the status of the operation.
\n
description (String): A description of the response.
\n
message (Object): Details of the operation, including the customer_id.
\n
status_code (Number): The status code of the response.
\n

Example

Request Body:

{\n  \"customer_id\": \"**********\",\n  \"blacklist\": true\n}\n\n

Response:

{\n  \"status\": true,\n  \"description\": \"\",\n  \"message\": {\n    \"details\": {\n      \"customer_id\": \"**********\"\n    }\n  },\n  \"status_code\": 0\n}\n\n

Get Customer Transactions

This endpoint allows you to fetch transactions for a specific customer.

Request Body

start_date (string, optional): The start date for filtering transactions.
\n
end_date (string, optional): The end date for filtering transactions.
\n

Example:

{\n  \"start_date\": \"\",\n  \"end_date\": \"\"\n}\n\n

Response

status (boolean): Indicates the status of the request.
\n
description (string): A description of the response.
\n
message (object): Details of the transactions.
\n
- details (object): Details of the transactions.
  - total_count (number): Total count of transactions.
    \n
  - transactions (array): Array of transaction details.
    \n
    - trans_id (string): The ID of the transaction.
      \n
    - reference (string, null): The reference of the transaction.
      \n
    - amount (string): The amount of the transaction.
      \n
    - fee (string): The fee of the transaction.
      \n
    - currency (string): The currency of the transaction.
      \n
    - service (string): The service of the transaction.
      \n
    - service_id (string): The ID of the service.
      \n
    - created_at (string): The creation date of the transaction.
      \n
    - status (string): The status of the transaction.
      \n
    \n
  \n
\n

Example Response:

{\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\n

This 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.

Request Body

None

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
page	String	optional	Page number, default as 1
page_size	String	optional	Default as 10
start_date	String	optional	Start date when the account was created. YYYY-MM-DD
end_date	String	optional	End date when the account was created. YYYY-MM-DD
search	String	optional	The search params - to get more accurate data

Response Body

The response will be in JSON format with the following structure:

status (boolean): Indicates the status of the request.
\n
description (string): Additional information about the response.
\n
message (object): Details of the response message.
\n
- details (object): Contains the list of customers and pagination details.
  - customers (array): An array of customer objects with their details.
    \n
    - customer_id (string): The unique identifier of the customer.
      \n
    - name (string): The name of the customer.
      \n
    - email (string): The email address of the customer.
      \n
    - status (string): The status of the customer.
      \n
    \n
  - total (number): Total number of customers.
    \n
  - page (number): Current page number.
    \n
  - page_size (number): Number of customers per page.
    \n
  \n
\n

Example Response

{\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\n

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: customer.created

Security - Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n\n

Payload shape

{\n  \"customer_id\": \"0aec40ba-2065-4198-ba5a-71ec21d0fae6\",\n  \"name\": \"Umar Phil\",\n  \"email\": \"bahtf69142@payscribe.ng\",\n  \"phone\": \"08147802675\",\n  \"country\": \"NG\",\n  \"address\": \"[]\",\n  \"identity\": \"[]\",\n  \"created_at\": \"2026-04-10 09:40:11\",\n  \"identification_type\": null,\n  \"identification_number\": null,\n  \"status\": \"active\",\n  \"event_id\": \"0aec40ba-2065-4198-ba5a-71ec21d0fae6\",\n  \"event_type\": \"customers.created\"\n}\n\n

Responding - Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: customer.tier.upgraded

Security — Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n\n

Payload shape

{\n  \"event_id\": \"dd833bc4-0f4a-49b8-b0dc-2897d432d31a\",\n  \"event_type\": \"customers.update\",\n  \"customer_id\": \"6b337f04-3206-4aee-b468-da6f2b4619fc\",\n  \"email\": \"myemail@gmail.com\",\n  \"status\": \"active\",\n  \"updated_at\": \"2026-04-10 07:04:25\"\n}\n\n

Responding -Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Webhook events related to customer lifecycle changes.

\n","_postman_id":"9447d58c-7d28-4545-9e82-d958258ddcc7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}}],"id":"448bbbab-2909-47bf-9e93-c734db2fc8ca","description":"

This resource endpoints helps in creating and managing your customers. Its required for wallet account creation, card issue ...

\n","_postman_id":"448bbbab-2909-47bf-9e93-c734db2fc8ca","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Collections","item":[{"name":"Wallet System API","item":[{"name":"Create Order","id":"e9210850-c309-47a3-a842-ffd3e43c0e12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API Token}}","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\": \"bc4114c5-e2af-431d-a5a1-232d37a26764\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/collections/wallet/create-order","description":"

Create Wallet Order

This endpoint is used to create a new order for wallet payment.

Purpose

The purpose of this request is to initiate a wallet payment order for a specific user.

Expected Input

The request should include the following parameters in the raw request body:

username: The username of the user initiating the payment, (payscribe email, or payscribe tag)
\n
pin: The user's PIN for authentication
\n
title: The title or purpose of the payment
\n
description: A brief description of the payment, this is optional.
\n
amount: The amount to be paid
\n
currency: The currency in which the payment is to be made (e.g., \"ngn\" for Nigerian Naira, or USD )
\n
ref: A unique reference for the transaction, such as a UUID
\n

Expected Output

The response will have the following structure:

status: Indicates the success or failure of the request
\n
description: Additional information about the status
\n
message: Details of the order including ID, amount, creation and expiry timestamps, and user information
\n
status_code: A code indicating the status of the request
\n

Example

{\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\n

Wallet Payment via Payscribe Tag

This endpoint allows you to initiate a wallet payment using the Payscribe tag of the customer.

Request Body

id (String, required): The creare order ID that was generated.
\n
otp (String, required): The one-time password for verification.
\n

Response

Upon successful execution, the response will have a status code of 200 and a JSON object with the following structure:

{\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\n

Authentication

The request requires appropriate authentication credentials to authorize the wallet payment transaction.

Example

{\n    \"payscribe\": \"sample_payscribe_tag\",\n    \"amount\": 100,\n    \"pin\": 1234,\n    \"product\": \"Sample Product\",\n    \"remark\": \"Sample Description\"\n}\n\n

Receive Payments using Payscribe Wallet-as-a-service.

This endpoints allows you to receive payment from your customers that already has an account with Payscribe..

\n","_postman_id":"fcbb5ec4-b366-46db-8514-53e63ffbb192","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"NGN Virtual Accounts","item":[{"name":"Create a Permanent Virtual Account","id":"8a019ef3-0568-45fe-b912-2124d3006091","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API Token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"account_type\": \"static\",\r\n \"currency\": \"NGN\",\r\n \"customer_id\": \"e55dd4c9-8b01-450d-9c2e-643a5aaf9520\",\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":"

Create Virtual Account

This endpoint is used to create a virtual account.

Request

Method: POST
\n
URL: https://sandbox.payscribe.ng/api/v1//collections/virtual-accounts/create
\n
Body:
\n
- account_type (string, required): The type of account to be created. Default is static
  \n
- currency (string, optional): The currency for the virtual account. Default is NGN
  \n
- customer (string, required): The customer id for whom the virtual account is being created.
  \n
- bank (array, required): An array of banks associated with the virtual account.
  \n
- bvn (string, optional): This is ONLY required when you are creating Palmpay virtual account, and the customer is in tier 0
  \n
\n

The 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  \"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\n

Deactivate Virtual Account

This endpoint is used to deactivate a virtual account.

Request Body

account: (string) The account to be deactivated.

Response

status: (boolean) Indicates the status of the deactivation.
\n
description: (string) Description of the deactivation status.
\n
message: (object) Details of the deactivation.
\n
- details: (object) Additional details of the deactivation.
  - id: (string) The ID of the deactivated account.
    \n
  - account: (string) The deactivated account.
    \n
  - status: (string) The status of the deactivation.
    \n
  - updated_at: (string) The timestamp when the deactivation was updated.
    \n
  \n
\n

Example Response:

{\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\n

Activate Virtual Account

This endpoint is used to activate a virtual account.

Request Body

account (string, required): The virtual account to be activated.

Response

The response is in JSON format and follows the schema below:

{\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\n

Create Virtual Account

This endpoint allows you to create a dynamic virtual account.

Request Body

account_type (string, required): The type of the account.
\n
ref (string, required): Reference for the account.
\n
currency (string, required): The currency of the account.
\n
order (object, required): Details of the order.
\n
- amount (number, required): The amount of the order.
  \n
- 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
  \n
- description (string, required): Description of the order.
  \n
- expiry (object, required): Expiry details.
  \n
  - duration (number, required): Duration of the expiry.
    \n
  - duration_type (string, required): Type of the duration. which can only be hours or minute
    \n
  \n
\n
customer (object, required): Customer details.
\n
- name (string, required): Name of the customer.
  \n
- email (string, required): Email of the customer.
  \n
- phone (string, required): Phone number of the customer.
  \n
\n

Response

The response is a JSON object with the following properties:

status (boolean): Indicates the status of the request.
\n
description (string): Description of the response.
\n
message (object): Details of the response message.
\n
- details (object): Details of the virtual account.
  - customer (object): Customer details.
    \n
    - name (string): Name of the customer.
      \n
    - email (string): Email of the customer.
      \n
    - phone (string): Phone number of the customer.
      \n
    \n
  - account (array): Array of account details.
    \n
    - id (string): ID of the account.
      \n
    - account_number (string): Account number.
      \n
    - account_name (string): Account name.
      \n
    - bank_name (string): Name of the bank.
      \n
    - bank_code (string): Bank code.
      \n
    - currency (string): Currency of the account.
      \n
    - account_type (string): Type of the account.
      \n
    \n
  - expiry (number): Expiry details.
    \n
  - expiry_date (string): Expiry date of the account.
    \n
  - status (string): Status of the account.
    \n
  - created_at (string): Creation date of the account.
    \n
  - updated_at (string): Last update date of the account.
    \n
  \n
\n
status_code (number): Status code of the response.
\n

Example 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\n

Confirm Payment for Virtual Account

This endpoint is used to confirm a payment for a virtual account.

Request Body

trans_id (string): The transaction ID.
\n
session_id (string): The session ID.
\n
amount (number): The amount of the payment.
\n
account_number (string): The virtual account number.
\n

Response

Please note that transaction_hash always comes with a successful transaction.

And you can verify it using the SHA512. See the webhook structure below

POST /collections/virtual-accounts/simulate-transfer

This endpoint is used to simulate a transfer for virtual accounts. - Static account

Request Body

ref (string, required): Reference for the transfer.
\n
amount (string, required): Amount to be transferred.
\n
description (string, required): Description of the transfer.
\n
currency (string, required): Currency of the transfer.
\n
account (string, required): Account details for the transfer.
\n
name (string, required): Name of the account holder.
\n
bank (string, required): Bank sort code for the transfer.
\n
sender_account_number (string, required): Sender's account number.
\n
sender_name (string, required): Sender's name.
\n
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.
\n

Response

The response is in JSON format and follows the schema below:

{\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\n

Virtual 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
Please 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.
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.
\n

There are basically two types of virtual account numner.

1. 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.

Please note that the virtual account becomes inactive (Not to be used once the time set as expired).

2. 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.

**Requirements

**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.

Supported Banks

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

S/N	Bank Name	Value
1	9PSB Microfinance Bank	9psb
2	Palmpay	palmpay
3	Cashconnect MFB	cashconnect

","_postman_id":"95048159-9d5c-4114-b0fb-e1bfcdde5365","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Collection Webhook","item":[{"name":"Webhook Reference - accounts.payments.status","id":"f370da06-73e4-4a29-be7f-67f81cdef4ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: accounts.payments.status

Security - Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n\n

Fired when funds land in a permanent or dynamic virtual account.

Payload shape

{\n  \"event_id\": \"9762b79f-7d8f-4950-8359-35462cb4d17f\",\n  \"event_type\": \"accounts.payment.status\",\n  \"trans_id\": \"9762b79f-7d8f-4950-8359-35462cb4d17f\",\n  \"amount\": 500,\n  \"fee\": 3.2500000000000004,\n  \"currency\": \"NGN\",\n  \"transaction\": {\n    \"session_id\": \"100004260410085056156858444543\",\n    \"date\": \"2026-04-10 09:51:22\",\n    \"amount\": 500,\n    \"currency\": \"NGN\",\n    \"narration\": \"Transfer from MUSTAPHA HAMZA\",\n    \"bank_name\": \"Opay Digital Services\",\n    \"bank_code\": \"100004\",\n    \"sender_account\": \"8063604029\",\n    \"sender_name\": \"MUSTAPHA HAMZA\"\n  },\n  \"customer\": {\n    \"id\": \"48f39145-66e2-40f2-b594-1f8db79b2261\",\n    \"name\": \"YOUR BUSINESS/HAMZA MUSTAPHADANGE\",\n    \"number\": \"5300286431\",\n    \"bank\": \"psb\",\n    \"account_id\": \"07ebb209-5b1e-4d98-9f12-749318d750ef\",\n    \"account_type\": \"static\"\n  },\n  \"created_at\": \"2026-04-10 09:51:22\",\n  \"transaction_hash\": \"728614202E6E3E9C1EB8900CC9CD285995C424C6AABB6D1FCE098B320B775EDD2DD6A8BB2F9EEF811B96182DD7567F5FE734750C334EFA9F84F54836CABCCB56\"\n}\n\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Webhook events fired when a payment is received into a virtual account or wallet.

\n","_postman_id":"08f91ce7-6ebb-4861-82ba-22ddc5b2568c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}}],"id":"a50a7cef-737f-434a-9fc0-dd087ba01e12","description":"

Welcome to Collection API. Receive payment from your customer with no stress.

You can check out a basic PHP integration for this here

\n","_postman_id":"a50a7cef-737f-434a-9fc0-dd087ba01e12","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Payment Links","item":[{"name":"Payment Link Webhooks","item":[{"name":"Webhook Reference - payment_link.paid","id":"be5c17e0-e8f8-4f82-9c4f-cb10c540d713","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: payment_link.paid

Security - Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n\n

Fired once payment is confirmed and settled.

Payload shape

{\n  \"event\": \"payment_link.paid\",\n  \"link_id\": \"3f9a8c21-...\",\n  \"slug\": \"a1b2c3d4\",\n  \"trans_id\": \"tx-uuid\",\n  \"ref\": \"your-ref\",\n  \"amount\": 25000,\n  \"currency\": \"NGN\",\n  \"payment_method\": \"bank_transfer\",\n  \"customer\": {\n    \"name\": \"John Doe\",\n    \"email\": \"john@example.com\",\n    \"phone\": \"+2348012345678\"\n  },\n  \"created_at\": \"2026-04-09T10:00:00Z\"\n}\n\n

Responding - Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Webhook events fired when someone pays through a payment link.

\n","_postman_id":"6ffc5fcb-0e5a-406d-91b9-d5d0018993ab","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"List Payment Links","id":"cf3cf79d-25ee-490e-bddd-70c9237e1ee3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_sk_test_YOUR_SECRET_KEY","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1/links/?page=1&per_page=20","description":"

Returns a paginated list of all payment links for your business.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Query param	Type	Default	Description
`page`	integer	1	Page number
`per_page`	integer	20	Results per page (max 100)
`status`	string	—	Filter: `active` or `inactive`
`q`	string	—	Search title, slug, or link ID

Page number

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Results per page (max 100)

\n","type":"text/plain"},"key":"per_page","value":"20"},{"disabled":true,"description":{"content":"

Filter: active | inactive

\n","type":"text/plain"},"key":"status","value":"active"},{"disabled":true,"description":{"content":"

Search title, slug, or link ID

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"9eaf037a-5e7e-430e-9fb0-514da0405593","name":"List Payment Links - 200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_sk_test_YOUR_SECRET_KEY","type":"text"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1//links/?page=1&per_page=20","host":["https://sandbox.payscribe.ng/api/v1/"],"path":["links",""],"query":[{"key":"page","value":"1","description":"Page number"},{"key":"per_page","value":"20","description":"Results per page (max 100)"},{"key":"status","value":"active","description":"Filter: active | inactive","disabled":true},{"key":"q","value":"","description":"Search title, slug, or link ID","disabled":true}]},"description":"Returns a paginated list of all payment links for your business.\n\n| Query param | Type | Default | Description |\n|-------------|------|---------|-------------|\n| `page` | integer | 1 | Page number |\n| `per_page` | integer | 20 | Results per page (max 100) |\n| `status` | string | — | Filter: `active` or `inactive` |\n| `q` | string | — | Search title, slug, or link ID |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"List Payment Links \\u2014 200\",\n \"data\": {\n \"links\": [\n {\n \"id\": \"3f9a8c21-...\",\n \"title\": \"Product Purchase\",\n \"slug\": \"a1b2c3d4\",\n \"url\": \"https://links.payscribe.co/inv/a1b2c3d4\",\n \"amount\": 25000,\n \"currency\": \"NGN\",\n \"status\": \"active\",\n \"created_at\": \"2026-04-09 10:00:00\"\n }\n ],\n \"total\": 1,\n \"page\": 1,\n \"per_page\": 20\n },\n \"status_code\": 200\n}"},{"id":"004f096a-b222-4674-8155-acd45426cc12","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_sk_test_YOUR_SECRET_KEY","type":"text"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1/links/?page=1&per_page=20","host":["https://sandbox.payscribe.ng/api/v1/links"],"path":[""],"query":[{"key":"page","value":"1","description":"Page number"},{"key":"per_page","value":"20","description":"Results per page (max 100)"},{"key":"status","value":"active","description":"Filter: active | inactive","disabled":true},{"key":"q","value":"","description":"Search title, slug, or link ID","disabled":true}]},"description":"Returns a paginated list of all payment links for your business.\n\n| Query param | Type | Default | Description |\n|-------------|------|---------|-------------|\n| `page` | integer | 1 | Page number |\n| `per_page` | integer | 20 | Results per page (max 100) |\n| `status` | string | — | Filter: `active` or `inactive` |\n| `q` | string | — | Search title, slug, or link ID |"},"status":"Error","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"description\": \"Business not found for this API key.\",\n \"status_code\": 401\n}"}],"_postman_id":"cf3cf79d-25ee-490e-bddd-70c9237e1ee3"},{"name":"Create Payment Link","id":"5e4b2615-a343-4b27-b23c-e51b36a0fdf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_sk_test_YOUR_SECRET_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Product Purchase\",\n \"description\": \"Payment for premium subscription\",\n \"currency\": \"NGN\",\n \"amount\": 25000,\n \"success_message\": \"Thank you! Payment received.\",\n \"redirect\": \"https://yoursite.com/thank-you\",\n \"custom_link\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/links","description":"

Creates a new payment link.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`title`	string	Yes	Link title (5–30 characters)
`description`	string	Yes	Short description shown to payers (5–150 chars)
`currency`	string	Yes	`NGN` or `USD`
`amount`	number	No	Fixed amount; omit for open-amount / donation mode
`success_message`	string	No	Message displayed after successful payment
`redirect`	string	No	URL to redirect payer to after payment
`custom_link`	string	No	Custom slug (must be unique within your account)

Minimum amounts: NGN 100 · USD 5 · Max: 1,000,000 per currency

Retrieves a single payment link by its ID or slug.

Updates an existing payment link.

Pass only the fields you want to change. To toggle status only, send {\"status\": \"inactive\"} or {\"status\": \"active\"}.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`title`	string	New title (5–30 chars)
`description`	string	New description (5–150 chars)
`currency`	string	`NGN` or `USD`
`amount`	number	New fixed amount (or `null` for open-amount)
`success_message`	string	Post-payment message
`redirect`	string	Redirect URL
`status`	string	`active` or `inactive`

Soft-deletes a payment link. The link becomes immediately inaccessible to payers. This action cannot be undone via API.

Send a URL to anyone and collect payment - no code required on the payer side. Payscribe handles the payment collection for you

Flow

Create a payment link → share the url with your customer
\n
Customer opens the link and pays (bank transfer, Payscribe wallet, PalmPay)
\n
You receive a payment_link.paid webhook event
\n

Link types

Fixed amount - set amount; payer cannot change it
\n
Open amount - omit amount; payer enters what they want (donation/tip mode)
\n

\n","_postman_id":"bc1deca9-d008-4540-b254-ef81385bdcc8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Invoices","item":[{"name":"Invoice Webhooks","item":[{"name":"Webhook Reference - invoice.sent","id":"ebbf60a4-96f8-4d28-87ae-aa3a3141d31d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: invoice.sent

Security - Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n\n

Payload shape

{\n  \"event\": \"invoice.sent\",\n  \"invoice_id\": \"inv-uuid\",\n  \"invoice_no\": \"INV-2026-00001\",\n  \"amount\": 725000,\n  \"currency\": \"NGN\",\n  \"customer_id\": \"cust-uuid\",\n  \"due_date\": \"2026-04-23\",\n  \"created_at\": \"2026-04-09T10:00:00Z\"\n}\n\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: invoice.paid

Security - Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n\n

Fired when paid_amount >= total_amount.

Payload shape

{\n  \"event\": \"invoice.paid\",\n  \"invoice_id\": \"inv-uuid\",\n  \"invoice_no\": \"INV-2026-00001\",\n  \"amount\": 725000,\n  \"amount_paid\": 725000,\n  \"currency\": \"NGN\",\n  \"customer_id\": \"cust-uuid\",\n  \"payment_method\": \"bank_transfer\",\n  \"created_at\": \"2026-04-09T12:00:00Z\"\n}\n\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: invoice.partially_paid

Security - Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n\n

Payload shape

{\n  \"event\": \"invoice.partially_paid\",\n  \"invoice_id\": \"inv-uuid\",\n  \"invoice_no\": \"INV-2026-00001\",\n  \"amount\": 725000,\n  \"amount_paid\": 300000,\n  \"balance\": 425000,\n  \"currency\": \"NGN\",\n  \"customer_id\": \"cust-uuid\",\n  \"created_at\": \"2026-04-09T11:00:00Z\"\n}\n\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: invoice.overdue

Security - Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n\n

Payload shape

{\n  \"event\": \"invoice.overdue\",\n  \"invoice_id\": \"inv-uuid\",\n  \"invoice_no\": \"INV-2026-00001\",\n  \"amount\": 725000,\n  \"paid_amount\": 0,\n  \"currency\": \"NGN\",\n  \"customer_id\": \"cust-uuid\",\n  \"due_date\": \"2026-04-23\",\n  \"days_overdue\": 1,\n  \"created_at\": \"2026-04-24T00:01:00Z\"\n}\n\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Webhook events fired when invoice state changes.

\n","_postman_id":"bf2e7010-4463-4734-aa31-6eb697e7ea93","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"List Invoices","id":"74e47c69-d6d7-41da-b0ed-d9b452ba3047","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_sk_test_YOUR_SECRET_KEY","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1//invoices/?page=1&per_page=20","description":"

Returns a paginated list of all invoices for your business.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Query param	Type	Default	Description
`page`	integer	1	Page number
`per_page`	integer	20	Results per page (max 100)
`status`	string	—	`draft` · `sent` · `paid` · `partially_paid` · `overdue`
`customer_id`	string	—	Filter by customer UUID
`q`	string	—	Search title, invoice number, or customer name/email

Page number

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Results per page (max 100)

\n","type":"text/plain"},"key":"per_page","value":"20"},{"disabled":true,"description":{"content":"

draft | sent | paid | partially_paid | overdue

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by customer UUID

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

Search title, invoice number, customer name/email

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"4c53bbd5-3faf-4b00-b86b-020e018add9b","name":"List Invoices - 200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_sk_test_YOUR_SECRET_KEY","type":"text"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1/invoices/?page=1&per_page=20","host":["https://sandbox.payscribe.ng/api/v1/invoices"],"path":[""],"query":[{"key":"page","value":"1","description":"Page number"},{"key":"per_page","value":"20","description":"Results per page (max 100)"},{"key":"status","value":"","description":"draft | sent | paid | partially_paid | overdue","disabled":true},{"key":"customer_id","value":"","description":"Filter by customer UUID","disabled":true},{"key":"q","value":"","description":"Search title, invoice number, customer name/email","disabled":true}]},"description":"Returns a paginated list of all invoices for your business.\n\n| Query param | Type | Default | Description |\n|-------------|------|---------|-------------|\n| `page` | integer | 1 | Page number |\n| `per_page` | integer | 20 | Results per page (max 100) |\n| `status` | string | — | `draft` · `sent` · `paid` · `partially_paid` · `overdue` |\n| `customer_id` | string | — | Filter by customer UUID |\n| `q` | string | — | Search title, invoice number, or customer name/email |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"List Invoices \\u2014 200\",\n \"data\": {\n \"invoices\": [\n {\n \"id\": \"inv-uuid\",\n \"invoice_no\": \"INV-2026-00001\",\n \"title\": \"Project Invoice\",\n \"currency\": \"NGN\",\n \"total_amount\": 725000,\n \"paid_amount\": 0,\n \"status\": \"sent\",\n \"issue_date\": \"2026-04-09\",\n \"due_date\": \"2026-04-23\",\n \"customer\": {\n \"id\": \"cust-uuid\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n },\n \"created_at\": \"2026-04-09 10:00:00\"\n }\n ],\n \"total\": 1,\n \"page\": 1,\n \"per_page\": 20\n },\n \"status_code\": 200\n}"}],"_postman_id":"74e47c69-d6d7-41da-b0ed-d9b452ba3047"},{"name":"Create Invoice","id":"7c4e0ed7-f41c-4803-b39f-a459e7f3aab0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_sk_test_YOUR_SECRET_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer_id\": \"\",\n \"title\": \"Project Invoice \\u2014 April 2026\",\n \"description\": \"Web development services\",\n \"currency\": \"NGN\",\n \"issue_date\": \"2026-04-09\",\n \"due_date\": \"2026-04-23\",\n \"po_number\": \"PO-2026-001\",\n \"allow_partial\": true,\n \"items\": [\n {\n \"description\": \"UI/UX Design\",\n \"quantity\": 10,\n \"unit\": \"hr\",\n \"rate\": 15000,\n \"line_discount_amount\": 0,\n \"line_tax_amount\": 0\n },\n {\n \"description\": \"Backend Development\",\n \"quantity\": 20,\n \"unit\": \"hr\",\n \"rate\": 25000,\n \"line_discount_amount\": 0,\n \"line_tax_amount\": 0\n },\n {\n \"description\": \"Server setup\",\n \"quantity\": 1,\n \"unit\": \"flat\",\n \"rate\": 75000,\n \"line_discount_amount\": 0,\n \"line_tax_amount\": 0\n }\n ],\n \"discount_amount\": 0,\n \"tax_amount\": 0,\n \"shipping_amount\": 0,\n \"notes\": \"Payment due within 14 days.\",\n \"post_type\": \"draft\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1//invoices/","description":"

Creates a new invoice with line items.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`customer_id`	string	Yes	UUID of the customer
`title`	string	No	Invoice title
`description`	string	No	Notes shown on the invoice
`currency`	string	Yes	`NGN` or `USD`
`issue_date`	string	No	Date issued `YYYY-MM-DD` (default: today)
`due_date`	string	No	Payment due date `YYYY-MM-DD`
`po_number`	string	No	Purchase order / reference number
`allow_partial`	boolean	No	Accept partial payments (default: `true`)
`items`	array	Yes	Line items — see item schema below
`discount_amount`	number	No	Invoice-level discount applied to total
`tax_amount`	number	No	Invoice-level tax applied to total
`shipping_amount`	number	No	Shipping / handling fee
`notes`	string	No	Payment instructions or remarks
`post_type`	string	No	`draft` (default) or `send` (emails the invoice immediately)

Item object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`description`	string	Yes	Line item description
`quantity`	number	Yes	Quantity
`unit`	string	No	Unit label: `hr`, `unit`, `flat`, etc.
`rate`	number	Yes	Price per unit
`line_discount_amount`	number	No	Per-line discount amount
`line_tax_amount`	number	No	Per-line tax amount

Returns the full invoice including all line items, customer details, and payment history.

Updates an existing invoice.

Sending items replaces the entire line-item list — include the full updated set.

Cannot update a paid or cancelled invoice.

Emails the invoice to the customer.

Transitions status draft → sent
\n
Email includes an itemised breakdown and a Pay Now link
\n
Can be called again to re-send (e.g. after updating the invoice). Please note that you can only send an invoice a maximum of 3 times.
\n

Soft-deletes an invoice. Paid invoices cannot be deleted.

Create, send, and track professional invoices.

Invoice lifecycle

draft → sent → partially_paid → paid\n                   ↓\n                overdue  (if due_date passes without full payment)\n

Line items — Use items[] (an array of objects); each item's amount is auto-calculated as (quantity × rate) − line_discount_amount + line_tax_amount.

Invoice-level adjustments — Apply a blanket discount_amount, tax_amount, or shipping_amount on top of line totals.

\n","_postman_id":"c165d348-963c-42ba-b5f3-e1e137471483","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"FX & Conversions","item":[{"name":"Live Fx Rate","event":[{"listen":"test","script":{"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":"2be9fcbc-1545-4746-815e-b1f526dfe147"}}],"id":"90d152a4-5d07-4469-bdb1-41e211e7bc4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/fx/rates","description":"

DEPRECATED. Get Currency Pair Details

This endpoint allows you to retrieve the details of a currency pair.

Request

Method: GET
\n
Endpoint: https://sandbox.payscribe.ng/api/v1//currency_pair
\n
Query Parameters:
\n
- from: The currency code to convert from (e.g. NGN)
  \n
- to: The currency code to convert to (e.g. USD)
  \n
\n

Response

The response will include the details of the currency pair, such as the exchange rate and other relevant information.

{\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\n

DEPRECATED. Get Currency Pair Details

This endpoint allows you to retrieve the details of a currency pair.

Request

Method: GET
\n
Endpoint: https://sandbox.payscribe.ng/api/v1//currency_pair
\n
Query Parameters:
\n
- from: The currency code to convert from (e.g. NGN)
  \n
- to: The currency code to convert to (e.g. USD)
  \n
\n

Response

The response will include the details of the currency pair, such as the exchange rate and other relevant information.

{\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\n

Create Quote - Currency Pair

This 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.

Purpose

Use 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.

HTTP Request

POST https://sandbox.payscribe.ng/api/v1/currency-pair

Authorization

This endpoint requires Bearer Token authentication. Include the following header in your request:

Authorization: Bearer {{API Token}}\n

Request Body Parameters

Send a JSON object in the request body with the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
from	string	Yes	The source currency code (e.g., \"NGN\").
to	string	Yes	The target currency code (e.g., \"USD\").
amount	number	Yes	The amount to convert from the source currency.

Example:

{\n  \"from\": \"NGN\",\n  \"to\": \"USD\",\n  \"amount\": 5000\n}\n

Successful Response

A successful response returns HTTP 200 and a JSON object with the quote details.

Response Structure:

{\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}\n

Response Fields

status: 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.
\n

Notes

The quote is valid only until the expires_at timestamp.
Always check the rate and fee before proceeding with a transaction.

For more details, refer to the Welcome to Payscribe API.

Execute A Quote

This request executes a currency conversion quote previously created via the Payscribe API. It finalizes the conversion transaction based on the provided quote details.

Purpose

Use 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.

Authorization

Header: Authorization: Bearer <API_KEY>
- Replace <API_KEY> with your valid Payscribe API key.
\n

Request Body

Send a raw JSON object with the following parameters:

quote_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  \"quote_id\": 110,\n  \"sig\": \"0f79353c2e27e659119de496e7f02134d44807d8...\"\n}\n

Successful Response

A 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}\n

Response Fields

trans_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.

Notes

Ensure the sig parameter is generated according to Payscribe's security documentation.
Only valid, unexpired quotes can be executed.

For more details, refer to the Payscribe API documentation or contact support.

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.

Request

No request body is required for this request.

Response

Status: 200
\n
Content-Type: application/json
\n

The response will include a JSON object with the following structure:

{\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\n

The 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.

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":"e83efc54-aa49-40e3-a429-3ffaac16eb75","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Card Issueing","item":[{"name":"Card Endpoints","item":[{"name":"Create a Card","id":"8fde7c12-2837-40a8-8919-4cc3c71b66dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"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\": \"ffad4eb3-b425-4ee5-86ad-fb0145a5fbf2\"\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":"

Create Card

This endpoint allows you to create a card for a specific user.

Request Body

customer_id (String, required): The customer id that was generated when creating the customer.
\n
currency (String, optional): The card currency. The default and available option is USD.
\n
brand (String, required): VISA or MASTERCARD.
\n
amount (Decimal, required): The amount you want to top up on the card. The minimum amount is 1.
\n
type (String, optional): Card type, which can be virtual or physical. The default is virtual.
\n

Response

{\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

JSON Schema for Response

{\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\n

Topup Card

This endpoint allows you to top up an existing card.

Request Body

amount (required, Number): The amount you want to top up.
ref (optional, String): Your system transaction ID for reference.

Response

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.

Example

{\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}\n

Withdraw Card Balance

This endpoint allows you to withdraw a specified amount from a card.

Request Body

amount (number) - The amount to be withdrawn from the card balance.
\n
ref (string) - A reference for the withdrawal transaction.
\n

Response

status (boolean) - Indicates the status of the withdrawal request.
\n
description (string) - Additional description, if any.
\n
message (object) - Details of the transaction, including transaction ID, customer details, card details, currency, action, and timestamps.
\n
status_code (number) - The status code of the response.
\n

Get Card Details

This endpoint allows you to retrieve the details of a specific card by providing the card ID in the URL.

Request Body

This request does not require a request body.

Response Body

status (boolean): Indicates the status of the response.
\n
description (string): Provides additional information about the response.
\n
message (object): Contains the details of the card.
\n
- details (object): Includes the following card details:
  - id (string): The unique identifier of the card.
    \n
  - currency (string): The currency associated with the card.
    \n
  - card_type (string): The type of the card.
    \n
  - brand (string): The brand of the card.
    \n
  - first_six (string): The first six digits of the card number.
    \n
  - last_four (string): The last four digits of the card number.
    \n
  - masked (string): The masked card number.
    \n
  - card_number (string): The full card number.
    \n
  - expiry (string): The expiry date of the card.
    \n
  - ccv (string): The CCV (Card Verification Value) of the card.
    \n
  - balance (number): The balance associated with the card.
    \n
  - status (string): The status of the card.
    \n
  - billing (object): Contains the billing address details.
    \n
    - address (string): The address associated with the card.
      \n
    - country (string): The country in the billing address.
      \n
    - state (string): The state in the billing address.
      \n
    - city (string): The city in the billing address.
      \n
    - postal_code (string): The postal code in the billing address.
      \n
    \n
  - created_at (string): The date and time when the card was created.
    \n
  - updated_at (string): The date and time when the card was last updated.
    \n
  - terminate (boolean): Indicates if the card is terminated.
    \n
  - terminate_date (string): The date when the card was terminated.
    \n
  - customer (object): Contains the details of the customer associated with the card.
    \n
    - id (string): The unique identifier of the customer.
      \n
    - name (string): The name of the customer.
      \n
    \n
  \n
\n

Example

{\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\n

Replace Carrd (Decommissioned BINs)

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.
\n
Transferring the balance from the old card to the new one
\n
Terminating the old card.
\n
Allowing users to continue transacting with the new card.
\n

Usage

To 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.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory	Description
card_id	String	Yes	The unique identifier of the card that needs to be replaced due to decommissined BINs

Replace Carrd (Decommissioned BINs)

Replacing the old card with a new one.
\n
Transferring the balance from the old card to the new one
\n
Terminating the old card.
\n
Allowing users to continue transacting with the new card.
\n

Usage

To 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.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory	Description
card_id	String	Yes	The unique identifier of the card that needs to be replaced due to decommissined BINs

This resouce allows you to get a card transaction.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
start_date	String	required	Return transactions created after and on this date. YYYY- MM-DD
start_date	String	required	Return transactions created before and on this date. YYYY-MM-DD
page_size	Int	optional	how many transactions shoud be fetched on each page, default is 20
page	int	optional	The page counter

Freeze Card

This endpoint is used to freeze a specific card identified by the card ID in the URL.

Request Body

ref (string, required): Reference for the freeze action.

Response

status (boolean): Indicates the status of the freeze action.
\n
description (string): Description of the freeze action.
\n
message (object): Details of the freeze action including transaction ID, reference, customer ID, card details, currency, action, and creation timestamp.
\n
status_code (integer): Status code of the response.
\n

Example response:

{\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\n

This resource allows you to unfreeze a card.

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.

Create a Card Funded by Stablecoin

Description

Issues a new virtual USD card for a customer, funded by a stablecoin deposit (USDT or USDC) rather than your Payscribe USD wallet balance.

When this endpoint is called:

Payscribe finds or provisions a dedicated on-chain deposit address for the customer.
The response returns the deposit address and the exact stablecoin amount the customer must send.
Once the on-chain deposit is confirmed by the payment processor, the card is created automatically and a cards.created webhook is fired.

The order expires after 24 hours if no deposit is received.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`customer_id`	string	Yes	UUID of the customer to issue the card to
`currency`	string	Yes	Must be `USD`
`brand`	string	Yes	`VISA` or `MASTERCARD`
`amount`	number	Yes	Card load amount in USD (minimum `1`)
`type`	string	No	`virtual` (default)
`ref`	string	Yes	Your idempotency reference
`payment_method`	string	Yes	Must be `stablecoin` to trigger this flow
`stablecoin_currency`	string	No	`USDT` (default) or `USDC`
`stablecoin_network`	string	No	`Tron` (default), `Ethereum`, `BNB`, etc.
`stablecoin_chain`	string	No	`TRC20` (default), `ERC20`, `BEP20`, etc.

\n
Note: A card creation fee of $2 USD (or $1 on paid plans) is added to the amount. The amount field in the response reflects the total you must deposit, inclusive of the fee.
\n

Response

{\n  \"status\": true,\n  \"description\": \"Deposit address ready. Your card will be created once the deposit is confirmed.\",\n  \"message\": {\n    \"status\": \"pending_payment\",\n    \"payment_method\": \"stablecoin\",\n    \"address\": \"TRxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"memo_tag\": null,\n    \"currency\": \"USDT\",\n    \"network\": \"Tron\",\n    \"chain\": \"TRC20\",\n    \"amount\": 7.00,\n    \"expires_at\": \"2025-04-11T10:00:00+00:00\"\n  },\n  \"status_code\": 200\n}\n

What happens next

Your customer sends the exact amount in currency to the address shown.
Payscribe detects the deposit on-chain.
The card is created and the customer's cards.created webhook is fired with the full card object.
If the deposit does not arrive within 24 hours the order expires — call this endpoint again to get a fresh address.

Top Up a Card via Stablecoin

Description

Adds funds to an existing active virtual card using a stablecoin deposit (USDT or USDC) rather than your Payscribe USD wallet balance.

When called:

Payscribe finds or provisions a deposit address tied to the card's owner.
\n
The response returns the address and exact amount to send.
\n
Once the deposit is confirmed on-chain, the card balance is increased automatically and a cards.topup webhook fires.
\n

The order expires after 24 hours.

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`card_id`	UUID of the card to top up

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`amount`	number	Yes	Amount in USD to add to the card (minimum `1`)
`ref`	string	No	Your idempotency reference
`payment_method`	string	Yes	Must be `stablecoin`
`stablecoin_currency`	string	No	`USDT` (default) or `USDC`
`stablecoin_network`	string	No	`Tron` (default), `Ethereum`, `BNB`, etc.
`stablecoin_chain`	string	No	`TRC20` (default), `ERC20`, `BEP20`, etc.

\n
Note: There is no additional fee for stablecoin top-ups. The amount in the response matches what you passed - it is the exact stablecoin value to deposit, and this is also dependent on the amount .
\n

Response

{\n  \"status\": true,\n  \"description\": \"Deposit address ready. Your card will be topped up once the deposit is confirmed.\",\n  \"message\": {\n    \"status\": \"pending_payment\",\n    \"payment_method\": \"stablecoin\",\n    \"address\": \"TRxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"memo_tag\": null,\n    \"currency\": \"USDT\",\n    \"network\": \"Tron\",\n    \"chain\": \"TRC20\",\n    \"amount\": 10.00,\n    \"expires_at\": \"2025-04-11T10:00:00+00:00\"\n  },\n  \"status_code\": 200\n}\n\n

Supported Networks

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Network	Chain	Currency
Tron	TRC20	USDT, USDC
Ethereum	ERC20	USDT, USDC
BNB Smart Chain	BEP20	USDT, USDC

\n
Always send the exact amount shown. Sending more or less may delay settlement or require manual reconciliation.
\n

Stablecoin Cards

Pay for card creation and top-ups using on-chain stablecoins (USDT or USDC) instead of your Payscribe USD wallet balance.

This flow is ideal when:

Your customers hold crypto and want to fund their cards directly from a wallet.
\n
You want to avoid pre-funding your Payscribe USD balance before issuing cards.
\n
You need to support Web3-native payment flows in your product.
\n

How it works

Call the Create Card or Top Up Card endpoint with payment_method: \"stablecoin\" added to the request body.
\n
Payscribe returns a deposit address and the exact stablecoin amount required.
\n
The customer sends the stablecoin to the address on-chain.
\n
Once confirmed, Payscribe creates the card or adds the funds automatically.
\n
A webhook event fires to notify your system.
\n

Supported Stablecoins

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Stablecoin	Networks
USDT	Tron (TRC20), Ethereum (ERC20), BNB Smart Chain (BEP20)
USDC	Tron (TRC20), Ethereum (ERC20), BNB Smart Chain (BEP20)

Important Notes

Card creation includes a fee ($2 standard, $1 on paid plans). The fee is included in the deposit amount returned. You can contact your account manager for more clarity
\n
Top-ups carry no additional fee - deposit exactly the USD amount you want on the card.
\n
Orders expire after 24 hours. Call the endpoint again to get a fresh address.
\n
The deposit address is customer-scoped: any future card operations for the same customer on the same network reuse the same address.
\n

\n","_postman_id":"d77908db-c563-4d27-b1d9-9195a7fb6b6e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Card Webhook","item":[{"name":"Webhook Reference - card.auth.refund","id":"28b73b04-27d6-490f-bb8b-8590ed693a22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: card.adjusted.refund

Security - Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n\n

Fired for every card spend, ATM withdrawal, or online purchase.

Payload shape

{\n  \"trans_id\": \"f72bec18-8267-45e2-b657-b9c05de826e7\",\n  \"customer\": {\n    \"id\": \"1c4df398-7839-42bb-8bff-f9aa3beacf03\"\n  },\n  \"amount\": 1,\n  \"acceptor_name\": \"Auth Reversal-FACEBK *T1U4            fb.me/cc  \",\n  \"auth_currency\": \"SAR\",\n  \"auth_country\": \"NLD\",\n  \"reason\": \"Auth Reversal - Advice\",\n  \"created_at\": \"2026-04-10 13:57:40\",\n  \"card\": {\n    \"id\": \"db2bb467-b1d4-4a4a-91d1-6d695797239d\",\n    \"first_six\": \"428852\",\n    \"last_four\": \"2230\",\n    \"prev_balance\": 30.44,\n    \"balance\": 2.51\n  },\n  \"event_id\": \"f72bec18-8267-45e2-b657-b9c05de826e7\",\n  \"event_type\": \"cards.adjusted.refund\"\n}\n\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: cards.auth.verified

Security - Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n\n

Payload shape

{\n  \"trans_id\": \"bbd5811f-57b8-4669-9391-bb9b93c3ff5d\",\n  \"customer\": {\n    \"id\": \"bccd1d42-21c7-4187-914f-3d866d19d82d\"\n  },\n  \"acceptor_name\": \"STARLINK INTERNET      Dublin         IE\",\n  \"auth_currency\": \"EUR\",\n  \"auth_country\": null,\n  \"auth_amount\": 0,\n  \"mcc\": \"4812\",\n  \"created_at\": \"2026-04-10 13:59:16\",\n  \"card\": {\n    \"id\": \"855dbedb-242f-4eed-8ae6-a7351c8c05d6\",\n    \"first_six\": \"428852\",\n    \"last_four\": \"1788\",\n    \"prev_balance\": 186.25,\n    \"balance\": 186.25\n  },\n  \"event_id\": \"bbd5811f-57b8-4669-9391-bb9b93c3ff5d\",\n  \"event_type\": \"cards.auth.verified\"\n}\n\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: card.status.changed

Security — Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n

Payload shape

{\n  \"event\": \"card.status.changed\",\n  \"card_id\": \"card-uuid\",\n  \"customer_id\": \"cust-uuid\",\n  \"previous_status\": \"active\",\n  \"new_status\": \"frozen\",\n  \"created_at\": \"2026-04-09T10:00:00Z\"\n}\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Webhook events fired when a card transaction or status change occurs.

\n","_postman_id":"b81d810e-1b71-4908-afce-27d6515afae2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}}],"id":"29c3311d-791a-487b-be77-56584f8388c5","description":"

Card Issuance

Overview

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:

Virtual Card: A basic virtual card, not enabled for contactless payment methods.
\n
Contactless Virtual Card: A full-featured virtual card that supports contactless payment channels like Apple Pay, Google Pay, and other tokenization services.
\n

These endpoints allow you to issue cards across various use cases while enabling control, flexibility, and digital accessibility.

Comparison Between Virtual Card Vs Contactless Virtual Card

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Feature	Virtual Card	Contactless Virtual Card
Can be used online	Yes	Yes
Supports contactless payments	No	Yes ( e.g Apple pay, google pay)
Reloadable	Yes	Yes
Can be added to digital wallets	No	Yes
Custom MCC Whitelisting/Blacklisting	No	Yes
Custom MID Blocking/Unblocking	Yes	Yes
Suitable for:	Basic online transactions	Basic online transactions + Rich digital wallet experience

Please note that we currently suppport USD Card.

How Card Issuing Works

Create customer if not already existing.
\n
Enroll customer to Tier 2 Or use the Create Customer - Full endpoint to avoid upgrading customer.
\n
Create a new card, select between virtual and contact virtual card
\n
Configure controls such as daily or transaction limits
\n
Whitelist or blacklist MCCs to manage card usage
\n

Where Can the Card be used?

Payscribe Virtual card works on mostly US merchants, if you encounter any issue or need more clarity please contact hello@payscribe.co

Restricted MCCs

There are several merchant sites where the cards may be
rejected. They are denoted using a category code known as MCC - Merchant
Category Code

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description
4829	Money Transfer
5966	Direct Marketing – Outbound Telemarketing Merchant
6051	Non-Financial Institutions – Foreign Currency, Non-Fiat Currency (for example: Cryptocurrency), Money Orders (Not Money Transfer), Travelers Cheques, and Debt Repayment
6211	SECURITY BROKERS/DEALERS
7273	Dating Services
7297	Massage Parlors
7800	Government-Owned Lotteries (US Region only)
7801	Government Licensed On-Line Casinos (On-Line Gambling) (US Region only)
7802	Government-Licensed Horse/Dog Racing (US Region only
7995	Betting, including Lottery Tickets, Casino Gaming Chips, Off-Track Betting, and Wagers at Race Tracks

Summary

All cards issued via these endpoints are virtual in form.
\n
Contactless Virtual Cards support advanced digital wallet integrations (e.g., Apple Pay, Google Pay).
\n
Contactless Cards are available on Mastercard and Visa cards.
\n
NGN cards (currently not available) do not support contactless functionality.
\n
Reloadability depends on user needs; use the Lite Card endpoint to issue cards that are for one-time use.
\n
The 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.
\n

\n","_postman_id":"29c3311d-791a-487b-be77-56584f8388c5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"KYC API","item":[{"name":"Lookup kyc","id":"809392d7-10c5-4a95-a825-a209fe8f925b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1/kyc/lookup?type=bvn&value=22392226780","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}},"urlObject":{"path":["lookup"],"host":["https://sandbox.payscribe.ng/api/v1/kyc"],"query":[{"key":"type","value":"bvn"},{"key":"value","value":"22392226780"}],"variable":[]}},"response":[{"id":"8bcf5b42-57cc-4169-9baf-3affd7371031","name":"BVN Lookup","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_live_bac981179f367603e0147dd534e41f54d5a3ff7667fc03e61d0e501fe75378cf","type":"text"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1//kyc/lookup?type=nin&value=86206236524","host":["https://sandbox.payscribe.ng/api/v1/"],"path":["kyc","lookup"],"query":[{"key":"type","value":"nin"},{"key":"value","value":"86206236524"}]}},"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":"435"},{"key":"date","value":"Fri, 05 Jan 2024 11:10:45 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": {\n \"description\": \"Lookup successful\",\n \"details\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"gender\": \"Male\",\n \"photo\": \"base64encodeImageUrl\",\n \"phone_number\": \"2348088992200\",\n \"dob\": \"1990-01-19\",\n \"transaction_status\": \"success\",\n \"amount\": \"35.00\",\n \"total_charge\": \"35.00\",\n \"trans_id\": \"PS-kyc-0hV17044530457868O7j\",\n \"type\": \"bvn\",\n \"value\": \"12345678901\",\n \"datetime\": \"2024-01-05 11:10:45\",\n \"score\": 98,\n \"blacklist\": false\n }\n },\n \"status_code\": 200\n}"},{"id":"4c1e9a3c-3080-4ddb-9656-8116dbfa6456","name":"Lookup kyc","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}","type":"text"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1//kyc/lookup?type=nin&value=1122663355","host":["https://sandbox.payscribe.ng/api/v1/"],"path":["kyc","lookup"],"query":[{"key":"type","value":"nin"},{"key":"value","value":"1122663355"}]}},"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":"set-cookie","value":"ci_session=oraga8msc5v3eurh9di365q4l7jcphpa; expires=Sat, 13-Jan-2024 13:28:12 GMT; Max-Age=7200; path=/; HttpOnly; secure"},{"key":"content-type","value":"application/json"},{"key":"transfer-encoding","value":"chunked"},{"key":"date","value":"Sat, 13 Jan 2024 11:28:12 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"x-turbo-charged-by","value":"LiteSpeed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": {\n \"description\": \"Lookup successful\",\n \"details\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"Phil\",\n \"gender\": \"m\",\n \"phone_number\": \"08088992200\",\n \"expiry_date\": null,\n \"photo\": \"/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a\\nHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy\\nMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAHSAV4DASIA\\nAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/\\nAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3\\nODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWm\\np6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEA\\nAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSEx\\nBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElK\\nU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3\\nuLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwCtnJpT\\nSHg0DIqRoUgetHakNKOlAwx6Ug44p+KaRTAdmgjNNHFG6gQu2kCkHrSg0vWgBRRTSvNGSB1pgOpM\\n80uTRxQAA0tJiigBaMCijFAgxS4pKUGgAwaKeuMc0HFIZHSU4ikoAQikp1HFFgI+9L3pcUYoGJQO\\ntChiDuGKdikAw9ab3p5XNN20AJRTgtIRg0DEopcUbc9KAEopcUYoASkNLSGgAopRQRQAdqSl7UlA\\nEpXPNJin0hFMkYwpDSt0pooAeORS9qapqTjFADCOKbipCM00igBB3pwNNAxS4pDHZoxxSjFFUIaB\\nilpcUmKAFooHFLwaBCUUvFGKAAHmlJ44pMUdKBijilBGaRTSkDJoEKduOlJtHY000UDArxSYpc0h\\nPNIBOaX60ueKKAENITSkCkxQMTFGMU4Y6Gm4I6GgApCeaOabznmgY+jFIKUmkAnekNA607vQIbt+\\nU+tNIxUvFMIyaBjQcUdaXFJigBOlGc0uKAKQEpOKM8Uh5pKsgRjTKcTTaQxQeakHNRVItAD6KQGl\\noATFGKWlAzQAwcUoNKRSYpiHjBo20gNPBBoAYRijFPYUgoATFKAaKcKAG078KXFFACYHpSFadiig\\nBhX3poX1qQikNAyPFBp3NGM0gGClpcUUANPSgUpFGMUDG4JpCpp9A60BcaFIpMGpKOKLBcjGaCPW\\npKQ0ARjg0pFOIFGKAG0ZxTsUhFIY08mjGKdgUUAJjik6UpHvSYoAeab0qTFMZaogjJpKcemDxSY5\\noAB1qQc0gWnDjigAFLS0lABjNOpBS0AKORSUvagDmgBgGKcpxT8ZpCtACjmgjFNwRTgaADFKKOoo\\nFAC0uMUnalzQAuOKQ07HHFIBxQA2kIp4FIRQAzFGOKdSEUANxRilxijFADMUYpxAo4oHcjxSqpJ4\\np5xjmkUgc0ANIwcUlOPLZppoAKO1KBzRjmkMbiloooAKQ0tFACUYpcUYNADcUYp9JzQFxxHNJUm2\\nkK8mmQRMKaF5qTaTS7aAGgcUoFOApwFAxnemkVLimHk8UAIOKKUjAptAC9qcDTKKAJc0opi07nrQ\\nA6ikBzTsUAJilxRT80xDduRQRxzSjNKTjrQMQCgZpw5FLSAYQe1Ic96fjmkODQAymmnUmKAE4ooo\\noAKTHNKaQUABHFAAoPSm5xQA7bSYFG7ikLUALj0pSBj3pAaXigYzr1o20/FGKAIyKMU+kIoAaAaU\\ninYoxQA3FGKdjmlxSAfSU/FNK81RA3FLjNOxxRigBmKWnYOaQigYlNK806g0AMI4pCKcRmigBlNq\\nXAppXmkMQUuaMY7UhBzQA8GnCoh1qQUAOzTx04qOng8UxDs01ueDTucZqCa6hgGZXVR7mgCYA0tY\\n8/iOwhzibcR2WoG8W6eoBDN78UWA38U3PNYq+KtNfH70gn2q7BqVpdKDHMv50DLlIaTPpzSZpALR\\niiigBDR2pTRQAwg460mw1JjiigBoWgrTqSgBAKUClpMUAJRilooASkz2p1JigAxRS0YoASlopaAH\\n4pT1paKZIYpBTqSmAd6aVp3eigCM0lPINNI5pAJTT0p2KQigYzPFJk0rU3mgY7NHWm+1GcGgBcU4\\nU3NGcdaQEuc1HPcxW0LSSuFUeprN1LWYdPT+9J1CiuNvtSuL6UvK/BPCDoKaQjZ1LxdI5aG0G0dm\\nPeueuby4uW3TzM59Caj2ZIPU0GMseB0psdiPucGmt1AqcREDkc96DFgdKLhYgJx0pUd1OVJH0NSB\\nM5GOaYY2Bz2pAatnr19auAJS6Ds1dXp2u297hCQsncGvP9pQ+x5FPVnRwwJUjoRxRYD1MHIyOlKK\\n4nS/EksAEdyS6Doe4rsLa6juoVkRgcjtSAnooooAM8UmaeFyKjwaAHdqTvRRjmgBaSlxSHrQAUUU\\ntACUUtJQAYooozQAGgmkPTNNJoGWqCKKWmSNpAeaUnFNB5oAdSHNOFNYUxC9qTHNKPeigBhFIRUh\\nFRkc0DI3FMPFSt0pjikMZmjvRTWdUUsxwPWkA4sFBLEADrXO6p4gKl4bbBPQtVXVtYe4doICRGOC\\nR3rKjgZuMU9hatkDmSRyXYsx6kmpI7c9StXFth361OsYVelS5GsYFVLXPap0s0Xr1qTdjpRv5rNy\\nZpyoDbpjpULQJ6VMXNNzmldhYgFmhNL9hAHHNTipFzTuwsjOlsWySBkelVpIGGMg8Vud6QxqwOVp\\nqTE4I54rhvSr2napPp8u5GJTupq1NYqw3AciqUlqycYODVqVzN0+x22n6zb34+U7Wx0NaasD715l\\nHJJazq8ZIINdXo2ufaX8ucqrDp70yLWOjLGm5NJuyM0DpQAopRSUtAC5zTaWkoAO9LRRigBOtGKX\\nFIaACjFGeKQsKAA0zvTic9KTFAFrNGaSimIGFMXrT80g4NADu1FIKWgBO9BoPJoNAAKaRzS0maAG\\nMKYwzUpxTCM0AQsdvXgd65bW9X8xzBA3yjgn1rQ1/UxbReRGcyMOfauUTLP83fmmNak8Ee44/Gry\\nIF60yCMdQKsbM1lJm0VYj20hz0qUKaXyyahs0SK+KMHtVgQE0vk7QeOaRVittoC1OFJPIpxT0FK4\\nWIlWpFQ1IkZJFSqvOBTuFiIKcdKTaKtbfUcU1owegpisVytRum7tVgoRTCKTdgaMy6tsgstUPniY\\nFTgjvXQMoIwR1rNvIAoyBVxkZyibug6yblPImYB16H1roa81jdoJA6HDDpXbaRqIvrYZ++BzWhhY\\n1BS02gGgY6ik7UZoCwuaXNNzSE0CHE4poOaQZNIAc0DHZo9eKAKXvQAgWnYpelFAiYUUtBpiGmjF\\nLSUAAz3pc8UnSjIoAB1ooooAQ9aaRSnrSUAJUFzcLbQPKxwFGanrn/E1yUtlt1PL8mmBzN1M13dv\\nK38R70+CPc49R3pkSDcc88cCr1vGcgEd6iTNIK5YjjIGKnEXFOSPHWpQfyrJmyI1hU/ePFKFA6c0\\nrsMcVXMp3YpF3LACj2NNcZquWk/CnK5pDQ/b6CkCHNKr44p+eQB1pAhVUZyamRVA6VWL4bFSI+aa\\nBssHGBTSoFN3jGaTzM0yQZRioWXI4qdSDSkDHAoYJlIrVe5i3pV9kyOlQvHlSBSTsNowmjG4giru\\niXhtL8Ln5G4IqOWPYxzVcDB3dD7VvF3OaSPQUYFc5pQazdHuzd2K7h8ynBrQwRTJFpc0lHakMX60\\no5puOaXGKAFoHWlpAOaBC0UAU6mAUZpOaWgCeiiimQFJS0UAIaSnYpKBjaWlxSHrQA09aSnU00wE\\nrjPEMnnaoVH8Irsj35xXCagxl1SY5z82KAGxJlkIPfmtKJTzx06VXs4XJKleOua0ioC/SsZs3prQ\\nYCQKazHGBSO2DikD81PQ0EKyMpIxgVEVYjJFWSflxRgjoKm5SiVtkgwe1PA9an2M4wBUi23TOSaV\\nylGxVUEe9PXOeastbnPSkS3IpcyHYrsuaVMr0FWfJ7UeTg9OlCkDREckUw8CrHljuKasbyMeOKq5\\nDRCvWp15FJJAy1FuKEZqmxWJioK1Cyc04SAinA5NSMoTQZycVQkQYwRzXQtGGwMcVnXsSRycDjFV\\nB6kTiSeHXZZpIj90810grlNGfbqagEhT+tdZ17Vsc4uOKMUoHFGKQBxS5oxS44oASilxSgUwEoxS\\n0UAFJS0YoAsUUuM0YqiBKTFLRQAlJg06kosAhpM0ppOlMANNPSnZoNICKXiM/Q1wLL/pz5Ocsa72\\ncfuXz0wa4GMf6YR6safQFub1txFz1pksgHepPuRAe1QrbyTt8qnB71ztHSiq8pJPBNKjHjIyfStS\\nDSGeQLuX6etakXhdHG4uwJp2TBtowFcgDK4J9aeGnO790OBkY710Z0iKDo4YKMc81H9jQAbCN1HL\\nFC5pGTBE7xrJjBParqLuC5GGq/bWwCEDG4ULYOSScDHU0nGL2Gpy6ldoAF+7k1EIVH41tm0byhgc\\netZk8TITxWTjY2UrlX7PnkDNQyKV7VpxRs2AB17Us1kzvtCnOKIoJSZicuMgZwelMMjx5wQMetbc\\nemN1I2n1pRpibz5ncdDWiijNyZgNfYHzYNQNOsingg10jaRDKwztGOnNK3hyGXhXy/t0quVEqbOU\\n3sp+6QKsRzA8CtyXw9LBwRlT1BrPuNLeI5UYFS1YpO4Iciqt2ilCeM1JGWQ7W6064AaBs+lJblPY\\nytNQf2mvPANdeoxXIacdmpRdyTiuyAzW5yvcAOKMVIF4oC96BEdKKftpNooAbRT8U3aTQA3FOxxS\\nhDmn7eKAIwKdingCl20AOxjvSU/FIBzWljO400lPK0mOaQxtJ3qTFJjmgBh60mKcaSgBppaWg0AQ\\nzLvidfUVwcI/00oezEc/WvQG6VwjIV1qQEdXNHQa3NuKLzcA9K0FjWNNoqO3UKlNnuFjxnk54A71\\nytu9jrVrXLtvJtcEAcdK1HunjtsjqBXIy6m0fyxv854CKMtVB9UupJHjEFwZVU5yemBnp9K0hHQi\\nUkdLJfsXIOMUJcru5OK4tNTMxA8uUsx4CHkmrYnuYApO8A8gOOv40nBjU0dnHIyfOo3D0qwl2N4I\\nOR3zXP6Rem5bZznupq9cBoJyGGMcj3FS4tDTT0Ojim8w7G796zL/AAHql9uaMcHjtVK81IMwI696\\nTZSTR0WmRqx3NWm0cSfN0471zFnqKiMEcH61bm1IvGBk5PH4UIGjQnkDHC4A61nTTKrkKS2ffNQ3\\nNy9vaq7HBfpn0rFOoPgkOETP3scn6VXKRzGtJJKoJHBotrmXzAckk9R0rm5tSbMoMV1IY03uTxge\\np9qit9bUlisc2F5Ow5wPWmoO4e0Vj0AXDImWz+VUp5Um4I5xWPaay8y7EuDk9EmXrU8lzuIMiBCe\\nAQcg0pjgxtzbfxAVQmGEYE9K1hl12nqKzrxQA+B1FTEuWxk6VEJNXX2JNdgEIrltDjd9UDjA2Alq\\n62ug5HuN7UdqdijFIBo4pR9KXFKBTASgU7GaMcUANpwGaAtSAcUCGBMGnAe9OxS7aAG0d6Wk71Zm\\nB60mOaUUHrQNCUHrSmkoAbjNIRzTzTD1oC4lNpxpKQXErlbq3Ca83y9RurT1O4uGkMULmMDqRVCE\\nzyTbrhg5HAJHOKlysaRg9zRTiIVR1G3nlhJiwv8Atd6vBhtxT+WUAjisE7O5020I/Btxpmk3LHU7\\ndvMbpMRuo15IrPxEmq6XJFc27kl4lbrkYII+hqdLWNuq5q7Hp9qyfPbqT6kVcZa3M5xR55ZWzG/U\\nK/kqHzknG0V2Oq6ro8lnBaqySeVgZA60X2nQxuTFAgz6L0rOESRP82xce2ac/eYoK2osklhGENvM\\nyS5+Urnj/EU6bVLm4OLjbuUYyoxmnS6hAmFSJWPqBVM75pNxGBUt2Roldlhpiy8A1TkJZhkVoRQf\\nIc1TlXa+DWVzaKJ4n2qCKsfaARjdjio4UUwg45JplzbnGRQK1yG5upLudZLuTZbQjAC9WNFnqdhH\\nqCTSgsqHhSpIFOikVVKvGG+tSl42HEarjjgVsncyat0GeIbuCa4kvdPuVJuITDPGFIyp6iqeguEt\\nLu0RY0e6wklxIfuR5yQPc1oxwpIcMqn6itywsoMAGFPrirjOxm4j9an0GbQorGyt5Li5jXCzKmMH\\n61y1lFqEMwjmHyH+8c129xFHHH8inJ68VlyQhmzx+NZyZcI6EIDIAGGKq3gypwO1XZGPRuT61VnH\\nFR1NOhT8Opi4nOM44zXR44rAs7v+z0ZEgLMzEls1t2d0t3HnbtYdQa6EzllFrUlxQF9eKkxSkZp2\\nIuR7acBS7acBQA0D2oxT8UUANApwFAFOA4oATFLilxRigCOkNLRVkCUUUUgCkNKabQFxMZNIRzSg\\nnNIc5oAQik7U4800gY60AYF1sOtQKScOCSKH2+edv3R0qretIfEMCxruO01a8sq5U9RxWEtzsivd\\nRJGfmFXFGcc1XSMipkUmsbmqRbTYg+8P61IbwRrhTj3qptYDjj61WlYjOCD9KtOxLVxbqcyghnOP\\nSst8O4VBzU7rJMcYwKlggWP+IL65pOQ1GxWjslUFm5PvUyQgH2qSRgflUE+9N3EcCoLuPYgLgVRk\\nXdJ0q5jKmowuTmlcaHIm2NanAEi4NBQlBTAWVulJsaGNaAnB61A9oyZwM/Sr+d/zelSgqwGOtWmS\\nzPgGDz1rTt5GXADECoWthuLjNSxcHkVVyLGilw5G1jlfeo5Cp6DNJEoYYPFOaMAcdfek2CRVlwRx\\nVSQZFW5EOcCq7L2qbl20Ehg8+FsYDIpbNLoTNIjMxyc9RUInNtFM+35dhGab4WcyQOfcmtoLUxqW\\n5TosUtGKXFbnIJiloxTgKAEoxmlxSCgBQKWkpaAFApaQU7FAyvRRSVRAtJQKU0AIaSlpKQDc0UEU\\nnQUAJSHnilptIaMiJUGuyXDrzHHxSRsJ5Gl/vEmoJ3IvrsA87Kbpcm+2U9wSDWEjrhsjVijzgVdS\\nEKMnFU4nw3Wp2kJHBrFGrI7mQLwoyazyrO31NXjGzHH60+O1z0zVbhdIo7Nh6GpbfT3uJAAcAnqa\\n1ks405cYprzNbwsQOh+WqUSXMz9Uig05BGhDzN1x2rKgYsTkc1qtp8125kf5mbnmnrpMkKlnwB9a\\niWuxcdFqUwnGMUixHcRWzZaaLmVRnPtTptNMMh3A9elZPTUuJQMICAc9KhdQFNbcWmyXEbY4CjJN\\nV/7MLhsc00rgzAiuPLuVDj5Sa2rnT1WFZoSMOKQ6JKykhCfwpmZ7aE2z54Py57VpHTciXkQKCo/m\\nakCHdmpogH/h6e1TC3CgkjA+tNkxZFC4UgOKvpDHIuSf1qqbfHJOfSnRqUbG5lB7ikULPbBc9+Kz\\npUwa1JHIjG773TNZs/JqepXQS2SGe2ubZ1y7DI/KqPhePy4Jlz91yKjjnKawQDgBeRV3w+o+yyuP\\n4nJrogc9T4TX5pwpQOKXFbHKJnFLnmgjNGKAF7UUUUAFKKSnCgApwptOA4oArUUUU7isJRnNFNIx\\nzSuFhx4pM5pM5ozRcLCGmsadmmmi4WE7UhoNJnigDDvoxDqPmH7rDBpLaJYJJAo+RjuWtC+t/OjJ\\nHUVUDKIEUdRWMzpg7otKwxUqscCqqPU6gnGKx2NuhdRcgVoW0Sque9VIBgiryA7M5rSJDEdVkJBP\\nGOar3iL9l2r1U5q18pGD0rLvUDs22RgD2Bqr6EpXYpuMQfJjIHHNZcEuu3Ur/NamFTxHnDfnmoGg\\n8sNtmcZ7A5qsp8qXcHJbtk1lE1lsdVp9xLazLI2VcHp1Fa1zdJeNvIAPpXKWt3KcCbkdq0TcxAAg\\n847UpQuNSsbcl5HbWDRQ/wCsk6n0rAnm1KNS1pbFz6u2BVO7vpwT5WBjueazH1LUZgyGbj/ZGKcV\\n3FJ9jdsNY1ZpCl7DHGD0KNmr1xtuZIxkZzzXL25u87hctn/a5rTgSTcC0hdvU0dRK9jTEGyTFWRF\\nlOlV4yfLx3q3bsGOGJFVuLYiZWUY2kj6UCMYyAPpVqbAHH4g1UdwF96TRUWUbptpCgjr0qlK3Gas\\nXJDPwaoytxU7sp7FNIlU3N25+YjABrV0SIx6eoI6nNUp4TOUVSNgAyB3NbdsnlQIoGK2pmFR6E69\\nKWminVqc4ZoBzSdDS0AFFFFMApwptKKBDh1pwplPFAFOjNFJmgQtApoPFJmgBSPSm0Emm54oGLmk\\nzSZpN1AClsUwmkNITQAuR36VQuYCvzIPlPWrhNMfDAg96UlcqLsUYmwQMVbVhkVRyVkPsasJICet\\nck1ZnXB3RqwSZAq2swwAOtZEcuKnSbmqiwki1cz7FNY89wzHA6VZunL8VUMTL2z602yVoUriby+Z\\nCQD0xVIzlWHy4J5zV65gLc9fTiq4sZ5eAhB7cU00DuTrcmNcFssemKlWYhfnbmqB068QltjfWotl\\n2GwEJNDY1Fmi0/By3OPzqKNgDuOCT1HpUCWN3KQdmKtf2ZdRKWA5I6GkmgaZOH7jrjtVmGdwRk1V\\nghmVQH4J65q4IiBkAGk0NPQ0LeYnHStGE4OSKxoGCEcVpbx5e4dqaEXZHGzA/Gs+4ccEelI1wSMV\\nWml46ZqWVFFeU8k1Tky52jJzU7NzSWi77pQegGaIq7CTsi1Z2gVQ79fSr/FNFKDXSlZHG229R4pe\\n9N7UA0xDu9LTc80A0AOooooABS0gNLQAuadmmUuaAKmaTNJmkpiFBpCc0maSgB1NNBNNJoAaTTSa\\nCaYxoAcSaYWpC3GKaSaBjiaQnim5pC1JgVZ1Kyk9jQhwelPuDlM+lQjJFYVInRTehbVzinxtk9e9\\nVo2PIJqaNsNzUI0exO4LNkVLHCrYLkCombABHWqUc80l60Eikd0OeGqrEJ6m2sdsSPkDH1q1FHCo\\nyAAax2ufIwNjEepoGsRodpiJ9SKasiuST2NpxEVJKYI4zVGS0QyE7OvTFJDqNvNtG78D1rRRkcgl\\ngCKHYEmimkKrjg1ZWHK4C4HrSTSQowLuo59aR7+FH2edGmR/EelCSG7gbWEjJjBx7VH9mRlzGwBH\\nUGmy6hDHMIhMjkjOY+R+NVZ7pSGkTIwuTnim0iUn1JTEASOppyE+WwJPNZ+nXdxdx73i2ZJHXrV8\\nttHPWhIl7kDnD4qGVs9ae7Akk/nUDEE89KzsaJjHZf0qxYpl2f0GBVOTqQK0bNTHbgN1PNXTWpnU\\nehb6ClpmcilHStzAfnigdKQUoNAC0o60maKBD+tApA1LQAtFGaO1IYoNLSCigClmkzSE0maokUmk\\n3Cmk03NADiabmjNNzQAE8VETzTmNRk4oACfWkLCmFqaWpDHlqYWzTS1MLUAPJBFQLw+007dUM0gU\\nr69qiSui4PUmGS1TA85qtHLuNWAy45rDY6b6FlRvXBpuz94AQARyrUQ8jg1M6hhzwRTuyUkKYTcF\\nVJA9zTxo/mEBOfemwyY+U9a1bOQIynOcdqpWLUmtjFm0WaI5KnAPFJ9nuCpO9jt966t3Dpkp1qr5\\nSqsg/vUWLjVdtUc2LB5GG8s31NWU0oNtGASfUVvpbqyoMYx1wKsEJEh2Lk+9CQSqPoc+mmiNTuAR\\nh1A71HcW4lQIThB1rRnb5yzHH41SJaQ47ZpMzcmySABVAQYUDFJc4Ubcdak+6B7VUuH6k4LU0yGi\\nuzkjHaomYYpDx82eT2qPDHOTRuF7Doo2knArV6DA7cVUt0CLuPLHvVjdxWkVoYzd2SA0/NRA04Hm\\nrJJaXtTQeKXNAhaUHmkFFIY/vTqYDzTs5oELS9aKUUDCiiloAzSabmg1GWq7EDyaTNN3CmlqQx5O\\nKYTSZyKQmgBDUbHNOJ4qJjQAhNMY0M1RFqQ0OLUwv7UwvnNM3H0oAez4BPYVcsLaO40rUrwgMY1V\\nUP481lTx3MxMUEEj4HzMBwD2FdJbWUlj4Uvd4wxRMgdASx4/IVLehpFWVzn42xxVhG57k1VX9anQ\\ngEZP41lyml7FuFxu9qt53d6zkOGJ7VZViSp6etJody2EAxxzUsUrxN6imQHcRmrgiBUtn2pWKJV1\\nKMLhgaDfxk55qGSDK9Bn0pVtTsDVVieYspq0SAcH8KbLqbyDbFGRnvSR2gZulSrAoHA5p2DmKBWS\\nTmT8hSgcYAwBWkbcFc46VRmbb90Ef4VLiO5CZDtyDVCdsvnPH86syOAGPQdKpSOpGCetVaxFyMn5\\n89qkgOWJYA4qPGFPtSwNgGiK1CWxd35pwNQBqeGrYwJ1NPBqFWqQNzQBMDS5qPNKDQBJmnCo+tPW\\ngB1Kp5ptOFADxTqaKdQACnUmOadQBjE1GTTi1MzVECZpuaGPynFRlsdaGMkJppbmmM4AyTxUJvba\\nMjfJnJxheaV0NJsmJ6moySQSOnrUc2tQqu2Cyjcj+KUnn8qo3OoXN3H5blUQ/wDLNBgUrlqDLwaM\\n7i8qIo6ljTY5tOaQhrs4AyWC8YrH8sRn51yueTmopkCxsOxPA9c1DZoqZ32j6BHqmkvqMKZhBIUy\\ntjIHfFXtN0K3hVJnRWkaUDpkAd6u+GbaVfB0MbRMkbAAFuAQeta5tp0tpFgVY50Q7cjKFiOtYUpy\\nlJ3FNKJk6dbRz3upkK/k+asaZYEE45247c/zrB8VtcWmnJaMhRJr1sEdGVU4/lXW6RaCzg8qFRJM\\nAW2p8oaQnJPPbNZHi+CdPDliLpSs/nlmyc7WPUCt3sZq9zglXBqXZ8mSM5oRAasbDgVKNWiEHBx2\\nqVpNqANnnpSFQG5PaopTlT1wOhpiLiXRQMFYHHc1dt74sGUnKqMk+9YbhjsQNgMdzH1p6zJHKSSR\\nkYo5RcxvQX/nkkdmxzV9JhsAf9K5b7XiFNvA6n2NXkvwIxg5yKJDizdjuUQMMjOOKjhmDu3mdR6H\\nsKw2uwCG5GDUS6g6zbu7DB9hRFBJnRyajCgXZuG5d2KpzXCvlwMqDxWSLgyTkoWwox83FQteOGwT\\nyOcD6mm1cSkXZJdzHHAqFEzktzT7ZHkj8yQYJPA9BU5QAcAVOxS1KsvA9M9KetrMlhDdMn7qUnDD\\n1BxTZR2xXcaXDDc+Eo/lUgy7F46ZfmlF6jnscQHxUgbIq9rehnTPMuUmKrtyYn+6G9c1RsbW4voF\\nkgaKViCSiONw/A81opJmTi7XJFNSBuaieGeBtssbofQigNiqJLKtmnA8VApqRWoAlBp4NRA89adm\\ngCYHNOqMMDT80AOB5qUVCpqUHimId3paaKU0AYVRucGkZxWfc35BKRcH+8abdhKLZZmuI4VJdsVn\\nS6k7f6oYU8ZpkYSYkTsS/XNNlt/IUANwRx9azbNoxSHRyM4PnMzDv2pkkPlglQCD2FKiA7Q7Fieo\\nHrUmTv2yDOOnFI0sVQwiXA78A4p0YXgE5zyfWnsm9SpJzn7x7U0KVTIOSTgkCkhg4LqV24HUCoru\\nNVgXJJweKsZwMEEZOKZeofs+MYwO/Y02K9j2Gw3y+H9GbeFjABYdiAOlVtTvpnKw2RVICWM1zJJ8\\nkX+J9qNNvZb34fWb20Bdo8I2Bz+FVV8P6hqNqPtMFrGLbc8VuxJTPqwHU1z0N5E1ChFaTwymfSL/\\nAFC91CJCSY1Xbk+zcY+lO8U/2hLoOmy3/M3mHzSV2kMR6Utu812ot4fEEVheRtuCR2xiB9j2I96P\\niReGDR9JjuZvNuS6lmDZDe/FdFjNPU5VUzyKnUZFRxfdBHOatIm6szYrvGG+o/WoWjAzkcHtWh5f\\nJ459ajli4zVXFYynt2SQGMbk9M9KjnjOAojYY5zitVF74xV2NVbqPwppkuJys8pKnB4AxRFOAoQ5\\nz6iuseyicYMYP1FRjTLdQSIl/KquieVnONcKABuLEDPSkiuWkVi59+ldKunW548tcemKlNjDGfli\\nQH0xRdBytnNxmUuAFLZ5I9qt29kFfe5yScgelarwDk4UfQVEsfz5zUORcYInjQBORxUcm3k4qwq4\\nAzTHUEk1LNEjNu2EUEj5wApOa6P4ck33gqaGZ0DLcZQzfdznPNcl4gnEGmTf7Q213fw7tDY+D1aQ\\nhTJM3zYzjnFVBGdQXxtYxy2zrMU+aLaDyFz15Oea8ztBIsSyRsVdeMqea9V8bI/9lKqANKmTwRjH\\nrXlFk7LkcHNZx+Jlx1RsQeIdRhOHfzlH8Mw3frV2PV9NvHb7QhtJOxUZU1gODjcARimGJgQTyDWq\\nFKKOsFoxXfbuk8eM7kOTUQyOoP41zsLTW0gkilaNgeChwa1ItcZmJv4jIvTzEADf4GquZumXw2DU\\noOagie3ugWtJxJj/AJZt8rj8KcCVPPFMzsywpFSZFQK3eng80xEwqYdKrqanUnFMB3elNA5NLigD\\nhJr03BwoKL2HrUG0vIFwCeSBTzgl8jCjgH3pjFreZMZIGOR3rO9zp5bbDHikt2XejM3XFTNKGi4O\\ncHJ9q0d4mRH8wEnqCOlZeoQGKcMhwrHoOlMSFBxgdz8xNWFbcMk8EflVWFhIuMmpUYKWBHDDjNSV\\ncdnBB6n+HjinkDazkcGiPaUwwOMdKRmGSOBk4U/40D3QzZlRIOQvH6027RZ7cj+LHAz1qRgxOwfK\\nAQDUV5kRfKMMvBP40yGd/wCA9bvv+EXkt9qhYJginHJH9a7e9lax0VmABeYgMW4wD1rzTwH9pneb\\n7M8apCoZ1f8AnXptzNBqMAtpUkETLjzAvGcVlTVptEVNkzlJIYTatol7CZLhRuimiHO0nIBJ6jFZ\\nHxJ0xZvCdrfWcpaK2YKRjqPWuzuNFhSMzB/OkgACyzjdg8YAUd+R+dVtd0gXXha60rcQ3k7sjgMc\\nf41sZnl+kzi5tI2zzjBrVjBBzXHaHdNa3Jt5MqwJUg9iK7OFg4BzWTVmdMXdFhFDdajngI6c1Mi1\\nI2dtAGYBzjvU6ZyMUskQY56GljOOCKLhYnWUEgHg+9TbNwySMVVP0o3sPutRcVi4qADJyBUcjru6\\n1EHZl+ZuKQkAfKM0XCxFI+eB606GPJ+bpSKmW5NWlTC1LLGEdwOBUEnfmrDnA9Ky9Uu1trZ3z0FG\\n4HNeJrnz5YrVD1YZr1nTpvs2hxaWYWjaVWZHHqHyf0rxnT4ZdX8Q2cCth5pgAT2r6CutMDrY2jOI\\n28xgXA5IIJwP1rVKyMJO7Od8cGa20dphyBFtJwc815jaAAx87QRycZr0X4jXC2uiS2yHPnSKiLno\\nB3/SvPdOID4fkVlDVs1joidgoJ2/NnpmjHygcH3qRo8n5myx6AVGBtA7Y4wa1KA7VUMCQaf5CMWd\\nwSD/ADo2q52hjx14yKmbPAYHb6igCn5JLEpxg8Y4P51aTULmJSpPmgf3h81KwEanBJB6A9qjYq+S\\np57/AEppikjStr+OUhT8rehq8DXMhSMPnH9K07S+Aby5Wx6NTTMZQ7Gwhqwh4qnE4b7rBh7VaSrR\\nlsTijNIvSimwOInSPax24PXms+XLZ3NtbAIAPWtN1YkqE+YDI/8Ar1mXQ2t06dDWJ0su2M/7lz03\\nD8jT3jea3ZcqxjP3u9Z9vLs245DH5vatAF/NEiFQMAt70wSKEayxys3lnb0FI8w+XO4NwDntW6ks\\nToOB909arXH2e5VkaLa54DCgVypFOJFxk5HAPrT5gCrPxzxgdqzJEa1uMBmZM8Emr0bqRnru60DT\\nLEGZWUt1U8n+8O1RXKj5QTk4OffmpIwVIwOeops0a/608ccAnnNCCRu/Dy4ePVnthKE8xSuAMk8c\\nV65AjT6YiySNDJGMF8fdI6mvDdGuX0/WbeWJwjjqT6V7Tp0cEk0l5OZsSlWCsSEJPHArJ+7Uv3Ik\\nrxJQbaD7FJc3BVJJNsIc4aaQjqw/DP5U6Y7llFwQSEbcRxnHX9MGqmu5n0mdnltFu7M5MjAkQqTn\\nj/axip3szrlkVS5aH7TEr7lHUMo/wrYyR856zI6+JL2TofPLDHTFdDYaoNqZPBFes2Hg3TrFI4Jr\\neKWZ1dJX2jLA9Cfwry3x34am8N6qJYIStjN/qmB4HsamSuaQnbQ2re4R1+91q1kEVxenakVwGNdD\\nbXwkUc1lsb7l8pk9aPLBGCPxFRrLu5BFTo/ODSAYYvQ03yeeRVkpnninBRTuBXWBO+fwpWTaMKMe\\nhNWeAM1XmmC+9K4WGqnc9akZwqdaqibJPaoZ7jap54ouOw64uFT61x/iO/Lutup46mtW7vAMnPAr\\njbyczXDOTnJq4K7Im7I7X4XaUb3xTFdkZitQXOe5I4r2LV7qVY7SSNC3mSjOeNvXn9K8/wDg5PbR\\npexswFySHAbuo9K9JkdL6TYh2i3dWwR171pJ6GCep5h8SyI5LO3aPBClvM3cE9xXI2BPGR8yndx3\\nzV7xfqn9qa9clT+6VtqLk44J5wao23ysWHYZrKkmo6nR5Gk+Sd/AOM8VCw+clOSe+e9WSY3BVcc9\\nh6VXkJHB25B4wK0GEbDawGM+1WVCbQCGyB3qmMFgwbjvnip1bIU5I45yOKAEckR5LYOelQopLF4w\\nQwHQ96ewAG4Efl1p0YZOgGD1GORSuPdCt5ec7856/WogoI9qHATLNwCM5HfimRykMc5KnoKogtwT\\nvaSZjPGOQehrcs76G54DFJP7h/p61gBtqbmBB9aaGRiADz6jqKLkuCZ2Ape9Y1hqxVhFdscDgOB0\\n+tbQwQCDlT0I5BrRO5hKLRx9wGI8xCRnr9KzLlgylSh6fKcVquzNE4Y8nqqism5+RS2CQeB7Vkjp\\nZUtyQNq8setasSkRiNiAC3OPSscMUmU/pWrbN5jKWO3kk4piTH7hHGUHQ96iWXc5JyM9KklZcYPO\\n727VAuS4ycAn8qAsOuUSWP5l+b+E1VhBilIY8HitQJH5Ay688gDrUX2dJCshHHTGaTGixbIDED3H\\nTNRypmQ9GfoB2FWYlUYULhfWkkiKjcmNpPPNAFD5o7hXY5K88cV7FoWoyXGnWNxMybpl8oFRuCnt\\nXlEsSyRlgRnHau18I3yvo0lg7osituhDNk5/2QKzqrRMXSx3V0xltpo0mtm82A4SRMb3HVj7Umhs\\nyw2bPIj/ALoKzp909RxSafMNTtA7+VIh3I4YbWRe4x71k391BpsCPGCtpbECKNTgZ+taRd1cwtZl\\nLxz4ludD1pIbRk3um593OF9qwj4sttds/wCz9VRZo2bG/b07A/hXOeJdSk1rWZb+aPYzAAc52qKp\\nmVAQItpRBuUkYLH3pm0IJkfiDw1c+Hr8xjM0BUMsqKcYPNU7W9aNgCeK9e8H+KbfWbBdJ1CGPztm\\nE3Dhx6fWuA8ceG10fU2uLJJTZSkncyEBG9Klq4XcZWYy2v8AkZNa8M4k71xNtMw6n6Vs2l0VI5xW\\nTVjZO50uT60u7HOagglMkYNR3E+35RU3KsSTXWBgGqMkwPJNV5ZiM84qnJN33UaiLzXIVTzWddXm\\nc81BNcfKSTWc8+8nBqkhNobeXDFCAetYzKWkxjqa0pgWFGnadcX1yfs8Jk8vG7HQVtFGE3c09EuL\\njT762ltTtkDYPONw7ivW01H7NFPqO8eXDGWYY4LdhXMeEvDcL30X2/8AelAxUDooFUPEusPcp9gQ\\nlbaNt5HQkkU2Ta7OWvbiS8vprmQANK5dgvQZParFl6Y496qLktjoKv2oxzjLUGqWpfiyspTK4x3H\\namSIBIoGPTk0vlt5e4dR1zRJkx7htDAelSWV1G8MvChDnHerKn5QGbDgZ6dagjwswIxuYcsKesqx\\nupDEydGbHSgQ9w3lheBtPbtTIkOfnc8nvUx29AmWJ7nrUcp4GDz3zQCILgh1JTOF4IpkOFbcTlfe\\nmM/ITHOc5FSjEiBcDcTTFsyxCxkB5O31PSpjEpGQg3AEggc1HHEgXndx0HqanwxA2sd3fb0FIGUi\\nWxho+vQirNrqNxaKVjkwp7MM1IUVkGFwB+NV3RQcHg07ifmEm8vksc+vtWbqKqULIDsOMGtmdWCn\\nBxhc8ds1j36/K24nacAYpIbM5+QpHPGc+tW4JFVCwPOKpodqjPOKkT5ZAFGeeRVEF4ncglfOQARi\\nmtgHYBj0yakLkQktgH7u2o8DdljkjHJ+lIeo9WwvOTVy3hBiOVYZ7CqWCFUAnnrgVqxptC4JVcZI\\nI5oGhhVh8235V4A9aQqZVKn8hRKrq+QeGyMe1MbIYMST9OKRXQeBtjVgoXPar+j3SafrEMxcbGID\\nMOuD15qhtYuy5yXXKg9qiikkmUoIxnJKjHpUyV1YSR7Pa2lpZu9xbKGiuByynIz2NR6vpMOoaQ9s\\nyBhJh4gTgbh2/GuQ8LeLWsWa01A5tTwM/wAGMf8A169Djkik08TwyBoJFDRnPIz0rmhKVOVpbEzj\\n1R4NfW0kFzJDJC0MqEq8ZqnHt3gSEhQdxIr3i98JaT4gSGe9gKXA+80Z2k+uT3rmPHPgexstDF/p\\ncAia2H70Dncp7123T2JjUtoef2tyto8TxPsdH3x46+ua9puIp9b0C3eOeJIriAMVkjD5JHYGvDJD\\nHJdQtGVAXAAxjPOOK9w8JubnwbpTm0FwVj2844wcd/pSRdV3imeSeKPCr+H7yEiVJIpwSCgxg+mO\\n1ZIfy+c8e9ew+NtOfUPDV0yaehmt8SqV271x16dfwrxK7nBi4POKTVyYSNSDVwhCB+tPlvN3O6uN\\nMzrJu3d617OYzrz1qJQsaqZoPOz9DmozuwSamjgzjNVb+XywUU80kgbKVzOWcgGmwoSRxkntTYYW\\nkYEjOe3rXrXgjwRbTWP2zUIyTIMJHJlCpHORVpGcpWOZ0L4canrduLmdhaW7fdZ+p/Cutt/hxceH\\nbGZrO5N0X+ZsLg10N/fLoEaQR3bbXG1VmO5QepxTLj4gabb6UHts3FwAB5YG0ZqtjLWRzqte6FpN\\n7fygxm4j8uKM44J4J+tedXTO5PGSevvXQ67rl5rNyJbmTaQMqg+6v09656RizhgeR+tJm0Y2RTVf\\nnGeR6elaNuF4XktnPtVZUHXoTVyBAihicc9PSgpF4DMWVYehFVlU4kVh7gjvVgJglXYcjtVcj5yS\\nOAdvWkMhRCc5BAXnINPyTJuUk5HQjihU27sD7wwfcEUwswZSpI6jkdKY3rqSq7tlm5CjhicVXuXz\\nygPPrVlNm0jGFB4Hc1QkJLsWPU8AmglCN8pz3xVy3jBUNyWPTHas4EvIAR3rWUCSQKq7eOOaZL3L\\nMeCvzAbhycdaUIoxv+RcZp4j6kRcdDz+dPCOVHyKSTuK7uwoC4wDk4Ktj0/So5lUhSQST1NTbXCk\\nmNQM889eaVVDKQ56HjPSkMrGMqNvGxscis7UIdqHaMsTx6VrKVV9qt8nGc9ar3ca4ZSGKsflY9jS\\nTHJHLg7lYkc5p0chV1AxyaJhtmkB+U5ORTIAHB6ZHrVmdzR+cymU4Cnnn6U6SNo2UqS5PU9hRES1\\nsiHn19qe7loygz16ikNCId0igs3J/hFbiHCbixJXpkdaybQfvk5Kkc1pLLIr5BB780inuJM4LkEc\\n42jHY1VClGePeflH3fWp3BHpk800jDpIFz/ez60mNBEp3M7oCIyCeevtVp57eIytDbGOc8li2RjF\\nViI/NfcSA3P1NJ8oGBnbjH1pMfUIlxJl4wM5ct6V1XhbxQNHuHS9Eskbp8qjkA8f4fqa5do9gZmk\\nL7m3IBUzvIyedgc/hSlHmQj2eznEtibuyl3rIA7Rs2dpPUe1Zeq3RufDuo+ZIrosR3W+3DfnXm9j\\nrN7YO6W05RX5IzXZ6H4j07WUks9QULKep9ayTlS32IcL6nnJsVuZ/N0z95H3hb76d+ley6dozw6d\\npFnHfvA1rb5kiQ43kr1/A81zo8H29t4gtLiN8gSb9yHBAXB59Rniu1byrlnkWKOVTGVBU4fntW0a\\nsJbMmXNaxzcktzo+kXlvrzySx+S3+mqc5Zs4Q/hivn2SU4Kk59/UV9R6lYvc6VPaQRq4ki2BJeic\\ndfrXzJrFhLp2oTWs6lZY2w2e/vWm5MTLYZPStTSgQwrPArU08bRnpSexoje3BYyfasSUGecsemav\\nvIXTaD1q9omg3er38NvBCxDnl8cAfWpK2NHwb4Yi1e+/0q48iJAWAH3mx6V7HFJstIkgR2Xao5Hz\\nAYrnrKHTPCumbpd/nITzKmX49PauUvvH2pTzSRWv7iNnLBhycdqd0jPlczQ+IEtpcpaNC6GWJmja\\nMn5h7/pXFSGRmLuSSwBGeOPSpJpXlnd5JGdpTlmPXNTgW7IyklWYfMTz+VJu6NYx5Srq0Ahgtp45\\nMmROV67TWUrh2LYII4xVhld5gjuSh+VM0fZiG2scKeCRSTsVa4+KLz1AXIKjgkVbt4MsokAJHPHe\\nktIRFKd3JH3Mc8VoSKdhZMFx09qoWxmSOPMYDj1zUTAsGUHgc4BpbwhiWHJ70+E5ZyAoJTmkNshk\\nkEakEEHsfp2pETzSDjBByOabJ++faCMgZ5qzbl8DkYB6/hRcGxjHILMVA9azLmQ+YQvIBrTuAsce\\n4Y67TkVkHM0xpklqzRWcB84NbCwMsx8sdcYrNtVXap9DzWrC8cZUAEqwPJ9aLia6lnCsN4BGBgrn\\n9akxjJABznIPbioVwHUbDnHr2qRc9MnBHNNEjvM2N5jKGwBhR9M1A6jGDlxnpmiR9sjZGR06UAAn\\nGeKRSG5jkGUxlRyKguI2aLZIu08kbjTduHIHBJA3d6QEzSNGdx/2icUmhp30OXuCRK2RzioLJj9o\\nxng1JqK+VcNycZxVS1Yi4yKtbGT0Z0cMaxyMzIWVh09ahZSWGRwasW4LIGZ8HHymoyOV5IAHp1pM\\npbluzVQScZbGBV7A2BgOnaq1opEW4CrSdSQT09KFsW9xm09u9KVzGyA++PSlxhCck01OHUkdfSkw\\nXYQgIEJAGeCT2p2wuRwCnYrSsowwx1p8aBFXBKkckYzxSAjiiKZTqVGT6ClLYiAyACehFSzqDISS\\nMN1I6VGyYJQE4A470xETsI1AIO4/wmn2snlXQk5wSMkdRSEBmBzyOuaSJmbdzyDwppSV1Yaep6D4\\nimex8O2eo2t0xkLAcnqKyNL8bTxmOK4UMrEgso5HPFc5d3dy+mQ20khaGJyVB7ZrNRzFOkgf5TwP\\naueOHVh311PbtR1g2unx3cUD3IOGSHdtYn2rx7xVaWutalNe29w9vcNw9vcLjBHow/rXp9sX1TQt\\nNMYRW3BS7N90ex9a6WfR7K4thayQJsIy3T5j7+taYfSNmY1N9D5UZGjkKkcg4NXYHCqAO9ehfEfw\\nXa6faLe6cgTy22uoP3u+ce1YHga2sJH+03cSTOsmGDHHlp/ercSkamj+FDd2oN07QyMQwB4+X1zX\\ndWuq6R4c0kESJPPCPLEaHn8a5jWNcFzL9ktVYqWG3bzuHY1m/YpbWJoZMG5nbBjByefWufnfM30N\\nuRW1Oh8Y6kksESqxaadVdu+0HtXGwjcMDGM45qe6jmtrkwzggpgHLZ4pm3DDYvHr6UQjbU1bSVkR\\nuuGznBHGKYAfLA6gZqVkAJZsEdxTG2+XtU8Z61ZJWkKb8x5wCOD2NSJJ5zY4PakZWQ8Becc0JA2/\\nAJDZ9KYrl23wFyQeDxVhGCq756kjHqDVdCcBsHcOCMdaeRvwp+p9qEJoo3ijyyNvK9Kq25KuOcDp\\nV+5VNoCckcYNZ8I/f5K5wegpiRNCg3AvyD1rS1CeAsIIIkVUAxgc475rPyCAgxu5GRUwwiSqFDcc\\nMetKwyjfSEKFIO3+lVbaPcwOCAD0p12zPIoU8d/erdpFyecHHQ1ZPUsRJuOFqeYeURn7pHIpFjMZ\\nBAwTxUdy+6TbnkVJXQuxOXjLM2W6fhVgDAB6nOADUMI326bQMr+oqwuZVHJLjt2qiBsqeZgoOQMY\\n9ajWN8Y+6R71aiOxOSMdMGqV3L5ZBx83SgVyuf8AWL/vU2H/AFx+poooY47nK6t/rj9ao2v+tH0o\\nop9CZbnRW3/Hsv0P8qnm+7F9KKKTGty5a/8AHsKsD7p+tFFC2Le4lOT74+lFFJgtxexplux8uXk9\\nKKKALOAUcYGMiq8X+sf60UUCGkDaTjncKcAA83Haiih7CEl50v8AOq0ajdjAxtFFFEdxs9a8NceF\\no8cfN/Wuv/5Zg99vX8KKKxo9TKoea+K2L+MLWJyWj+zsdh5GeOcV57p8aJqd6qooBkxgDtmiitp7\\nCjujZszsv5inykKcY4xVzwwBL4it2kAcl85bmiisH8B0y3IfFAA8RT4GPmrLJO8c0UUUfhGxQBkc\\nVXn4BA6ZoorQY2f/AI9kPfNPJPmpyetFFMhl4/6tfxpR95j7UUUIb2KNz92s9TiR8UUUyS2oAkXA\\nx8tSN938KKKBmO/3/wAa1rcfuAe+aKKogur1H0qjc83DfhRRUstGhb8Ngf3RUhJD8HtRRVEMfGx8\\n1Rk4xVK6/wCPhqKKaJZ//9k=\",\n \"transaction_status\": \"success\",\n \"amount\": \"110.00\",\n \"total_charge\": \"110.00\",\n \"trans_id\": \"PS-kyc-GOk17051452925753nWK\",\n \"type\": \"nin\",\n \"value\": \"11226633554\",\n \"datetime\": \"2024-01-13 11:28:12\",\n \"score\": null,\n \"blacklist\": false\n }\n },\n \"status_code\": 200\n}"},{"id":"2764fc94-e711-460f-9397-ff23809ad383","name":"Lookup kyc","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}","type":"text"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1/kyc/lookup?type=bvn&value=22392226780","host":["https://sandbox.payscribe.ng/api/v1/kyc"],"path":["lookup"],"query":[{"key":"type","value":"bvn"},{"key":"value","value":"22392226780"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Thu, 02 Apr 2026 23:25:43 GMT"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"server","value":"cloudflare"},{"key":"nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"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":"*"},{"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":"6d3e52f68506706e8ecc369db803eb71"},{"key":"content-encoding","value":"gzip"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"vary","value":"accept-encoding"},{"key":"report-to","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=%2BlwAdUCLgeswqwqEKUv7uzAgL9VlmJVmCV2NWbvs2b6lWa91B%2FJrAznUtyU8CLbyHkTKQRDrFkP5VP56vyg07%2BOL7RcfGhpdM8pGk%2BYlhZGFIlFofvjFdlhSmNs%2Bg%2BfJAC%2BEMI%2BtHA%3D%3D\"}]}"},{"key":"cf-ray","value":"9e63982b7b0f0014-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"Lookup successful.!\",\n \"message\": {\n \"details\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"Adetokunbo\",\n \"gender\": \"male\",\n \"phone_number\": \"0910088228\",\n \"expiry_date\": null,\n \"dob\": \"2026-04-03 00:25:43\",\n \"photo\": \"base64\",\n \"transaction_status\": \"success\",\n \"amount\": \"35.00\",\n \"total_charge\": \"35.00\",\n \"trans_id\": \"25deaf32-1d8f-473a-aff4-1ac3237c9a5d\",\n \"type\": \"bvn\",\n \"value\": \"22392226780\",\n \"datetime\": \"2026-04-03 00:25:43\",\n \"score\": null,\n \"blacklist\": false\n }\n },\n \"status_code\": 200\n}"}],"_postman_id":"809392d7-10c5-4a95-a825-a209fe8f925b"}],"id":"f8515ba4-897b-43a4-b576-d9c6421ba042","description":"

Our 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":"f8515ba4-897b-43a4-b576-d9c6421ba042","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Savings API","item":[{"name":"Savings Webhooks","item":[{"name":"Webhook Reference - savings.contribution.success","id":"e7042e8e-23db-41f3-8337-43a8eccb05a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: savings.contribution.success

Security — Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n

Fired after each successful scheduled contribution.

Payload shape

{\n  \"event\": \"savings.contribution.success\",\n  \"plan_id\": 42,\n  \"customer_id\": \"cust-uuid\",\n  \"trans_id\": \"sv_tx_uuid\",\n  \"amount\": 50000,\n  \"currency\": \"NGN\",\n  \"balance_after\": 150000,\n  \"created_at\": \"2026-05-01T09:00:30Z\"\n}\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: savings.contribution.failed

Security — Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n

Payload shape

{\n  \"event\": \"savings.contribution.failed\",\n  \"plan_id\": 42,\n  \"customer_id\": \"cust-uuid\",\n  \"amount\": 50000,\n  \"currency\": \"NGN\",\n  \"reason\": \"Insufficient wallet balance\",\n  \"retry_count\": 1,\n  \"next_retry_at\": \"2026-05-02T09:00:00Z\",\n  \"created_at\": \"2026-05-01T09:00:10Z\"\n}\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: savings.withdrawal.success

Security — Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n

Payload shape

{\n  \"event\": \"savings.withdrawal.success\",\n  \"plan_id\": 42,\n  \"withdrawal_id\": 17,\n  \"customer_id\": \"cust-uuid\",\n  \"amount_requested\": 50000,\n  \"amount_credited\": 50000,\n  \"penalty_amount\": 0,\n  \"currency\": \"NGN\",\n  \"ledger_ref\": \"SVWD-17\",\n  \"created_at\": \"2026-04-09T10:00:00Z\"\n}\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Payscribe sends a POST request to your configured webhook URL when this event fires.

Event: savings.withdrawal.failed

Security — Every webhook request includes an X-Payscribe-Signature header. Verify it before processing:

HMAC-SHA256(secret_key, raw_request_body)\n

Payload shape

{\n  \"event\": \"savings.withdrawal.failed\",\n  \"plan_id\": 42,\n  \"customer_id\": \"cust-uuid\",\n  \"amount_requested\": 50000,\n  \"currency\": \"NGN\",\n  \"reason\": \"Ledger credit failed\",\n  \"created_at\": \"2026-04-09T10:00:00Z\"\n}\n

Responding — Return HTTP 200 to acknowledge. Any non-2xx response will trigger retries (up to 5 attempts, exponential back-off).

Webhook events fired when a savings contribution or withdrawal changes state.

\n","_postman_id":"640f39be-10d5-4dee-93f5-de04d29f3def","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"List Savings Plans","id":"4c132011-76c6-4d00-9403-f2c562dbba2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_sk_test_YOUR_SECRET_KEY","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1//savings/plans/?page=1&per_page=20","description":"

Returns a paginated list of savings plans for your business.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Query param	Type	Default	Description
`page`	integer	1	Page number
`per_page`	integer	20	Results per page (max 100)
`status`	string	—	`active` · `paused` · `cancelled` · `completed` · `failed`
`customer_id`	string	—	Filter by customer UUID
`currency`	string	—	`NGN` or `USD`
`q`	string	—	Search plan title or customer name

Page number

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Results per page (max 100)

\n","type":"text/plain"},"key":"per_page","value":"20"},{"disabled":true,"description":{"content":"

active | paused | cancelled | completed | failed

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by customer UUID

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

NGN | USD

\n","type":"text/plain"},"key":"currency","value":"NGN"},{"disabled":true,"description":{"content":"

Search plan title or customer name

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"7f76a89f-4c4f-4cf7-9ebc-e5feea2e7ce5","name":"List Savings Plans - 200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ps_sk_test_YOUR_SECRET_KEY","type":"text"}],"url":{"raw":"https://sandbox.payscribe.ng/api/v1//savings/plans/?page=1&per_page=20","host":["https://sandbox.payscribe.ng/api/v1/"],"path":["savings","plans",""],"query":[{"key":"page","value":"1","description":"Page number"},{"key":"per_page","value":"20","description":"Results per page (max 100)"},{"key":"status","value":"","description":"active | paused | cancelled | completed | failed","disabled":true},{"key":"customer_id","value":"","description":"Filter by customer UUID","disabled":true},{"key":"currency","value":"NGN","description":"NGN | USD","disabled":true},{"key":"q","value":"","description":"Search plan title or customer name","disabled":true}]},"description":"Returns a paginated list of savings plans for your business.\n\n| Query param | Type | Default | Description |\n|-------------|------|---------|-------------|\n| `page` | integer | 1 | Page number |\n| `per_page` | integer | 20 | Results per page (max 100) |\n| `status` | string | — | `active` · `paused` · `cancelled` · `completed` · `failed` |\n| `customer_id` | string | — | Filter by customer UUID |\n| `currency` | string | — | `NGN` or `USD` |\n| `q` | string | — | Search plan title or customer name |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"description\": \"List Savings Plans \\u2014 200\",\n \"data\": {\n \"plans\": [\n {\n \"id\": 42,\n \"title\": \"Emergency Fund\",\n \"type\": \"fixed\",\n \"currency\": \"NGN\",\n \"status\": \"active\",\n \"contribution_amount\": 50000,\n \"frequency\": \"monthly\",\n \"balance\": 150000,\n \"available_balance\": 150000,\n \"total_contributed\": 150000,\n \"total_withdrawn\": 0,\n \"next_run_at\": \"2026-05-01 09:00:00\",\n \"created_at\": \"2026-04-09 10:00:00\",\n \"customer\": {\n \"id\": \"cust-uuid\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n }\n }\n ],\n \"total\": 1,\n \"page\": 1,\n \"per_page\": 20\n },\n \"status_code\": 200\n}"}],"_postman_id":"4c132011-76c6-4d00-9403-f2c562dbba2c"},{"name":"Create Savings Plan","id":"89a9a29a-e50f-4ed6-8793-08e545a89e15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ps_sk_test_YOUR_SECRET_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer_id\": \"\",\n \"title\": \"Emergency Fund\",\n \"type\": \"fixed\",\n \"currency\": \"NGN\",\n \"contribution_amount\": 50000,\n \"frequency\": \"monthly\",\n \"start_at\": \"2026-05-01 09:00:00\",\n \"timezone\": \"Africa/Lagos\",\n \"lock_type\": \"flexible\",\n \"missed_policy\": \"retry_until_success\",\n \"retry_max\": 3,\n \"retry_interval_minutes\": 1440\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.payscribe.ng/api/v1//savings/plans/","description":"

Creates a savings plan and schedules automated contributions.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`customer_id`	string	Yes	UUID of the customer
`title`	string	Yes	Plan name (max 100 chars)
`type`	string	Yes	`fixed` or `target`
`currency`	string	Yes	`NGN` or `USD`
`contribution_amount`	number	Yes	Amount debited per cycle
`frequency`	string	Yes	`daily`, `weekly`, or `monthly`
`start_at`	string	Yes	First contribution datetime `YYYY-MM-DD HH:MM:SS`
`timezone`	string	No	IANA timezone string (default: `UTC`)
`lock_type`	string	No	`flexible` (default) or `locked`
`missed_policy`	string	No	`retry_until_success` (default), `skip_and_continue`, `pause_on_failure`
`retry_max`	integer	No	Max retry attempts 0–20 (default: 3)
`retry_interval_minutes`	integer	No	Minutes between retries 5–10080 (default: 1440)
`target_amount`	number	Conditional	Required when `type` is `target` (unless `target_date` is set)
`target_date`	string	Conditional	`YYYY-MM-DD` — required when `type` is `target` (unless `target_amount` is set)
`early_withdrawal_penalty_bps`	integer	No	Penalty in basis points for `locked` plans (e.g. `500` = 5%)

Returns the full savings plan including balances, schedule, and customer details.

Pauses an active savings plan.

The scheduled cron job is disabled — no contributions will be collected until the plan is resumed. The existing balance is unaffected.

Returns 400 if the plan is not currently active.

Resumes a paused savings plan.

The cron job is re-enabled. The next contribution will fire on the next scheduled occurrence (not immediately).

Returns 400 if the plan is not currently paused.

Permanently cancels a savings plan and removes the scheduled cron job.

This action is irreversible. The plan cannot be reactivated. Withdraw any remaining balance before cancelling.

Returns 400 if the plan is already cancelled or completed.

Withdraws funds from the savings plan and credits your business wallet.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`amount`	number	Yes	Amount to withdraw
`idempotency_key`	string	No	Unique key to prevent duplicate withdrawals (auto-generated if omitted)

Important

Only available_balance can be withdrawn — locked balance is excluded
For locked plans, funds only become available after the maturity date
Re-submitting the same idempotency_key safely returns the original result (idempotent)

Create and manage automated savings plans for your customers.

How it works

Create a plan for a customer — specify the contribution amount, frequency, and start date
Payscribe schedules automatic contributions via cron (debiting from the customer's balance)
Funds accumulate in the plan's internal balance
The customer (or you via API) can withdraw to the business wallet at any time

Plan types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Description
`fixed`	Contributions run indefinitely on the set schedule
`target`	Contributions run until a `target_amount` or `target_date` is reached

Lock types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Lock	Description
`flexible`	Funds can be withdrawn any time
`locked`	Funds are locked until the maturity date; early withdrawal may incur a penalty

Missed contribution policies

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Policy	Behaviour
`retry_until_success`	Keeps retrying on the configured interval until success
`skip_and_continue`	Skips the missed cycle and continues as normal
`pause_on_failure`	Pauses the plan after the first failure

","_postman_id":"ff7045a6-3db2-47ec-b7cc-58731e354e30","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Misc APIs","item":[{"name":"Blacklist","item":[{"name":"List Blacklist","id":"175c605c-dc01-44f9-a629-eba7afeb2b94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1//misc/blacklists/lists","description":"

By default 100 blacklist details will be fetched, but you can fetch for more using the below params.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
filter_by	String	Optional	ip
page	Int	Optional	The number of page you want to fetch..

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}},"urlObject":{"path":["misc","blacklists","lists"],"host":["https://sandbox.payscribe.ng/api/v1/"],"query":[],"variable":[]}},"response":[{"id":"06e29c2e-f8be-4cab-8f3c-d52c0a9623c0","name":"List Blacklist","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}","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":"175c605c-dc01-44f9-a629-eba7afeb2b94"},{"name":"Lookup Blacklist","id":"ea10bdfa-f73f-4530-b3b0-f1dd38dc68a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API Token}}","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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
title	String	Array	Required

This is subjected to review before it will be available to the public.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
title	String	Required	The phone number, ip, email, account number, you want to add
title_type	String	Required	ip, or name, account_number, phone, email
issue	String	Required	A detailed informarion of what went wrong, how the perpetrator hacked into your system or tried to.
note	String	Required	A detailed information that can help others to avoid the issue.

We call this folder \"Blacklist\".

In 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.

Use 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

This endpoints is a work in progress, and the idea came from Sokoya Philip Linkedin Post

If 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":"f54d20e9-29f8-4b79-9b40-19b19a1f0017","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Fetch Services","id":"9a96a86f-3d9f-4c3c-a321-546479060a38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}","type":"text"}],"url":"https://sandbox.payscribe.ng/api/v1//misc/services?group_by=betting","description":"

Get list of available services.

You can also group the services by passing the group_by as a GET method

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
group_by	String	Optional	airtime or data or tv or electricity or recharge_card or betting or internet.

Miscellaneous - Some API references that you can power your project on.

\n","_postman_id":"68207c38-8783-4504-a94d-2f4bad1dbc39","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Stablecoin (NEW)","item":[{"name":"Get available currencies","id":"becbc1ee-3793-46e0-bbc8-7c2c468312b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}","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.

Create Stable Address

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.

Request Method

POST

Request URL

https://sandbox.payscribe.ng/api/v1/stable/address/create

Request Body

The request should be sent in JSON format with the following parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory	Description
currency	String	Yes	The currency for which the address is being created (e.g., USDT).
network	String	Yes	The network on which the currency operates (e.g., Tron).
chain	String	Yes	The specific blockchain chain (e.g., TRC20).
label	String	Yes	A label for the address to help identify it (e.g., \"Tomiwa USDT\").
customer_id	String	Yes	The unique identifier for the customer requesting the address.

Response Format

Upon a successful request, the server will respond with a JSON object containing the following structure:

{\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\n

Notes

A successful response will have a status code of 200.
\n
The message.details object will contain information about the created address, including its unique ID, currency, network, and other relevant details.
\n
Ensure that all mandatory parameters are included in the request to avoid errors.
\n

This endpoint is essential for users looking to generate stable addresses for their cryptocurrency transactions in a seamless manner.

Retrieve Address Details

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.

Request

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\n

Where {address_id} is the unique identifier of the address you want to retrieve.

Expected Response

A successful response will return a JSON object with the following structure:

{\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\n

Response Fields

status: Indicates the success of the request (boolean).
\n
description: Additional information about the response (string).
\n
message: Contains the details of the address.
\n
- details:
  \n
  - id: Unique identifier for the address (integer).
    \n
  - user_id: Identifier for the user associated with the address (nullable).
    \n
  - customer_id: Identifier for the customer (string).
    \n
  - currency: Currency type associated with the address (string).
    \n
  - network: Network type (string).
    \n
  - chain: Blockchain chain information (string).
    \n
  - address: The actual address (string).
    \n
  - memo_tag: Optional memo tag (nullable).
    \n
  - label: Label for the address (string).
    \n
  - tracking_id: Tracking identifier (string).
    \n
  - provider: Provider information (string).
    \n
  - is_primary: Indicates if this is the primary address (boolean).
    \n
  - status: Current status of the address (string).
    \n
  - created_at: Timestamp of when the address was created (string).
    \n
  \n
\n
status_code: Code representing the status of the response (integer).
\n

Notes

Ensure that the address_id is valid to receive the correct address details.
\n
The response may vary based on the address status and associated user data.
\n

Retrieve Address Details

This endpoint retrieves the details of addresses associated with a user. The request is made using the GET method to the specified endpoint.

Request

To fetch the details of addresses, send a GET request to the endpoint:

GET https://sandbox.payscribe.ng/api/v1/stable/addresses\n\n

Expected Response

A successful response will return a JSON object with the following structure:

{\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\n

Response Fields

status: Indicates the success of the request (boolean).
\n
description: Additional information about the response (string).
\n
message: Contains the details of the addresses.
\n
- details: An array of address details, where each address detail includes:
  \n
  - id: Unique identifier for the address (integer).
    \n
  - user_id: Identifier for the user associated with the address (nullable).
    \n
  - customer_id: Identifier for the customer (string).
    \n
  - currency: Currency type associated with the address (string).
    \n
  - network: Network type (string).
    \n
  - chain: Blockchain chain information (string).
    \n
  - address: The actual address (string).
    \n
  - memo_tag: Optional memo tag (nullable).
    \n
  - label: Label for the address (string).
    \n
  - tracking_id: Tracking identifier (string).
    \n
  - is_primary: Indicates if this is the primary address (boolean).
    \n
  - status: Current status of the address (string).
    \n
  - created_at: Timestamp of when the address was created (string).
    \n
  \n
\n
status_code: Code representing the status of the response (integer).
\n

Notes

Ensure that the request is made to the correct endpoint to retrieve the address details.
\n
The response may vary based on the addresses associated with the user.
\n

Retrieve Address Details

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.

Request

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\n

Where {address_id} is the unique identifier of the address you want to retrieve.

Expected Response

A successful response will return a JSON object with the following structure:

{\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\n

Response Fields

status: Indicates the success of the request (boolean).
\n
description: Additional information about the response (string).
\n
message: Contains the details of the address.
\n
- details:
  \n
  - id: Unique identifier for the address (integer).
    \n
  - user_id: Identifier for the user associated with the address (nullable).
    \n
  - customer_id: Identifier for the customer (string).
    \n
  - currency: Currency type associated with the address (string).
    \n
  - network: Network type (string).
    \n
  - chain: Blockchain chain information (string).
    \n
  - address: The actual address (string).
    \n
  - memo_tag: Optional memo tag (nullable).
    \n
  - label: Label for the address (string).
    \n
  - tracking_id: Tracking identifier (string).
    \n
  - provider: Provider information (string).
    \n
  - is_primary: Indicates if this is the primary address (boolean).
    \n
  - status: Current status of the address (string).
    \n
  - created_at: Timestamp of when the address was created (string).
    \n
  \n
\n
status_code: Code representing the status of the response (integer).
\n

Notes

Ensure that the address_id is valid to receive the correct address details.
\n
The response may vary based on the address status and associated user data.
\n

Create a unique stablecoin deposit address for your customers.

\n","_postman_id":"67e26a44-37bd-47fc-8bc5-e2a119e1eb1d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ps_sk_test_YOUR_SECRET_KEY"}]},"isInherited":true,"source":{"_postman_id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","id":"bd058fb8-c6c2-4a08-9522-32bafcb01e8d","name":"Welcome to Payscribe API","type":"collection"}}},{"name":"Get Transaction Report","id":"cbde4dc3-ccbf-42b0-bd50-ca9efa7c0578","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API Token}}"}],"url":"https://sandbox.payscribe.ng/api/v1/requery/?trans_id=e03e20b0-b815-4a46-b945-87e3d47e4ba1","description":"

Get a transaction report.

The transaction id that was seen when you initiated the transaction or the ref_id you passed when calling the endpoint.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Type	Required	Description
trans_id	String	required	The transaction ID for lookup, this can also be your ref_id

Getting Started

Breaking changes

Response code and message in response body

Events (Webhook)

Payscribe Webhook Security

Headers sent on every delivery

How the signature is built

Replay attack protection

Idempotency

Verifying the signature - PHP

Verifying the signature — Node.js

Verifying the signature — Python

Common mistakes to avoid

1. Parsing the body before verifying

2. Using == instead of a constant-time comparison

3. Skipping the timestamp check

4. Not implementing idempotency

5. Returning a non-2xx status on success

HTTP POST https://sandbox.payscribe.ng/api/v1/multichoice/vend

Request Body

HTTP POST https://sandbox.payscribe.ng/api/v1/multichoice/topup

Request Body

GET /internet/list

Response

Example Response

GET /data/lookup

Request Parameters

Response

HTTP POST /data/vend

Request Body

Response

Requery Transaction

Response

Request Description

Response

HTTP POST /betting/vend

Request Body

Response

Fetch Account Balance

Description

Request Body

Response

Example

Get Business Profile

Description

Request

Response

Example Response

Get Wallet Ledger

Description

Query Parameters

Response

Example Response

List Transactions

Description

Query Parameters

Response

Example Response

Get Payout Bank List

Request

Query Parameters

Response

Validate account before initiating transfer

Get Payouts Fee

Request Parameters

Response

HTTP POST /payouts/transfer

Get Payout Verification

Request

Response

Example Response

Create New Customer

Request Body

Response

Update Customer Tier 1

Request Body

Response Body

Update Customer Tier 2

Request Body

Response

2. Using `==` instead of a constant-time comparison