Payout details
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.
Path Parameters
ID of the payout
Response Body
application/json
curl -X GET "https://connect-api-sandbox.volt.io/payouts/efffed42-40f7-4bd2-840d-908aae9a33ad"{
"id": "efffed42-40f7-4bd2-840d-908aae9a33ad",
"status": "CREATED",
"createdAt": "2019-08-24T14:15:22Z",
"amount": 500,
"currency": "EUR",
"paymentTitle": "Payout123456",
"beneficiary": {
"name": "John Johnson",
"accountNumber": "12345678",
"sortCode": "404452",
"iban": "DK8389009999910135",
"swiftBic": "SXPYDKKKXXX"
},
"sender": {
"sortCode": "404777",
"accountNumber": "8765432",
"iban": "DK8389009999910135",
"swiftBic": "SXPYDKKKXXX"
},
"externalReference": "string",
"createdBy": {
"name": "Jack Jackson"
},
"approvals": [
{
"user": {
"name": "Robert Robertson"
},
"type": "APPROVAL",
"createdAt": "2019-08-24T14:15:22Z"
}
]
}Eligible beneficiaries list GET
**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.
Payout list GET
**Payouts are only available when using Volt Connect** This will return a list of all existing payouts. ### Usage The list is paginated by default and can be filtered using the parameters shown in the request section below. ### More information Full details on payouts can be found in our comprehensive integration guides.