MOmollie
Balance Transfers API

List all Connect balance transfers

Returns a paginated list of balance transfers associated with your organization. These may be a balance transfer that was received or sent from your balance, or a balance transfer that you initiated on behalf of your clients. If no balance transfers are available, the resulting array will be empty. This request should never throw an error.

🔑 Access with

Advanced access token with balance-transfers.read

OAuth access with balance-transfers.read

get/v2/connect/balance-transfers

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/connect/balance-transfers
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: balance-transfers.read

Query parameters

fromstring
Example:cbtr_j8NvRAM2WNZtsykpLEX8J

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.

sortstring
Example:desc

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

Possible values: asc desc

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 Connect balance transfers. For a complete reference of the Connect balance transfer object, refer to the Get balance transfer endpoint documentation.

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": {
    "connect_balance_transfers": [
      {
        "resource": "connect-balance-transfer",
        "id": "cbtr_j8NvRAM2WNZtsykpLEX8J",
        "amount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "source": {
          "type": "organization",
          "id": "org_1234567",
          "description": "Invoice fee"
        },
        "destination": {
          "type": "organization",
          "id": "org_1234567",
          "description": "Invoice fee"
        },
        "description": "Invoice fee",
        "status": "created",
        "statusReason": {
          "code": "insufficient_funds",
          "message": "Insufficient funds in the source balance."
        },
        "category": "invoice_collection",
        "metadata": {
          "order_id": 12345,
          "customer_id": 9876
        },
        "createdAt": "2024-03-20T09:13:37+00:00",
        "executedAt": "2024-03-20T09:28:37+00:00",
        "mode": "live"
      }
    ]
  },
  "_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.