MOmollie
Balances API

Get balance

Changed on

When processing payments with Mollie, we put all pending funds — usually 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 on your balance.
  • The available amount. This is the amount that you can get paid out to your bank account, or use for refunds.

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.

get/v2/balances/{balanceId}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/balances/{balanceId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: balances.read

Query parameters

testmodeboolean

You can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

The balance object.

resourcestring required

Indicates the response contains a balance object. Will always contain the string balance for this endpoint.

idstring required
mode'live' | 'test' required

Whether this entity was created in live mode or in test mode.

createdAtstring required

The entity's date and time of creation, in ISO 8601 format.

currency'EUR' | 'GBP' | 'CHF' | 'DKK' | 'NOK' | 'PLN' | 'SEK' | 'USD' | 'CZK' | 'HUF' | 'AUD' | 'CAD' | 'RON' required
descriptionstring required

The description or name of the balance. Can be used to denote the purpose of the balance.

status'active' | 'inactive' required

The status of the balance.

transferFrequency'every-day' | 'daily' | 'every-monday' | 'every-tuesday' | 'every-wednesday' | 'every-thursday' | 'every-friday' | 'monthly' | 'revenue-day' | 'never'

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

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

transferReferencestring nullable

The transfer reference set to be included in all the transfers for this balance.

Example response

{
  "resource": "balance",
  "id": "bal_gVMhHKqSSRYJyPsuoPNFH",
  "mode": "live",
  "createdAt": "2024-03-20T09:13:37+00:00",
  "currency": "EUR",
  "description": "Balance description",
  "status": "active",
  "transferFrequency": "daily",
  "transferThreshold": {
    "currency": "EUR",
    "value": "10.00"
  },
  "transferReference": "RF12-3456-7890-1234",
  "transferDestination": {
    "type": "bank-account",
    "beneficiaryName": "John Doe"
  },
  "availableAmount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "pendingAmount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes