Use loans to represent the loan accounts of your customers managed in Mambu Core. They can be either:
- Stand-alone
- Attached to a credit arrangement (see Credit arrangement object)
| Attribute | Description |
|---|---|
object | Always "loan". |
id | The loan ID. |
amount | The loan amount. |
currency | The loan currency. |
status | The loan status. See Loan lifecycle. |
cbs_source | The source of the loan. Only "mambu" is supported. |
cbs_account_type | Always "loan". |
cbs_account_id | The loan ID in Mambu Core. |
credit_arrangement_id | The ID of the credit arrangement the loan is attached to. See Credit arrangement object. |
disbursement_details | Relevant information about the disbursement of the loan. Empty if the loan is attached to a credit arrangement. |
> connected_account_id | The ID of the connected account used to disburse the loan. See Connected account object. |
> receiving_account_id | The ID of the external account receiving the disbursement. See External account object. |
> related_payment_ids | The ID of the payment orders initiated to disburse the loan. See Payment order object. |
repayment_details | Relevant information about the repayment of the loan. Empty if the loan is attached to a credit arrangement. |
> direct_debit_mandate | Relevant information about the repayment via direct debit. |
>> direct_debit_mandate_id | The ID of the direct debit mandate used to initiate direct debit collections for the loan. See Direct debit mandate object. |
>> previous_direct_debit_mandate_ids | The list of IDs of previously attached direct debit mandate. |
>> related_payment_ids | The ID of the payment orders initiated to repay the loan. See Payment order object. |
> credit_transfer | Relevant information about the repayment via credit transfer. |
>> receiving_account_id | The ID of the internal account used to receive repayment as credit transfer. See Internal account object. |
metadata | Additional data in JSON key:value format. See Metadata. |
custom_fields | Custom fields in JSON key:value format. See Custom fields. |
{
"object": "loan",
"id": "some ID",
"status": "active",
"amount": 1000,
"currency": "EUR",
"cbs_source": "mambu",
"cbs_account_type": "loan",
"cbs_account_id": "123ABC",
"credit_arrangement_id": null,
"disbursement_details": {
"connected_account_id": "93622059-70bf-46af-8a6e-55987272f377 ",
"receiving_account_id": "017e205b-2d9c-4de4-896e-e9bd9e5b0a54 ",
"related_payment_order_ids": ["017e205b-2d9c-4de4-896e-e9bd9e5b0a54 "]
},
"repayment_details": {
"direct_debit": {
"direct_debit_mandate_id": "017e205b-2d9c-4de4-896e-e9bd9e5b0a54 ",
"previous_direct_debit_mandate_ids": ["7155ea59-f242-4725-81f8-6801916bc507"]
},
"credit_transfer": {
"receiving_account_id": "2f7b8f3b-4c9c-415a-9df4-1ee5e19cd08f "
}
},
"metadata": {},
"custom_fields":{},
"created_at": "2025-01-03T11:53:19.734182Z"
}{
"object": "loan",
"id": "some ID",
"status": "active",
"amount": 1000,
"currency": "EUR",
"cbs_source": "mambu",
"cbs_account_type": "loan",
"cbs_account_id": "123ABC",
"credit_arrangement_id": "e2da0c30-249c-480e-9b69-d22790910cb4",
"disbursement_details": null,
"repayment_details": null,
"metadata": {},
"custom_fields":{},
"created_at": ""
}