Skip to main content
POST
/
installments-plans
Create Installments 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 '
{
  "name": "plan_007",
  "account_id": [
    "{{account-code}}"
  ],
  "merchant_reference": "Test",
  "installments_plan": [
    {
      "installment": 1,
      "rate": 1
    },
    {
      "installment": 3,
      "rate": 1,
      "financial_costs": [
        {
          "type": "CFT",
          "rate": 45.25
        },
        {
          "type": "TEA",
          "rate": 38.5
        }
      ]
    },
    {
      "installment": 6,
      "rate": 1
    },
    {
      "installment": 9,
      "rate": 1
    },
    {
      "installment": 12,
      "rate": 1
    }
  ],
  "country_code": "CO",
  "amount": {
    "currency": "COP",
    "min_value": 0,
    "max_value": 100000000
  },
  "availability": {
    "start_at": "2023-09-12T00:00:00Z",
    "finish_at": "2030-09-20T00:00:00Z"
  },
  "payment_method_type": "NU_PAY_ENROLLMENT"
}
'
{
  "id": "4d573425-33f9-4c46-b009-2c7e749b0ec7",
  "name": "plan_007",
  "account_id": [
    "f7c5fe77-721b-49c2-84d3-957748df3c2c"
  ],
  "merchant_reference": "Test",
  "installments_plan": [
    {
      "installment": 1,
      "rate": 1,
      "provider_id": ""
    },
    {
      "installment": 3,
      "rate": 1,
      "provider_id": "",
      "financial_costs": [
        {
          "type": "CFT",
          "rate": 45.25,
          "formatted_value": "45,25%"
        },
        {
          "type": "TEA",
          "rate": 38.5,
          "formatted_value": "38,50%"
        }
      ]
    },
    {
      "installment": 6,
      "rate": 1,
      "provider_id": ""
    },
    {
      "installment": 9,
      "rate": 1,
      "provider_id": ""
    },
    {
      "installment": 12,
      "rate": 1,
      "provider_id": ""
    }
  ],
  "type": "",
  "source": "",
  "provider_id": "",
  "scheme": "",
  "brand": [
    "VISA"
  ],
  "issuer": "",
  "issuer_id": "",
  "iin": null,
  "country_code": "US",
  "first_installment_deferral": 0,
  "amount": {
    "Currency": "USD",
    "min_value": 0,
    "max_value": 100000000
  },
  "availability": {
    "start_at": "2023-09-12T00:00:00Z",
    "finish_at": "2030-09-20T00:00:00Z"
  },
  "payment_method_type": "NU_PAY_ENROLLMENT",
  "created_at": "2023-10-11T17:52:31.886178246Z",
  "updated_at": "2023-10-11T17:52:31.886178246Z"
}
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
default:<Your public-api-key>
required
​
private-secret-key
string
header
default:<Your private-secret-key>
required

Body

application/json
​
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

​
country_code
string

The issuer's country (ISO 3166-1 MAX 2; MIN 2)

​
brand
string[]

Card’s brand [blocked] 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<int32>

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.

​
availability
object

The dates that the installment plan will be available for. If null then it does not have a finish date

​
payment_method_type
enum<string>

Allows specifying the payment method type when creating an installment plan.

Available options:
CARD,
NU_PAY_ENROLLMENT

Response

200

​
id
string
Example:

"4d573425-33f9-4c46-b009-2c7e749b0ec7"

​
name
string
Example:

"plan_007"

​
account_id
string[]
​
merchant_reference
string
Example:

"Test"

​
installments_plan
object[]
​
type
string
Example:

""

​
source
string
Example:

""

​
provider_id
string
Example:

""

​
scheme
string
Example:

""

​
brand
string[]
​
issuer
string
Example:

""

​
issuer_id
string
Example:

""

​
iin
any
​
country_code
string
Example:

"US"

​
first_installment_deferral
integer
default:0
Example:

0

​
amount
object
​
availability
object
​
created_at
string
Example:

"2023-10-11T17:52:31.886178246Z"

​
updated_at
string
Example:

"2023-10-11T17:52:31.886178246Z"

​
payment_method_type
string
Example:

"NU_PAY_ENROLLMENT"