Get payment dashboard

curl --request GET \
  --url https://payments.sandbox.lerian.net/v1/dashboards/payments \
  --header 'Authorization: <api-key>' \
  --header 'X-Organization-Id: <x-organization-id>'

import requests

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

headers = {
    "X-Organization-Id": "<x-organization-id>",
    "Authorization": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Organization-Id': '<x-organization-id>', Authorization: '<api-key>'}
};

fetch('https://payments.sandbox.lerian.net/v1/dashboards/payments', 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/dashboards/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-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"
	"net/http"
	"io"
)

func main() {

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

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

	req.Header.Add("X-Organization-Id", "<x-organization-id>")
	req.Header.Add("Authorization", "<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://payments.sandbox.lerian.net/v1/dashboards/payments")
  .header("X-Organization-Id", "<x-organization-id>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Authorization"] = '<api-key>'

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

{
  "byStatus": {},
  "byType": {},
  "totalAmount": "<string>",
  "totalApproved": 123,
  "totalCanceled": 123,
  "totalCreated": 123,
  "totalExecuted": 123,
  "totalFailed": 123,
  "totalPendingApproval": 123,
  "totalRejected": 123,
  "totalScheduled": 123,
  "totalSettled": 123,
  "totalSettledAmount": "<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"
}

GET

dashboards

payments

Get payment dashboard

curl --request GET \
  --url https://payments.sandbox.lerian.net/v1/dashboards/payments \
  --header 'Authorization: <api-key>' \
  --header 'X-Organization-Id: <x-organization-id>'

import requests

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

headers = {
    "X-Organization-Id": "<x-organization-id>",
    "Authorization": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Organization-Id': '<x-organization-id>', Authorization: '<api-key>'}
};

fetch('https://payments.sandbox.lerian.net/v1/dashboards/payments', 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/dashboards/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-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"
	"net/http"
	"io"
)

func main() {

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

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

	req.Header.Add("X-Organization-Id", "<x-organization-id>")
	req.Header.Add("Authorization", "<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://payments.sandbox.lerian.net/v1/dashboards/payments")
  .header("X-Organization-Id", "<x-organization-id>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Authorization"] = '<api-key>'

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

{
  "byStatus": {},
  "byType": {},
  "totalAmount": "<string>",
  "totalApproved": 123,
  "totalCanceled": 123,
  "totalCreated": 123,
  "totalExecuted": 123,
  "totalFailed": 123,
  "totalPendingApproval": 123,
  "totalRejected": 123,
  "totalScheduled": 123,
  "totalSettled": 123,
  "totalSettledAmount": "<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"
}

Authorizations

Authorization

string

header

required

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

Headers

X-Organization-Id

string

required

Tenant organization ID

Query Parameters

from

string

Created from date (YYYY-MM-DD)

string

Created to date (YYYY-MM-DD)

type

enum<string>

Payment type filter

Available options:

BANKSLIP,

UTILITIES,

DARF

Response

byStatus

object

Show child attributes

byType

object

Show child attributes

totalAmount

string

totalApproved

integer

totalCanceled

integer

totalCreated

integer

totalExecuted

integer

totalFailed

integer

totalPendingApproval

integer

totalRejected

integer

totalScheduled

integer

totalSettled

integer

totalSettledAmount

string

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Get payment dashboard

Authorizations

Headers

Query Parameters

Response