Get Installment Plan

GET

installments-plans

{installments_plan_id}

Get installment plan

curl --request GET \
  --url https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id} \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>'

import requests

url = "https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id}"

headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'public-api-key': '<api-key>', 'private-secret-key': '<api-key>'}
};

fetch('https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "private-secret-key: <api-key>",
    "public-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id}")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
  }
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "amount must be greater than 0",
    "country must not be blank"
  ]
}

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)

Path Parameters

installments_plan_id

string<uuid>

required

The unique identifier of the installment plan

Response

Installment plan details

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[]

Show child attributes

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

Show child attributes

Get installment plan

curl --request GET \
  --url https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id} \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>'

import requests

url = "https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id}"

headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'public-api-key': '<api-key>', 'private-secret-key': '<api-key>'}
};

fetch('https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "private-secret-key: <api-key>",
    "public-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id}")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/installments-plans/{installments_plan_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
  }
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "amount must be greater than 0",
    "country must not be blank"
  ]
}

Getting started

Conventions

Core

Recurring

Hosted

Marketplace

Embedded finance

Operations

Recovery

Reference data

Authorizations

Path Parameters

Response