| Field | Type | Required | Description | Example |
|---|---|---|---|---|
resource |
String | ✔️ | Indicates the response contains a balance transfer object. Will always contain the string connect-balance-transfer for this endpoint. |
connect-balance-transfer |
id |
String | ✔️ | 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. |
cbtr_j8NvRAM2WNZtsykpLEX8J |
amount |
Amount | ✔️ | In v2 endpoints, monetary amounts are represented as objects with a currency and value field. |
|
source |
EntityBalanceTransferPartyResponse | ✔️ | A party involved in the balance transfer, either the sender or the receiver. | |
destination |
EntityBalanceTransferPartyResponse | ✔️ | A party involved in the balance transfer, either the sender or the receiver. | |
description |
String | ✔️ | The transfer description for initiating party. | Invoice fee |
status |
BalanceTransferStatus | ✔️ | The status of the transfer. | created |
statusReason |
EntityBalanceTransferResponseStatusReason | ✔️ | The reason for the current status of the transfer, if applicable. | |
category |
Optional<BalanceTransferCategoryResponse> | ➖ | The type of the transfer. Different fees may apply to different types of transfers. | invoice_collection |
metadata |
Map<String, Object> | ➖ | 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. |
{ "order_id": 12345, "customer_id": 9876 } |
createdAt |
String | ✔️ | The entity's date and time of creation, in ISO 8601 format. | 2024-03-20T09:13:37+00:00 |
executedAt |
JsonNullable<String> | ➖ | The date and time when the transfer was completed, in ISO 8601 format. This parameter is omitted if the transfer is not executed (yet). |
2024-03-20T09:28:37+00:00 |
mode |
Mode | ✔️ | Whether this entity was created in live mode or in test mode. | live |