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 '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
  }
}

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)

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