---
title: "Contract List"
method: GET
path: "/api/checkout/v1/applications/"
tags: ["api"]
---

# Contract List

`GET /api/checkout/v1/applications/`

An endpoint to list the details of all applications for a given merchant. If external_contract_uuid is supplied, other filters will be ignored. If start_date or end_date are supplied, they must be supplied together. If confirmed_start_date or confirmed_end_date are supplied, they must be supplied together.

## Query parameters

- `confirmed_end_date` string, date
- `confirmed_start_date` string, date
- `end_date` string, date
- `external_contract_uuid` string, uuid
- `limit` integer
- `offset` integer
- `start_date` string, date

## Response `200`

- PaginatedMerchantApplicationDetailResponseList
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` MerchantApplicationDetailResponse[], required
    - `contract_uuid` string — External Contract UUID
    - `merchant_uuid` string — Merchant UUID (uuid4)
    - `first_name` string — Applicant first name
    - `last_name` string — Applicant last name
    - `email` string — Applicant email address
    - `phone_number` string
    - `formatted_shipping_address` object, nullable, required — Formatted shipping address
    - `order_reference` string, nullable, required — Order reference passed from the ecommerce platform
    - `status` string, required — Application Status [cancelled, pending, awaiting_confirmation, success]
    - `failure_url` string, nullable, required — Failure Redirect URL
    - `success_url` string, nullable, required — Success Redirect URL
    - `number_of_installments` string — Number of installments
    - `amount` number, double, required — Amount to be financed in decimal format
    - `currency` string, required — ISO 4217 Currency code of the amount to be financed.
    - `minor_amount` integer, required — Amount to be financed in minor format
    - `credit_type` string — Credit type - options: [BNPL factoring, regulated credit, unregulated credit]
    - `application_approved_at` string, nullable, required — Application approved at
    - `contract_confirmed_at` string, nullable, required — Contract confirmed at
    - `secondary_contract_id` string — A secondary contract id
    - `national_identification_number` string — National identification number
    - `external_product_ids` string[], required — External product ids
    - `created_at` string — Created at
    - `updated_at` string — Updated at
    - `payment_plan_reference` string — Payment plan reference
    - `refund_amount` number, double, required — Total refunded amount in decimal format (0 if no refund)

## Other responses

- `400`

---

[API](https://skmtc.net/heylight/apis/heidipay-checkout-api.md) · [All operations](https://skmtc.net/heylight/apis/heidipay-checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/heylight/heidipay-checkout-api/versions/c51570cfc888/schema)