Get VertoFX Beneficiaries
Endpoint: /integrations/vertofx/beneficiaries
Method: GET
Query Parameters:
Parameter | Type | Description |
---|---|---|
page | Int | The page number to retrieve (default: 1) |
size | Int | The number of records per page (default: 10) |
curl --request GET \
--url https://server26-dot-royalti-project.uc.r.appspot.com/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
}
]
}
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
The page number to retrieve
The number of records per page
Success
The response is of type object
.
curl --request GET \
--url https://server26-dot-royalti-project.uc.r.appspot.com/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
}
]
}