{"openapi":"3.1.0","info":{"title":"Lending","description":"Automate payments across banks with a single API","version":"1","contact":{"name":"API Support","email":"dev@numeral.io"}},"tags":[{"name":"Credit arrangements","description":"Credit arrangements endpoints"},{"name":"Loans","description":"Loans endpoints"}],"servers":[{"url":"https://sandbox.numeral.io/v1"}],"components":{"securitySchemes":{"sec0":{"type":"apiKey","in":"header","name":"x-api-key"}},"parameters":{"list.common_parameters.sort_order":{"name":"sort_order","in":"query","description":"Order is based on attribute `created_at`. If `asc`, results are fetched in chronological order. If `desc`, results are fetched in reversed chronological order. Default order is `desc`.\n","schema":{"type":"string","enum":["asc","desc"]}}},"responses":{"errors.400.validation":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"errors.404.not_found":{"description":"The specified resource was not found."},"errors.409.conflict":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"errors.415.unsupported_media_type":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"errors.500.internal_server_error":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"error":{"type":"object","properties":{"error":{"type":"string","example":"validation_error"},"message":{"type":"string","example":"validation errors occurred while processing request"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"reason":{"type":"string"}}}},"correlation_id":{"type":"string","format":"uuid"}}},"common.metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"common.custom_fields":{"type":"object","description":"Custom fields in JSON `key:value` format. See [Custom fields](ref:custom-fields)."},"credit_arrangement.cbs_booking_account_details":{"type":"object","description":"Account in Mambu Core where the disbursement should be booked when executed in Mambu Payment.","properties":{"source":{"type":"string","description":"Only `mambu` is supported.","enum":["mambu"],"example":"mambu"},"type":{"description":"Always `deposit`.","enum":["deposit"],"example":"deposit"},"id":{"type":"string","description":"The account ID in Mambu Core.","example":"838f3022-538a-4597-ace4-4c10f755b73a"}}},"credit_arrangement.disbursement_details_connected_account_id":{"type":"string","format":"uuid","description":"The ID of the connected account used to disburse the credit arrangement. Must be the ID of an enabled connected account.","example":"0959a2b4-dc68-4681-a223-c109af60bc20"},"credit_arrangement.disbursement_details_internal_account_id":{"type":"string","format":"uuid","description":"The ID of the internal account used to disburse the credit arrangement (optional). Must be the ID of an active internal account.","example":"0959a2b4-dc68-4681-a223-c109af60bc20"},"credit_arrangement.disbursement_details_receiving_account_id":{"type":"string","format":"uuid","description":"The ID of the external account receiving the disbursement. Must be the ID of an approved external account.","example":"553eb3db-5acb-48ce-954f-f58551df2de6"},"credit_arrangement.repayment_details_direct_debit":{"type":"object","properties":{"direct_debit_mandate_id":{"type":"string","format":"uuid","description":"The ID of the direct debit mandate used to initiate direct debit collections for the credit arrangement. Must be the ID of an active and outgoing direct debit mandate.","example":"fcee1c3e-1c16-44c7-a248-81784be8ed50"}}},"credit_arrangement.repayment_details_credit_transfer":{"type":"object","properties":{"receiving_account_id":{"type":"string","format":"uuid","description":"The ID of the internal account used to receive repayment as credit transfer. Must be the ID of an active internal account.","example":"d1c80f6f-8ddd-4b49-9b7e-92d0b8bf88a1"}}},"credit_arrangement.creation_params":{"type":"object","required":["amount","currency","cbs_source","cbs_account_type","cbs_account_id"],"properties":{"amount":{"type":"integer","description":"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`.","format":"int64","minimum":0,"example":3000},"currency":{"type":"string","description":"The ISO 4217 currency code of the credit arrangement.","example":"EUR"},"cbs_source":{"type":"string","description":"The source of the credit arrangement. Only `mambu` is supported.","enum":["mambu"],"example":"mambu"},"cbs_account_type":{"type":"string","description":"Always `credit_arrangement`.","enum":["credit_arrangement"],"example":"credit_arrangement"},"cbs_account_id":{"type":"string","description":"The credit arrangement ID in Mambu Core.","example":"6810c913-7d72-4a0e-bced-e5591f2e66fa"},"disbursement_details":{"type":"object","description":"","properties":{"connected_account_id":{"$ref":"#/components/schemas/credit_arrangement.disbursement_details_connected_account_id"},"internal_account_id":{"$ref":"#/components/schemas/credit_arrangement.disbursement_details_internal_account_id"},"receiving_account_id":{"$ref":"#/components/schemas/credit_arrangement.disbursement_details_receiving_account_id"},"cbs_booking_account":{"$ref":"#/components/schemas/credit_arrangement.cbs_booking_account_details"}}},"repayment_details":{"type":"object","description":"","properties":{"direct_debit":{"$ref":"#/components/schemas/credit_arrangement.repayment_details_direct_debit"},"credit_transfer":{"$ref":"#/components/schemas/credit_arrangement.repayment_details_credit_transfer"},"cbs_booking_account":{"$ref":"#/components/schemas/credit_arrangement.cbs_booking_account_details"}}},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"}}},"credit_arrangement.update_params":{"type":"object","properties":{"disbursement_details":{"type":"object","description":"","properties":{"connected_account_id":{"$ref":"#/components/schemas/credit_arrangement.disbursement_details_connected_account_id"},"internal_account_id":{"$ref":"#/components/schemas/credit_arrangement.disbursement_details_internal_account_id"},"receiving_account_id":{"$ref":"#/components/schemas/credit_arrangement.disbursement_details_receiving_account_id"},"cbs_booking_account":{"$ref":"#/components/schemas/credit_arrangement.cbs_booking_account_details"}}},"repayment_details":{"type":"object","description":"","properties":{"direct_debit":{"$ref":"#/components/schemas/credit_arrangement.repayment_details_direct_debit"},"credit_transfer":{"$ref":"#/components/schemas/credit_arrangement.repayment_details_credit_transfer"},"cbs_booking_account":{"$ref":"#/components/schemas/credit_arrangement.cbs_booking_account_details"}}},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"}}},"credit_arrangement.disburse_params":{"type":"object","required":["reference"],"properties":{"reference":{"type":"string","description":"The reference of the payment order."},"requested_execution_date":{"type":"string","format":"date","description":"The date on which the payment order should be executed."}}},"credit_arrangement.details":{"type":"object","required":["id","object","status","amount","currency","cbs_source","cbs_account_type","cbs_account_id","created_at"],"properties":{"id":{"type":"string","format":"uuid","description":"The ID of the credit arrangement.","example":"23c782f4-c069-4bf5-a426-df3ef9b894fa"},"object":{"type":"string","description":"Type of the object, `credit_arrangement`.","example":"credit_arrangement"},"status":{"type":"string","description":"The status of the credit arrangement.","enum":["active","closed"]},"amount":{"type":"integer","description":"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`.","format":"int64","minimum":0,"example":3000},"currency":{"type":"string","description":"The ISO 4217 currency code of the credit arrangement.","example":"EUR"},"loan_ids":{"type":"array","description":"The ID of the loans attached to the credit arrangement.","items":{"type":"string","format":"uuid"}},"cbs_source":{"type":"string","description":"The source of the credit arrangement. Only `mambu` is supported.","enum":["mambu"],"example":"mambu"},"cbs_account_type":{"type":"string","description":"Always `credit_arrangement`.","enum":["credit_arrangement"],"example":"credit_arrangement"},"cbs_account_id":{"type":"string","description":"The credit arrangement ID in Mambu Core.","example":"6810c913-7d72-4a0e-bced-e5591f2e66fa"},"disbursement_details":{"type":"object","description":"","properties":{"connected_account_id":{"$ref":"#/components/schemas/credit_arrangement.disbursement_details_connected_account_id"},"internal_account_id":{"$ref":"#/components/schemas/credit_arrangement.disbursement_details_internal_account_id"},"receiving_account_id":{"$ref":"#/components/schemas/credit_arrangement.disbursement_details_receiving_account_id"},"cbs_booking_account":{"$ref":"#/components/schemas/credit_arrangement.cbs_booking_account_details"},"related_payment_order_ids":{"type":"array","description":"The ID of the payment orders initiated to disburse the credit arrangement. See [Payment order object](ref:payment-order-object).","items":{"type":"string","format":"uuid"}}}},"repayment_details":{"type":"object","description":"Must be left empty if `credit_arrangement_id` is provided.","properties":{"direct_debit":{"$ref":"#/components/schemas/credit_arrangement.repayment_details_direct_debit"},"credit_transfer":{"$ref":"#/components/schemas/credit_arrangement.repayment_details_credit_transfer"},"cbs_booking_account":{"$ref":"#/components/schemas/credit_arrangement.cbs_booking_account_details"}}},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"},"created_at":{"type":"string","format":"date-time","example":"2026-02-02T15:03:31.052019Z","description":"The UTC timestamp of the creation of this credit arrangement."}}},"credit_arrangement.search_result":{"type":"object","properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/credit_arrangement.details"}}}},"loan.disbursement_details_connected_account_id":{"type":"string","format":"uuid","description":"The ID of the connected account used to disburse the loan. Must be the ID of an enabled connected account.","example":"0959a2b4-dc68-4681-a223-c109af60bc20"},"loan.disbursement_details_internal_account_id":{"type":"string","format":"uuid","description":"The ID of the internal account used to disburse the loan (optional). Must be the ID of an active internal account.","example":"0959a2b4-dc68-4681-a223-c109af60bc20"},"loan.disbursement_details_receiving_account_id":{"type":"string","format":"uuid","description":"The ID of the external account receiving the disbursement. Must be the ID of an approved external account.","example":"553eb3db-5acb-48ce-954f-f58551df2de6"},"loan.repayment_details_direct_debit":{"type":"object","properties":{"direct_debit_mandate_id":{"type":"string","format":"uuid","description":"The ID of the direct debit mandate used to initiate direct debit collections for the loan. Must be the ID of an active and outgoing direct debit mandate.","example":"fcee1c3e-1c16-44c7-a248-81784be8ed50"}}},"loan.repayment_details_credit_transfer":{"type":"object","properties":{"receiving_account_id":{"type":"string","format":"uuid","description":"The ID of the internal account used to receive repayment as credit transfer. Must be the ID of an active internal account.","example":"d1c80f6f-8ddd-4b49-9b7e-92d0b8bf88a1"}}},"loan.creation_params":{"type":"object","required":["amount","currency","cbs_source","cbs_account_type","cbs_account_id"],"properties":{"amount":{"type":"integer","description":"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`.","format":"int64","minimum":0,"example":3000},"currency":{"type":"string","description":"The ISO 4217 currency code of the loan.","example":"EUR"},"credit_arrangement_id":{"type":"string","format":"uuid","description":"The ID of the credit arrangement the loan must be attached to. Must be the ID of an active credit arrangement.","example":"af648dd4-3c9d-404e-8b9f-dd94db88f24a"},"cbs_credit_arrangement_id":{"type":"string","description":"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":{"type":"string","description":"The source of the loan. Only `mambu` is supported.","enum":["mambu"],"example":"mambu"},"cbs_account_type":{"type":"string","description":"Always `loan`.","enum":["loan"],"example":"loan"},"cbs_account_id":{"type":"string","description":"The loan ID in Mambu Core.","example":"322fd8b9-9a00-45b9-93c2-4e1be2945494"},"disbursement_details":{"type":"object","description":"Must be left empty if `credit_arrangement_id` is provided.","properties":{"connected_account_id":{"$ref":"#/components/schemas/loan.disbursement_details_connected_account_id"},"internal_account_id":{"$ref":"#/components/schemas/loan.disbursement_details_internal_account_id"},"receiving_account_id":{"$ref":"#/components/schemas/loan.disbursement_details_receiving_account_id"}}},"repayment_details":{"type":"object","description":"Must be left empty if `credit_arrangement_id` is provided.","properties":{"direct_debit":{"$ref":"#/components/schemas/loan.repayment_details_direct_debit"},"credit_transfer":{"$ref":"#/components/schemas/loan.repayment_details_credit_transfer"}}},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"}}},"loan.update_params":{"type":"object","properties":{"disbursement_details":{"type":"object","description":"Possible only when `status` = `approved` or `ready_for_disbursement`.","properties":{"connected_account_id":{"$ref":"#/components/schemas/loan.disbursement_details_connected_account_id"},"internal_account_id":{"$ref":"#/components/schemas/loan.disbursement_details_internal_account_id"},"receiving_account_id":{"$ref":"#/components/schemas/loan.disbursement_details_receiving_account_id"}}},"repayment_details":{"type":"object","description":"","properties":{"direct_debit":{"$ref":"#/components/schemas/loan.repayment_details_direct_debit"},"credit_transfer":{"$ref":"#/components/schemas/loan.repayment_details_credit_transfer"}}},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"}}},"loan.disburse_params":{"type":"object","required":["reference"],"properties":{"reference":{"type":"string","description":"The reference of the payment order."},"requested_execution_date":{"type":"string","format":"date","description":"The date on which the payment order should be executed."}}},"loan.details":{"type":"object","required":["id","object","status","amount","currency","cbs_source","cbs_account_type","cbs_account_id","created_at"],"properties":{"id":{"type":"string","format":"uuid","description":"The ID of the loan.","example":"23c782f4-c069-4bf5-a426-df3ef9b894fa"},"object":{"type":"string","description":"Type of the object, `loan`.","example":"loan"},"status":{"type":"string","description":"The status of the loan.","enum":["approved","ready_for_disbursement","pending_disbursement","active","paused","closed"]},"amount":{"type":"integer","description":"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`.","format":"int64","minimum":0,"example":3000},"currency":{"type":"string","description":"The ISO 4217 currency code of the loan.","example":"EUR"},"credit_arrangement_id":{"type":"string","format":"uuid","description":"The ID of the credit arrangement the loan must be attached to. Must be the ID of an active credit arrangement.","example":"af648dd4-3c9d-404e-8b9f-dd94db88f24a"},"cbs_credit_arrangement_id":{"type":"string","description":"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":{"type":"string","description":"The source of the loan. Only `mambu` is supported.","enum":["mambu"],"example":"mambu"},"cbs_account_type":{"type":"string","description":"Always `loan`.","enum":["loan"],"example":"loan"},"cbs_account_id":{"type":"string","description":"The loan ID in Mambu Core.","example":"322fd8b9-9a00-45b9-93c2-4e1be2945494"},"disbursement_details":{"type":"object","description":"","properties":{"connected_account_id":{"$ref":"#/components/schemas/loan.disbursement_details_connected_account_id"},"internal_account_id":{"$ref":"#/components/schemas/loan.disbursement_details_internal_account_id"},"receiving_account_id":{"$ref":"#/components/schemas/loan.disbursement_details_receiving_account_id"},"related_payment_order_ids":{"type":"array","description":"The ID of the payment orders initiated to disburse the loan. See [Payment order object](ref:payment-order-object).","items":{"type":"string","format":"uuid"}}}},"repayment_details":{"type":"object","description":"","properties":{"direct_debit":{"$ref":"#/components/schemas/loan.repayment_details_direct_debit"},"credit_transfer":{"$ref":"#/components/schemas/loan.repayment_details_credit_transfer"}}},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"},"created_at":{"type":"string","format":"date-time","example":"2026-02-02T15:03:31.052019Z","description":"The UTC timestamp of the creation of this loan."}}},"loan.search_result":{"type":"object","properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/loan.details"}}}}}},"security":[{"sec0":[]}],"paths":{"/credit_arrangements":{"post":{"description":"Create a credit arrangement, reflecting a credit arrangement from Mambu Core.","summary":"Create credit arrangement","operationId":"create-credit-arrangement","tags":["Credit arrangements"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_arrangement.creation_params"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_arrangement.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"409":{"$ref":"#/components/responses/errors.409.conflict"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"List credit arrangements","description":"List and filter credit arrangements.","operationId":"list-credit-arrangements","tags":["Credit arrangements"],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25,"minimum":0,"maximum":100}},{"name":"starting_after","in":"query","description":"The ID of the object from which your list request will start. It is not included in the result.","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/list.common_parameters.sort_order"},{"name":"start_date","in":"query","description":"The creation date of the credit arrangement.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"The creation date of the credit arrangement.","schema":{"type":"string","format":"date"}},{"name":"status","in":"query","description":"The status of the credit arrangement.","schema":{"type":"string","enum":["active","closed"]}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_arrangement.search_result"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"}}}},"/credit_arrangements/{id}/disburse":{"post":{"summary":"Disburse credit arrangement","description":"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`.","operationId":"disburse-credit-arrangement","tags":["Credit arrangements"],"parameters":[{"name":"id","in":"path","description":"The ID of the credit arrangement to disburse. Credit arrangement must have at least 1 attached loan in status `approved`.","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_arrangement.disburse_params"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_arrangement.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"}}}},"/credit_arrangements/{id}/close":{"post":{"summary":"Close credit arrangement","description":"Close a credit arrangement.","operationId":"close-credit-arrangement","tags":["Credit arrangements"],"parameters":[{"name":"id","in":"path","description":"The ID of the credit arrangement.","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_arrangement.details"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/credit_arrangements/{id}":{"post":{"summary":"Update credit arrangement","description":"Update a credit arrangement.","operationId":"update-credit-arrangement","tags":["Credit arrangements"],"parameters":[{"name":"id","in":"path","description":"The ID of the credit arrangement.","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_arrangement.update_params"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_arrangement.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"Retrieve credit arrangement","description":"Retrieve the details of an credit arrangement.","operationId":"retrieve-credit-arrangement","tags":["Credit arrangements"],"parameters":[{"name":"id","in":"path","description":"The ID of the credit arrangement.","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_arrangement.details"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"}}}},"/loans":{"post":{"description":"Create a loan, reflecting a loan account from Mambu Core.","summary":"Create loan","operationId":"create-loan","tags":["Loans"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/loan.creation_params"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/loan.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"409":{"$ref":"#/components/responses/errors.409.conflict"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"List loans","description":"List and filter loans.","operationId":"list-loans","tags":["Loans"],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25,"minimum":0,"maximum":100}},{"name":"starting_after","in":"query","description":"The ID of the object from which your list request will start. It is not included in the result.","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/list.common_parameters.sort_order"},{"name":"start_date","in":"query","description":"The creation date of the loan.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"The creation date of the loan.","schema":{"type":"string","format":"date"}},{"name":"status","in":"query","description":"The status of the loan.","schema":{"type":"string","enum":["approved","ready_for_disbursement","pending_disbursement","active","paused","closed"]}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/loan.search_result"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"}}}},"/loans/{id}/disburse":{"post":{"summary":"Disburse loan","description":"Initiate a payment order using the loan’s disbursement details. The loan will switch to `pending_disbursement`. When the payment order reaches a defined status, the loan account in Mambu Core will be automatically disbursed and the loan will switch to status `active`.","operationId":"disburse-loan","tags":["Loans"],"parameters":[{"name":"id","in":"path","description":"The ID of the loan to disburse. Loan must be in status `ready_for_disbursement`. Loans attached to a credit arrangement cannot be disbursed individually.","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/loan.disburse_params"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/loan.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"}}}},"/loans/{id}/activate":{"post":{"summary":"Activate loan","description":"Activate a loan.","operationId":"activate-loan","tags":["Loans"],"parameters":[{"name":"id","in":"path","description":"The ID of the loan.","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/loan.details"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/loans/{id}/pause":{"post":{"summary":"Pause loan","description":"Pause a loan.","operationId":"pause-loan","tags":["Loans"],"parameters":[{"name":"id","in":"path","description":"The ID of the loan.","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/loan.details"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/loans/{id}/close":{"post":{"summary":"Close loan","description":"Close a loan.","operationId":"close-loan","tags":["Loans"],"parameters":[{"name":"id","in":"path","description":"The ID of the loan.","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/loan.details"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/loans/{id}":{"post":{"summary":"Update loan","description":"Update a loan.","operationId":"update-loan","tags":["Loans"],"parameters":[{"name":"id","in":"path","description":"The ID of the loan.","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/loan.update_params"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/loan.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"Retrieve loan","description":"Retrieve the details of an loan.","operationId":"retrieve-loan","tags":["Loans"],"parameters":[{"name":"id","in":"path","description":"The ID of the loan.","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/loan.details"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"}}}}}}