Pular para o conteúdo
Vintém

Pedir a confirmação da recorrência no app do pagador (jornada 1)

POST
/solicrec
curl --request POST \
  --url http://localhost:8080/solicrec \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "idRec": "example", "calendario": { "dataExpiracaoSolicitacao": "2026-04-15T12:00:00Z" }, "destinatario": { "conta": "example", "ispbParticipante": "example", "agencia": "example" } }'

Authorizations

Seção intitulada “Authorizations”

Parameters

Seção intitulada “Parameters”

Header Parameters

Seção intitulada “Header Parameters”
Idempotency-Key
required
string
>= 1 characters <= 255 characters

Reenvio com a mesma chave em até 24 h devolve a resposta original (RN-11).

Request Bodyrequired

Seção intitulada “Request Bodyrequired”
Media typeapplication/json
object
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}$/
calendario
required
object
dataExpiracaoSolicitacao
required

No futuro e em até 30 dias (RN-41).

string format: date-time
destinatario
required
object
conta
required
string
>= 1 characters <= 20 characters
ispbParticipante
required
string
/^[0-9A-Z]{8}$/
agencia
string
<= 4 characters

Example generated

{
  "idRec": "example",
  "calendario": {
    "dataExpiracaoSolicitacao": "2026-04-15T12:00:00Z"
  },
  "destinatario": {
    "conta": "example",
    "ispbParticipante": "example",
    "agencia": "example"
  }
}

Responses

Seção intitulada “Responses”

201

Seção intitulada “201”

Solicitação criada.

Media typeapplication/json
object
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}$/
calendario
required
object
dataExpiracaoSolicitacao
required

No futuro e em até 30 dias (RN-41).

string format: date-time
destinatario
required
object
conta
required
string
>= 1 characters <= 20 characters
ispbParticipante
required
string
/^[0-9A-Z]{8}$/
agencia
string
<= 4 characters
idSolicRec
required
string
status
required
string
Allowed values: CRIADA ENVIADA RECEBIDA ACEITA REJEITADA EXPIRADA CANCELADA

Example 

{
  "status": "CRIADA"
}

400

Seção intitulada “400”

Requisição fora do formato ou violando uma regra de negócio.

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

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

501

Seção intitulada “501”

O PSP da conta não oferece essa capacidade (RN-50).

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