Get balance report¶
GET
https://api.mollie.com/v2/balances/*balanceId*/report
With the Get balance report endpoint you can retrieve a summarized report for all movements on a given balance within a given timeframe.
The API also provides a detailed report on all Mollie ‘fee-prepayments’ that were deducted from your balance during the reported period ahead of your Mollie invoice.
Parameters¶
Replace *balanceId*
in the endpoint URL by the balance token, which can be retrieved by the
List balances endpoint.
from
dateYYYY-MM-DD
format. The from date is ‘inclusive’, and in Central European
Time. This means a report with for example from: 2020-01-01
will include movements of
2020-01-01 0:00:00 CET
and onwards.until
dateYYYY-MM-DD
format. The until date is ‘exclusive’, and in Central European
Time. This means a report with for example until: 2020-02-01
will include movements up until
2020-01-31 23:59:59 CET
.grouping
stringoptionalYou can retrieve reports in two different formats. With the status-balances
format, transactions are grouped
by status (e.g. pending, available), then by transaction type, and then by other sub-groupings where available
(e.g. payment method).
With the transaction-categories
format, transactions are grouped by transaction type, then by status, and
then again by other sub-groupings where available.
Possible values: status-balances
transaction-categories
Response¶
200
application/hal+json
resource
stringbalance-report
for
this endpoint.balanceId
stringtimeZone
stringfrom
and until
parameters. Currently only time zone Europe/Amsterdam
is
supported.from
dateYYYY-MM-DD
format. The from date is ‘inclusive’, and in Central European
Time. This means a report with for example from: 2020-01-01
will include movements of
2020-01-01 0:00:00 CET
and onwards.until
dateYYYY-MM-DD
format. The until date is ‘exclusive’, and in Central European
Time. This means a report with for example until: 2020-02-01
will include movements up until
2020-01-31 23:59:59 CET
.grouping
stringYou can retrieve reports in two different formats. With the status-balances
format, transactions are grouped
by status (e.g. pending, available), then by direction of movement (e.g. moved from pending to available), then
by transaction type, and then by other sub-groupings where available (e.g. payment method).
With the transaction-categories
format, transactions are grouped by transaction type, then by direction of
movement, and then again by other sub-groupings where available.
Both reporting formats will always contain opening and closing amounts that correspond to the start and end dates of the report.
Possible values: status-balances
transaction-categories
totals
objectIf grouping status-balances
is chosen, the totals
object will be formatted roughly as follows:
pendingBalance
open
amount
pending
amount
subtotals
payments
count
amount
subtotals
- etc.
movedToAvailable
amount
subtotals
- etc.
close
amount
availableBalance
open
amount
movedFromPending
amount
subtotals
- etc.
immediatelyAvailable
amount
subtotals
- etc.
close
amount
If grouping transaction-categories
is chosen, the totals
object will be formatted roughly as follows:
open
pending
amount
available
amount
payments
pending
count
amount
subtotals
- etc.
movedToAvailable
etc.
immediatelyAvailable
etc.
refunds
- etc.
chargebacks
- etc.
capital
- etc.
transfers
- etc.
fee-prepayments
- etc.
corrections
- etc.
close
- etc.
_links
objectLinks to help navigate through the API. Every URL object will contain an href
and a type
field.
self
URL objectdocumentation
URL objectExample¶
Request¶
1 2 | curl -X GET https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH/report?from=2021-01-01&until=2021-02-01&grouping=transaction-categories \ -H 'Authorization: Bearer access_vR6naacwfSpfaT5CUwNTdV5KsVPJTNjURkgBPdvW' |
1 2 3 4 5 6 7 8 9 10 11 12 | <?php $mollie = new \Mollie\Api\MollieApiClient(); $mollie->setAccessToken("access_vR6naacwfSpfaT5CUwNTdV5KsVPJTNjURkgBPdvW"); $report = $mollie->balanceReports->get( "bal_gVMhHKqSSRYJyPsuoPNFH", [ "from" => "2021-01-01", "until" => "2021-02-01", "grouping" => "transaction-categories", ] ); |
1 2 3 4 | We don't have a Python code example for this API call yet. If you have some time to spare, feel free to share suggestions on our Discord: https://discord.gg/VaTVkXB4aQ |
1 2 3 4 | We don't have a Ruby code example for this API call yet. If you have some time to spare, feel free to share suggestions on our Discord: https://discord.gg/VaTVkXB4aQ |
1 2 3 4 | We don't have a Node.js code example for this API call yet. If you have some time to spare, feel free to share suggestions on our Discord: https://discord.gg/VaTVkXB4aQ |
Response¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | HTTP/1.1 200 OK Content-Type: application/hal+json { "resource": "balance-report", "balanceId": "bal_gVMhHKqSSRYJyPsuoPNFH", "timeZone": "Europe/Amsterdam", "from": "2021-01-01", "until": "2021-01-31", "grouping": "transaction-categories", "totals": { "open": { "available": { "amount": { "currency": "EUR", "value": "0.00" } }, "pending": { "amount": { "currency": "EUR", "value": "0.00" } } }, "payments": { "immediatelyAvailable": { "amount": { "currency": "EUR", "value": "0.00" } }, "pending": { "amount": { "currency": "EUR", "value": "4.98" }, "subtotals": [ { "transactionType": "payment", "count": 1, "amount": { "currency": "EUR", "value": "4.98" }, "subtotals": [ { "amount": { "currency": "EUR", "value": "4.98" }, "count": 1, "method": "ideal" } ] } ] }, "movedToAvailable": { "amount": { "currency": "EUR", "value": "0.00" } } }, "refunds": { "..." }, "chargebacks": { "..." }, "capital": { "..." }, "transfers": { "..." }, "fee-prepayments": { "immediatelyAvailable": { "amount": { "currency": "EUR", "value": "0.00" } }, "movedToAvailable": { "amount": { "currency": "EUR", "value": "-0.36" }, "subtotals": [ { "amount": { "currency": "EUR", "value": "-0.29" }, "count": 1, "prepaymentPartType": "fee", "subtotals": [ { "amount": { "currency": "EUR", "value": "-0.29" }, "count": 1, "feeType": "payment-fee", "subtotals": [ { "amount": { "currency": "EUR", "value": "-0.29" }, "count": 1, "method": "ideal" } ] } ] }, { "amount": { "currency": "EUR", "value": "-0.0609" }, "prepaymentPartType": "fee-vat" }, { "amount": { "currency": "EUR", "value": "-0.0091" }, "prepaymentPartType": "fee-rounding-compensation" } ] }, "pending": { "amount": { "currency": "EUR", "value": "-0.36" }, "subtotals": [ { "amount": { "currency": "EUR", "value": "-0.29" }, "count": 1, "prepaymentPartType": "fee", "subtotals": [ { "amount": { "currency": "EUR", "value": "-0.29" }, "count": 1, "feeType": "payment-fee", "subtotals": [ { "amount": { "currency": "EUR", "value": "-0.29" }, "count": 1, "method": "ideal" } ] } ] }, { "amount": { "currency": "EUR", "value": "-0.0609" }, "prepaymentPartType": "fee-vat" }, { "amount": { "currency": "EUR", "value": "-0.0091" }, "prepaymentPartType": "fee-rounding-compensation" } ] } }, "corrections": { "..." }, "close": { "available": { "amount": { "currency": "EUR", "value": "0.00" } }, "pending": { "amount": { "currency": "EUR", "value": "4.32" } } } }, "_links": { "documentation": { "href": "https://docs.mollie.com/reference/v2/balances-api/get-balance-report", "type": "text/html" }, "self": { "href": "https://api.mollie.com/v2/balances/{balanceId}/report?from=2021-01-01&until=2021-02-01&grouping=transaction-categories", "type": "application/hal+json" } } } |