Accounts API

Get business account

Changed on

πŸ”’ Restricted access

This API is currently only available to Mollie's authorized partners via OAuth. Direct access for individual businesses isn't available yet, but it's on our roadmap β€” check back here for updates.

Retrieve a single business account object by its account ID. This allows you to check the current status, balance, and account details.

get/v2/business-accounts/accounts/{businessAccountId}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/business-accounts/accounts/{businessAccountId}
  • Auth
    OAuth 2
    Authorization code: https://my.mollie.com/oauth2/authorize
    Token URL: https://api.mollie.com/oauth2/tokens scopes: business-accounts.read

Query parameters

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, 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 business account object.

resourcestring required

Indicates the response contains a business account object. Will always contain the string business-account for this endpoint.

idstring required
status'active' | 'blocked' | 'closed' required

The status of the business account.

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.

Example response

{
  "resource": "business-account",
  "id": "ba_nopqrstuvwxyz23456789A",
  "accountDetails": {
    "accountHolderName": "Mollie B.V.",
    "name": "Main Checking Account",
    "currency": "EUR",
    "iban": "NL95MLLE1234567890",
    "bic": "MLLENL2AXXX"
  },
  "balance": {
    "total": {
      "currency": "EUR",
      "value": "10.00"
    }
  },
  "status": "active",
  "mode": "live",
  "createdAt": "2024-03-20T09:13:37+00:00"
}

Changes