List payments

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

import requests

url = "https://payments.sandbox.lerian.net/v1/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/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/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/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/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/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

{
  "items": [
    {
      "amount": "<string>",
      "canceledAt": "<string>",
      "createdAt": "<string>",
      "darf": {
        "fineAmount": "<string>",
        "interestAmount": "<string>",
        "mainAmount": "<string>",
        "name": "<string>",
        "personType": "<string>",
        "referenceDate": "<string>",
        "taxId": "<string>",
        "treasuryRevenueCode": "<string>",
        "type": "<string>"
      },
      "description": "<string>",
      "digitableLine": "<string>",
      "dueDate": "<string>",
      "errorMessage": "<string>",
      "failedAt": "<string>",
      "id": "<string>",
      "payee": {
        "name": "<string>",
        "taxId": "<string>"
      },
      "providerId": "<string>",
      "rejectedAt": "<string>",
      "scheduledDate": "<string>",
      "settledAmount": "<string>",
      "settledAt": "<string>",
      "status": "<string>",
      "type": "<string>"
    }
  ],
  "limit": 123,
  "page": 123,
  "total": 123
}

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

payments

List payments

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

import requests

url = "https://payments.sandbox.lerian.net/v1/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/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/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/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/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/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

{
  "items": [
    {
      "amount": "<string>",
      "canceledAt": "<string>",
      "createdAt": "<string>",
      "darf": {
        "fineAmount": "<string>",
        "interestAmount": "<string>",
        "mainAmount": "<string>",
        "name": "<string>",
        "personType": "<string>",
        "referenceDate": "<string>",
        "taxId": "<string>",
        "treasuryRevenueCode": "<string>",
        "type": "<string>"
      },
      "description": "<string>",
      "digitableLine": "<string>",
      "dueDate": "<string>",
      "errorMessage": "<string>",
      "failedAt": "<string>",
      "id": "<string>",
      "payee": {
        "name": "<string>",
        "taxId": "<string>"
      },
      "providerId": "<string>",
      "rejectedAt": "<string>",
      "scheduledDate": "<string>",
      "settledAmount": "<string>",
      "settledAt": "<string>",
      "status": "<string>",
      "type": "<string>"
    }
  ],
  "limit": 123,
  "page": 123,
  "total": 123
}

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

page

integer

Page number (default: 1)

limit

integer

Items per page (default: 20, max: 100)

status

enum<string>

Status filter

Available options:

CREATED,

SCHEDULED,

PENDING_APPROVAL,

APPROVED,

EXECUTED,

SETTLED,

REJECTED,

FAILED,

CANCELED

type

enum<string>

Payment type filter

Available options:

BANKSLIP,

UTILITIES,

DARF

from

string

Created from date (YYYY-MM-DD)

string

Created to date (YYYY-MM-DD)

Response

items

object[]

Show child attributes

limit

integer

page

integer

total

integer

⌘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)

List payments

Authorizations

Headers

Query Parameters

Response