Pular para o conteúdo
Vintém

Criar cobrança recorrente com txid definido pelo cliente

PUT
/cobr/{txid}
curl --request PUT \
  --url http://localhost:8080/cobr/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "idRec": "example", "calendario": { "dataDeVencimento": "2026-04-15" }, "valor": { "original": "10.50" }, "ajusteDiaUtil": true, "infoAdicional": "example" }'

O txid já identifica a criação, então Idempotency-Key é opcional aqui (RN-11).

Authorizations

Seção intitulada “Authorizations”

Parameters

Seção intitulada “Parameters”

Path Parameters

Seção intitulada “Path Parameters”
txid
required
string
/^[a-zA-Z0-9]{26,35}$/

Header Parameters

Seção intitulada “Header Parameters”
Idempotency-Key
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
dataDeVencimento
required

Data prevista de liquidação, de 2 a 10 dias corridos à frente (RN-42).

string format: date
valor
required
object
original
required
string
/^\d{1,10}\.\d{2}$/

Example 

10.50
ajusteDiaUtil

Leva a liquidação para o próximo dia útil se o vencimento cair num dia não útil.

boolean
default: true
infoAdicional
string
<= 140 characters

Responses

Seção intitulada “Responses”

201

Seção intitulada “201”

Cobrança recorrente 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
dataDeVencimento
required

Data prevista de liquidação, de 2 a 10 dias corridos à frente (RN-42).

string format: date
valor
required
object
original
required
string
/^\d{1,10}\.\d{2}$/
ajusteDiaUtil
required

Leva a liquidação para o próximo dia útil se o vencimento cair num dia não útil.

boolean
default: true
infoAdicional
string
<= 140 characters
txid
required
string
/^[a-zA-Z0-9]{26,35}$/
status
required
string
Allowed values: CRIADA ATIVA CONCLUIDA EXPIRADA REJEITADA CANCELADA
tentativas
required
Array<object>
object
dataLiquidacao
required
string format: date
tipo
required
string
Allowed values: AGND NTAG RIFL
status
required
string
Allowed values: SOLICITADA AGENDADA PAGA CANCELADA REJEITADA EXPIRADA
endToEndId
string
motivoRejeicao
string
motivoEncerramento

Código e descrição da rejeição ou do cancelamento.

string

Example 

{
  "valor": {
    "original": "10.50"
  },
  "ajusteDiaUtil": true,
  "status": "CRIADA",
  "tentativas": [
    {
      "tipo": "AGND",
      "status": "SOLICITADA"
    }
  ]
}

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

409

Seção intitulada “409”

Txid já existe, revisão desatualizada, ou Idempotency-Key reutilizada com outro payload.

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