Use credit arrangements to represent the credit arrangements of your customers managed in Mambu Core.
| Attribute | Description |
|---|---|
object | Always "credit_arrangement". |
id | The credit arrangement ID. |
amount | The credit arrangement amount. |
currency | The credit arrangement currency. |
status | The credit arrangement status. See Credit arrangement lifecycle. |
cbs_source | The source of the credit arrangement. Only "mambu" is supported. |
cbs_account_type | Always "credit_arrangement". |
cbs_account_id | The credit arrangement ID in Mambu Core. |
loan_ids | The list of loans attached to this credit arrangement. See Loan object. |
disbursement_details | Relevant information about the disbursement of the credit arrangement. |
> connected_account_id | The ID of the connected account used to disburse the credit arrangement. See Connected account object. |
> receiving_account_id | The ID of the external account receiving the disbursement. See External account object. |
> cbs_booking_account | Account in Mambu Core where the disbursement should be booked when executed in Mambu Payment. Contains source, type and id. |
> related_payment_ids | The ID of the payment orders initiated to disburse the credit arrangement. See Payment order object. |
repayment_details | Relevant information about the repayment of the 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 this credit arrangement. 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 credit arrangement. 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. |
> cbs_booking_account | Account in Mambu Core where each repayment should be booked when executed in Mambu Payment. Contains source, type and id. |
metadata | Additional data in JSON key:value format. See Metadata. |
custom_fields | Custom fields in JSON key:value format. See Custom fields. |
{
"object": "credit_arrangement",
"id": "some ID",
"amount": 10000000,
"currency": "EUR",
"status": "active",
"cbs_source": "mambu",
"cbs_account_type": "credit_arrangement",
"cbs_account_id": "123ABC",
"loan_ids": ["9775098b-adeb-4c04-b52c-e728d262602e", "613b4346-45d4-4823-b2db-41ff7fa4087b"],
"disbursement_details": {
"connected_account_id": "6f1523a5-b398-4bad-a3b5-4797a851a40f",
"receiving_account_id": "39df4230-12fb-461d-b6d0-49b1a09a6c30",
"cbs_booking_account": {
"source": "mambu",
"type": "deposit",
"id": "456DEF"
},
"related_payment_order_ids": ["f0995580-2e81-4715-915d-00ff22de2265 ", "894ad712-e2bd-4219-957a-7896a3bc3ae0 "]
},
"repayment_details": {
"direct_debit": {
"direct_debit_mandate_id": "f4dfdce0-9036-465e-99be-33810a14bafc ",
"previous_direct_debit_mandate_ids": ["9775098b-adeb-4c04-b52c-e728d262602e", "613b4346-45d4-4823-b2db-41ff7fa4087b"]
},
"cbs_booking_account": {
"source": "mambu",
"type": "deposit",
"id": "789GHI"
},
"credit_transfer": {
"receiving_account_id": "015528a4-53b3-4d31-a074-f04d6c5f415b"
}
},
"metadata": {},
"custom_fields": {}
}