Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Loans

Pause loan

Pause a loan.

post/loans/{id}/pause

Path parameters

idstring uuid required

The ID of the loan.

Response

200

idstring uuid required

The ID of the loan.

objectstring required

Type of the object, loan.

status'approved' | 'ready_for_disbursement' | 'pending_disbursement' | 'active' | 'paused' | 'closed' required

The status of the loan.

amountinteger required

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

currencystring required

The ISO 4217 currency code of the loan.

credit_arrangement_idstring uuid

The ID of the credit arrangement the loan must be attached to. Must be the ID of an active credit arrangement.

cbs_credit_arrangement_idstring

The ID of the credit arrangement in Mambu Core the loan refers to. Must be left empty if credit_arrangement_id is provided.

cbs_source'mambu' required

The source of the loan. Only mambu is supported.

cbs_account_type'loan' required

Always loan.

cbs_account_idstring required

The loan 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 loan.

Example response

{
  "id": "23c782f4-c069-4bf5-a426-df3ef9b894fa",
  "object": "loan",
  "amount": 3000,
  "currency": "EUR",
  "credit_arrangement_id": "af648dd4-3c9d-404e-8b9f-dd94db88f24a",
  "cbs_source": "mambu",
  "cbs_account_type": "loan",
  "cbs_account_id": "322fd8b9-9a00-45b9-93c2-4e1be2945494",
  "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"
  },
  "repayment_details": {
    "direct_debit": {
      "direct_debit_mandate_id": "fcee1c3e-1c16-44c7-a248-81784be8ed50"
    },
    "credit_transfer": {
      "receiving_account_id": "d1c80f6f-8ddd-4b49-9b7e-92d0b8bf88a1"
    }
  },
  "metadata": {
    "property_a": true,
    "property_b": "some label"
  },
  "created_at": "2026-02-02T15:03:31.052019Z"
}