Revise (cancel) recurrence request (Pix Automático)

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

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

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

}

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/solicrec/{idSolicRec}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

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

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

print(response.text)

{
  "calendario": {
    "dataExpiracaoSolicitacao": "2023-12-20T12:17:11Z"
  },
  "destinatario": {
    "conta": "550689",
    "ispbParticipante": "91193552",
    "agencia": "2569",
    "cnpj": "<string>",
    "cpf": "15231470190"
  },
  "idRec": "<string>",
  "idSolicRec": "<string>",
  "status": "CRIADA"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

PATCH

api

brcode

solicrec

{idSolicRec}

Revise (cancel) recurrence request (Pix Automático)

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

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

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

}

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/solicrec/{idSolicRec}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

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

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

print(response.text)

{
  "calendario": {
    "dataExpiracaoSolicitacao": "2023-12-20T12:17:11Z"
  },
  "destinatario": {
    "conta": "550689",
    "ispbParticipante": "91193552",
    "agencia": "2569",
    "cnpj": "<string>",
    "cpf": "15231470190"
  },
  "idRec": "<string>",
  "idSolicRec": "<string>",
  "status": "CRIADA"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

idSolicRec

string

required

Identificador da solicitação [a-zA-Z0-9]{29}.

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

Body

application/json

status

enum<string>

required

Status alvo da revisão (apenas CANCELADA).

Available options:

CANCELADA

Example:

"CANCELADA"

Response

Created

calendario

object

required

Show child attributes

destinatario

object

required

Show child attributes

idRec

string

required

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

idSolicRec

string

required

Identificador da solicitação.

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

status

enum<string>

required

Available options:

CRIADA,

ENVIADA,

RECEBIDA,

REJEITADA,

ACEITA,

EXPIRADA,

CANCELADA