Pular para o conteúdo
Vintém

Overview

Vintém 0.1.0

Seção intitulada “Vintém 0.1.0”

API do Vintém, o gateway Pix self-hosted.

As rotas Pix (/cob, /cobv…) são compatíveis com a API Pix do Banco Central (spec v2.10.0): mesmo caminho, mesmos campos, mesmo formato de erro. Quem já tem cliente escrito contra a spec troca a URL base e a autenticação. Este arquivo é escrito pelo Vintém — não é cópia da spec do BCB.

O que o Vintém acrescenta à spec vem marcado com x-vintem: true: o header Idempotency-Key e o campo expirada, por exemplo.

Rotas que não existem na spec (contas, API keys, administração) vivem em /vintem/v1/... (ADR-003).

Dinheiro trafega como string decimal com exatamente duas casas ("10.50").

Information

Operations

Seção intitulada “Operations”
GET
/cob/{txid}
PUT
/cob/{txid}
PATCH
/cob/{txid}
GET
/cob
POST
/cob
GET
/cobv/{txid}
PUT
/cobv/{txid}
PATCH
/cobv/{txid}
GET
/cobv
POST
/rec
GET
/rec/{idRec}
POST
/solicrec
POST
/cobr
GET
/cobr/{txid}
PUT
/cobr/{txid}
PATCH
/cobr/{txid}
POST
/cobr/{txid}/retentativa/{data}
GET
/pix/{e2eid}/devolucao/{id}
PUT
/pix/{e2eid}/devolucao/{id}
GET
/health
GET
/vintem/v1/contas
POST
/vintem/v1/contas
GET
/vintem/v1/contas/{id}
POST
/vintem/v1/contas/{id}/desativar
GET
/vintem/v1/webhooks/entregas
POST
/vintem/v1/webhooks/entregas/{eventoId}/reenviar
POST
/webhooks/pix/{contaId}/{token}
POST
/webhooks/pix/{contaId}/{token}/pix
POST
/webhooks/rec/{contaId}/{token}
POST
/webhooks/rec/{contaId}/{token}/rec
POST
/webhooks/cobr/{contaId}/{token}
POST
/webhooks/cobr/{contaId}/{token}/cobr

Authentication

Seção intitulada “Authentication”

apiKey

Seção intitulada “apiKey”

API key do Vintém, com escopos (RN-60). Envie Authorization: Bearer vtm_...

Security scheme type: http