Get balance

Balances API v2
GEThttps://api.mollie.com/v2/balances/*balanceId*
Authentication:Organization access tokensApp access tokens

When processing payments with Mollie, we put all pending funds — minus Mollie fees — on a balance. Once you have linked a bank account to your Mollie account, we can pay out your balance towards this bank account.

With the Balances API you can retrieve your current balance. The response includes two amounts:

  • The ‘pending amount’. These are payments that have been marked as ‘paid’, but are not yet available for paying out.
  • The ‘available amount’. This is the amount that you can get paid out to your bank account.

With instant payment methods like iDEAL, payments are moved to the available balance instantly. With slower payment methods, like credit card for example, it can take a few days before the funds are available on your balance. These funds will be shown under the ‘pending amount’ in the meanwhile.

Parameters

Replace balanceId in the endpoint URL by the balance ID, which can be retrieved by the List balances endpoint.

Response

200 application/hal+json

resourcestring
Indicates the response contains a balance object. Will always contain balance for this endpoint.
idstring
The identifier uniquely referring to this balance. Mollie assigns this identifier at balance creation time. For example bal_gVMhHKqSSRYJyPsuoPNFH.
createdAtdatetime
The balance’s date and time of creation, in ISO 8601 format.
currencystring
The balance’s ISO 4217 currency code.
statusstring

The status of the balance.

Possible values:

  • active The balance is operational and ready to be used.
  • inactive In case the account is still being validated by our team or the balance has been blocked. Contact our support department for more information.
transferFrequencystring

The frequency at which the available amount on the balance will be settled to the configured transfer destination. See transferDestination.

Possible values:

  • daily Every business day.
  • twice-a-week Every Tuesday and Friday.
  • every-monday Every Monday.
  • every-tuesday Every Tuesday.
  • every-wednesday Every Wednesday.
  • every-thursday Every Thursday.
  • every-friday Every Friday.
  • twice-a-month On the first and the fifteenth of the month.
  • monthly On the first of the month.
  • never Automatic settlements are paused for this balance.

Note

Settlements created during weekends or on bank holidays will take place on the next business day.

transferThresholdamount object

The minimum amount configured for scheduled automatic settlements. As soon as the amount on the balance exceeds this threshold, the complete balance will be paid out to the transferDestination according to the configured transferFrequency.

Show child parameters

currencystring
An ISO 4217 currency code. Currently only EUR is supported.
valuestring
A string containing the exact EUR threshold. Make sure to send the right amount of decimals. Non-string values are not accepted.
transferReferencestring
The transfer reference set to be included in all the transfers for this balance. Either a string or null.
transferDestinationobject

The destination where the available amount will be automatically transferred to according to the configured transferFrequency.

Show child parameters

typestring

The default destination of automatic scheduled transfers. Currently only bank-account is supported.

Possible values:

  • bank-account Transfer the balance amount to an external bank account.
bankAccountstring
The configured bank account number of the beneficiary the balance amount is to be transferred to.
beneficiaryNamestring
The full name of the beneficiary the balance amount is to be transferred to.
availableAmountamount object

The amount directly available on the balance, e.g. {"currency":"EUR", "value":"100.00"}.

Show child parameters

currencystring
The ISO 4217 currency code of the available amount.
valuestring
A string containing the exact available amount of the balance in the given currency.
pendingAmountamount object

The total amount that is queued to be transferred to your balance. For example, a credit card payment can take a few days to clear.

Show child parameters

currencystring
The ISO 4217 currency code of the pending amount.
valuestring
A string containing the exact pending amount of the balance in the given currency.
_linksobject

An object with several URL objects relevant to the balance. Every URL object will contain an href and a type field.

Show child parameters

selfURL object
The API resource URL of the balance itself.
documentationURL object
The URL to the balance retrieval endpoint documentation.

Example

Request

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH \
   -H 'Authorization: Bearer access_vR6naacwfSpfaT5CUwNTdV5KsVPJTNjURkgBPdvW'

1
2
3
4
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_vR6naacwfSpfaT5CUwNTdV5KsVPJTNjURkgBPdvW");
$balance = $mollie->balances->get("bal_gVMhHKqSSRYJyPsuoPNFH");

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
HTTP/1.1 200 OK
Content-Type: application/hal+json

{
  "resource": "balance",
  "id": "bal_gVMhHKqSSRYJyPsuoPNFH",
  "mode": "live",
  "createdAt": "2019-01-10T10:23:41+00:00",
  "currency": "EUR",
  "status": "active",
  "availableAmount": {
    "value": "905.25",
    "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": "NL53INGB0654422370",
    "bankAccountId": "bnk_jrty3f"
  },
  "_links": {
    "self": {
      "href": "https://api.mollie.com/v2/balances/bal_gVMhHKqSSRYJyPsuoPNFH",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/v2/balances-api/get-balance",
      "type": "text/html"
    }
  }
}