Get Beneficiaries

Get list of beneficiaries added to your Terraswitch account.

Beneficiaries are automatically added to your Terraswitch account if you specify while calling the API to withdraw from your wallet or send money to a NGN bank account.

GET {{ BASE_URL }}/v1/corporate/beneficiaries

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/beneficiaries`;

// 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": [
        {
            "accountName": "AGBELEYE OLUWATOBI EMMANUEL",
            "accountNo": "0252872742",
            "code": "ddf990ff",
            "bankName": "guaranty trust bank",
            "bankCode": "058"
        }
    ],
    "message": "successful",
    "status": 200
}