Retrieve recurring charge

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/cobr/{txid} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

{
  "ajusteDiaUtil": true,
  "atualizacao": [
    {
      "data": "<string>",
      "status": "CRIADA"
    }
  ],
  "calendario": {
    "dataDeVencimento": "<string>",
    "criacao": "<string>"
  },
  "idRec": "<string>",
  "politicaRetentativa": "NAO_PERMITE",
  "recebedor": {
    "conta": "<string>",
    "tipoConta": "CORRENTE",
    "agencia": "<string>"
  },
  "revisao": 123,
  "status": "CRIADA",
  "txid": "<string>",
  "valor": {
    "original": "<string>"
  },
  "atestacaoTitularidade": {
    "atestadaEm": "<string>",
    "atestadaPor": "<string>",
    "conta": "<string>",
    "tipoConta": "<string>",
    "agencia": "<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>",
  "tentativas": [
    {
      "atualizacao": [
        {
          "data": "<string>",
          "status": "SOLICITADA"
        }
      ],
      "dataLiquidacao": "<string>",
      "endToEndId": "<string>",
      "status": "SOLICITADA",
      "tipo": "AGND",
      "rejeicao": {
        "codigo": "<string>",
        "descricao": "<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"
  }
}

GET

api

brcode

cobr

{txid}

Retrieve recurring charge

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/cobr/{txid} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

{
  "ajusteDiaUtil": true,
  "atualizacao": [
    {
      "data": "<string>",
      "status": "CRIADA"
    }
  ],
  "calendario": {
    "dataDeVencimento": "<string>",
    "criacao": "<string>"
  },
  "idRec": "<string>",
  "politicaRetentativa": "NAO_PERMITE",
  "recebedor": {
    "conta": "<string>",
    "tipoConta": "CORRENTE",
    "agencia": "<string>"
  },
  "revisao": 123,
  "status": "CRIADA",
  "txid": "<string>",
  "valor": {
    "original": "<string>"
  },
  "atestacaoTitularidade": {
    "atestadaEm": "<string>",
    "atestadaPor": "<string>",
    "conta": "<string>",
    "tipoConta": "<string>",
    "agencia": "<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>",
  "tentativas": [
    {
      "atualizacao": [
        {
          "data": "<string>",
          "status": "SOLICITADA"
        }
      ],
      "dataLiquidacao": "<string>",
      "endToEndId": "<string>",
      "status": "SOLICITADA",
      "tipo": "AGND",
      "rejeicao": {
        "codigo": "<string>",
        "descricao": "<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"
  }
}

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}$

Response

ajusteDiaUtil

boolean

required

atualizacao

object[]

required

Histórico das mudanças de status da cobrança recorrente.

Show child attributes

calendario

object

required

Show child attributes

idRec

string

required

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

politicaRetentativa

enum<string>

required

Política de retentativa vigente para esta cobrança (congelada da Rec na criação).

Available options:

NAO_PERMITE,

PERMITE_3R_7D

recebedor

object

required

Show child attributes

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

Show child attributes

atestacaoTitularidade

object

Show child attributes

devedor

object

Show child attributes

encerramento

object

Show child attributes

infoAdicional

string

Maximum string length: 140

tentativas

object[]

Histórico de tentativas de liquidação.

Show child attributes