---
title: "List credit arrangements"
method: GET
path: "/credit_arrangements"
tags: ["Credit arrangements"]
---

# List credit arrangements

`GET /credit_arrangements`

List and filter credit arrangements.

## Query parameters

- `limit` integer
- `starting_after` string, uuid
- `sort_order` 'asc' | 'desc'
- `start_date` string, date
- `end_date` string, date
- `status` 'active' | 'closed'

## Response `200`

200

- CreditArrangementSearchResult
  - `records` CreditArrangementDetails[]
    - `id` string, uuid, required — The ID of the credit arrangement.
    - `object` string, required — Type of the object, `credit_arrangement`.
    - `status` 'active' | 'closed', required — The status of the credit arrangement.
    - `amount` integer, 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`.
    - `currency` string, required — The ISO 4217 currency code of the credit arrangement.
    - `loan_ids` string[] — 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_id` string, required — The credit arrangement ID in Mambu Core.
    - `disbursement_details` object
      - `connected_account_id` string, uuid — The ID of the connected account used to disburse the credit arrangement. Must be the ID of an enabled connected account.
      - `internal_account_id` string, uuid — The ID of the internal account used to disburse the credit arrangement (optional). Must be the ID of an active internal account.
      - `receiving_account_id` string, uuid — The ID of the external account receiving the disbursement. Must be the ID of an approved external account.
      - `cbs_booking_account` CreditArrangementCbsBookingAccountDetails — Account in Mambu Core where the disbursement should be booked when executed in Mambu Payment.
        - `source` 'mambu' — Only `mambu` is supported.
        - `type` 'deposit' — Always `deposit`.
        - `id` string — The account ID in Mambu Core.
      - `related_payment_order_ids` string[] — The ID of the payment orders initiated to disburse the credit arrangement. See [Payment order object](https://docs.numeral.io/reference/payment-order-object).
    - `repayment_details` object — Must be left empty if `credit_arrangement_id` is provided.
      - `direct_debit` CreditArrangementRepaymentDetailsDirectDebit
        - `direct_debit_mandate_id` string, uuid — 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.
      - `credit_transfer` CreditArrangementRepaymentDetailsCreditTransfer
        - `receiving_account_id` string, uuid — The ID of the internal account used to receive repayment as credit transfer. Must be the ID of an active internal account.
      - `cbs_booking_account` CreditArrangementCbsBookingAccountDetails — Account in Mambu Core where the disbursement should be booked when executed in Mambu Payment.
        - `source` 'mambu' — Only `mambu` is supported.
        - `type` 'deposit' — Always `deposit`.
        - `id` string — The account ID in Mambu Core.
    - `metadata` object — Additional client data in JSON format. See [Metadata](https://docs.numeral.io/reference/metadata).
    - `custom_fields` CommonCustomFields — Custom fields in JSON `key:value` format. See [Custom fields](https://docs.numeral.io/reference/custom-fields).
    - `created_at` string, date-time, required — The UTC timestamp of the creation of this credit arrangement.

## Other responses

- `400` — Validation error.

---

[API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/revisions/220f101cc2ef/schema)