Pular para o conteúdo
Vintém

Criar cobrança imediata com txid definido pelo cliente

PUT
/cob/{txid}
curl --request PUT \
  --url http://localhost:8080/cob/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "calendario": { "expiracao": 86400 }, "devedor": { "cpf": "example", "cnpj": "example", "nome": "example" }, "loc": { "id": 1 }, "valor": { "original": "10.50", "modalidadeAlteracao": 0 }, "chave": "example", "solicitacaoPagador": "example", "infoAdicionais": [ { "nome": "example", "valor": "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
calendario
required
object
expiracao

Validade em segundos a partir da criação (RN-13).

integer format: int32
default: 86400 >= 1
devedor

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
loc
object
id
integer format: int64
valor
required
object
original
required
string
/^\d{1,10}\.\d{2}$/

Example 

10.50
modalidadeAlteracao

1 permite ao pagador alterar o valor.

integer format: int32
0 <= 1
chave
required

Chave Pix do recebedor (telefone, e-mail, CPF/CNPJ ou EVP).

string
<= 77 characters
solicitacaoPagador
string
<= 140 characters
infoAdicionais
Array<object>
<= 50 items
object
nome
required
string
<= 50 characters
valor
required
string
<= 200 characters

Responses

Seção intitulada “Responses”

201

Seção intitulada “201”

Cobrança criada.

Media typeapplication/json
object
calendario
required
object
criacao
required
string format: date-time
expiracao
required
integer format: int32
txid
required
string
/^[a-zA-Z0-9]{26,35}$/
revisao
required

Começa em 0 e cresce de 1 em 1 a cada alteração.

integer format: int32
devedor

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
loc
object
id
required
integer format: int64
location
string
tipoCob
string
Allowed values: cob cobv
criacao
string format: date-time
location
string
status
required
string
Allowed values: ATIVA CONCLUIDA REMOVIDA_PELO_USUARIO_RECEBEDOR REMOVIDA_PELO_PSP
valor
required
object
original
required
string
/^\d{1,10}\.\d{2}$/
modalidadeAlteracao

1 permite ao pagador alterar o valor.

integer format: int32
0 <= 1
chave
required

Chave Pix do recebedor (telefone, e-mail, CPF/CNPJ ou EVP).

string
<= 77 characters
solicitacaoPagador
string
infoAdicionais
Array<object>
object
nome
required
string
<= 50 characters
valor
required
string
<= 200 characters
pixCopiaECola
string
<= 512 characters
expirada

Extensão do Vintém. Na spec a cob continua ATIVA depois de expirar; este campo poupa o cálculo (RN-13).

boolean

Example 

{
  "loc": {
    "tipoCob": "cob"
  },
  "status": "ATIVA",
  "valor": {
    "original": "10.50",
    "modalidadeAlteracao": 0
  }
}

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

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