---
title: "Create Installments Plan"
method: POST
path: "/installments-plans"
---

# Create Installments Plan

`POST /installments-plans`

## Request body

- object
  - `name` string, required — The installment plan name (MAX 255; MIN 3)
  - `account_id` string[], required — The unique identifier(s) of the account(s) that will have the installment plan (UUID; 36 chars).
  - `merchant_reference` string, required — Identification of the installment plan (MAX 255; MIN 3)
  - `installments_plan` object[], required — Definition of installments available for each scenario
    - `installment` integer, required — The number of monthly installments shoppers can choose
    - `rate` number, float — The rate applied to the final amount of the transaction by the payment provider after using installments. The value should be entered as a multiplier, not a percentage. For example, to apply a 20% rate, enter `1.20` instead of `20`.
    - `financial_costs` object[] — Optional financial costs details for this installment option.
      - `type` string, required — The financial cost type identifier (MIN 3; MAX 255). <br/> Example: `CFT`, `TEA`, `CET`, `CAT`
      - `rate` number, float, required — The financial cost rate as a decimal number (e.g., 45.25 for 45.25%).
    - `type` 'MERCHANT_INSTALLMENTS' | 'ISSUER_INSTALLMENTS' — Installment’s type. Only available for Ecuador and Mexico. Merchant refers to payments deferred with interest, and Issuer refer to payments deferred without interest
  - `country_code` string — The issuer's country (ISO 3166-1 MAX 2; MIN 2)
  - `brand` string[] — Card’s [brand](brands) information (MAX 255; MIN 3).
  - `issuer` string — Card issuer (MAX 255; MIN 3)
  - `iin` string[] — The issuer identification number (IIN) refers to the first few digits of a payment card number issued by a financial institution (MAX 8; MIN 6)
  - `first_installment_deferral` integer — The amount of months to wait to debit the first installment (MAX: 3).
  - `amount` object — The amounts that the installment plan will be available for. If null, available for any amount.
    - `currency` string, required — The currency used to make the payment (ISO 4217 MAX 3; MIN 3)
    - `min_value` number, float — The minimum amount the installment plan will be available to use (multiple of 0.0001).
    - `max_value` number, float — The maximum amount the installment plan will be available to use (multiple of 0.0001).
  - `availability` object — The dates that the installment plan will be available for. If null then it does not have a finish date
    - `start_at` string, date-time — The start date that the installment plan will be available to use (UTC format)
    - `finish_at` string, date-time — The end date until the installment plan will be available to use (UTC format)
  - `payment_method_type` 'CARD' | 'NU_PAY_ENROLLMENT' — Allows specifying the payment method type when creating an installment plan.

## Response `200`

200

- object
  - `id` string
  - `name` string
  - `account_id` string[]
  - `merchant_reference` string
  - `installments_plan` object[]
    - `installment` integer
    - `rate` integer
    - `provider_id` string
    - `financial_costs` object[]
      - `type` 'CFT' | 'TEA' | 'CET' | 'CAT'
      - `rate` number, float
      - `formatted_value` string
  - `type` string
  - `source` string
  - `provider_id` string
  - `scheme` string
  - `brand` string[]
  - `issuer` string
  - `issuer_id` string
  - `iin` unknown
  - `country_code` string
  - `first_installment_deferral` integer
  - `amount` object
    - `Currency` string
    - `min_value` integer
    - `max_value` integer
  - `availability` object
    - `start_at` string
    - `finish_at` string
  - `created_at` string
  - `updated_at` string
  - `payment_method_type` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/y/apis/ai-caller.md) · [All operations](https://skmtc.net/y/apis/ai-caller/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/y/ai-caller/versions/05b629819b49/schema)