Get Pix charge (COB or COBV) by access token — JWS response

​

Payload location da API Pix v2.9.0: GET /{pixUrlAccessToken} para cobrança imediata e GET /cobv/{pixUrlAccessToken} para cobrança com vencimento. São as URLs que o loc.location anuncia e que viajam no BR Code (tag 26.25), montadas pelo LocationUrlBuilder a partir de pix.dynamic.location.url-base. A resolução é a mesma nas duas rotas — o token identifica a cobrança, seja ela COB ou COBV.

O corpo é uma serialização compacta JWS (RFC 7515, alg=PS256, typ=JOSE, cadeia x5c) cujo payload é o CobPayload/CobVPayload da API Pix — é esse o schema declarado abaixo, como na norma, que também publica o payload sob application/jose. O consumidor deve verificar a assinatura contra o JWK Set publicado antes de usar o conteúdo. 404 for unknown tokens, 410 for removed charges. Optional COBV query params: DPP (data de pagamento pretendida, ISO date) and codMun (IBGE, 7 digits). When DPP is set, includes valor.final and detalhamentoValorFinal; codMun is echoed in the breakdown.

Path Parameters
  • pixUrlAccessToken
    Type: string
    required
Query Parameters
  • DPP
    Type: string Format: date

    Data de pagamento pretendida (DPP), ISO 8601 YYYY-MM-DD. Nome conforme o OpenAPI do Pix 2.9.0, GET /cobv/{pixUrlAccessToken}. Quando informado, a resposta COBV inclui valor.final e detalhamentoValorFinal calculados para essa data.

  • codMun
    Type: string

    IBGE municipality code of the payer (7 digits), echoed in detalhamentoValorFinal.

Responses
  • application/jose
  • 400

    Bad Request

  • 404

    Not Found

  • 410

    Gone

Request Example for get/{pixUrlAccessToken}
curl http://localhost:8080/19abde72-7e4a-4a1a-9d5d-9c4b03a3e2e7 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "txid": "string",
  "revisao": 1,
  "status": "ATIVA",
  "calendario": {
    "criacao": "string",
    "expiracao": 1,
    "dataDeVencimento": "string",
    "validadeAposVencimento": 1,
    "apresentacao": "string"
  },
  "valor": {
    "original": "string",
    "final": "string",
    "modalidadeAlteracao": 1,
    "retirada": {
      "saque": {
        "valor": "string",
        "modalidadeAlteracao": 1,
        "modalidadeAgente": "string",
        "prestadorDoServicoDeSaque": "string"
      },
      "troco": {
        "valor": "string",
        "modalidadeAlteracao": 1,
        "modalidadeAgente": "string",
        "prestadorDoServicoDeSaque": "string"
      }
    },
    "abatimento": "string",
    "juros": "string",
    "multa": "string",
    "desconto": "string"
  },
  "devedor": {
    "cpf": "string",
    "cnpj": "string",
    "nome": "string",
    "email": "string",
    "logradouro": "string",
    "cidade": "string",
    "uf": "string",
    "cep": "string"
  },
  "recebedor": {
    "cpf": "string",
    "cnpj": "string",
    "nome": "string",
    "logradouro": "string",
    "cidade": "string",
    "uf": "string",
    "cep": "string"
  },
  "chave": "string",
  "solicitacaoPagador": "string",
  "infoAdicionais": [
    {
      "nome": "string",
      "valor": "string"
    }
  ],
  "loc": {
    "id": 1,
    "location": "string",
    "tipoCob": "cob",
    "criacao": "string"
  },
  "pixCopiaECola": "string"
}

OK