Skip to main content
POST
/
v1
/
installments-plans
Create installment plan
curl --request POST \
  --url https://api-sandbox.y.uno/v1/installments-plans \
  --header 'Content-Type: application/json' \
  --header 'account-code: <api-key>' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "account_id": [
    "1a3a576a-01d0-40ff-a68e-494f82145773"
  ],
  "name": "Standard Plan",
  "merchant_reference": "001 08 Agosto 2023",
  "installments_plan": [
    {
      "installment": 1,
      "rate": 1
    },
    {
      "installment": 2,
      "rate": 1.294
    },
    {
      "installment": 6,
      "rate": 1.42
    },
    {
      "installment": 12,
      "rate": 1.525
    }
  ],
  "country_code": "BR",
  "amount": {
    "Currency": "BRL",
    "min_value": 0,
    "max_value": 10000000000
  },
  "brand": null,
  "iin": null
}
'
{
  "id": "3e599453-e147-4d1c-8643-73e4d980c2ae",
  "name": "Standard Plan",
  "account_id": [
    "1a3a576a-01d0-40ff-a68e-494f82145773"
  ],
  "merchant_reference": "001 08 Agosto 2023",
  "installments_plan": [
    {
      "installment": 1,
      "rate": 1
    },
    {
      "installment": 2,
      "rate": 1.294
    },
    {
      "installment": 12,
      "rate": 1.525
    }
  ],
  "brand": null,
  "iin": null,
  "country_code": "BR",
  "first_installment_deferral": 1,
  "amount": {
    "Currency": "BRL",
    "min_value": 0,
    "max_value": 10000000000
  }
}
Yuno allows you to create installment plans to offer to your customers. These plans can be used based on factors such as the amount to pay, currency, and card used, as described below:
  • Filtered by Amount Range (mandatory): The system checks if the installment plan is suitable for the specific amount of your transaction. Only plans that can handle that amount are considered.
  • Card BIN: The system verifies if the BIN of your card matches those allowed for certain installment plans. If there’s a match, that plan is considered.
  • Specific Currency: Only plans that work with the currency you are using are considered.
  • Plan Availability: The system checks if the installment plan is active. Only plans that have not expired and are available are considered.
Defining the Plan IDThe plan_id is only necessary when applying a fixed installment plan that doesn’t change during the purchase. If the installment.plan_id is not provided, the SDK will automatically search through all available installment plans associated with that account and select the one it considers most suitable. You should include the plan_id to ensure that a specific plan is applied.
Merchants InstallmentsThis endpoint is only required for Merchant installments integration. For Provider defined installments, we use the installment plan defined by your payment provider.
For merchant-created installments, you also have the possibility of specifying the plan for every checkout session by using the plan_id while creating the session. If you do not send it, we will use the installment plan that matches the conditions set for the checkout session.

Authorizations

​
public-api-key
string
header
required

Your public API key from the Yuno Dashboard

​
private-secret-key
string
header
required

Your private secret key (server-side only)

​
account-code
string
header
required

Your account identifier. The alias X-Account-Code is also accepted.

Body

application/json
​
account_id
string<uuid>[]
required

Account IDs this plan applies to

Example:
["1a3a576a-01d0-40ff-a68e-494f82145773"]
​
name
string
required

Name of the installment plan

Example:

"Standard Plan"

​
merchant_reference
string
required

Merchant reference for the plan

Example:

"001 08 Agosto 2023"

​
installments_plan
object[]
required

Array of installment options with rates

​
country_code
string
required

ISO 3166-1 alpha-2 country code

Pattern: ^[A-Z]{2}$
Example:

"BR"

​
amount
object
required
​
brand
string | null

Card brand filter (optional)

​
iin
string | null

IIN/BIN filter (optional)

Response

Installment plan created successfully

​
id
string<uuid>

Unique installment plan identifier

Example:

"3e599453-e147-4d1c-8643-73e4d980c2ae"

​
name
string
Example:

"Standard Plan"

​
account_id
string<uuid>[]
Example:
["1a3a576a-01d0-40ff-a68e-494f82145773"]
​
merchant_reference
string
Example:

"001 08 Agosto 2023"

​
installments_plan
object[]
​
brand
string | null
​
iin
string | null
​
country_code
string
Example:

"BR"

​
first_installment_deferral
integer

Number of periods before first installment

Example:

1

​
amount
object