Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Credit arrangements

Disburse credit arrangement

Initiate a payment order using the credit arrangement’s disbursement details. The payment order will have an amount equal to the sum of amounts of all loans in status approved attached to the credit arrangement. All attached loans in status approved will switch to pending_disbursement. When the payment order reaches a defined status, a deposit transaction will be booked in the CBS booking account defined in credit arrangement and all attached loans will switch to status active.

post/credit_arrangements/{id}/disburse

Path parameters

idstring uuid required

The ID of the credit arrangement to disburse. Credit arrangement must have at least 1 attached loan in status approved.

Request body

referencestring required

The reference of the payment order.

requested_execution_datestring date

The date on which the payment order should be executed.

Response

200

idstring uuid required

The ID of the credit arrangement.

objectstring required

Type of the object, credit_arrangement.

status'active' | 'closed' required

The status of the credit arrangement.

amountinteger required

The absolute amount of the credit arrangement, in the specified currency's smallest units. For euro credit arrangements, the smallest unit is cents. €20 is represented as 2000.

currencystring required

The ISO 4217 currency code of the credit arrangement.

loan_idsstring[]

The ID of the loans attached to the credit arrangement.

cbs_source'mambu' required

The source of the credit arrangement. Only mambu is supported.

cbs_account_type'credit_arrangement' required

Always credit_arrangement.

cbs_account_idstring required

The credit arrangement ID in Mambu Core.

metadataobject

Additional client data in JSON format. See Metadata.

custom_fieldsCommonCustomFields

Custom fields in JSON key:value format. See Custom fields.

created_atstring date-time required

The UTC timestamp of the creation of this credit arrangement.

Example response

{
  "id": "23c782f4-c069-4bf5-a426-df3ef9b894fa",
  "object": "credit_arrangement",
  "amount": 3000,
  "currency": "EUR",
  "cbs_source": "mambu",
  "cbs_account_type": "credit_arrangement",
  "cbs_account_id": "6810c913-7d72-4a0e-bced-e5591f2e66fa",
  "disbursement_details": {
    "connected_account_id": "0959a2b4-dc68-4681-a223-c109af60bc20",
    "internal_account_id": "0959a2b4-dc68-4681-a223-c109af60bc20",
    "receiving_account_id": "553eb3db-5acb-48ce-954f-f58551df2de6",
    "cbs_booking_account": {
      "source": "mambu",
      "type": "deposit",
      "id": "838f3022-538a-4597-ace4-4c10f755b73a"
    }
  },
  "repayment_details": {
    "direct_debit": {
      "direct_debit_mandate_id": "fcee1c3e-1c16-44c7-a248-81784be8ed50"
    },
    "credit_transfer": {
      "receiving_account_id": "d1c80f6f-8ddd-4b49-9b7e-92d0b8bf88a1"
    },
    "cbs_booking_account": {
      "source": "mambu",
      "type": "deposit",
      "id": "838f3022-538a-4597-ace4-4c10f755b73a"
    }
  },
  "metadata": {
    "property_a": true,
    "property_b": "some label"
  },
  "created_at": "2026-02-02T15:03:31.052019Z"
}