Example settlements report
Download example settlements report: example_payments_report.csv.
Fields in a settlement report
| Field | Always filled? | Description | Example |
|---|---|---|---|
batchId |
yes |
Volt settlement identifier (UUID) |
d33bd8be-9845-4400-9fc0-f65f3f1cd593 |
paymentId |
no | Volt payment identifier (UUID) |
a4593507-aa28-4ed5-b612-77f620a3793d |
customerId |
yes | Volt customer identifier (UUID) |
60be91cd-2faa-4079-9a47-aa85b2251fcc |
uniqueReference |
no | transaction reference |
fc1bd20d2faa400 |
|
|
yes | timestamp when transaction was initiated |
2022-01-03T13:43:49+00:00 |
|
|
yes | timestamp when transaction was confirmed by the provider |
2022-01-03T13:43:49+00:00 |
transactionCurrency
|
yes | transaction currency |
GBP |
transactionGrossCredit |
yes | transaction credit amount in given currency in minor units, for incoming transactions >0, otherwise 0 (e.g. for a payment of 100 GBP, it will show 10000) |
100 |
|
|
yes | transaction debit amount in given currency in minor units, for outgoing transactions (e.g. refund/payout) >0, otherwise 0 |
100 |
|
|
yes | currency in which the settlement was processed |
GBP |
|
|
yes | settlement total credit amount in the settlement in minor currency units |
10000 |
|
|
yes | total net value of the settlement transaction in minor currency units credited to you |
10000 |
|
|
yes | settlement debit amount in the in minor currency units in settlement currency |
10000 |
settlementNetDebit
|
yes |
10000 |
|
commission |
yes | fee (applicable for net settlements, otherwise 0) in minor currency units |
0 |
exchangeRate |
yes | exchange rate for a given payment (1 if payment currency = settlement currency) |
1 |
paymentMethod |
no | payment scheme used to process the Volt Gateway transaction, blank if the payment was not processed by Volt |
SEPA |
refundId |
no | Volt refund identifier (UUID), blank if the record is not a refund (not available in LATAM or AUS reports) |
ka1bd20d2faa433 |
operationStatus |
no | indication of whether the operations failed or succeeded, only for refunds and payouts. Note that this will only be visible when a refund or payout is in progress when a settlement happens, and fails after the settlement. If it is initiated and fails in one settlement, such refund/payout will not be included in the report (not available in LATAM reports). |
PAYOUT_FAILED or REFUND_FAILED |
payoutId |
no | Volt refund identifier (UUID) (not available in LATAM reports). |
gc1bl11h2faa902 |
merchantInternalReference |
no | payment reference used by some merchants for internal reconciliation purposes, set by the merchant on payment initiation (not available in LATAM reports). |
test123 |
type |
yes |
transaction type, can have one of the following values:
|
|
transactionId |
no |
Volt unique credit identifier (UUID) (only used for transactions type = credit or reversal) |
|
reserveFiled7-10 |
no |
Volt internal fields |
|
- On this page
- Example settlements report
- Fields in a settlement report