Summary of payments received

If you’d like a summary of funds received for reconciliation purposes, you can call the GET /payments endpoint of the Volt API with a receivedAt parameter containing the date or range of dates you’d like to view. This will list all the payments received into your virtual IBAN during the specified period. You can select other filters to refine the information further.

Request location

  • Sandbox
  • Production
GET https://api.sandbox.volt.io/payments
GET https://api.volt.io/payments

Request examples

  • Sandbox
  • Production
To view all payments received on or since 31 Jan 2021
GET https://api.sandbox.volt.io/payments?status=RECEIVED&statusUpdate[newStatus]=RECEIVED&statusUpdate[createdAt][gte]=20210131000000
To view all payments received between 25 Jan and 31 Jan 2021
GET https://api.sandbox.volt.io/payments?status=RECEIVED&statusUpdate[newStatus]=RECEIVED&statusUpdate[createdAt][gte]=20210131000000&statusUpdate[createdAt][lte]=20210125235959
To view all payments received on or since 31 Jan 2021
GET https://api.volt.io/payments?status=RECEIVED&statusUpdate[newStatus]=RECEIVED&statusUpdate[createdAt][gte]=20210131000000
To view all payments received between 25 Jan and 31 Jan 2021
GET https://api.volt.io/payments?status=RECEIVED&statusUpdate[newStatus]=RECEIVED&statusUpdate[createdAt][gte]=20210131000000&statusUpdate[createdAt][lte]=20210125235959

Response example

Where the request parameter was: receivedAt=20200602

[
  {
  "id": "662384a0-9734-4556-a8bd-3f1e774e2a3c",
    "currency": {
    "id": "GBP",
    "name": "Pound Sterling",
    "decimal": 2,
    "active": true
    },
  "bank": {
    "id": "662384a0-9734-4556-a8bd-3f1e774e2a3c",
    "name": "Barclays Bank",
    "country": {
      "id": "GB",
      "name": "United Kingdom"
      },
    "officialName": "Barclays Bank Plc",
    "branchName": "Barclays Bank Branch Plc",
    "shortBranchName": "Barclays Bank Branch",
    "active": true,
    "logo": "https://cdn.volt.io/banks/logos/xx_barclays_bank.png",
    "icon": "https://cdn.volt.io/banks/icons/xx_barclays_bank.png"
    },
  "amount": 12345,
  "type": "OTHER",
  "uniqueReference": "sale123456",
  "status": "RECEIVED",
  "createdAt": "2020-06-02T05:48:53.000Z"
  }
]

Summary of funds settled

To get a settlement report, you can call GET /payments against Volt’s API with the batchID parameter containing the batchId you received in your settlement report notification. This will list all the payments settled in that particular batch. A CSV report will also be available to download from the URL in the settlement report notification.

Coming soon

Future features

Connect is always being updated with features to make it easier than ever for you to stay on top of your payments. Below are some of the enhancements launching soon. More information – including release dates – will be published as it becomes available.

Refunds

  • Instruct refunds for Connect payments received, by using the Volt API
  • Refunds will be sent directly from your virtual IBAN, subject to available funds

Payouts

  • Payouts are outbound payments not directly related to an incoming payment
  • Instruct payouts using the Volt API to be sent directly from your virtual IBAN, again subject to available funds

Foreign exchange

  • Receive payments in one currency and batch them into a different currency for settlement at near-wholesale foreign exchange rates
  • Or use our foreign exchange services to pay your customers in their local currency