Eligible beneficiaries list
Payouts are only available when using Volt Connect
For regulatory purposes, it's a closed-loop payout system, meaning you may only payout funds to a person or organisation you've previously received money from using Volt Connect.
This endpoint will return a list of beneficiaries you are allowed send payouts to.
Usage
The list is paginated by default.
More information
Full details on payouts can be found in our comprehensive integration guides.
Query Parameters
Name of the beneficiary you'd like to send a payout to
Domestic account number for the beneficiary you'd like to send a payout to
iban for the beneficiary you'd like to send a payout to
You can request additional pages of information by appending the page parameter to your GET request. Pages start numbering at 1 and are in blocks of 50 records, so to call records 51-100, append page=2 to your request. If you omit the page parameter, we will return you the information on page 1.
11 <= valueIf you want to return more than the default number of records per page, append the parameter items to your GET request. To get the first 100 records, append limit=100 to your request. To get the next 100 records, append page=2&limit=100. If you omit the items parameter, we will return 50 records per page.
501 <= value <= 100Response Body
application/json
curl -X GET "https://connect-api-sandbox.volt.io/payouts/beneficiaries"[
{
"name": "John Johnson",
"accountNumber": "12345678",
"sortCode": "404452",
"iban": null,
"swiftBic": null
}
]Global Accounts API
View OpenAPI schemas.
Payout details GET
**Payouts are only available when using Volt Connect** This will return details of the selected payout, with approval update history. ### Usage Pass the **id** of the payout as part of the URL. ### More information Full details on payouts can be found in our comprehensive integration guides.