Aviso de Pix recebido, enviado pelo banco

POST

/webhooks/pix/{contaId}/{token}

curl --request POST \
  --url http://localhost:8080/webhooks/pix/example/example \
  --header 'Content-Type: application/json' \
  --data '{}'

Chamada pelo banco, não pela sua aplicação. A URL (com o token) é gerada por vintem conta webhook e registrada no PSP. O corpo segue o callback da spec do BCB ({"pix": [...]}); bancos que desviam são tratados pelo adapter da conta. Responde 200 só depois de gravar (RN-30).

Parameters

Path Parameters

contaId

required

string

/^[a-z0-9][a-z0-9-]{0,62}$/

token

required

string

/^[0-9a-f]{48}$/

Request Body^required

Media typeapplication/json

Callback da spec do BCB. Aceito como objeto livre porque quem interpreta é o adapter do banco.

object

Example ^generated

{}

Responses

200

Pix gravados (os repetidos são ignorados).

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