Filter Payment Links

Get a list of your subaccounts on Terraswitch.

POST {{ BASE_URL }}/v1/corporate/filter-payments

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"

Body Parameters

Property	Data Type	Description	Example	Required
isEnabled	boolean	Specify filter value for the enabled status of the payment link	true	Yes, if no other field is specified
type	string	The type for a payment link. This can be fixed or dynamic	"fixed"	Yes if no other field is specified
feature	string	The feature of the payment link. This can either be request, product or invoice	"request"	Yes if no other field is specified

Node.js

import Axios from 'axios';

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

// define request body
const data = {
    isEnabled: true,
    type: "fixed",
    feature: "request"
}

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

Response

{
    "error": false,
    "errors": [],
    "count": 1,
    "total": 1,
    "pagination": {},
    "data": [
        {
            "name": "Crowd Fund School",
            "slug": "crowd-fund",
            "link": "https://staging-web.terraswitch.com/link/crowd-fund",
            "qrcode": "https://storage.googleapis.com/concreap-buckets/qrcode-4ebc1b81",
            "redirectUrl": "",
            "feature": "request",
            "type": "fixed",
            "isEnabled": true,
            "message": "Thank you for your payment",
            "description": "",
            "amount": 5000,
            "totalAmount": 15000,
            "createdAt": "2024-01-13T05:39:48.624Z",
            "updatedAt": "2024-01-13T06:12:53.060Z",
            "options": {
                "card": true,
                "transfer": true,
                "bank": false,
                "ussd": false,
                "bankQR": false
            }
        }
    ],
    "message": "successful",
    "status": 200
}