StroWallet

https://strowallet.readme.io
Admin
StroWallet is an API platform for licensed financial institutions to issue and manage Naira Verve...
Tokens:118,054
Snippets:397
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Exchange Rate (JavaScript)

Source: https://strowallet.readme.io/reference/getting-started-with-your-api

Example of making a POST request to get the exchange rate. Ensure you have the necessary HTTP client library configured.

```javascript
$http.post('/someUrl', data).success(successCallback);

alert('test');
```

--------------------------------

### OpenAPI Definition Example

Source: https://strowallet.readme.io/reference/update-customer

This is an example of an OpenAPI definition object.

```json
{
  "_id": "66f95b0b6f9e270013ef9086:66f95b8d79f2d300315039fe"
}
```

--------------------------------

### Get Card Withdraw Status - Completed Example

Source: https://strowallet.readme.io/reference/get-card-withdraw-status

This example shows a successful retrieval of a completed card withdrawal status. It includes details like the reference, status, amount, date, and a remark.

```json
{
  "message": "Transaction status retrieved successfully",
  "reference": "WithdrawCard_11MEV0Y",
  "status": "Completed",
  "amount": "0.85",
  "Date": "2024-05-27T13:46:45.000000Z",
  "remark": "Refund for successful vcard withdrawal: 1.00"
}
```

--------------------------------

### Get Card Withdraw Status - Pending Example

Source: https://strowallet.readme.io/reference/get-card-withdraw-status

This example demonstrates the response for a pending card withdrawal. Note that the amount, date, and remark fields may be null for pending transactions.

```json
{
  "message": "Transaction status retrieved successfully",
  "reference": "WITHDRAWCARD_000DRF1",
  "status": "Pending",
  "amount": null,
  "Date": null,
  "remark": null
}
```

--------------------------------

### Error Response Example

Source: https://strowallet.readme.io/reference/naira-card-user

This snippet shows an example of a 400 Bad Request error response, typically returned when a required field is missing.

```APIDOC
## Error Response (400)

### Description
This response indicates a bad request, often due to missing required fields.

### Response Example (400)
{
  "success": false,
  "message": "The public key field is required."
}
```

--------------------------------

### Incoming Webhook Request Payload Example

Source: https://strowallet.readme.io/reference/whatsapp-banking

This is an example of the JSON payload StroWallet sends to your webhook when a customer sends a message.

```json
{
"event": "whatsapp.inbound",
"from": "+2348011111111",
"to": "whatsapp:+16593005060",
"message": "menu",
"selected_tenant": 1,
"timestamp": "2025-12-14T21:40:00Z"
}
```

--------------------------------

### Successful SMS Send Response Example

Source: https://strowallet.readme.io/reference/send-sms

Example of a successful response when an SMS is sent. It indicates the operation was successful and provides a confirmation message.

```json
{
    "success": true,
    "message": "Message Sent"
}
```

--------------------------------

### Transaction Created Webhook

Source: https://strowallet.readme.io/reference/card-authorization

This is an example payload received after a transaction is successfully approved and created.

```APIDOC
## Transaction Created Event

### Description
This webhook is received when a transaction is approved and successfully created in the system.

### Event Payload
```json
{
  "transaction.created": "6854b2e222054f",
  "card_Id": "683dcd85646e55e",
  "cardtype": "unknown",
  "brand": null,
  "currency": "NGN",
  "maskedPan": null,
  "merchant": {
    "category": "6012",
    "name": "DEMO MERCHANT",
    "merchantId": "SB14001226LA000",
    "city": "TEDE ATISBO L.G",
    "state": "OY",
    "country": "NG",
    "postalCode": "100001"
  },
  "terminal": {
    "rrn": "250620020102",
    "stan": "000000116444",
    "terminalId": "2232ZTM1",
    "terminalOperatingEnvironment": "on_premise",
    "terminalAttendance": "attended",
    "terminalType": "pos",
    "panEntryMode": "magnetic_stripe",
    "pinEntryMode": "magnetic_stripe",
    "cardHolderPresence": true,
    "cardPresence": true
  },
  "merchantAmount": 100,
  "fee": 20,
  "channel": "pos",
  "type": "purchase",
  "date": "2025-06-20T01:06:20+00:00"
}
```
```

--------------------------------

### Get Exchange Rate

Source: https://strowallet.readme.io/reference/getting-started-with-your-api

This endpoint retrieves the exchange rate between two specified currencies. For example, you can get the rate for NGN/USD or USD/NGN.

```APIDOC
## GET /api/exchange-rate/{base}/{quote}/

### Description
This endpoint will help you get Strowallet Exchange Rate. NGN/USD or USD/NGN

### Method
GET

### Endpoint
/api/exchange-rate/USD/NGN/

### Parameters
#### Path Parameters
- **base** (string) - Required - The base currency code (e.g., USD).
- **quote** (string) - Required - The quote currency code (e.g., NGN).

### Request Example
```bash
curl --request GET \
     --url https://strowallet.com/api/exchange-rate/USD/NGN/
```

### Response
#### Success Response (200)
- **rate** (string) - The current exchange rate.

#### Response Example
```json
{
    "rate": "850.00000000"
}
```

#### Error Response (400)
- **error** (string) - Description of the error if invalid currencies are selected.

#### Error Response Example
```json
{
    "error": "Invalid currencies selected."
}
```
```

--------------------------------

### Initiate Bank Transfer

Source: https://strowallet.readme.io/reference/bank-transfer

This endpoint allows you to initiate a bank transfer. You need to provide your public key, the amount, bank code, account number, narration, and a name enquiry reference. An optional SenderName and mode for testing can also be included.

```APIDOC
## POST /

### Description
Initiates a bank transfer with the provided details.

### Method
POST

### Endpoint
https://strowallet.com/api/banks/request/

### Parameters
#### Query Parameters
- **public_key** (string) - Required - Your public key for authentication.
- **amount** (string) - Required - The amount to transfer.
- **bank_code** (string) - Required - The code of the destination bank.
- **account_number** (string) - Required - The destination account number.
- **narration** (string) - Required - A description for the transfer.
- **name_enquiry_reference** (string) - Required - Reference for name enquiry.
- **SenderName** (string) - Optional - The name of the sender.
- **mode** (string) - Optional - Set to "sandbox" for testing purposes.

### Response
#### Success Response (200)
- **Result** (object) - An empty object indicating a successful transfer initiation.

#### Response Example
```json
{
  "Result": {}
}
```

#### Error Response (400)
- **Result** (object) - An empty object indicating a bad request.

#### Response Example
```json
{
  "Result": {}
}
```
```

--------------------------------

### Initiate Card Payment

Source: https://strowallet.readme.io/reference/card-payment

This endpoint initiates a card payment by generating a payment URL. It requires several query parameters including public key, amount, payer details, and redirection URLs.

```APIDOC
## POST /

### Description
Initiates a card payment and generates a payment URL.

### Method
POST

### Endpoint
https://strowallet.com/api/stw-payments/

### Parameters
#### Query Parameters
- **public_key** (string) - Required - Your public key.
- **amount_usd** (string) - Required - The payment amount in USD.
- **payer_name** (string) - Required - Customer's Name.
- **payer_email** (string) - Required - customer's email.
- **success_url** (string) - Required - The page you want redirect user to if successful.
- **failed_url** (string) - Required - The page you want redirect user to if failed or cancelled.
- **item** (string) - Required - Purpose of this payment.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **status** (boolean) - Indicates if the operation was successful.
- **message** (string) - A message describing the result of the operation.
- **payment_url** (string) - The URL for the payment.
- **txn_ref** (string) - The transaction reference.

#### Response Example
```json
{
    "status": true,
    "message": "Payment link generated successfully",
    "payment_url": "https://strowallet.com/pay/STWCheckJF1OGD1Z",
    "txn_ref": "STWCF1OGD1Z"
}
```

#### Error Response (400)
- **success** (boolean) - Indicates if the operation was successful.
- **message** (object) - An object containing error messages.
  - **success_url** (array) - An array of strings, each being an error message for the success_url field.

#### Response Example
```json
{
    "success": false,
    "message": {
        "success_url": [
            "The success url field is required."
        ]
    }
}
```
```

--------------------------------

### Enable 2FA

Source: https://strowallet.readme.io/reference/enable-2fa

This endpoint allows you to enable two-factor authentication (2FA) or SafeToken for your account. You need to provide your public key, card ID, and optionally the mode (sandbox or production).

```APIDOC
## POST /naira_enable2Fa

### Description
To enable 2fa or SafeToken

### Method
POST

### Endpoint
https://strowallet.com/api/naira_enable2Fa/

### Parameters
#### Query Parameters
- **public_key** (string) - Required - Your public key.
- **card_id** (string) - Required - The ID of your card.
- **mode** (string) - Optional - The mode for the operation, defaults to "sandbox".

### Request Example
```json
{
  "example": "{\"public_key\": \"your_public_key\", \"card_id\": \"your_card_id\", \"mode\": \"sandbox\"}"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **message** (string) - A message confirming the success of the 2FA enrollment.

#### Response Example
```json
{
  "example": "{\"success\": true, \"message\": \"2FA enrollment Successful.\"}"
}
```
```

--------------------------------

### Standalone PHP WhatsApp Banking Webhook

Source: https://strowallet.readme.io/reference/whatsapp-banking

A sample PHP implementation of a WhatsApp Banking Webhook compatible with StroWallet BankBot, demonstrating basic menu handling and session management.

```PHP
<?php
/**
 * Standalone WhatsApp Banking Webhook (Tenant)
 * Compatible with StroWallet BankBot
 */
header('Content-Type: application/json');

// Read raw input
$raw = file_get_contents('php://input');
$data = json_decode($raw, true);

// Basic validation
if (!$data || !isset($data['from'], $data['message'])) {
    echo json_encode([
        'reply' => 'Invalid request.'
    ]);
    exit;
}

$from    = trim($data['from']);     // +234801xxxxxxx
$message = strtolower(trim($data['message']));

// -------------------------------------------------
// VERY SIMPLE SESSION (for demo only)
// In production, use Redis / DB
// -------------------------------------------------
session_id(md5($from));
session_start();

$state = $_SESSION['state'] ?? 'menu';

// -------------------------------------------------
// MENU HANDLING
// -------------------------------------------------
if ($message === 'menu' || $state === 'menu') {
    $_SESSION['state'] = 'awaiting_choice';

    echo json_encode([
        'reply' =>
            "🏦 *Welcome to DemoBank*\n\n" .
            "1️⃣ Check Balance\n" .
            "2️⃣ Send Money\n" .
            "3️⃣ Buy Airtime\n" .
            "4️⃣ Buy Data\n" .
            "5️⃣ My Account\n\n" .
            "Reply with a number."
    ]);
    exit;
}

// -------------------------------------------------
// MAIN OPTIONS
// -------------------------------------------------
if ($state === 'awaiting_choice') {

    switch ($message) {

        // CHECK BALANCE
        case '1':
            $_SESSION['state'] = 'menu';
            echo json_encode([
                'reply' => "💰 *Your Balance*\nNGN 25,430.50\n\nReply MENU to continue."
            ]);
            exit;

        // SEND MONEY
        case '2':
            $_SESSION['state'] = 'send_money';
            echo json_encode([
                'reply' =>
                    "💸 *Send Money*\n" .
                    "Send like this:\n\n" .
                    "`5000 0123456789 058`\n\n" .
                    "(amount account bankcode)"
            ]);
            exit;

        // BUY AIRTIME
        case '3':
            $_SESSION['state'] = 'airtime';
            echo json_encode([
                'reply' =>
                    "📱 *Buy Airtime*\n" .
                    "Send like this:\n\n" .
                    "`1000 08031234567`"
            ]);
            exit;

        // BUY DATA
        case '4':
            $_SESSION['state'] = 'data';
            echo json_encode([
                'reply' =>
                    "🌐 *Buy Data*\n" .
                    "Send like this:\n\n" .
                    "`MTN 2GB 08031234567`"
            ]);
            exit;

        // MY ACCOUNT
        case '5':
            $_SESSION['state'] = 'menu';
            echo json_encode([
                'reply' =>
                    "👤 *My Account*\n" .
                    "Name: John Doe\n" .
                    "Phone: {$from}\n" .
                    "Status: Active\n\n" .
                    "Reply MENU to continue."
            ]);
            exit;

        default:
            echo json_encode([
                'reply' => "❌ Invalid option.\nReply MENU to start again."
            ]);
            exit;
    }

}
?>

```

--------------------------------

### Get Subhistory OpenAPI Definition

Source: https://strowallet.readme.io/reference/get-subhistory

This is the OpenAPI 3.1.0 definition for the Get Subhistory API. It specifies the endpoint, parameters, and responses.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Get subhistory",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://strowallet.com/api/get_subhistory"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/": {
      "get": {
        "summary": "Get Subhistory",
        "description": "",
        "operationId": "get-subhistory",
        "parameters": [
          {
            "name": "subaccount_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "secret_key",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true,
  "_id": "68153cce17419a000f4232b2:68153d19c5dcf10018a5a294"
}
```

--------------------------------

### Data Flow - PHP

Source: https://strowallet.readme.io/reference/whatsapp-banking

Handles the 'data' state. This flow confirms successful data purchase and activation, prompting the user to reply 'MENU' to continue.

```php
$_SESSION['state'] = 'menu';

echo json_encode([
    'reply' =>
        "✅ *Data Purchase Successful*\n" .
        "Your data has been activated.\n\n" .
        "Reply MENU to continue."
]);
exit;
```

--------------------------------

### Get Payroll API Definition

Source: https://strowallet.readme.io/reference/get-payroll

This is the OpenAPI definition for the Get Payroll API. It outlines the available endpoints, parameters, and responses.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "getpayroll",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://strowallet.com/api/GetPayroll"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/": {
      "get": {
        "summary": "Get Payroll",
        "description": "Fetch all Your payroll Accounts",
        "operationId": "get-payroll",
        "parameters": [
          {
            "name": "public_key",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "payroll_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "mode",
            "in": "query",
            "schema": {
              "type": "string",
              "default": "sandbox"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true,
  "_id": "685d57f924235d0072de9f19:685d58443494db007a272914"
}
```

--------------------------------

### OpenAPI Definition Example

Source: https://strowallet.readme.io/reference/verify-cac

This snippet shows a portion of an OpenAPI definition, including proxy settings and a unique identifier.

```json
{
  "proxy-enabled": false
},
"x-readme-fauxas": true,
"_id": "66be8123be787b00191516cb:66be82daab526a003c9405e1"
}
```

--------------------------------

### Initiate API Payment

Source: https://strowallet.readme.io/reference/standard

Initiates an API payment by making a GET request to the specified endpoint with all required parameters.

```APIDOC
## Initiate API Payment

### Description
Initiates an API payment by making a GET request to the specified endpoint with all required parameters.

### Method
GET

### Endpoint
https://strowallet.com/express/initiate

### Parameters
All parameters are required.

- **amount** (string) - Required - The payment amount.
- **currency** (string) - Required - The currency of the payment (e.g., NGN).
- **details** (string) - Required - A description of the purchase.
- **custom** (string) - Required - A custom identifier for the transaction.
- **ipn_url** (string) - Required - The URL for Instant Payment Notification.
- **success_url** (string) - Required - The URL to redirect to upon successful payment.
- **cancel_url** (string) - Required - The URL to redirect to upon cancellation.
- **public_key** (string) - Required - Your public API key.
- **name** (string) - Required - The name of the payer.
- **email** (string) - Required - The email address of the payer.

### Request Example (PHP)
```php
// create array With Parameters
$parameters = array(
    'amount' => '100',
    'currency' => 'NGN',
    'details' => 'Purchase Software',
    'custom' => 'ABCD1234',
    'ipn_url' => 'http://www.abc.com/ipn.php',
    'success_url' => 'http://www.abc.com/success.php',
    'cancel_url' => 'http://www.abc.com/cancelled.php',
    'public_key' => 'ABCDEFGH123456789',
    'name' => 'Mr. ABC XYZ',
    'email' => 'abc@abc.com'
);

// Generate The Url (LIVE)
$endpoint = 'https://strowallet.com/express/initiate';
$call = $endpoint . "?" . http_build_query($parameters);

// Send Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_URL, $call);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);
$response = curl_exec($ch);
curl_close($ch);
```

### Response
#### Success Response (200)
- **message** (string) - Indicates payment initiation success.
- **url** (string) - The URL to redirect the user to for payment.

#### Error Response
- **error** (string) - Indicates an error occurred.
- **message** (object) - Contains details about the validation errors for each field.

### Response Example (Success)
```json
{
    "error": "ok",
    "message": "Payment Initiated. Redirect to url",
    "url": "https://strowallet.com/express/payment/UNIQUE_CODE"
}
```

### Response Example (Error)
```json
{
    "error": "error",
    "message": {
        "amount": [
            "The amount format is invalid."
        ],
        "details": [
            "The details field is required."
        ]
    }
}
```
```

--------------------------------

### Initiate API Payment Request (PHP)

Source: https://strowallet.readme.io/reference/standard

Use this PHP code to construct and send a payment initiation request to the Strowallet API. Ensure all parameters are correctly populated. The response will contain a URL for payment redirection.

```php
$parameters = array(
'amount' => '100',
'currency' => 'NGN',
'details' => 'Purchase Software',
'custom' => 'ABCD1234',
'ipn_url' => '<http://www.abc.com/ipn.php>',
'success_url' => '<http://www.abc.com/success.php>',
'cancel_url' => '<http://www.abc.com/cancelled.php>',
'public_key' => 'ABCDEFGH123456789',
'name' => 'Mr. ABC XYZ',
'email' => '<abc@abc.com>' );

// Generate The Url (LIVE)
$endpoint = '<https://strowallet.com/express/initiate>';
$call = $endpoint . "?" . http_build_query($parameters);

// Send Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_URL, $call);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);
$response = curl_exec($ch);
curl_close($ch);
```

--------------------------------

### Get SmePlans OpenAPI Definition

Source: https://strowallet.readme.io/reference/get-smeplans

This is the OpenAPI 3.1.0 definition for the Get SME Data plans API. It includes details about the endpoint, parameters, and responses.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Get SME Data plans",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://strowallet.com/api/get_smeplans"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/": {
      "get": {
        "summary": "Get SmePlans",
        "description": "",
        "operationId": "get-smeplans",
        "parameters": [
          {
            "name": "network",
            "in": "query",
            "description": "MTN, GLO, 9MOBILE, AIRTEL",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true,
  "_id": "67cd6ee59cde5b005b7dacfa:67cd719ccc238882ee6ab0b3"
}
```

--------------------------------

### Get Data Plans

Source: https://strowallet.readme.io/reference/get-data-plans

Fetches a list of available data plans for a specified service provider.

```APIDOC
## GET /api/buydata/plans

### Description
Retrieves a list of data plans for a given service provider.

### Method
GET

### Endpoint
https://strowallet.com/api/buydata/plans

### Parameters
#### Query Parameters
- **public_key** (string) - Required - Your public key for authentication.
- **service_name** (string) - Required - The name of the service provider (e.g., mtn-data, airtel-data, glo-data, etisalat-data, spectranet, smile-direct).

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **message** (string) - A message describing the outcome of the request.
- **data** (object) - Contains the data plan details.
  - **service_name** (string) - The name of the service provider.
  - **service_id** (string) - The unique identifier for the service.
  - **varations** (array) - A list of available data plan variations.
    - **variation_code** (string) - The code for the specific data plan variation.
    - **name** (string) - The name of the data plan variation.
    - **variation_amount** (string) - The price of the data plan variation.
    - **fixedPrice** (string) - Indicates if the price is fixed ('Yes' or 'No').

### Response Example
```json
{
    "success": true,
    "message": "Suceess!",
    "data": {
        "service_name": "MTN Data",
        "service_id": "mtn-data",
        "varations": [
            {
                "variation_code": "mtn-XXX-XXX",
                "name": "N100 XXX- 24 hrs",
                "variation_amount": "100.00",
                "fixedPrice": "Yes"
            },
            {
                "variation_code": "mtn-50mb-200",
                "name": "N200 200MB - 2 days",
                "variation_amount": "200.00",
                "fixedPrice": "Yes"
            }
        ]
    }
}
```
```

--------------------------------

### Get Customer OpenAPI Definition

Source: https://strowallet.readme.io/reference/get-customer

This is the OpenAPI 3.1.0 definition for the Get Customer API. It outlines the endpoint, parameters, and response structures for retrieving customer details.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Get customer",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://strowallet.com/api/bitvcard/getcardholder"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/": {
      "get": {
        "summary": "Get Customer",
        "description": "",
        "operationId": "get-customer",
        "parameters": [
          {
            "name": "public_key",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customerId",
            "in": "query",
            "description": "By customer ID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customerEmail",
            "in": "query",
            "description": "By customer email",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"success\": true,\n  \"data\": {\n    \"dateOfBirth\": \"2000-02-09\",\n    \"customerEmail\": \"fgfhhyyjhhht@gmail.com\",\n    \"firstName\": \"Apifjcrgg\",\n    \"lastName\": \"dfergrgr\",\n    \"line1\": \"Demo street\",\n    \"status\": \"high kyc\",\n    \"idImage\": \"https://exmple.com/halfwhite.png\",\n    \"userPhoto\": \"https://exmple.com/fwhite.png\",\n    \"customerId\": \"b3b39cb5-cec127e99\"\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "dateOfBirth": {
                          "type": "string",
                          "example": "2000-02-09"
                        },
                        "customerEmail": {
                          "type": "string",
                          "example": "fgfhhyyjhhht@gmail.com"
                        },
                        "firstName": {
                          "type": "string",
                          "example": "Apifjcrgg"
                        },
                        "lastName": {
                          "type": "string",
                          "example": "dfergrgr"
                        },
                        "line1": {
                          "type": "string",
                          "example": "Demo street"
                        },
                        "status": {
                          "type": "string",
                          "example": "high kyc"
                        },
                        "idImage": {
                          "type": "string",
                          "example": "https://exmple.com/halfwhite.png"
                        },
                        "userPhoto": {
                          "type": "string",
                          "example": "https://exmple.com/fwhite.png"
                        },
                        "customerId": {
                          "type": "string",
                          "example": "b3b39cb5-cec127e99"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"success\": false,\n  \"message\": \"Cardholder not found or does not belong to the user\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "message": {
                      "type": "string",
                      "example": "Cardholder not found or does not belong to the user"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true,
  "_id": "66ff9be03fd178003f91c2b3:66ff9c44225d6c000f0bf4d0"
}
```

--------------------------------

### Get SME Plans

Source: https://strowallet.readme.io/reference/get-smeplans

Retrieves available SME data plans for a specified network.

```APIDOC
## GET /api/get_smeplans

### Description
Retrieves available SME data plans for a specified network.

### Method
GET

### Endpoint
/api/get_smeplans

### Parameters
#### Query Parameters
- **network** (string) - Required - The mobile network operator (e.g., MTN, GLO, 9MOBILE, AIRTEL).

### Response
#### Success Response (200)
- **Example**: `{}` (An empty JSON object, actual response structure may vary based on network and plan availability.)

#### Error Response (400)
- **Example**: `{}` (An empty JSON object, indicating a bad request.)
```

--------------------------------

### Get MasterCard Details OpenAPI Definition

Source: https://strowallet.readme.io/reference/get-mastercard-details

This is the OpenAPI 3.1.0 definition for the Get MasterCard Details API endpoint. It specifies the request parameters and the structure of the successful response.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Get MasterCard Details",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://strowallet.com/api/bitvcard/fetch-mastercard-detail"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/": {
      "get": {
        "summary": "Get MasterCard Details",
        "description": "",
        "operationId": "get-mastercard-details",
        "parameters": [
          {
            "name": "public_key",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "card_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "mode",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"success\": true,\n    \"message\": \"Card details retrieved successfully.\",\n    \"response\": {\n        \"card_detail\": {\n            \"card_id\": \"697bc8a4b3b7f6\",\n            \"card_type\": \"virtual\",\n            \"card_brand\": \"mastercard\",\n            \"card_status\": \"active\",\n            \"masked_pan\": \"537100******1100\",\n            \"last4\": \"2240\",\n            \"expiry\": \"01/29\",\n            \"balance\": \"11.31\",\n            \"currency\": \"USD\",\n            \"billing_address\": {\n                \"line1\": \"1007 N Orange St. 4th Floor\",\n                \"line2\": \"\",\n                \"city\": \"Wilmington\",\n                \"state\": \"Delaware\",\n                \"country\": \"US\",\n                \"postalCode\": \"19801\"\n            },\n            \"created_at\": \"2026-01-29T21:10:04.293Z\",\n            \"updated_at\": \"2026-01-29T21:10:04.783Z\",\n            \"secure_data\": {\n                \"vault_id\": \"fo5\",\n                \"token\": \"eyJhhYzQpv9CTfwvA\",\n                \"card_id\": \"697b4b300b7f6\"\n            }\n        }\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "message": {
                      "type": "string",
                      "example": "Card details retrieved successfully."
                    },
                    "response": {
                      "type": "object",
                      "properties": {
                        "card_detail": {
                          "type": "object",
                          "properties": {
                            "card_id": {
                              "type": "string",
                              "example": "697bc8a4b3b7f6"
                            },
                            "card_type": {
                              "type": "string",
                              "example": "virtual"
                            },
                            "card_brand": {
                              "type": "string",
                              "example": "mastercard"
                            },
                            "card_status": {
                              "type": "string",
                              "example": "active"
                            },
                            "masked_pan": {
                              "type": "string",
                              "example": "537100******1100"
                            },
                            "last4": {
                              "type": "string",
                              "example": "2240"
                            },
                            "expiry": {
                              "type": "string",
                              "example": "01/29"
                            },
                            "balance": {
                              "type": "string",
                              "example": "11.31"
                            },
                            "currency": {
                              "type": "string",
                              "example": "USD"
                            },
                            "billing_address": {
                              "type": "object",
                              "properties": {
                                "line1": {
                                  "type": "string",
                                  "example": "1007 N Orange St. 4th Floor"
                                },
                                "line2": {
                                  "type": "string",
                                  "example": ""
                                },
                                "city": {
                                  "type": "string",
                                  "example": "Wilmington"
                                },
                                "state": {
                                  "type": "string",
                                  "example": "Delaware"
                                },
                                "country": {
                                  "type": "string",
                                  "example": "US"
                                },
                                "postalCode": {
                                  "type": "string",
                                  "example": "19801"
                                }
                              }
                            },
                            "created_at": {
                              "type": "string",
                              "example": "2026-01-29T21:10:04.293Z"
                            },
                            "updated_at": {
                              "type": "string",
                              "example": "2026-01-29T21:10:04.783Z"
                            },
                            "secure_data": {
                              "type": "object",
                              "properties": {
                                "vault_id": {
                                  "type": "string",
                                  "example": "fo5"
                                },
                                "token": {
                                  "type": "string",
                                  "example": "eyJhhYzQpv9CTfwvA"
                                },
                                "card_id": {
                                  "type": "string",
                                  "example": "697b4b300b7f6"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### OpenAPI Definition for Get CAC Details

Source: https://strowallet.readme.io/reference/get-cac-details

This is the OpenAPI 3.1.0 definition for the Get CAC Details API. It outlines the API's endpoints, parameters, and response schemas.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Get CAC Details",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://strowallet.com/api/kyb_getcac"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/": {
      "get": {
        "summary": "Get CAC Details",
        "description": "",
        "operationId": "get-cac-details",
        "parameters": [
          {
            "name": "public_key",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "rc_number",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "company_type",
            "in": "query",
            "description": "RC or BN",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"company_name\": \"DEMO TECHNOLOGY LIMITED\",\n    \"surname\": \"john\",\n    \"firstname\": \"doe\",\n    \"otherName\": \"testing\",\n    \"email\": \"johndoe@gmail.com\",\n    \"phoneNumber\": \"08123456789\",\n    \"gender\": \"MALE\",\n    \"city\": \"Alagbado\",\n    \"occupation\": \"Web developer\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "company_name": {
                      "type": "string",
                      "example": "DEMO TECHNOLOGY LIMITED"
                    },
                    "surname": {
                      "type": "string",
                      "example": "john"
                    },
                    "firstname": {
                      "type": "string",
                      "example": "doe"
                    },
                    "otherName": {
                      "type": "string",
                      "example": "testing"
                    },
                    "email": {
                      "type": "string",
                      "example": "johndoe@gmail.com"
                    },
                    "phoneNumber": {
                      "type": "string",
                      "example": "08123456789"
                    },
                    "gender": {
                      "type": "string",
                      "example": "MALE"
                    },
                    "city": {
                      "type": "string",
                      "example": "Alagbado"
                    },
                    "occupation": {
                      "type": "string",
                      "example": "Web developer"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"success\": false,\n    \"message\": \"Verification Failed\",\n    \"verification_status\": \"NOT-VERIFIED\",\n    \"reference\": \"07a16285646c2ba8\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "message": {
                      "type": "string",
                      "example": "Verification Failed"
                    },
                    "verification_status": {
                      "type": "string",
                      "example": "NOT-VERIFIED"
                    },
                    "reference": {
                      "type": "string",
                      "example": "07a16285646c2ba8"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true,
  "_id": "66c1b7635328cc0012ea3170:66c1b88c56bfb800537f9098"
}
```
Tokens:
Raw