Pular para o conteúdo
Vintém

Cadastrar conta recebedora

POST
/vintem/v1/contas
curl --request POST \
  --url http://localhost:8080/vintem/v1/contas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "example", "nome": "example", "psp": "example", "chave": "example", "ambiente": "homologacao", "credenciais": { "clientId": "example", "clientSecret": "example", "certificado": "example", "senhaCertificado": "example", "chaveAplicacao": "example" } }'

Exige o escopo conta:admin. As credenciais são cifradas antes de gravar (RN-61) e nunca voltam em resposta nenhuma. Use só sobre TLS.

Authorizations

Seção intitulada “Authorizations”

Request Bodyrequired

Seção intitulada “Request Bodyrequired”
Media typeapplication/json
object
id
required
string
/^[a-z0-9][a-z0-9-]{0,62}$/
nome
required
string
>= 1 characters
psp
required
string
>= 1 characters
chave
required

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

string
<= 77 characters
ambiente
required
string
Allowed values: homologacao producao
credenciais
object
clientId
string
clientSecret
string
certificado

Certificado do mTLS em base64: .p12 (com senhaCertificado) ou PEM com certificado e chave no mesmo arquivo. É conferido no cadastro: arquivo ilegível, senha errada, chave que não corresponde ou certificado vencido respondem 400.

string format: byte
senhaCertificado
string
chaveAplicacao

Chave de aplicação (developer_application_key) do portal do Banco do Brasil. Só o adapter bb usa.

string

Responses

Seção intitulada “Responses”

201

Seção intitulada “201”

Conta criada.

Media typeapplication/json
object
id
required
string
nome
required
string
psp
required
string
chave
required

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

string
<= 77 characters
ambiente
required
string
Allowed values: homologacao producao
ativa
required
boolean
certificado

Dados públicos do certificado do mTLS, conferido no cadastro (RN-62). O certificado e a chave privada nunca saem do Vintém. Ausente se a conta não tiver certificado.

object
sujeito
required
string
impressaoDigital
required

SHA-256 do certificado (DER), em hexadecimal minúsculo.

string
/^[0-9a-f]{64}$/
validade
required

Fim da validade (NotAfter), em UTC.

string format: date-time

Example 

{
  "ambiente": "homologacao",
  "certificado": {
    "sujeito": "CN=loja.example.com,O=Loja"
  }
}

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