MOmollie
Balances API

Get primary balance

Retrieve the primary balance. This is the balance of your account's primary currency, where all payments are settled to by default.

This endpoint is a convenient alias of the Get balance endpoint.

🔑 Access with

Advanced access token with balances.read

OAuth access with balances.read

get/balances/primary

Request

  • Base URL
    https://api.mollie.com/v2
  • URL
    https://api.mollie.com/v2/balances/primary
  • 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

Response

The primary balance object.

resourcestring required

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

idstring required

The identifier uniquely referring to this balance.

modestring required

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

Possible values: live test

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

The balance's ISO 4217 currency code.

descriptionstring required

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

statusstring required

The status of the balance.

Possible values: active inactive

transferFrequencystring

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.

Possible values: every-day daily every-monday every-tuesday every-wednesday every-thursday every-friday monthly revenue-day never

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

No recorded changes to this operation across all 1 revision of this API.