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

FieldDescriptionAlways filled
customerIdThe Volt customer used to create the payment.Yes
customerNameThe Volt customer name.Yes
applicationNameThe Volt application used to create the payment.Yes
voltIdThe id from in the payment request response.Yes
merchantInternalReferenceThe merchantInternalReference used in the payment request.No
referenceThe uniqueReference used in the payment request.Yes
shopperNameThe shopperName used in the payment request.No
shopperEmailThe shopperEmail used in the payment request.No
shopperFirstNameThe shopperFirstName used in the payment request.No
shopperLastNameThe shopperLastName used in the payment request.No
shopperOrganisationNameThe shopperOrganisationName used in the payment request.No
shopperReferenceThe shopperReference used in the payment request.Yes
shopperDocumentIdThe shopperDocumentId used in the payment request.No
shopperAccountNumberThe shopper account number.No
shopperBankCodeThe shopper bank code.No
shopperDeviceThe shopper device.Yes
shopperBrowserThe shopper browser.Yes
shopperIpMerchantThe shopper IP address logged by merchant.No
shopperIpVoltThe shopper IP address logged by Volt.Yes
shopperDeviceFingerprintThe shopper device fingerprint.No
amountThe amount used in the payment request.Yes
currencyThe currency used in the payment request.Yes
statusThe status of the payment at the moment of the generation of the report.Yes
bankCountryThe country code of the shopper's bank.No
bankNameThe bank name of the shopper's bank.No
createdAtThe timestamp when the payment was created.Yes
updatedAtThe timestamp when the payment was updated.Yes

Some fields may not be available in Australian reports due to regional differences.

Example CSV

How is this guide?

Last updated on

On this page