Balances API

List balance transactions

Retrieve a list of all balance transactions. Transactions include for example payments, refunds, chargebacks, and settlements.

For an aggregated report of these balance transactions, refer to the Get balance report endpoint.

The alias primary can be used instead of the balance ID to refer to the organization's primary balance.

The results are paginated.

🔑 Access with

Advanced access token with balances.read

OAuth access with balances.read

get/balances/{balanceId}/transactions

Request

Base URL
https://api.mollie.com/v2
URL
https://api.mollie.com/v2/balances/{balanceId}/transactions
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

fromstring

Example:baltr_QM24QwzUWR4ev4Xfgyt29A

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable

Example:50

The maximum number of items to return. Defaults to 50 items.

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.

Response

A list of balance transaction objects.

countinteger required

The number of items in this result set. If more items are available, a _links.next URL will be present in the result as well.

The maximum number of items per result set is controlled by the limit property provided in the request. The default limit is 50 items.

Example response

{
  "count": 5,
  "_embedded": {
    "balance_transactions": [
      {
        "resource": "balance-transaction",
        "id": "baltr_QM24QwzUWR4ev4Xfgyt29d",
        "type": "payment",
        "resultAmount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "initialAmount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "deductions": {
          "currency": "EUR",
          "value": "10.00"
        },
        "deductionDetails": {
          "fees": {
            "currency": "EUR",
            "value": "10.00"
          },
          "commissions": {
            "currency": "EUR",
            "value": "10.00"
          },
          "repayments": {
            "currency": "EUR",
            "value": "10.00"
          },
          "reservations": {
            "currency": "EUR",
            "value": "10.00"
          }
        },
        "context": {
          "payment": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description"
          },
          "capture": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "captureId": "cpt_vytxeTZskVKR7C7WgdSP3d",
            "captureDescription": "Capture Description"
          },
          "capture-commision": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "captureId": "cpt_vytxeTZskVKR7C7WgdSP3d",
            "captureDescription": "Capture Description"
          },
          "capture-rolling-reserve-release": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "captureId": "cpt_vytxeTZskVKR7C7WgdSP3d",
            "captureDescription": "Capture Description"
          },
          "unauthorized-direct-debit": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description"
          },
          "failed-payment": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description"
          },
          "refund": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "refundId": "re_5B8cwPMGnU",
            "refundDescription": "Refund Description"
          },
          "refund-compensation": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "refundId": "re_5B8cwPMGnU",
            "refundDescription": "Refund Description"
          },
          "returned-refund": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "refundId": "re_5B8cwPMGnU",
            "refundDescription": "Refund Description"
          },
          "returned-refund-compensation": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "refundId": "re_5B8cwPMGnU",
            "refundDescription": "Refund Description"
          },
          "chargeback": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "chargebackId": "chb_xFzwUN4ci8HAmSGUACS4J",
            "chargebackDescription": "Chargeback Description"
          },
          "chargeback-reversal": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "chargebackId": "chb_xFzwUN4ci8HAmSGUACS4J",
            "chargebackDescription": "Chargeback Description"
          },
          "chargeback-compensation": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "chargebackId": "chb_xFzwUN4ci8HAmSGUACS4J",
            "chargebackDescription": "Chargeback Description"
          },
          "reversed-chargeback-compensation": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "chargebackId": "chb_xFzwUN4ci8HAmSGUACS4J",
            "chargebackDescription": "Chargeback Description"
          },
          "outgoing-transfer": {
            "transferId": "trf_nyjwa2",
            "settlementId": "stl_5B8cwPMGnU"
          },
          "canceled-outgoing-transfer": {
            "transferId": "trf_nyjwa2",
            "settlementId": "stl_5B8cwPMGnU"
          },
          "returned-transfer": {
            "transferId": "trf_nyjwa2",
            "settlementId": "stl_s3hcSM2hKP"
          },
          "invoice-compensation": {
            "invoiceId": "inv_aHbjjdrUdm"
          },
          "application-fee": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "payingOwner": "org_1234567"
          },
          "split-payment": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "paymentOnwer": "org_1234567"
          },
          "platform-payment-refund": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "refundId": "re_5B8cwPMGnU",
            "refundDescription": "Refund Description"
          },
          "returned-platform-payment-refund": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "refundId": "re_5B8cwPMGnU",
            "refundDescription": "Refund Description"
          },
          "platform-payment-chargeback": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "chargebackId": "chb_xFzwUN4ci8HAmSGUACS4J",
            "chargebackDescription": "Chargeback Description"
          },
          "reversed-platform-payment-chargeback": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "chargebackId": "chb_xFzwUN4ci8HAmSGUACS4J",
            "chargebackDescription": "Chargeback Description"
          },
          "payment-commission": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description",
            "organizationId": "org_1234567"
          },
          "reimbursement-fee": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description"
          },
          "failed-payment-fee": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description"
          },
          "payment-fee": {
            "paymentId": "tr_5B8cwPMGnU",
            "paymentDescription": "Payment Description"
          },
          "managed-fee": {
            "feeType": "feeType",
            "feeId": "feeId"
          },
          "returned-managed-fee": {
            "feeType": "feeType",
            "feeId": "feeId"
          },
          "post-payment-split-payment": {
            "paymentId": "tr_5B8cwPMGnU"
          }
        },
        "createdAt": "2024-03-20T09:13:37+00:00"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "previous": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "next": {
      "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.