MOmollie
Balance Transfers API

Get a Connect balance transfer

Retrieve a single Connect balance transfer object by its ID.

🔑 Access with

Advanced access token with balance-transfers.read

OAuth access with balance-transfers.read

get/v2/connect/balance-transfers/{balanceTransferId}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/connect/balance-transfers/{balanceTransferId}
  • 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

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

The Connect balance transfer object.

resourcestring required

Indicates the response contains a balance transfer object. Will always contain the string connect-balance-transfer for this endpoint.

idstring required

The identifier uniquely referring to this balance transfer. Mollie assigns this identifier at balance transfer creation time. Mollie will always refer to the balance transfer by this ID. Example: cbtr_j8NvRAM2WNZtsykpLEX8J.

descriptionstring required

The transfer description for initiating party.

statusstring required

The status of the transfer.

Possible values: created failed succeeded

categorystring

The type of the transfer. Different fees may apply to different types of transfers.

Possible values: invoice_collection purchase chargeback refund service_penalty discount_compensation manual_correction other_fee

metadataobject

A JSON object that you can attach to a balance transfer. This can be useful for storing additional information about the transfer in a structured format. Maximum size is approximately 1KB.

createdAtstring required

The entity's date and time of creation, in ISO 8601 format.

executedAtstring nullable

The date and time when the transfer was completed, in ISO 8601 format. This parameter is omitted if the transfer is not executed (yet).

testmodeboolean

Whether to create the entity in test mode or live mode.

You can enable test mode by setting testmode to true.

modestring required

Whether this entity was created in live mode or in test mode.

Possible values: live test

Example response

{
  "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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.