Skip to main content
GET
/
integrations
/
vertofx
/
beneficiaries
Get Beneficiaries List
curl --request GET \
  --url https://api.royalti.io/integrations/vertofx/beneficiaries \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": 4754,
      "accountNumber": "2092805598",
      "bankName": "United Bank for Africa Plc",
      "beneficiaryAddress": "PMB 2406 UBA House, 57, Marina",
      "beneficiaryCity": "Lagos",
      "beneficiaryCompanyName": null,
      "beneficiaryCountryCode": "NG",
      "beneficiaryEntityType": "individual",
      "beneficiaryPostcode": "",
      "beneficiaryEmail": null,
      "country": "NIGERIA",
      "reference": "RP-22042024-006",
      "currency": "NGN",
      "firstName": "John",
      "lastName": "Doe",
      "linkedUserId": null
    }
  ]
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Endpoint: /integrations/vertofx/beneficiaries Method: GET Query Parameters:
ParameterTypeDescription
pageIntThe page number to retrieve (default: 1)
sizeIntThe number of records per page (default: 10)

​
Code Examples

const response = await fetch('https://api.royalti.io/integrations/vertofx/beneficiaries', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const data = await response.json();
console.log(data);

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

​
page
integer
default:1

The page number to retrieve

​
size
integer
default:10

The number of records per page

Response

Success

​
success
boolean
​
data
object[]