Pular para o conteúdo principal
PATCH
/
api
/
v1
/
brcode
/
cobv
/
{txid}
Revisar cobrança com vencimento
curl --request PATCH \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chave": "<string>",
  "devedor": {
    "cep": "<string>",
    "cidade": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>",
    "email": "<string>",
    "logradouro": "<string>",
    "nome": "<string>",
    "uf": "<string>"
  },
  "infoAdicionais": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ],
  "loc": {
    "id": 123
  },
  "solicitacaoPagador": "<string>",
  "status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
  "valor": {
    "original": "<string>"
  }
}
'
import requests

url = "https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}"

payload = {
"chave": "<string>",
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"cnpj": "<string>",
"cpf": "<string>",
"email": "<string>",
"logradouro": "<string>",
"nome": "<string>",
"uf": "<string>"
},
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"loc": { "id": 123 },
"solicitacaoPagador": "<string>",
"status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
"valor": { "original": "<string>" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
chave: '<string>',
devedor: {
cep: '<string>',
cidade: '<string>',
cnpj: '<string>',
cpf: '<string>',
email: '<string>',
logradouro: '<string>',
nome: '<string>',
uf: '<string>'
},
infoAdicionais: [{nome: '<string>', valor: '<string>'}],
loc: {id: 123},
solicitacaoPagador: '<string>',
status: 'REMOVIDA_PELO_USUARIO_RECEBEDOR',
valor: {original: '<string>'}
})
};

fetch('https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}', 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/cobv/{txid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'chave' => '<string>',
'devedor' => [
'cep' => '<string>',
'cidade' => '<string>',
'cnpj' => '<string>',
'cpf' => '<string>',
'email' => '<string>',
'logradouro' => '<string>',
'nome' => '<string>',
'uf' => '<string>'
],
'infoAdicionais' => [
[
'nome' => '<string>',
'valor' => '<string>'
]
],
'loc' => [
'id' => 123
],
'solicitacaoPagador' => '<string>',
'status' => 'REMOVIDA_PELO_USUARIO_RECEBEDOR',
'valor' => [
'original' => '<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/cobv/{txid}"

payload := strings.NewReader("{\n \"chave\": \"<string>\",\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"cpf\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"nome\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"infoAdicionais\": [\n {\n \"nome\": \"<string>\",\n \"valor\": \"<string>\"\n }\n ],\n \"loc\": {\n \"id\": 123\n },\n \"solicitacaoPagador\": \"<string>\",\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"valor\": {\n \"original\": \"<string>\"\n }\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"chave\": \"<string>\",\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"cpf\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"nome\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"infoAdicionais\": [\n {\n \"nome\": \"<string>\",\n \"valor\": \"<string>\"\n }\n ],\n \"loc\": {\n \"id\": 123\n },\n \"solicitacaoPagador\": \"<string>\",\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"valor\": {\n \"original\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chave\": \"<string>\",\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"cpf\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"nome\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"infoAdicionais\": [\n {\n \"nome\": \"<string>\",\n \"valor\": \"<string>\"\n }\n ],\n \"loc\": {\n \"id\": 123\n },\n \"solicitacaoPagador\": \"<string>\",\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"valor\": {\n \"original\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "calendario": {
    "criacao": "<string>",
    "dataDeVencimento": "<string>",
    "validadeAposVencimento": 123
  },
  "chave": "<string>",
  "devedor": {
    "cep": "<string>",
    "cidade": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>",
    "email": "<string>",
    "logradouro": "<string>",
    "nome": "<string>",
    "uf": "<string>"
  },
  "loc": {
    "criacao": "<string>",
    "id": 123,
    "location": "<string>"
  },
  "location": "<string>",
  "pixCopiaECola": "<string>",
  "recebedor": {
    "cep": "<string>",
    "cidade": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>",
    "logradouro": "<string>",
    "nome": "<string>",
    "nomeFantasia": "<string>",
    "uf": "<string>"
  },
  "revisao": 123,
  "txid": "<string>",
  "valor": {
    "abatimento": {
      "modalidade": 123,
      "valorPerc": "<string>"
    },
    "desconto": {
      "modalidade": 3,
      "descontoDataFixa": [
        {
          "data": "<string>",
          "valorPerc": "<string>"
        }
      ],
      "valorPerc": "<string>"
    },
    "juros": {
      "modalidade": 123,
      "valorPerc": "<string>"
    },
    "multa": {
      "modalidade": 123,
      "valorPerc": "<string>"
    },
    "original": "<string>"
  },
  "infoAdicionais": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ],
  "solicitacaoPagador": "<string>"
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

txid
string
obrigatório

Identificador da transação [a-zA-Z0-9]{26,35}.

Corpo

application/json
calendario
object

Controle de tempo da cobrança.

chave
string

Chave DICT do recebedor.

Maximum string length: 77
devedor
object

Devedor da cobrança.

infoAdicionais
object[] | null

Informações adicionais (máx 50).

loc
object

Referência de location.

solicitacaoPagador
string

Texto livre apresentado ao pagador.

Maximum string length: 140
status
enum<string>

Único valor aceito: REMOVIDA_PELO_USUARIO_RECEBEDOR (remove a cobrança).

Opções disponíveis:
REMOVIDA_PELO_USUARIO_RECEBEDOR
valor
object

Valores monetários da cobrança.

Resposta

OK

calendario
object
obrigatório
chave
string
obrigatório

Chave DICT do recebedor.

Maximum string length: 77
devedor
object
obrigatório
loc
object
obrigatório
location
string
obrigatório

Localização do payload.

Maximum string length: 77
pixCopiaECola
string
obrigatório

Pix Copia e Cola (BR Code) correspondente à cobrança.

Maximum string length: 512
recebedor
object
obrigatório
revisao
integer<int64>
obrigatório

Revisão da cobrança (inicia em 0).

status
enum<string>
obrigatório

Status do registro da cobrança.

Opções disponíveis:
ATIVA,
CONCLUIDA,
REMOVIDA_PELO_USUARIO_RECEBEDOR,
REMOVIDA_PELO_PSP
txid
string
obrigatório

Identificador da transação.

Pattern: [a-zA-Z0-9]{26,35}
valor
object
obrigatório
infoAdicionais
object[] | null
solicitacaoPagador
string
Maximum string length: 140