Reporter
Payment Reports
Generate reports of all payments with statuses and metadata
Payment reports list all payments created by a Volt customer and optionally include those created by their hierarchical children. Payments are shown with the status as of the time the report was requested.
What's included
Payment reports include:
- All payment details from the original request
- Current payment status
- Shopper/payer information
- Device and browser metadata
- Timestamps and identifiers
Use payment reports to integrate Volt payment data into your own system for additional processing, reconciliation, or analytics.
Request a payment report
POST /reports/payments
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN
{
"startDate": "2026-01-01T00:00:00Z",
"endDate": "2026-01-31T23:59:59Z"
}Parameters
Prop
Type
Report fields
| Field | Description | Always filled |
|---|---|---|
customerId | The Volt customer used to create the payment. | Yes |
customerName | The Volt customer name. | Yes |
applicationName | The Volt application used to create the payment. | Yes |
voltId | The id from in the payment request response. | Yes |
merchantInternalReference | The merchantInternalReference used in the payment request. | No |
reference | The uniqueReference used in the payment request. | Yes |
shopperName | The shopperName used in the payment request. | No |
shopperEmail | The shopperEmail used in the payment request. | No |
shopperFirstName | The shopperFirstName used in the payment request. | No |
shopperLastName | The shopperLastName used in the payment request. | No |
shopperOrganisationName | The shopperOrganisationName used in the payment request. | No |
shopperReference | The shopperReference used in the payment request. | Yes |
shopperDocumentId | The shopperDocumentId used in the payment request. | No |
shopperAccountNumber | The shopper account number. | No |
shopperBankCode | The shopper bank code. | No |
shopperDevice | The shopper device. | Yes |
shopperBrowser | The shopper browser. | Yes |
shopperIpMerchant | The shopper IP address logged by merchant. | No |
shopperIpVolt | The shopper IP address logged by Volt. | Yes |
shopperDeviceFingerprint | The shopper device fingerprint. | No |
amount | The amount used in the payment request. | Yes |
currency | The currency used in the payment request. | Yes |
status | The status of the payment at the moment of the generation of the report. | Yes |
bankCountry | The country code of the shopper's bank. | No |
bankName | The bank name of the shopper's bank. | No |
createdAt | The timestamp when the payment was created. | Yes |
updatedAt | The timestamp when the payment was updated. | Yes |
Some fields may not be available in Australian reports due to regional differences.
Example CSV
customerId;customerName;applicationName;voltId;merchantInternalReference;reference;shopperName;shopperEmail;shopperFirstName;shopperLastName;shopperOrganisationName;shopperReference;shopperDocumentId;shopperAccountNumber;shopperBankCode;shopperDevice;shopperBrowser;shopperIpMerchant;shopperIpVolt;shopperDeviceFingerprint;amount;currency;status;bankCountry;bankName;createdAt;updatedAt
f93d0ae3-f774-4fb4-8968-f71086e5cf57;Customer;App1;4e8f70eb-8b02-453e-90e6-5a6840dd9eca;;5LJ8v53R49NPAT9nrU;;;;;;43ddd842212d5d4643adb2b706b0280a;;;;Android 14.0.0;Chrome Mobile 132.0;;127.0.0.1;;5000;EUR;RECEIVED;BE;ING;2025-01-26 20:38:11.458306 +0000 UTC;2025-01-26 21:47:08.847672 +0000 UTC
f93d0ae3-f774-4fb4-8968-f71086e5cf57;Customer;App1;c848d340-830d-447a-a68b-d90ae99fc867;;0YuIJlSNGfbyMgonfz;;;;;;43ddd842212d5d4643adb2b706b0280a;;;;Android 14.0.0;Chrome Mobile 132.0;;127.0.0.1;;5000;EUR;RECEIVED;BE;ING;2025-01-27 22:59:18.598447 +0000 UTC;2025-01-26 22:07:30.320918 +0000 UTC
f93d0ae3-f774-4fb4-8968-f71086e5cf57;Customer;App1;7ac3a64a-0862-4c18-8799-f5069307026a;;FyD1q7LA7d5VsDWZjF;;;;;;43ddd842212d5d4643adb2b706b0280a;;;;Android 14.0.0;Chrome Mobile 132.0;;127.0.0.1;;1000;EUR;RECEIVED;BE;ING;2025-01-28 10:58:47.469002 +0000 UTC;2025-01-26 11:51:32.555302 +0000 UTC
f93d0ae3-f774-4fb4-8968-f71086e5cf57;Customer;App1;8352a388-0e4b-4351-9747-bfaf6a6e1af8;;NNHggGlV9tcGspRbPN;;;;;;43ddd842212d5d4643adb2b706b0280a;;;;Android 14.0.0;Chrome Mobile 132.0;;127.0.0.1;;5000;EUR;RECEIVED;BE;ING;2025-01-27 19:56:59.243336 +0000 UTC;2025-01-27 11:52:05.934349 +0000 UTC
f93d0ae3-f774-4fb4-8968-f71086e5cf57;Customer;App1;7b7d1878-7b8d-44fe-9675-b0f9c150078f;;owUxfYtjsv7bDlzLr7;;;;;;eea1530d04ec2c751b9e88f83530b2cf;;;;Android 14.0.0;Chrome Mobile 132.0;;127.0.0.1;;2500;EUR;RECEIVED;BE;ING;2025-01-27 10:03:48.534587 +0000 UTC;2025-01-27 06:40:47.962951 +0000 UTC
f93d0ae3-f774-4fb4-8968-f71086e5cf57;Customer;App1;0758c84c-00e9-45fe-bdcf-9ba35ad61319;;Y554z43aJgNmcLlR0X;;;;;;756b00f909dcfe644625ef12c7294c3d;;;;Android 14.0.0;Chrome Mobile 132.0;;127.0.0.1;;2000;EUR;RECEIVED;BE;ING;2025-01-28 00:02:34.837582 +0000 UTC;2025-01-27 20:54:00.057068 +0000 UTC
f93d0ae3-f774-4fb4-8968-f71086e5cf57;Customer;App2;3596402c-13eb-4e74-9fad-3c7348a3c1ce;;i7Fp0ijxYBe8n7oLkM;;;;;;8969d7d2a77669508611f5b0f9ecd2b0;;;;iOS 18.1.1;Mobile Safari 18.1.1;;127.0.0.1;;4000;EUR;RECEIVED;AT;Raiffeisenbank;2025-01-27 11:43:57.200838 +0000 UTC;2025-01-28 10:31:42.130848 +0000 UTC
f93d0ae3-f774-4fb4-8968-f71086e5cf57;Customer;App1;ccd22a46-0c20-4a69-b49f-ac48dd1f1e14;;IKnwmH8GcxcmQZvdD3;;;;;;eea1530d04ec2c751b9e88f83530b2cf;;;;Android 14.0.0;Chrome Mobile 132.0;;127.0.0.1;;10000;EUR;RECEIVED;BE;ING;2025-01-28 01:10:23.258484 +0000 UTC;2025-01-28 05:28:53.952669 +0000 UTC
f93d0ae3-f774-4fb4-8968-f71086e5cf57;Customer;App3;0b2ad40e-e6d7-4e3c-93ea-a401bafc328a;;p5Rc3WOlgOd3v3uvl9;;;;;;1f7d3210ddcfc5a50c5403a8daf47b00;;;;Android 14.0.0;Chrome Mobile 132.0;;127.0.0.1;;20000;EUR;RECEIVED;AT;UniCredit Bank Austria;2025-01-27 15:35:36.937637 +0000 UTC;2025-01-26 08:22:43.730328 +0000 UTC
f93d0ae3-f774-4fb4-8968-f71086e5cf57;Customer;App1;6caa1a00-7f05-4b8f-b7c9-b812a4bb591f;;gyhA9YIBLa0ijFWgzt;;;;;;43ddd842212d5d4643adb2b706b0280a;;;;Android 10.0.0;Huawei Browser 99.0;;127.0.0.1;;5000;EUR;RECEIVED;AT;Raiffeisenbank;2025-01-27 10:09:57.131482 +0000 UTC;2025-01-26 12:33:39.38381 +0000 UTC
f93d0ae3-f774-4fb4-8968-f71086e5cf57;Customer;App2;890b08cd-e1d8-4764-8ee3-34fbb479759f;;AUsm8WKKnh3VC4BZC6;;;;;;3dd72fc3232440183aab268c61cc2e3d;;;;iOS 18.1.1;Mobile Safari 18.1.1;;127.0.0.1;;5000;EUR;RECEIVED;BE;KBC Bank;2025-01-26 11:50:54.273645 +0000 UTC;2025-01-27 10:04:27.251652 +0000 UTC
f93d0ae3-f774-4fb4-8968-f71086e5cf57;Customer;App2;2418589f-54db-4407-a297-57f555a1dc33;;EN6UtQQYBuRZ3ljwQr;;;;;;3952b1b1a504d37b4baaa488dee5672b;;;;iOS 18.1.1;Mobile Safari 18.1.1;;127.0.0.1;;2500;EUR;RECEIVED;BE;KBC Bank;2025-01-26 13:03:36.941681 +0000 UTC;2025-01-27 23:46:47.339688 +0000 UTC
f93d0ae3-f774-4fb4-8968-f71086e5cf57;Customer;App3;de487635-2ac7-430e-b95c-fdf16eef5560;;FE3AhWRxpt4UziuT2X;;;;;;756b00f909dcfe644625ef12c7294c3d;;;;iOS 18.1.1;Mobile Safari 18.1.1;;127.0.0.1;;100000;EUR;RECEIVED;BE;ING;2025-01-27 20:53:26.950955 +0000 UTC;2025-01-27 16:57:39.827087 +0000 UTC
f320253c-8b20-4d2c-b8a0-aeb517a4cc29;Customer_2;App4;5a2fa1ed-5ae2-4f0c-8f72-fe50d46ea2bb;;uhrk7Xzl7eFOh76nur;;;;;;72635f0bcd1361922f2c12c7f517e322;;;;iOS 18.1.1;Mobile Safari 18.1.1;;127.0.0.1;;2500;EUR;RECEIVED;BE;ING;2025-01-27 09:01:44.939215 +0000 UTC;2025-01-26 13:28:52.049239 +0000 UTC
f320253c-8b20-4d2c-b8a0-aeb517a4cc29;Customer_2;App4;19f51f4b-3166-49a7-afab-58f46f4cca6f;;tWFIfXWJFPeJlEBKjm;;;;;;43ddd842212d5d4643adb2b706b0280a;;;;iOS 18.1.1;Mobile Safari 18.1.1;;127.0.0.1;;5000;EUR;RECEIVED;BE;ING;2025-01-26 08:22:12.633903 +0000 UTC;2025-01-27 14:38:11.026829 +0000 UTCHow is this guide?
Last updated on