Revise immediate charge

curl --request PATCH \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/cob/{txid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "calendario": {
    "expiracao": 3600
  },
  "chave": "<string>",
  "devedor": {
    "cpf": "12345678901",
    "nome": "Fulano de Tal",
    "cep": "<string>",
    "cidade": "<string>",
    "cnpj": "12ABC34501DE35",
    "email": "<string>",
    "logradouro": "<string>",
    "uf": "<string>"
  },
  "infoAdicionais": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ],
  "loc": {
    "id": 2
  },
  "solicitacaoPagador": "<string>",
  "status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
  "valor": {
    "modalidadeAlteracao": 0,
    "original": "250.00",
    "retirada": {}
  }
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"calendario\": {\n    \"expiracao\": 3600\n  },\n  \"chave\": \"<string>\",\n  \"devedor\": {\n    \"cpf\": \"12345678901\",\n    \"nome\": \"Fulano de Tal\",\n    \"cep\": \"<string>\",\n    \"cidade\": \"<string>\",\n    \"cnpj\": \"12ABC34501DE35\",\n    \"email\": \"<string>\",\n    \"logradouro\": \"<string>\",\n    \"uf\": \"<string>\"\n  },\n  \"infoAdicionais\": [\n    {\n      \"nome\": \"<string>\",\n      \"valor\": \"<string>\"\n    }\n  ],\n  \"loc\": {\n    \"id\": 2\n  },\n  \"solicitacaoPagador\": \"<string>\",\n  \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n  \"valor\": {\n    \"modalidadeAlteracao\": 0,\n    \"original\": \"250.00\",\n    \"retirada\": {}\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    calendario: {expiracao: 3600},
    chave: '<string>',
    devedor: {
      cpf: '12345678901',
      nome: 'Fulano de Tal',
      cep: '<string>',
      cidade: '<string>',
      cnpj: '12ABC34501DE35',
      email: '<string>',
      logradouro: '<string>',
      uf: '<string>'
    },
    infoAdicionais: [{nome: '<string>', valor: '<string>'}],
    loc: {id: 2},
    solicitacaoPagador: '<string>',
    status: 'REMOVIDA_PELO_USUARIO_RECEBEDOR',
    valor: {modalidadeAlteracao: 0, original: '250.00', retirada: {}}
  })
};

fetch('https://spi.sandbox.lerian.net/api/v1/brcode/cob/{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/cob/{txid}"

payload = {
    "calendario": { "expiracao": 3600 },
    "chave": "<string>",
    "devedor": {
        "cpf": "12345678901",
        "nome": "Fulano de Tal",
        "cep": "<string>",
        "cidade": "<string>",
        "cnpj": "12ABC34501DE35",
        "email": "<string>",
        "logradouro": "<string>",
        "uf": "<string>"
    },
    "infoAdicionais": [
        {
            "nome": "<string>",
            "valor": "<string>"
        }
    ],
    "loc": { "id": 2 },
    "solicitacaoPagador": "<string>",
    "status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
    "valor": {
        "modalidadeAlteracao": 0,
        "original": "250.00",
        "retirada": {}
    }
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "calendario": {
    "criacao": "<string>",
    "expiracao": 123
  },
  "chave": "<string>",
  "revisao": 123,
  "status": "ATIVA",
  "txid": "<string>",
  "valor": {
    "original": "250.00",
    "modalidadeAlteracao": 0,
    "retirada": {
      "saque": {
        "modalidadeAgente": "AGPSS",
        "prestadorDoServicoDeSaque": "12345678",
        "valor": "5.00",
        "modalidadeAlteracao": 0
      },
      "troco": {
        "modalidadeAgente": "AGPSS",
        "prestadorDoServicoDeSaque": "12345678",
        "valor": "5.00",
        "modalidadeAlteracao": 0
      }
    }
  },
  "devedor": {
    "cpf": "12345678901",
    "nome": "Fulano de Tal",
    "cep": "<string>",
    "cidade": "<string>",
    "cnpj": "12ABC34501DE35",
    "email": "<string>",
    "logradouro": "<string>",
    "uf": "<string>"
  },
  "infoAdicionais": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ],
  "loc": {
    "criacao": "<string>",
    "id": 123,
    "tipoCob": "cob",
    "location": "<string>"
  },
  "location": "<string>",
  "pixCopiaECola": "<string>",
  "solicitacaoPagador": "<string>"
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

PATCH

api

brcode

cob

{txid}

Revise immediate charge

curl --request PATCH \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/cob/{txid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "calendario": {
    "expiracao": 3600
  },
  "chave": "<string>",
  "devedor": {
    "cpf": "12345678901",
    "nome": "Fulano de Tal",
    "cep": "<string>",
    "cidade": "<string>",
    "cnpj": "12ABC34501DE35",
    "email": "<string>",
    "logradouro": "<string>",
    "uf": "<string>"
  },
  "infoAdicionais": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ],
  "loc": {
    "id": 2
  },
  "solicitacaoPagador": "<string>",
  "status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
  "valor": {
    "modalidadeAlteracao": 0,
    "original": "250.00",
    "retirada": {}
  }
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"calendario\": {\n    \"expiracao\": 3600\n  },\n  \"chave\": \"<string>\",\n  \"devedor\": {\n    \"cpf\": \"12345678901\",\n    \"nome\": \"Fulano de Tal\",\n    \"cep\": \"<string>\",\n    \"cidade\": \"<string>\",\n    \"cnpj\": \"12ABC34501DE35\",\n    \"email\": \"<string>\",\n    \"logradouro\": \"<string>\",\n    \"uf\": \"<string>\"\n  },\n  \"infoAdicionais\": [\n    {\n      \"nome\": \"<string>\",\n      \"valor\": \"<string>\"\n    }\n  ],\n  \"loc\": {\n    \"id\": 2\n  },\n  \"solicitacaoPagador\": \"<string>\",\n  \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n  \"valor\": {\n    \"modalidadeAlteracao\": 0,\n    \"original\": \"250.00\",\n    \"retirada\": {}\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    calendario: {expiracao: 3600},
    chave: '<string>',
    devedor: {
      cpf: '12345678901',
      nome: 'Fulano de Tal',
      cep: '<string>',
      cidade: '<string>',
      cnpj: '12ABC34501DE35',
      email: '<string>',
      logradouro: '<string>',
      uf: '<string>'
    },
    infoAdicionais: [{nome: '<string>', valor: '<string>'}],
    loc: {id: 2},
    solicitacaoPagador: '<string>',
    status: 'REMOVIDA_PELO_USUARIO_RECEBEDOR',
    valor: {modalidadeAlteracao: 0, original: '250.00', retirada: {}}
  })
};

fetch('https://spi.sandbox.lerian.net/api/v1/brcode/cob/{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/cob/{txid}"

payload = {
    "calendario": { "expiracao": 3600 },
    "chave": "<string>",
    "devedor": {
        "cpf": "12345678901",
        "nome": "Fulano de Tal",
        "cep": "<string>",
        "cidade": "<string>",
        "cnpj": "12ABC34501DE35",
        "email": "<string>",
        "logradouro": "<string>",
        "uf": "<string>"
    },
    "infoAdicionais": [
        {
            "nome": "<string>",
            "valor": "<string>"
        }
    ],
    "loc": { "id": 2 },
    "solicitacaoPagador": "<string>",
    "status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
    "valor": {
        "modalidadeAlteracao": 0,
        "original": "250.00",
        "retirada": {}
    }
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "calendario": {
    "criacao": "<string>",
    "expiracao": 123
  },
  "chave": "<string>",
  "revisao": 123,
  "status": "ATIVA",
  "txid": "<string>",
  "valor": {
    "original": "250.00",
    "modalidadeAlteracao": 0,
    "retirada": {
      "saque": {
        "modalidadeAgente": "AGPSS",
        "prestadorDoServicoDeSaque": "12345678",
        "valor": "5.00",
        "modalidadeAlteracao": 0
      },
      "troco": {
        "modalidadeAgente": "AGPSS",
        "prestadorDoServicoDeSaque": "12345678",
        "valor": "5.00",
        "modalidadeAlteracao": 0
      }
    }
  },
  "devedor": {
    "cpf": "12345678901",
    "nome": "Fulano de Tal",
    "cep": "<string>",
    "cidade": "<string>",
    "cnpj": "12ABC34501DE35",
    "email": "<string>",
    "logradouro": "<string>",
    "uf": "<string>"
  },
  "infoAdicionais": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ],
  "loc": {
    "criacao": "<string>",
    "id": 123,
    "tipoCob": "cob",
    "location": "<string>"
  },
  "location": "<string>",
  "pixCopiaECola": "<string>",
  "solicitacaoPagador": "<string>"
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency

string

requerido

Idempotency key, max 255 characters.

Parámetros de ruta

txid

string

requerido

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

Cuerpo

application/json

calendario

object

Controle de tempo da cobrança.

Show child attributes

chave

string

Chave DICT do recebedor.

Maximum string length: 77

devedor

Pessoa Física · object

Devedor da cobrança.

Pessoa Física
Pessoa Jurídica

Show child attributes

infoAdicionais

object[] | null

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

Maximum array length: 50

Show child attributes

loc

object

Referência de location.

Show child attributes

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

Opciones disponibles:

REMOVIDA_PELO_USUARIO_RECEBEDOR

valor

object

Valores monetários da cobrança; cada membro ausente mantém o valor armazenado.

Show child attributes

Respuesta

calendario

object

requerido

Show child attributes

chave

string

requerido

Chave DICT do recebedor.

Maximum string length: 77

revisao

integer<int64>

requerido

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

status

enum<string>

requerido

Status do registro da cobrança.

Opciones disponibles:

ATIVA,

CONCLUIDA,

REMOVIDA_PELO_USUARIO_RECEBEDOR,

REMOVIDA_PELO_PSP

txid

string

requerido

Identificador da transação.

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

valor

object

requerido

Show child attributes

devedor

Pessoa Física · object

Pessoa Física
Pessoa Jurídica

Show child attributes

infoAdicionais

object[]

Show child attributes

loc

object

Show child attributes

location

string

Localização do payload.

Maximum string length: 77

pixCopiaECola

string

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

Maximum string length: 512

solicitacaoPagador

string

Maximum string length: 140