Skip to main content
PATCH
/
api
/
v1
/
brcode
/
cobr
/
{txid}
Revise recurring charge (cancel)
curl --request PATCH \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/cobr/{txid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "CANCELADA"
}
'
import requests

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

payload = { "status": "CANCELADA" }
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({status: 'CANCELADA'})
};

fetch('https://spi.sandbox.lerian.net/api/v1/brcode/cobr/{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/cobr/{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([
'status' => 'CANCELADA'
]),
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/cobr/{txid}"

payload := strings.NewReader("{\n \"status\": \"CANCELADA\"\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/cobr/{txid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"CANCELADA\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/cobr/{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 \"status\": \"CANCELADA\"\n}"

response = http.request(request)
puts response.read_body
{
  "ajusteDiaUtil": true,
  "calendario": {
    "dataDeVencimento": "<string>",
    "criacao": "<string>"
  },
  "idRec": "<string>",
  "recebedor": {
    "conta": "<string>",
    "agencia": "<string>"
  },
  "revisao": 123,
  "txid": "<string>",
  "valor": {
    "original": "<string>"
  },
  "atualizacao": [
    {
      "data": "<string>"
    }
  ],
  "devedor": {
    "cep": "<string>",
    "cidade": "<string>",
    "email": "<string>",
    "logradouro": "<string>",
    "uf": "<string>"
  },
  "encerramento": {
    "cancelamento": {
      "codigo": "<string>",
      "descricao": "<string>",
      "solicitante": "<string>"
    },
    "rejeicao": {
      "codigo": "<string>",
      "descricao": "<string>"
    }
  },
  "infoAdicional": "<string>"
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

txid
string
required

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

Pattern: ^[a-zA-Z0-9]{26,35}$

Body

application/json
status
enum<string>
required

Único valor aceito: CANCELADA.

Available options:
CANCELADA
Example:

"CANCELADA"

cancelamento
object

Detalhe do cancelamento (opcional).

Response

OK

ajusteDiaUtil
boolean
required
calendario
object
required
idRec
string
required
Pattern: ^[a-zA-Z0-9]{29}$
recebedor
object
required
revisao
integer<int64>
required
status
enum<string>
required
Available options:
CRIADA,
ATIVA,
CONCLUIDA,
EXPIRADA,
REJEITADA,
CANCELADA
txid
string
required
Pattern: ^[a-zA-Z0-9]{26,35}$
valor
object
required
atualizacao
object[] | null
devedor
object
encerramento
object
infoAdicional
string
Maximum string length: 140