Pular para o conteúdo principal
POST
/
v1
/
boletos
/
installments
Emitir boletos parcelados
curl --request POST \
  --url https://payments.sandbox.lerian.net/v1/boletos/installments \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "discount": {
    "amount": "<string>",
    "limitDate": "<string>",
    "type": "<string>"
  },
  "fine": {
    "amount": "<string>",
    "type": "<string>"
  },
  "firstDueDate": "<string>",
  "guarantor": {
    "address": {
      "city": "<string>",
      "complement": "<string>",
      "neighborhood": "<string>",
      "number": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zipCode": "<string>"
    },
    "document": "<string>",
    "name": "<string>"
  },
  "installmentAmounts": [
    "<string>"
  ],
  "installments": 123,
  "interest": {
    "amount": "<string>",
    "type": "<string>"
  },
  "intervalDays": 123,
  "midazAccountId": "<string>",
  "payer": {
    "address": {
      "city": "<string>",
      "complement": "<string>",
      "neighborhood": "<string>",
      "number": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zipCode": "<string>"
    },
    "document": "<string>",
    "name": "<string>"
  },
  "totalAmount": "<string>",
  "type": "<string>"
}
'
import requests

url = "https://payments.sandbox.lerian.net/v1/boletos/installments"

payload = {
    "discount": {
        "amount": "<string>",
        "limitDate": "<string>",
        "type": "<string>"
    },
    "fine": {
        "amount": "<string>",
        "type": "<string>"
    },
    "firstDueDate": "<string>",
    "guarantor": {
        "address": {
            "city": "<string>",
            "complement": "<string>",
            "neighborhood": "<string>",
            "number": "<string>",
            "state": "<string>",
            "street": "<string>",
            "zipCode": "<string>"
        },
        "document": "<string>",
        "name": "<string>"
    },
    "installmentAmounts": ["<string>"],
    "installments": 123,
    "interest": {
        "amount": "<string>",
        "type": "<string>"
    },
    "intervalDays": 123,
    "midazAccountId": "<string>",
    "payer": {
        "address": {
            "city": "<string>",
            "complement": "<string>",
            "neighborhood": "<string>",
            "number": "<string>",
            "state": "<string>",
            "street": "<string>",
            "zipCode": "<string>"
        },
        "document": "<string>",
        "name": "<string>"
    },
    "totalAmount": "<string>",
    "type": "<string>"
}
headers = {
    "X-Organization-Id": "<x-organization-id>",
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'X-Organization-Id': '<x-organization-id>',
    'Idempotency-Key': '<idempotency-key>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    discount: {amount: '<string>', limitDate: '<string>', type: '<string>'},
    fine: {amount: '<string>', type: '<string>'},
    firstDueDate: '<string>',
    guarantor: {
      address: {
        city: '<string>',
        complement: '<string>',
        neighborhood: '<string>',
        number: '<string>',
        state: '<string>',
        street: '<string>',
        zipCode: '<string>'
      },
      document: '<string>',
      name: '<string>'
    },
    installmentAmounts: ['<string>'],
    installments: 123,
    interest: {amount: '<string>', type: '<string>'},
    intervalDays: 123,
    midazAccountId: '<string>',
    payer: {
      address: {
        city: '<string>',
        complement: '<string>',
        neighborhood: '<string>',
        number: '<string>',
        state: '<string>',
        street: '<string>',
        zipCode: '<string>'
      },
      document: '<string>',
      name: '<string>'
    },
    totalAmount: '<string>',
    type: '<string>'
  })
};

fetch('https://payments.sandbox.lerian.net/v1/boletos/installments', 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://payments.sandbox.lerian.net/v1/boletos/installments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'discount' => [
        'amount' => '<string>',
        'limitDate' => '<string>',
        'type' => '<string>'
    ],
    'fine' => [
        'amount' => '<string>',
        'type' => '<string>'
    ],
    'firstDueDate' => '<string>',
    'guarantor' => [
        'address' => [
                'city' => '<string>',
                'complement' => '<string>',
                'neighborhood' => '<string>',
                'number' => '<string>',
                'state' => '<string>',
                'street' => '<string>',
                'zipCode' => '<string>'
        ],
        'document' => '<string>',
        'name' => '<string>'
    ],
    'installmentAmounts' => [
        '<string>'
    ],
    'installments' => 123,
    'interest' => [
        'amount' => '<string>',
        'type' => '<string>'
    ],
    'intervalDays' => 123,
    'midazAccountId' => '<string>',
    'payer' => [
        'address' => [
                'city' => '<string>',
                'complement' => '<string>',
                'neighborhood' => '<string>',
                'number' => '<string>',
                'state' => '<string>',
                'street' => '<string>',
                'zipCode' => '<string>'
        ],
        'document' => '<string>',
        'name' => '<string>'
    ],
    'totalAmount' => '<string>',
    'type' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-Organization-Id: <x-organization-id>"
  ],
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://payments.sandbox.lerian.net/v1/boletos/installments"

	payload := strings.NewReader("{\n  \"discount\": {\n    \"amount\": \"<string>\",\n    \"limitDate\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"fine\": {\n    \"amount\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"firstDueDate\": \"<string>\",\n  \"guarantor\": {\n    \"address\": {\n      \"city\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"number\": \"<string>\",\n      \"state\": \"<string>\",\n      \"street\": \"<string>\",\n      \"zipCode\": \"<string>\"\n    },\n    \"document\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"installmentAmounts\": [\n    \"<string>\"\n  ],\n  \"installments\": 123,\n  \"interest\": {\n    \"amount\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"intervalDays\": 123,\n  \"midazAccountId\": \"<string>\",\n  \"payer\": {\n    \"address\": {\n      \"city\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"number\": \"<string>\",\n      \"state\": \"<string>\",\n      \"street\": \"<string>\",\n      \"zipCode\": \"<string>\"\n    },\n    \"document\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"totalAmount\": \"<string>\",\n  \"type\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Organization-Id", "<x-organization-id>")
	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://payments.sandbox.lerian.net/v1/boletos/installments")
  .header("X-Organization-Id", "<x-organization-id>")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"discount\": {\n    \"amount\": \"<string>\",\n    \"limitDate\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"fine\": {\n    \"amount\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"firstDueDate\": \"<string>\",\n  \"guarantor\": {\n    \"address\": {\n      \"city\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"number\": \"<string>\",\n      \"state\": \"<string>\",\n      \"street\": \"<string>\",\n      \"zipCode\": \"<string>\"\n    },\n    \"document\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"installmentAmounts\": [\n    \"<string>\"\n  ],\n  \"installments\": 123,\n  \"interest\": {\n    \"amount\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"intervalDays\": 123,\n  \"midazAccountId\": \"<string>\",\n  \"payer\": {\n    \"address\": {\n      \"city\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"number\": \"<string>\",\n      \"state\": \"<string>\",\n      \"street\": \"<string>\",\n      \"zipCode\": \"<string>\"\n    },\n    \"document\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"totalAmount\": \"<string>\",\n  \"type\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://payments.sandbox.lerian.net/v1/boletos/installments")

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

request = Net::HTTP::Post.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"discount\": {\n    \"amount\": \"<string>\",\n    \"limitDate\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"fine\": {\n    \"amount\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"firstDueDate\": \"<string>\",\n  \"guarantor\": {\n    \"address\": {\n      \"city\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"number\": \"<string>\",\n      \"state\": \"<string>\",\n      \"street\": \"<string>\",\n      \"zipCode\": \"<string>\"\n    },\n    \"document\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"installmentAmounts\": [\n    \"<string>\"\n  ],\n  \"installments\": 123,\n  \"interest\": {\n    \"amount\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"intervalDays\": 123,\n  \"midazAccountId\": \"<string>\",\n  \"payer\": {\n    \"address\": {\n      \"city\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"number\": \"<string>\",\n      \"state\": \"<string>\",\n      \"street\": \"<string>\",\n      \"zipCode\": \"<string>\"\n    },\n    \"document\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"totalAmount\": \"<string>\",\n  \"type\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "boletos": [
    {
      "amount": "<string>",
      "dueDate": "<string>",
      "id": "<string>",
      "installmentLabel": "<string>",
      "installmentNumber": 123,
      "status": "<string>"
    }
  ],
  "installmentsCount": 123,
  "seriesId": "<string>",
  "status": "<string>",
  "totalAmount": "<string>"
}
{
  "code": "PBP-0001",
  "details": {},
  "message": "dueDate must be in YYYY-MM-DD format",
  "title": "Bad Request"
}
{
  "code": "PBP-0001",
  "details": {},
  "message": "dueDate must be in YYYY-MM-DD format",
  "title": "Bad Request"
}
{
  "code": "PBP-0001",
  "details": {},
  "message": "dueDate must be in YYYY-MM-DD format",
  "title": "Bad Request"
}
{
  "code": "PBP-0001",
  "details": {},
  "message": "dueDate must be in YYYY-MM-DD format",
  "title": "Bad Request"
}
{
  "code": "PBP-0001",
  "details": {},
  "message": "dueDate must be in YYYY-MM-DD format",
  "title": "Bad Request"
}

Autorizações

​
Authorization
string
header
obrigatório

Bearer token authentication (format: "Bearer {token}")

Cabeçalhos

​
X-Organization-Id
string
obrigatório

Tenant organization ID

​
Idempotency-Key
string
obrigatório

Idempotency key (UUID v4 or v7)

Corpo

application/json

Installment creation payload

​
discount
object
​
fine
object
​
firstDueDate
string
​
guarantor
object
​
installmentAmounts
string[]
​
installments
integer
​
interest
object
​
intervalDays
integer
​
midazAccountId
string
​
payer
object
​
totalAmount
string
​
type
string

Resposta

Created

​
boletos
object[]
​
installmentsCount
integer
​
seriesId
string
​
status
string
​
totalAmount
string