Conciliar cobranza

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "txId": "<string>"
}
'

import requests

url = "https://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile"

payload = { "txId": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({txId: '<string>'})
};

fetch('https://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile', 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://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile",
  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([
    'txId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile"

	payload := strings.NewReader("{\n  \"txId\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"txId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"txId\": \"<string>\"\n}"

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

{
  "amount": "<string>",
  "chargeType": "<string>",
  "createdAt": "<string>",
  "id": "<string>",
  "merchantCity": "<string>",
  "merchantName": "<string>",
  "pixKey": "<string>",
  "status": "<string>",
  "txId": "<string>",
  "updatedAt": "<string>",
  "discountAmount": "<string>",
  "dueAt": "<string>",
  "expiresAt": "<string>",
  "interestPercent": "<string>",
  "paidAt": "<string>",
  "payableAmount": "<string>",
  "payloadLocation": "<string>",
  "penaltyPercent": "<string>",
  "rawPayload": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

POST

api

brcode

charges

reconcile

Conciliar cobranza

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "txId": "<string>"
}
'

import requests

url = "https://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile"

payload = { "txId": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({txId: '<string>'})
};

fetch('https://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile', 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://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile",
  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([
    'txId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile"

	payload := strings.NewReader("{\n  \"txId\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"txId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"txId\": \"<string>\"\n}"

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

{
  "amount": "<string>",
  "chargeType": "<string>",
  "createdAt": "<string>",
  "id": "<string>",
  "merchantCity": "<string>",
  "merchantName": "<string>",
  "pixKey": "<string>",
  "status": "<string>",
  "txId": "<string>",
  "updatedAt": "<string>",
  "discountAmount": "<string>",
  "dueAt": "<string>",
  "expiresAt": "<string>",
  "interestPercent": "<string>",
  "paidAt": "<string>",
  "payableAmount": "<string>",
  "payloadLocation": "<string>",
  "penaltyPercent": "<string>",
  "rawPayload": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json

txId

string

requerido

Transaction identifier of the charge to mark as paid.

Ejemplo:

"txid-cobv-001"

Respuesta

amount

string

requerido

Original charge amount in BRL as a decimal string, scale 2.

Ejemplo:

"250.00"

chargeType

string

requerido

Charge type: COB (immediate), COBV (due-date), or LoteCobV batch item.

Ejemplo:

"COB"

createdAt

string

requerido

Creation timestamp in RFC3339 UTC.

Ejemplo:

"2025-03-07T14:30:00Z"

string

requerido

Server-assigned charge identifier (UUID).

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

merchantCity

string

requerido

Merchant city on the charge.

Ejemplo:

"São Paulo"

merchantName

string

requerido

Merchant legal/trade name on the charge.

Ejemplo:

"Lerian Studio"

pixKey

string

requerido

Pix key of the receiver settling the charge.

Ejemplo:

"12345678901"

status

string

requerido

Charge lifecycle status (ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP).

Ejemplo:

"ATIVA"

txId

string

requerido

Merchant transaction identifier for the charge.

Ejemplo:

"txid-cobv-001"

updatedAt

string

requerido

Last-update timestamp in RFC3339 UTC.

Ejemplo:

"2025-03-07T14:30:00Z"

discountAmount

string

Configured early-payment discount in BRL as a decimal string, scale 2; empty for none.

Ejemplo:

"10.00"

dueAt

string

Due date for due-date charges (COBV) as an RFC3339 UTC timestamp; null for immediate charges.

Ejemplo:

"2025-03-15T23:59:59Z"

expiresAt

string

Immediate-charge (COB) expiry as an RFC3339 UTC timestamp; null when not applicable.

Ejemplo:

"2025-03-08T23:59:59Z"

interestPercent

string

Configured monthly interest as a percentage decimal string (e.g. "1.00" = 1%); empty for none.

Ejemplo:

"1.00"

paidAt

string

Settlement timestamp as an RFC3339 UTC timestamp; null until the charge is reconciled as paid.

Ejemplo:

"2025-03-08T10:15:00Z"

payableAmount

string

Amount payable at the reference time in BRL, scale 2, after discount/penalty/interest; empty when not computed.

Ejemplo:

"252.50"

payloadLocation

string

Resolvable payload location URL for the dynamic charge QR (empty when unavailable).

Ejemplo:

"https://pix.example.com/qr/v2/txid-cobv-001"

penaltyPercent

string

Configured late-payment penalty as a percentage decimal string (e.g. "2.00" = 2%); empty for none.

Ejemplo:

"2.00"

rawPayload

string

Raw EMV copy-and-paste payload string for the charge (empty when unavailable).

Ejemplo:

"00020126580014br.gov.bcb.pix..."

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado (mensajería nativa)

Conciliar cobranza

Autorizaciones

Cuerpo

Respuesta