---
title: "Create an instalment"
method: POST
path: "/v1"
tags: ["Instalment Operations"]
---

# Create an instalment

`POST /v1`

This operation will create an instalment plan

## Query parameters

- `auditUser` string, required

## Request body

- CreateInstalmentRequest
  - `from` 'TRANSACTION', required — The source type for the instalment.
  - `description` string — Optional text describing the instalment request
  - `transactionId` string, biginteger, required
  - `planOptions` union, required
    - object — The `paymentPlan.type` field should be BUY_NOW_PAY_LATER.
      - `type` 'BUY_NOW_PAY_LATER' | 'INTEREST_FREE' | 'FIXED_INTEREST', required — The type of instalment plan.
      - `shift` integer, required — The number of months for which the plan is shifted. Must be in range [0..24]
    - BaseInterestOptions
      - `paymentPlan` object, required
        - `type` 'TENOR' | 'PORTION', required — Type of payment plan.
        - `value` number, required — The actual plan value, format depends on the type. Must be in range for TENOR: [2..180], and PORTION: [0.01..100 000]
    - BaseInterestOptions
      - `paymentPlan` object, required
        - `type` 'TENOR' | 'PORTION', required — Type of payment plan.
        - `value` number, required — The actual plan value, format depends on the type. Must be in range for TENOR: [2..180], and PORTION: [0.01..100 000]

## Response `201`

Successful creation of an instalment

- ResourceResponse
  - `description` string — Short description of the result of the action
  - `id` string — Will contain the ID of the resource that has been created or updated

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Instalment not found
- `409` — Instalment already exists for given transaction
- `500` — Internal server error

---

[API](https://skmtc.net/enfuce/apis/transfer-api.md) · [All operations](https://skmtc.net/enfuce/apis/transfer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/enfuce/transfer-api/revisions/dc4a41118f80/schema)