Reporting using the Volt API

Payments received

If you’d like a summary of payments received for reconciliation purposes, you can call the GET /payments endpoint of the Volt API with a filter for the date or range of dates you’d like to view.

Filter parameters

The best way to find what you’re looking for in this case is when the payment status was updated to RECEIVED. For this you’ll need to use the statusUpdate[newStatus] parameter with the value RECEIVED.

statusUpdate[newStatus]=RECEIVED

Then add an additional parameter to filter payments where that status change happened during the time period you’re looking for. We have a few different ways of doing this, depending on whether you want to filter before, since or during a time period.

Use the parameter statusUpdate[createdAt] in conjuction with [lte] to find timestamps on or before a certain time and [gte] to find timestamps on or later than a certain time.

About timestamps

Note that you should always include both date (yyyymmdd) and time (hhmmss) in your search. If you’re looking for things that happened within one specific day, use the same date with 000000 and 235959 as your time components.

To find status changes that happened on or later than a specific date/time (01/01/2023)

statusUpdate[createdAt][gte]=20230101000000

To find status changes that happened on or before a specific date (31/01/2023)

statusUpdate[createdAt][lte]=20230131235959

To find status changes that happened within a range of dates (01/01/2023 to 31/01/2023)

statusUpdate[createdAt][gte]=20230101000000&statusUpdate[createdAt][lte]=20230131235959

To find status changes that happened on one specific date (01/01/2023)

statusUpdate[createdAt][gte]=20230101000000&statusUpdate[createdAt][lte]=20230101235959

Request location

Sandbox
Production

GET https://api.sandbox.volt.io/payments

Request examples

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][lte]=20210131000000&statusUpdate[createdAt][gte]=20210125235959

GET https://api.volt.io/payments

Request examples

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][lte]=20210131000000&statusUpdate[createdAt][gte]=20210125235959

Sample response

[
  {
  "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",
  "merchantInternalReference": "MV91bmlxdWVfcmREVO12MV91bmlxdWVfcmREVO12MV91bmlxdWVfcmREVO12MV91bmlxdWVfcmREVO12MV91bmlxdWVfcmREVO12",
  "status": "RECEIVED",
  "createdAt": "2020-06-02T05:48:53.000Z"
  }
]

← Previous Get account balance

Next → Introduction to refunds

On this page
Payments received