Get primary balance

Balances API v2BETA
GEThttps://api.mollie.com/v2/balances/primary

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 an alias of the Get balance. Refer to the documentation of that endpoint for more information.

Response

200 application/hal+json

For the full list of fields, see Get balance. Only _links is listed here.

_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/primary \
    -H 'Authorization: Bearer access_vR6naacwfSpfaT5CUwNTdV5KsVPJTNjURkgBPdvW'
1
2
3
4
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_vR6naacwfSpfaT5CUwNTdV5KsVPJTNjURkgBPdvW");
$balance = $mollie->balances->getPrimary();
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-primary-balance",
      "type": "text/html"
    }
  }
}