List balances¶
Balances API v2
GET
https://api.mollie.com/v2/balances
Authentication:Organization access tokensApp access tokens
Retrieve all the organization’s balances, including the primary balance, ordered from newest to oldest.
The results are paginated. See pagination for more information.
Parameters¶
currency
stringoptional
Currency filter that will make it so only balances in given currency are returned. For example
EUR
.from
stringoptional
Offset the result set to the balance with this ID. The balance with this ID is included in the result set as
well.
limit
integeroptional
The number of balances to return (with a maximum of 250).
Response¶
200
application/hal+json
count
integer
The number of balances found in
_embedded
, which is either the requested number (with a maximum of 250) or
the default number._embedded
objectThe object containing the queried data.
balances
array
An array of balance objects as described in
Get balance.
_links
objectLinks to help navigate through the lists of balances. Every URL object will contain an href
and a type
field.
self
URL object
The URL to the current set of balances.
previous
URL object
The previous set of balances, if available.
next
URL object
The next set of balances, if available.
documentation
URL object
The URL to the balances list endpoint documentation.
Example¶
Request¶
cURLPHPPythonRubyNode.js
1 2 | curl -X GET https://api.mollie.com/v2/balances?limit=5 \ -H "Authorization: Bearer access_vR6naacwfSpfaT5CUwNTdV5KsVPJTNjURkgBPdvW" |
1 2 3 4 5 6 | <?php $mollie = new \Mollie\Api\MollieApiClient(); $mollie->setAccessToken("access_vR6naacwfSpfaT5CUwNTdV5KsVPJTNjURkgBPdvW"); $from = null; $limit = 5; $balances = $mollie->balances->page($from, $limit); |
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 | HTTP/1.1 200 OK Content-Type: application/hal+json { "count": 5, "_embedded": { "balances": [ { "resource": "balance", "id": "bal_gVMhHKqSSRYJyPsuoPNFH", "mode": "live", "createdAt": "2019-01-10T12:06:28+00:00", "currency": "EUR", "status": "active", "availableAmount": { "value": "0.00", "currency": "EUR" }, "pendingAmount": { "value": "0.00", "currency": "EUR" }, "transferFrequency": "daily", "transferThreshold": { "value": "40.00", "currency": "EUR" }, "transferReference": "Mollie payout", "transferDestination": { "type": "bank-account", "beneficiaryName": "Jack Bauer", "bankAccount": "NL53INGB0654422370", "bankAccountId": "bnk_jrty3f" }, "_links": { "self": { "href": "https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH", "type": "application/hal+json" } } }, { "resource": "balance", "id": "bal_gVMhHKqSSRYJyPsuoPABC", "mode": "live", "createdAt": "2019-01-10T10:23:41+00:00", "status": "active", "currency": "EUR", "availableAmount": { "value": "0.00", "currency": "EUR" }, "pendingAmount": { "value": "0.00", "currency": "EUR" }, "transferFrequency": "twice-a-month", "transferThreshold": { "value": "5.00", "currency": "EUR" }, "transferReference": "Mollie payout", "transferDestination": { "type": "bank-account", "beneficiaryName": "Jack Bauer", "bankAccount": "NL97MOLL6351480700", "bankAccountId": "bnk_jrty3e" }, "_links": { "self": { "href": "https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPABC", "type": "application/hal+json" } } }, { }, { }, { } ] }, "_links": { "documentation": { "href": "https://docs.mollie.com/reference/v2/balances-api/list-balances", "type": "text/html" }, "self": { "href": "https://api.mollie.com/v2/balances?limit=5", "type": "application/hal+json" }, "previous": null, "next": { "href": "https://api.mollie.com/v2/balances?from=bal_gVMhHKqSSRYJyPsuoPABC&limit=5", "type": "application/hal+json" } } } |