Get primary balance report

Balances API v2

GEThttps://api.mollie.com/v2/balances/primary/report

Authentication:Organization access tokensApp access tokens

With the Get primary balance report endpoint you can retrieve a summarized report for all movements on your primary balance within a given timeframe.

The API also provides a detailed report on all Mollie ‘fee-prepayments’ that were deducted from your primary balance during the reported period ahead of your Mollie invoice.

This endpoint is an alias of the Get balance report.

Parameters

fromdate

The start date of the report, in YYYY-MM-DD format. The from date is ‘inclusive’, and in Central European Time. This means a report with for example from: 2020-01-01 will include movements of 2020-01-01 0:00:00 CET and onwards.

untildate

The end date of the report, in YYYY-MM-DD format. The until date is ‘exclusive’, and in Central European Time. This means a report with for example until: 2020-02-01 will include movements up until 2020-01-31 23:59:59 CET.

groupingstringoptional

You can retrieve reports in two different formats. With the status-balances format, transactions are grouped by status (e.g. pending, available), then by transaction type, and then by other sub-groupings where available (e.g. payment method).

With the transaction-categories format, transactions are grouped by transaction type, then by status, and then again by other sub-groupings where available.

Possible values: status-balances transaction-categories

Response

200 application/hal+json

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

_linksobject

Links to help navigate through the API. Every URL object will contain an href and a type field.

Show child parameters

selfURL object

The URL to the current balance report.

documentationURL object

The URL to the balance reporting endpoint documentation.

Example

Request

curl -X GET https://api.mollie.com/v2/balances/primary/report?from=2021-01-01&until=2021-02-01&grouping=transaction-categories \
    -H 'Authorization: Bearer access_vR6naacwfSpfaT5CUwNTdV5KsVPJTNjURkgBPdvW'

$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_vR6naacwfSpfaT5CUwNTdV5KsVPJTNjURkgBPdvW");
$report = $mollie->balanceReports->getPrimary(
   [
      "from" => "2021-01-01",
      "until" => "2021-02-01",
      "grouping" => "transaction-categories",
   ]
);

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "resource": "balance-report",
    "balanceId": "bal_gVMhHKqSSRYJyPsuoPNFH",
    "timeZone": "Europe/Amsterdam",
    "from": "2021-01-01",
    "until": "2021-01-31",
    "grouping": "transaction-categories",
    "totals": {
        "open": {
            "available": {
                "amount": {
                    "currency": "EUR",
                    "value": "0.00"
                }
            },
            "pending": {
                "amount": {
                    "currency": "EUR",
                    "value": "0.00"
                }
            }
        },
        "payments": {
            "immediatelyAvailable": {
                "amount": {
                    "currency": "EUR",
                    "value": "0.00"
                }
            },
            "pending": {
                "amount": {
                    "currency": "EUR",
                    "value": "4.98"
                },
                "subtotals": [
                    {
                        "transactionType": "payment",
                        "count": 1,
                        "amount": {
                            "currency": "EUR",
                            "value": "4.98"
                        },
                        "subtotals": [
                            {
                                "amount": {
                                "currency": "EUR",
                                    "value": "4.98"
                                },
                                "count": 1,
                                "method": "ideal"
                            }
                        ]
                    }
                ]
            },
            "movedToAvailable": {
                "amount": {
                    "currency": "EUR",
                    "value": "0.00"
                }
            }
        },
        "refunds": {
            "..."
        },
        "chargebacks": {
            "..."
        },
        "capital": {
            "..."
        },
        "transfers": {
            "..."
        },
        "fee-prepayments": {
            "immediatelyAvailable": {
                "amount": {
                    "currency": "EUR",
                    "value": "0.00"
                }
            },
            "movedToAvailable": {
                "amount": {
                    "currency": "EUR",
                    "value": "-0.36"
                },
                "subtotals": [
                    {
                        "amount": {
                            "currency": "EUR",
                            "value": "-0.29"
                        },
                        "count": 1,
                        "prepaymentPartType": "fee",
                        "subtotals": [
                            {
                                "amount": {
                                    "currency": "EUR",
                                    "value": "-0.29"
                                },
                                "count": 1,
                                "feeType": "payment-fee",
                                "subtotals": [
                                    {
                                        "amount": {
                                            "currency": "EUR",
                                            "value": "-0.29"
                                        },
                                        "count": 1,
                                        "method": "ideal"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "amount": {
                            "currency": "EUR",
                            "value": "-0.0609"
                        },
                        "prepaymentPartType": "fee-vat"
                    },
                    {
                        "amount": {
                            "currency": "EUR",
                            "value": "-0.0091"
                        },
                        "prepaymentPartType": "fee-rounding-compensation"
                    }
                ]
            },
            "pending": {
                "amount": {
                    "currency": "EUR",
                    "value": "-0.36"
                },
                "subtotals": [
                    {
                        "amount": {
                            "currency": "EUR",
                            "value": "-0.29"
                        },
                        "count": 1,
                        "prepaymentPartType": "fee",
                        "subtotals": [
                            {
                                "amount": {
                                    "currency": "EUR",
                                    "value": "-0.29"
                                },
                                "count": 1,
                                "feeType": "payment-fee",
                                "subtotals": [
                                    {
                                        "amount": {
                                            "currency": "EUR",
                                            "value": "-0.29"
                                        },
                                        "count": 1,
                                        "method": "ideal"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "amount": {
                            "currency": "EUR",
                            "value": "-0.0609"
                        },
                        "prepaymentPartType": "fee-vat"
                    },
                    {
                        "amount": {
                            "currency": "EUR",
                            "value": "-0.0091"
                        },
                        "prepaymentPartType": "fee-rounding-compensation"
                    }
                ]
            }
        },
        "corrections": {
            "..."
        },
        "close": {
            "available": {
                "amount": {
                    "currency": "EUR",
                    "value": "0.00"
                }
            },
            "pending": {
                "amount": {
                    "currency": "EUR",
                    "value": "4.32"
                }
            }
        }
    },
    "_links": {
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/balances-api/get-primary-balance-report",
            "type": "text/html"
        },
        "self": {
            "href": "https://api.mollie.com/v2/balances/primary/report?from=2021-01-01&until=2021-02-01&grouping=transaction-categories",
            "type": "application/hal+json"
        }
    }
}