Pular para o conteúdo
Vintém

Consultar recorrência

GET
/rec/{idRec}
curl --request GET \
  --url http://localhost:8080/rec/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Seção intitulada “Authorizations”

Parameters

Seção intitulada “Parameters”

Path Parameters

Seção intitulada “Path Parameters”
idRec
required

Identificador da recorrência, gerado pelo PSP (R + R/N + ISPB + AAAAMMDD + 11 caracteres).

string
/^R[RN][0-9A-Z]{8}[0-9]{8}[a-zA-Z0-9]{11}$/

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

Recorrência.

Media typeapplication/json
object
vinculo
required
object
objeto
string
<= 35 characters
contrato
required
string
>= 1 characters <= 35 characters
devedor
required

Pessoa física (cpf) ou jurídica (cnpj). Informe um dos dois.

object
cpf
string
/^\d{11}$/
cnpj

Aceita o CNPJ alfanumérico.

string
/^[0-9A-Z]{14}$/
nome
required
string
<= 200 characters
calendario
required
object
dataInicial
required
string format: date
dataFinal
string format: date
periodicidade
required
string
Allowed values: SEMANAL MENSAL TRIMESTRAL SEMESTRAL ANUAL
valor

ValorRec fixa o valor de toda cobrança. Sem ele, o valor varia, e o pagador define um máximo na autorização; valorMinimoRecebedor é o piso desse máximo. Os dois são excludentes (RN-40).

object
valorRec
string
/^\d{1,10}\.\d{2}$/
valorMinimoRecebedor
string
/^\d{1,10}\.\d{2}$/
politicaRetentativa
required
string
Allowed values: NAO_PERMITE PERMITE_3R_7D
idRec
required

Identificador da recorrência, gerado pelo PSP (R + R/N + ISPB + AAAAMMDD + 11 caracteres).

string
/^R[RN][0-9A-Z]{8}[0-9]{8}[a-zA-Z0-9]{11}$/
status
required
string
Allowed values: CRIADA APROVADA REJEITADA EXPIRADA CANCELADA
motivoRejeicao
string

Example 

{
  "calendario": {
    "periodicidade": "SEMANAL"
  },
  "valor": {
    "valorRec": "10.50",
    "valorMinimoRecebedor": "10.50"
  },
  "politicaRetentativa": "NAO_PERMITE",
  "status": "CRIADA"
}

401

Seção intitulada “401”

API key ausente ou inválida.

Media typeapplication/problem+json

Erro no formato da spec do BCB (RFC 7807).

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
correlationId
string
violacoes
Array<object>
object
razao
string
propriedade
string
valor
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "correlationId": "example",
  "violacoes": [
    {
      "razao": "example",
      "propriedade": "example",
      "valor": "example"
    }
  ]
}

403

Seção intitulada “403”

A API key não tem o escopo necessário.

Media typeapplication/problem+json

Erro no formato da spec do BCB (RFC 7807).

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
correlationId
string
violacoes
Array<object>
object
razao
string
propriedade
string
valor
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "correlationId": "example",
  "violacoes": [
    {
      "razao": "example",
      "propriedade": "example",
      "valor": "example"
    }
  ]
}

404

Seção intitulada “404”

Recurso não encontrado.

Media typeapplication/problem+json

Erro no formato da spec do BCB (RFC 7807).

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
correlationId
string
violacoes
Array<object>
object
razao
string
propriedade
string
valor
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "correlationId": "example",
  "violacoes": [
    {
      "razao": "example",
      "propriedade": "example",
      "valor": "example"
    }
  ]
}

default

Seção intitulada “default”

Qualquer outro erro, sempre como Problema. Os mais comuns: 502 quando o banco recusa ou falha (PSPIndisponivel) e 500 para erro interno.

Media typeapplication/problem+json

Erro no formato da spec do BCB (RFC 7807).

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
correlationId
string
violacoes
Array<object>
object
razao
string
propriedade
string
valor
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "correlationId": "example",
  "violacoes": [
    {
      "razao": "example",
      "propriedade": "example",
      "valor": "example"
    }
  ]
}