Revisar recurrencia (Pix Automático)

curl --request PATCH \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/rec/{idRec} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "calendario": {
    "dataInicial": "<string>"
  },
  "status": "CANCELADA"
}
'

import requests

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

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

fetch('https://spi.sandbox.lerian.net/api/v1/brcode/rec/{idRec}', 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/rec/{idRec}",
  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([
    'calendario' => [
        'dataInicial' => '<string>'
    ],
    '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/rec/{idRec}"

	payload := strings.NewReader("{\n  \"calendario\": {\n    \"dataInicial\": \"<string>\"\n  },\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/rec/{idRec}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"calendario\": {\n    \"dataInicial\": \"<string>\"\n  },\n  \"status\": \"CANCELADA\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"calendario\": {\n    \"dataInicial\": \"<string>\"\n  },\n  \"status\": \"CANCELADA\"\n}"

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

{
  "calendario": {
    "dataInicial": "<string>",
    "dataFinal": "<string>"
  },
  "idRec": "<string>",
  "recebedor": {
    "conta": "<string>",
    "agencia": "<string>",
    "convenio": "<string>"
  },
  "vinculo": {
    "contrato": "<string>",
    "devedor": {
      "cnpj": "<string>",
      "cpf": "<string>",
      "nome": "<string>"
    },
    "objeto": "<string>"
  },
  "atualizacao": [
    {
      "data": "<string>"
    }
  ],
  "solicitacao": [
    {
      "calendario": {
        "dataExpiracaoSolicitacao": "2023-11-07T05:31:56Z"
      },
      "destinatario": {
        "conta": "<string>",
        "ispbParticipante": "<string>",
        "agencia": "<string>",
        "cnpj": "<string>",
        "cpf": "<string>"
      },
      "idRec": "<string>",
      "idSolicRec": "<string>"
    }
  ],
  "valor": {
    "valorMinimoRecebedor": "<string>",
    "valorRec": "<string>"
  }
}

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

Revisar recurrencia (Pix Automático)

Revisa parcialmente una recurrencia (Rec) por su idRec: cambia calendario.dataInicial (solo mientras status == CRIADA) y/o el status (CANCELADA cancela el mandato). API Pix PATCH /rec/. Rechaza cualquier cambio cuando la recurrencia está EXPIRADA/CANCELADA/REJEITADA (422). Los cambios en rec.loc no se aceptan en este endpoint. Un idRec desconocido devuelve 404 (envelope Problema canónico).

PATCH

api

brcode

rec

{idRec}

Revisar recurrencia (Pix Automático)

curl --request PATCH \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/rec/{idRec} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "calendario": {
    "dataInicial": "<string>"
  },
  "status": "CANCELADA"
}
'

import requests

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

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

fetch('https://spi.sandbox.lerian.net/api/v1/brcode/rec/{idRec}', 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/rec/{idRec}",
  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([
    'calendario' => [
        'dataInicial' => '<string>'
    ],
    '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/rec/{idRec}"

	payload := strings.NewReader("{\n  \"calendario\": {\n    \"dataInicial\": \"<string>\"\n  },\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/rec/{idRec}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"calendario\": {\n    \"dataInicial\": \"<string>\"\n  },\n  \"status\": \"CANCELADA\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"calendario\": {\n    \"dataInicial\": \"<string>\"\n  },\n  \"status\": \"CANCELADA\"\n}"

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

{
  "calendario": {
    "dataInicial": "<string>",
    "dataFinal": "<string>"
  },
  "idRec": "<string>",
  "recebedor": {
    "conta": "<string>",
    "agencia": "<string>",
    "convenio": "<string>"
  },
  "vinculo": {
    "contrato": "<string>",
    "devedor": {
      "cnpj": "<string>",
      "cpf": "<string>",
      "nome": "<string>"
    },
    "objeto": "<string>"
  },
  "atualizacao": [
    {
      "data": "<string>"
    }
  ],
  "solicitacao": [
    {
      "calendario": {
        "dataExpiracaoSolicitacao": "2023-11-07T05:31:56Z"
      },
      "destinatario": {
        "conta": "<string>",
        "ispbParticipante": "<string>",
        "agencia": "<string>",
        "cnpj": "<string>",
        "cpf": "<string>"
      },
      "idRec": "<string>",
      "idSolicRec": "<string>"
    }
  ],
  "valor": {
    "valorMinimoRecebedor": "<string>",
    "valorRec": "<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.

Encabezados

Idempotency-Key

string

Idempotency key, max 255 characters.

Parámetros de ruta

idRec

string

requerido

Identificador da recorrência [a-zA-Z0-9]{29}.

Pattern: ^[a-zA-Z0-9]{29}$

Cuerpo

application/json

calendario

object

Patch do calendário (apenas dataInicial).

Show child attributes

status

enum<string>

Novo status da recorrência (CANCELADA cancela o mandato — único destino de status aceito no PATCH, RecRevisada.status v2.9).

Opciones disponibles:

CANCELADA

Respuesta

calendario

object

requerido

Show child attributes

idRec

string

requerido

Identificador da recorrência.

Pattern: ^[a-zA-Z0-9]{29}$

politicaRetentativa

enum<string>

requerido

Opciones disponibles:

NAO_PERMITE,

PERMITE_3R_7D

recebedor

object

requerido

Show child attributes

status

enum<string>

requerido

Opciones disponibles:

CRIADA,

APROVADA,

REJEITADA,

EXPIRADA,

CANCELADA

vinculo

object

requerido

Show child attributes

atualizacao

object[] | null

Show child attributes

solicitacao

object[] | null

Show child attributes

valor

object

Show child attributes

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

Revisar recurrencia (Pix Automático)

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta