Payout list

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.

Query Parameters

page?integer

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.

Default1

Range1 <= value

limit?integer

If 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.

Default50

Range1 <= value <= 100

Response Body

`application/json`

curl -X GET "https://connect-api-sandbox.volt.io/payouts"

curl -X GET "https://connect-api-sandbox.volt.io/payouts"

[
  {
    "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"
  }
]