Revise recurring charge (cancel) - Lerian

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"
}
'

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

}

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

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)

{
  "ajusteDiaUtil": true,
  "calendario": {
    "dataDeVencimento": "<string>",
    "criacao": "<string>"
  },
  "idRec": "<string>",
  "recebedor": {
    "conta": "<string>",
    "tipoConta": "CORRENTE",
    "agencia": "<string>"
  },
  "revisao": 123,
  "status": "CRIADA",
  "txid": "<string>",
  "valor": {
    "original": "<string>"
  },
  "atualizacao": [
    {
      "data": "<string>",
      "status": "CRIADA"
    }
  ],
  "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": "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

/

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"
}
'

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

}

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

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)

{
  "ajusteDiaUtil": true,
  "calendario": {
    "dataDeVencimento": "<string>",
    "criacao": "<string>"
  },
  "idRec": "<string>",
  "recebedor": {
    "conta": "<string>",
    "tipoConta": "CORRENTE",
    "agencia": "<string>"
  },
  "revisao": 123,
  "status": "CRIADA",
  "txid": "<string>",
  "valor": {
    "original": "<string>"
  },
  "atualizacao": [
    {
      "data": "<string>",
      "status": "CRIADA"
    }
  ],
  "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": "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"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

txid

string

requerido

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

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

Cuerpo

application/json

status

enum<string>

requerido

Único valor aceito: CANCELADA.

Opciones disponibles:

CANCELADA

Ejemplo:

"CANCELADA"

cancelamento

object

Detalhe do cancelamento (opcional).

Show child attributes

Respuesta

OK

ajusteDiaUtil

boolean

requerido

calendario

object

requerido

Show child attributes

idRec

string

requerido

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

recebedor

object

requerido

Show child attributes

revisao

integer<int64>

requerido

status

enum<string>

requerido

Opciones disponibles:

CRIADA,

ATIVA,

CONCLUIDA,

EXPIRADA,

REJEITADA,

CANCELADA

txid

string

requerido

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

valor

object

requerido

Show child attributes

atualizacao

object[] | null

Show child attributes

devedor

object

Show child attributes

encerramento

object

Show child attributes

infoAdicional

string

Maximum string length: 140