List Subaccounts

Get a list of your subacccounts on Terraswitch.

GET {{ BASE_URL }}/v1/corporate/subaccounts

Optional Query Parameters

Property	Data Type	Description	Example
limit	string	Number of records per page	50
page	string	Page number to view	1
order	string	Arrangement of records in descending or ascending order	"asc" or "desc"

Node.js

import Axios from 'axios';

// set the api url
const API_URL = `${BASE_URL}/v1/corporate/subaccounts`;

// make request using axios
Axios({
    method: "GET",
    url: `${API_URL}`,
    headers: {
        lg: 'en',
        ch: 'web'
        Authorization: `Bearer ${API_KEY}`,
        'Content-Type': 'application/json',
    }
}).then((resp) => {
    console.log(resp)
}).catch((err) => {
    console.log(err)
})

Response

{
    "error": false,
    "errors": [],
    "count": 1,
    "total": 1,
    "pagination": {},
    "data": [
        {
            "code": "VSA_6yhyzzkcHc",
            "description": "Corporate NATs subaccount for terraswitch",
            "isEnabled": true,
            "name": "Concreap",
            "email": "[e-mail]",
            "phoneNumber": "02137031202",
            "phoneCode": "+234",
            "inflow": {
                "value": 0,
                "count": 0
            },
            "split": {
                "value": 10.05,
                "type": "percentage"
            },
            "bank": {
                "accountNo": "0125318431",
                "acccountName": "CONCREAP TECHNOLOGY SOLUTIONS LIMITED",
                "bankCode": "035",
                "name": "Wema Bank"
            },
            "slug": "corporate-nats",
            "createdAt": "2024-01-12T03:00:09.675Z",
            "updatedAt": "2024-01-12T03:00:09.675Z"
        }
    ],
    "message": "successful",
    "status": 200
}