Pular para o conteúdo principal

API Pix (2.6.1)

A API Pix padroniza serviços oferecidos pelo PSP recebedor no contexto do arranjo Pix, como criação de cobrança, verificação de Pix recebidos, devolução e consultas. Os serviços expostos pelo PSP recebedor permitem ao usuário recebedor estabelecer integração de sua automação com os serviços Pix do PSP.

Evolução da API Pix

A API Pix busca respeitar SemVer. Nesse sentido, mudanças compatíveis não devem gerar nova versão major.

A versão da API é composta por 4 elementos: major, minor, patch e release candidate. A versão v[x]que consta no path da URL é o elemento major da versão da API. A evolução da versão se dá seguinte forma:

  • Major: alterações incompatíveis, com quebra de contrato (v1.0.0 → v2.0.0)
  • Minor: alterações compatíveis, sem quebra de contrato (v1.1.0 → v1.2.0)
  • Patch: bugfixes, esclarecimentos às especificações, sem alterações funcionais (v1.1.1 → v1.1.2)
  • Release candidate: versões de pré-lançamento de qualquer patch futuro, minor ou major (v1.0.0-rc.1 → v1.0.0-rc.22)

Alterações sem quebra de contrato e esclarecimentos às especificações podem ocorrer a qualquer momento. Clientes devem estar preparados para lidar com essas mudanças sem quebrar.

As seguintes mudanças são esperadas e consideradas retrocompatíveis:

  • Adição de novos recursos na API Pix.
  • Adição de novos parâmetros opcionais a cobranças.
  • Adição de novos campos em respostas da API Pix.
  • Alteração da ordem de campos.
  • Adição de novos elementos em enumerações

Tratamento de erros

A API Pix retorna códigos de status HTTP para indicar sucesso ou falhas das requisições.

Códigos 2xx indicam sucesso. Códigos 4xx indicam falhas causadas pelas informações enviadas pelo cliente ou pelo estado atual das entidades. Códigos 5xx indicam problemas no serviço no lado da API Pix.

As respostas de erro incluem no corpo detalhes do erro seguindo o schema da RFC 7807.

O campo type identifica o tipo de erro e na API Pix segue o padrão:

https://pix.bcb.gov.br/api/v2/error/<TipoErro>

O padrão acima listado, referente ao campo type, não consiste, necessariamente, em uma URL que apresentará uma página web válida, ou um endpoint válido, embora possa, futuramente, ser exatamente o caso. O objetivo primário é apenas e tão somente identificar o tipo de erro.

Abaixo estão listados os tipos de erro e possíveis violações da API Pix.

Gerais

Esta seção reúne erros que poderiam ser retornados por quaisquer endpoints listados na API Pix.

RequisicaoInvalida

AcessoNegado

  • Significado: Requisição de participante autenticado que viola alguma regra de autorização.
  • HTTP Status Code: 403 Forbidden.

NaoEncontrado

  • Significado: Entidade não encontrada.
  • HTTP Status Code: 404 Not Found.

PermanentementeRemovido

  • Significado: Indica que a entidade existia, mas foi permanentemente removida.
  • HTTP Status Code: 410 Gone.

ErroInternoDoServidor

ServicoIndisponivel

  • Significado: Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.
  • HTTP Status Code: 503 Service Unavailable.

IndisponibilidadePorTempoEsgotado

  • Significado: Indica que o serviço demorou além do esperado para retornar.
  • HTTP Status Code: 504 Gateway Timeout.

Tag CobPayload

Esta seção reúne erros retornados pelos endpoints organizados sob a tag CobPayload. Estes erros indicam problemas na tentativa de recuperação, via location, do Payload JSON que representa a cobrança.

CobPayloadNaoEncontrado

  • Significado: a cobrança em questão não foi encontrada para a location requisitada.
  • HTTP Status Code: 404 ou 410.
  • endpoints: GET /{pixUrlAccessToken}, GET /cobv/{pixUrlAccessToken}.

Se a presente location exibia uma cobrança, mas não a exibirá mais de maneira permanentemente, pode-se aplicar o HTTP status code 410. Se a presente location não está exibindo nenhuma cobrança, pode-se utilizar o HTTP status code 404.

Uma cobrança pode estar "expirada" (calendario.expiracao), "vencida", "Concluida", entre outros estados em que não poderia ser efetivamente paga. Nesses casos, é uma liberalidade do PSP recebedor retornar o presente código de erro ou optar por servir o payload de qualquer maneira, objetivando fornecer uma informação adicional ao usuário pagador final a respeito da cobrança.

CobPayloadOperacaoInvalida

  • Significado: a cobrança existe, mas a requisição é inválida.
  • HTTP Status Code: 400.
  • endpoints: GET /cobv/{pixUrlAccessToken}.

Violações:

  • codMun não respeita o schema.
  • codMun não é um código válido segundo a tabela de municípios do IBGE.
  • DPP não respeita o schema.
  • DPP anterior ao momento presente.
  • DPP superior à validade da cobrança em função dos parâmetros calendario.dataDeVencimento e calendario.validadeAposVencimento. Exemplo: dataDeVencimento => 2020-12-25, validadeAposVencimento => 10, DPP => 2021-01-05. Neste exemplo, o parâmetro DPP é inválido considerando o contexto apresentado porque é uma data em que a cobrança não poderá ser paga. A cobrança, neste exemplo, não será considerada válida a partir da data 2021-01-05.

Tag Cob

Esta seção reúne erros retornados pelos endpoints organizados sob a tag Cob. Esses erros indicam problemas no gerenciamento de uma cobrança para pagamento imediato.

CobNaoEncontrado

  • Significado: Cobrança não encontrada para o txid informado.
  • HTTP Status Code: 404.
  • endpoints: [GET|PATCH] /cob/{txid}.

CobOperacaoInvalida

  • Significado: a requisição que busca alterar ou criar uma cobrança para pagamento imediato não respeita o schema ou está semanticamente errada.
  • HTTP Status Code: 400.
  • endpoints: [POST|PUT|PATCH] /cob/{txid}.

Violações para os endpoints PUT|PATCH /cob/{txid}:

  • O campo cob.calendario.expiracao é igual ou menor que zero.
  • O campo cob.valor.original não respeita o schema.
  • O campo cob.valor.original é zero.
  • O objeto cob.devedor não respeita o schema.
  • O campo cob.chave não respeita o schema.
  • O campo cob.chave corresponde a uma conta que não pertence a este usuário recebedor.
  • O campo solicitacaoPagador não respeita o schema.
  • O objeto infoAdicionais não respeita o schema.
  • O location referenciado por loc.id inexiste.
  • O location referenciado por loc.id já está sendo utilizado por outra cobrança.
  • O location referenciado por cob.loc.id apresenta tipo "cobv" (deveria ser "cob").

Violações específicas para o endpoint PUT /cob/{txid}:

  • A cobrança já existe, não está no status ATIVA, e a presente requisição busca alterá-la.

Violações específicas para o endpoint PATCH /cob/{txid}:

  • A cobrança não está ATIVA, e a presente requisição busca alterá-la.
  • A cobrança está ATIVA, e a presente requisição propõe alterar seu status para REMOVIDA_PELO_USUARIO_RECEBEDOR juntamente com outras alterações (não faz sentido remover uma cobrança ao mesmo tempo em que se realizam alterações que não serão aproveitadas).
  • o campo cob.status não respeita o schema.

CobConsultaInvalida

  • Significado: os parâmetros de consulta à lista de cobranças para pagamento imediato não respeitam o schema ou não fazem sentido semanticamente.
  • HTTP Status Code: 400.
  • endpoints: GET /cob e GET /cob/{txid}.

Violações específicas para o endpoint GET /cob:

  • algum dos parâmetros informados para a consulta não respeita o schema.
  • o timestamp representado pelo parâmetro fim é anterior ao timestamp representado pelo parâmetro inicio.
  • ambos os parâmetros cpf e cnpj estão preenchidos.
  • o parâmetro paginacao.paginaAtual é negativo.
  • o parâmetro paginacao.itensPorPagina é negativo.

Violações específicas para o endpoint GET /cob/{txid}:

  • o parâmetro revisao corresponde a uma revisão inexistente para a cobrança apontada pelo parâmetro txid.

Tag CobV

Esta seção reúne erros retornados pelos endpoints organizados sob a tag CobV. Esses erros indicam problemas no gerenciamento de uma cobrança com vencimento.

CobVNaoEncontrada

  • Significado: Cobrança com vencimento não encontrada para o txid informado.
  • HTTP Status Code: 404.
  • endpoints: [GET|PATCH] /cobv/{txid}.

CobVOperacaoInvalida

  • Significado: a requisição que busca alterar ou criar uma cobrança com vencimento não respeita o schema ou está semanticamente errada.
  • HTTP Status Code: 400.
  • endpoints: [PUT|PATCH] /cobv/{txid}.

Violações para os endpoints PUT|PATCH /cobv/{txid}:

  • Este txid está associado a um lote e no referido lote, o status desta cobrança está atribuído como "EM_PROCESSAMENTO" ou "NEGADA".
  • O campo cobv.calendario.dataDeVencimento é anterior à data de criação da cobrança.
  • O campo cobv.calendario.validadeAposVencimento é menor do que zero.
  • O objeto cobv.devedor não respeita o schema.
  • O objeto cobv.devedor não respeita o schema.
  • O campo cobv.chave não respeita o schema.
  • O campo cobv.chave corresponde a uma conta que não pertence a este usuário recebedor.
  • O campo solicitacaoPagador não respeita o schema.
  • O objeto infoAdicionais não respeita o schema.
  • O location referenciado por cobv.loc.id inexiste.
  • O location referenciado por cobv.loc.id já está sendo utilizado por outra cobrança.
  • O location referenciado por cobv.loc.id apresenta tipo "cob" (deveria ser "cobv").
  • O campo cobv.valor.original não respeita o schema.
  • O campo cobv.valor.original apresenta o valor zero.
  • O objeto cobv.valor.multa não respeita o schema.
  • O objeto cobv.valor.juros não respeita o schema.
  • O objeto cobv.valor.abatimento não respeita o schema.
  • O objeto cobv.valor.desconto não respeita o schema.
  • O objeto cobv.valor.abatimento representa um valor maior ou igual ao valor da cobrança original ou maior ou igual a 100%.
  • O objeto cobv.valor.desconto apresenta algum elemento de desconto que representa um valor maior ou igual ao valor da cobrança original ou maior ou igual a 100%.
  • O objeto cobv.valor.desconto apresenta algum elemento cuja data seja posterior à data de vencimento representada por calendario.dataDeVencimento.
  • O objeto cobv.valor.desconto apresenta modalidade no valor 1 ou 2, porém cobv.valor.desconto.valorPerc encontra-se preenchido
  • O objeto cobv.valor.desconto apresenta modalidade no valor 1 ou 2, porém o array cobv.valor.desconto.descontoDataFixa está vazio ou nulo.
  • O objeto cobv.valor.desconto apresenta modalidade nos valores de 3 a 6, porém o elemento cobv.valor.desconto.valorPerc não está preenchido.
  • O objeto cobv.valor.desconto apresenta modalidade nos valores de 3 a 6, porém o elemento cobv.valor.desconto.descontoDataFixa está preenchido ou não nulo.

Violações específicas para o endpoint PUT /cobv/{txid}:

  • A cobrança já existe, não está ATIVA, e a presente requisição busca alterá-la

Violações específicas para o endpoint PATCH /cobv/{txid}:

  • A cobrança não está ATIVA, e a presente requisição busca alterá-la
  • A cobrança está ATIVA, e a presente requisição propõe alterar seu status para REMOVIDA_PELO_USUARIO_RECEBEDOR juntamente com outras alterações (não faz sentido remover uma cobrança ao mesmo tempo em que se realizam alterações que não serão aproveitadas).
  • o campo cob.status não respeita o schema.

CobVConsultaInvalida

  • Significado: os parâmetros de consulta à lista de cobranças com vencimento não respeitam o schema ou não fazem sentido semanticamente.
  • HTTP Status Code: 400.
  • endpoints: GET /cobv e GET /cobv/{txid}.

Violações específicas para o endpoint GET /cobv:

  • algum dos parâmetros informados para a consulta não respeita o schema.
  • o timestamp representado pelo parâmetro fim é anterior ao timestamp representado pelo parâmetro inicio.
  • ambos os parâmetros cpf e cnpj estão preenchidos.
  • o parâmetro paginacao.paginaAtual é negativo.
  • o parâmetro paginacao.itensPorPagina é negativo.

Violações específicas para o endpoint GET /cobv/{txid}:

  • o parâmetro revisao corresponde a uma revisão inexistente para a cobrança apontada pelo parâmetro txid.

Tag LoteCobV

Esta seção reúne erros referentes a endpoints que tratam do gerenciamento de lotes de cobrança.

LoteCobVNaoEncontrado

  • Significado: Lote não encontrado para o id informado.
  • HTTP Status Code: 404.
  • endpoints: [GET|PATCH] /lotecobv/{id}.

LoteCobVOperacaoInvalida

  • Significado: a requisição que busca alterar ou criar um lote de cobranças com vencimento não respeita o schema ou está semanticamente errada.
  • HTTP Status Code: 400.
  • endpoints: [PUT|PATCH] /lotecobv/{id}.

Violações para os endpoints PUT|PATCH /lotecobv/{id}:

  • O campo loteCobV.descricao não respeita o schema.
  • O objeto loteCobV.cobsV não respeita o schema.

Violações para o endpoint PUT /lotecobv/{id}:

  • a presente requisição tenta criar um conjunto de cobranças dentre as quais pelo menos uma cobrança já encontra-se criada.
  • a presente requisição busca alterar um lote já existente, entretanto contém um array de solicitações de alteração de cobranças que não referencia exatamente as mesmas cobranças referenciadas pela requisição original que criou o lote. Uma vez criado um lote, não se pode remover ou adicionar solicitações de criação ou alteração de cobranças a este lote.

Violações para o endpoint PATCH /lotecobv/{id}:

  • a presente requisição busca alterar um lote já existente e contém, no array de cobranças representado por cobsv, uma cobrança não existente no array de cobranças atribuído pela requisição original que criou o lote. Uma vez criado um lote, não se pode remover ou adicionar cobranças a este lote.

Violações para os endpoints GET /lotecobv/{id}:

  • observação: para cada elemento do array cobsv, retornado por este endpoint, caso a requisição de criação de cobrança esteja em status "NEGADA", o atributo problema deste elemento deve ser preenchido respeitando o schema referenciado pela API Pix.
  • o preenchimento do atributo problema, conforme descrito acima, segue o mesmo regramento dos erros especificados para os endpoints [PUT/PATCH /cobv/{txid}], de maneira a possibilitar, ao usuário recebedor, entender qual foi a violação cometida ao se tentar criar a cobrança referenciada por este elemento do array cobsv.

LoteCobVConsultaInvalida

  • Significado: os parâmetros de consulta à lista de lotes de cobrança com vencimento não respeitam o schema ou não fazem sentido semanticamente.
  • HTTP Status Code: 400.
  • endpoints: GET /lotecobv e GET /lotecobv/{id}.

Violações específicas para o endpoint GET /lotecobv:

  • algum dos parâmetros informados para a consulta não respeitam o schema.
  • o timestamp representado pelo parâmetro fim é anterior ao timestamp representado pelo parâmetro inicio.
  • o parâmetro paginacao.paginaAtual é negativo.
  • o parâmetro paginacao.itensPorPagina é negativo.

Tag PayloadLocation

Esta seção reúne erros referentes a endpoints que tratam do gerenciamento de locations.

PayloadLocationNaoEncontrado

  • Significado: Location não encontrada para o id informado.
  • HTTP Status Code: 404.
  • endpoints: [GET|PATCH] /loc/{id}, DELETE /loc/{id}/txid.

PayloadLocationOperacaoInvalida

  • Significado: a presente requisição busca criar uma location sem respeitar o schema estabelecido.
  • HTTP Status Code: 400.
  • endpoints: POST /loc.

Violações para o endpoint POST /loc:

  • o campo tipoCob não respeita o schema.

PayloadLocationConsultaInvalida

  • Significado: os parâmetros de consulta à lista de locations não respeitam o schema ou não fazem sentido semanticamente.
  • HTTP Status Code: 400.
  • endpoints: GET /loc e GET /loc/{id}.

Violações específicas para o endpoint GET /loc:

  • algum dos parâmetros informados para a consulta não respeitam o schema.
  • o timestamp representado pelo parâmetro fim é anterior ao timestamp representado pelo parâmetro inicio.
  • o parâmetro paginacao.paginaAtual é negativo.
  • o parâmetro paginacao.itensPorPagina é negativo.

Tag Pix

Reúne erros em endpoints de gestão de Pix recebidos e solicitação de devoluções.

PixNaoEncontrado

  • Significado: pix não encontrada para o e2eid informado.
  • HTTP Status Code: 404.
  • endpoints: GET /pix/{e2eid}

PixDevolucaoNaoEncontrada

  • Significado: devolução representada por {id} não encontrada para o e2eid informado.
  • HTTP Status Code: 404.
  • endpoints: GET /pix/{e2eid}/devolucao/{id}

PixConsultaInvalida

  • Significado: os parâmetros de consulta à lista de pix recebidos não respeitam o schema ou não fazem sentido semanticamente.
  • HTTP Status Code: 400.
  • endpoints: GET /pix.

Violações específicas para o endpoint GET /pix:

  • algum dos parâmetros informados para a consulta não respeita o schema.
  • o timestamp representado pelo parâmetro fim é anterior ao timestamp representado pelo parâmetro inicio.
  • ambos os parâmetros cpf e cnpj estão preenchidos.
  • o parâmetro paginacao.paginaAtual é negativo.
  • o parâmetro paginacao.itensPorPagina é negativo.

PixDevolucaoInvalida

  • Significado: a presente requisição de devolução não respeita o schema ou não faz sentido semanticamente.
  • HTTP Status Code: 400.
  • endpoints: PUT /pix/{e2eid}/devolucao/{id}.

Violações específicas para o endpoint PUT /pix/{e2eid}/devolucao/{id}:

  • O campo devolucao.valor não respeita o schema.
  • A presente requisição de devolução, em conjunto com as demais prévias devoluções, se aplicável, excederia o valor do pix originário.
  • A presente requisição de devolução apresenta um {id} já utilizado por outra requisição de devolução para o {e2eid} em questão.
  • A presente requisição de devolução viola a janela de tempo permitida para solicitações de devoluções de um pix (hoje estabelecida como 90 dias desde a data de liquidação original do pix).

Tag Webhook

Reúne erros dos endpoints que tratam do gerenciamento dos Webhooks da API Pix.

WebhookOperacaoInvalida

  • Significado: a presente requisição busca criar um webhook sem respeitar o schema ou, ainda, apresenta semântica inválida.
  • HTTP Status Code: 400.
  • endpoints: PUT /webhook/{chave}.

Violações para o endpoint PUT /webhook/{chave}:

  • o parâmetro {chave} não corresponde a uma chave DICT válida.
  • o parâmetro {chave} não corresponde a uma chave DICT pertencente a este usuário recebedor.
  • Campo webhook.webhookUrl não respeita o schema.

WebhookNaoEncontrado

  • Significado: o webhook denotado por {chave} não encontra-se estabelecido.
  • HTTP Status Code: 404.
  • endpoints: GET /webhook/{chave}, DELETE /webhook/{chave}

WebhookConsultaInvalida

  • Significado: os parâmetros de consulta à lista de webhooks ativados não respeitam o schema ou não fazem sentido semanticamente.
  • HTTP Status Code: 400.
  • endpoints: GET /webhook.

Violações específicas para o endpoint GET /webhook:

  • algum dos parâmetros informados para a consulta não respeita o schema.
  • o timestamp representado pelo parâmetro fim é anterior ao timestamp representado pelo parâmetro inicio.
  • o parâmetro paginacao.paginaAtual é negativo.
  • o parâmetro paginacao.itensPorPagina é negativo.

Authentication

OAuth2

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://pix.example.com/oauth/token
Scopes:
  • cob.write -

    Permissão para alteração de cobranças imediatas

  • cob.read -

    Permissão para consulta de cobranças imediatas

  • cobv.write -

    Permissão para alteração de cobranças com vencimento

  • cobv.read -

    Permissão para consulta de cobranças com vencimento

  • lotecobv.write -

    Permissão para alteração de lotes de cobranças com vencimento

  • lotecobv.read -

    Permissão para consulta de lotes de cobranças com vencimento

  • pix.write -

    Permissão para alteração de Pix

  • pix.read -

    Permissão para consulta de Pix

  • webhook.read -

    Permissão para consulta do webhook

  • webhook.write -

    Permissão para alteração do webhook

  • payloadlocation.write -

    Permissão para alteração de payloads

  • payloadlocation.read -

    Permissão para consulta de payloads

Reúne endpoints (locations) que retornam o Payload JSON que representa uma Cobrança

Reúne endpoints (locations) utilizados pelo software do PSP pagador para recuperar o payload JSON que representa uma cobrança.

Os endpoints listados nesta Tag apresentam requisitos de autenticação e autorização diferenciados em relação aos outros endpoints listados na presente API.

São endpoints abertos para que qualquer cliente da internet possa se conectar. Cada location é uma url de capacidade, funcionalidade implementada via o fragmento {pixUrlAccessToken}. Para mais informações, consultar o Manual de Padrões para iniciação do Pix.

Recuperar o payload JSON que representa a cobrança imediata.

Endpoint (location) que serve um payload que representa uma cobrança imediata.

No momento que o usuário devedor efetua a leitura de um QR Code dinâmico gerado pelo recebedor, esta URL será acessada e seu conteúdo consiste em uma estrutura JWS. As informações sobre a segurança no acesso às urls encontram-se no Manual de Segurança do Pix disponível em nesse link.

path Parameters
pixUrlAccessToken
required
string

Responses

Response samples

Content type
application/jose
{
  "calendario": {
    "criacao": "2020-09-15T19:39:54.013Z",
    "apresentacao": "2020-04-01T18:00:00Z",
    "expiracao": 3600
  },
  "txid": "fc9a4366ff3d4964b5dbc6c91a8722d3",
  "revisao": 3,
  "status": "ATIVA",
  "valor": {
    "original": "500.00",
    "modalidadeAlteracao": 0
  },
  "chave": "7407c9c8-f78b-11ea-adc1-0242ac120002",
  "solicitacaoPagador": "Informar cartao fidelidade",
  "infoAdicionais": [
    {
      "nome": "quantidade",
      "valor": "2"
    }
  ]
}

Recuperar o payload JSON que representa a cobrança com vencimento.

Endpoint (location) que serve um payload que representa uma cobrança com vencimento.

No momento que o usuário devedor efetua a leitura de um QR Code dinâmico gerado pelo recebedor, esta URL será acessada e seu conteúdo consiste em uma estrutura JWS. As informações sobre a segurança no acesso às urls encontram-se no Manual de Segurança do Pix disponível em nesse link.

path Parameters
pixUrlAccessToken
required
string
query Parameters
codMun
string (Código do município) /^\d{7}$/

Código baseado na Tabela de Códigos de Municípios do IBGE que apresenta a lista dos municípios brasileiros associados a um código composto de 7 dígitos, sendo os dois primeiros referentes ao código da Unidade da Federação.

DPP
string <date>
Example: DPP=2021-04-01

Data de pagamento pretendida. Trata-se de uma data, no formato YYYY-MM-DD, segundo ISO 8601.

Responses

Response samples

Content type
application/jose
{
  "calendario": {
    "criacao": "2020-09-15T19:39:54.013Z",
    "apresentacao": "2020-04-01T18:00:00Z",
    "dataDeVencimento": "2020-12-31",
    "validadeAposVencimento": 30
  },
  "devedor": {
    "cnpj": "56989000019533",
    "nome": "Empresa de Alimentos SA"
  },
  "recebedor": {
    "logradouro": "Rua 20 Numero 70, Bairro Luz",
    "cidade": "Belo Horizonte",
    "uf": "MG",
    "cep": "55120750",
    "cnpj": "58900633120711",
    "nome": "Empresa de Abastecimento SA"
  },
  "txid": "fc9a4366ff3d4964b5dbc6c91a8722d3",
  "revisao": 3,
  "status": "ATIVA",
  "valor": {
    "original": "123.45",
    "multa": "15.00",
    "juros": "2.00",
    "final": "140.45"
  },
  "chave": "7407c9c8-f78b-11ea-adc1-0242ac120002",
  "solicitacaoPagador": "Informar cartao fidelidade",
  "infoAdicionais": [
    {
      "nome": "quantidade",
      "valor": "2"
    }
  ]
}

Gerenciamento de cobranças para pagamento imediato

Reúne endpoints destinados a lidar com gerenciamento de cobranças imediatas.

Criar cobrança imediata.

Endpoint para criar uma cobrança imediata.

Authorizations:
OAuth2 (cob.write)
path Parameters
txid
required
string (Id da Transação) [a-zA-Z0-9]{26,35}

Identificador da transação

O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.

Na pacs.008, é referenciado como TransactionIdentification <txId> ou idConciliacaoRecebedor.

Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.

O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.

Request Body schema: application/json

Dados para geração da cobrança imediata.

required
object (Calendário)

Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.

Pessoa Física (object) or Pessoa Jurídica (object)

Os campos aninhados sob o objeto devedor são opcionais e identificam o devedor, ou seja, a pessoa ou a instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar, efetivamente, o pagamento do documento. Não é permitido que o campo devedor.cpf e campo devedor.cnpj estejam preenchidos ao mesmo tempo. Se o campo devedor.cnpj está preenchido, então o campo devedor.cpf não pode estar preenchido, e vice-versa. Se o campo devedor.nome está preenchido, então deve existir ou um devedor.cpf ou um campo devedor.cnpj preenchido.

object

Identificador da localização do payload.

required
object

valores monetários referentes à cobrança.

chave
required
string (Chave DICT do recebedor) <= 77 characters

Formato do campo chave

  • O campo chave determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.
  • Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.
  • O formato das chaves pode ser encontrado na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para iniciação do Pix.
solicitacaoPagador
string (Solicitação ao pagador) <= 140 characters

O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation . O tamanho do campo na pacs.008 está limitado a 140 caracteres.

Array of objects (Informações adicionais) <= 50

Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.

Responses

Request samples

Content type
application/json
Example
{
  • "calendario": {
    },
  • "devedor": {
    },
  • "valor": {
    },
  • "chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
  • "solicitacaoPagador": "Serviço realizado.",
  • "infoAdicionais": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "calendario": {
    },
  • "txid": "7978c0c97ea847e78e8849634473c1f1",
  • "revisao": 0,
  • "loc": {
    },
  • "location": "pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25",
  • "status": "ATIVA",
  • "devedor": {
    },
  • "valor": {
    },
  • "chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
  • "solicitacaoPagador": "Serviço realizado.",
  • "infoAdicionais": [
    ]
}

Revisar cobrança imediata.

Authorizations:
OAuth2 (cob.write)
path Parameters
txid
required
string (Id da Transação) [a-zA-Z0-9]{26,35}

Identificador da transação

O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.

Na pacs.008, é referenciado como TransactionIdentification <txId> ou idConciliacaoRecebedor.

Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.

O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.

Request Body schema: application/json

Dados para geração da cobrança.

object (Calendário)

Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.

Pessoa Física (object) or Pessoa Jurídica (object)

Os campos aninhados sob o objeto devedor são opcionais e identificam o devedor, ou seja, a pessoa ou a instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar, efetivamente, o pagamento do documento. Não é permitido que o campo devedor.cpf e campo devedor.cnpj estejam preenchidos ao mesmo tempo. Se o campo devedor.cnpj está preenchido, então o campo devedor.cpf não pode estar preenchido, e vice-versa. Se o campo devedor.nome está preenchido, então deve existir ou um devedor.cpf ou um campo devedor.cnpj preenchido.

object

Identificador da localização do payload.

status
string (Status do registro da cobrança)
Value: "REMOVIDA_PELO_USUARIO_RECEBEDOR"
object (Valor da cobrança imediata)

valores monetários referentes à cobrança.

chave
string (Chave DICT do recebedor) <= 77 characters

Formato do campo chave

  • O campo chave determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.
  • Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.
  • O formato das chaves pode ser encontrado na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para iniciação do Pix.
solicitacaoPagador
string (Solicitação ao pagador) <= 140 characters

O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation . O tamanho do campo na pacs.008 está limitado a 140 caracteres.

Array of objects (Informações adicionais) <= 50

Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.

Responses

Request samples

Content type
application/json
Example
{
  • "loc": {
    },
  • "devedor": {
    },
  • "valor": {
    },
  • "solicitacaoPagador": "Cobrança dos serviços prestados."
}

Response samples

Content type
application/json
{
  • "calendario": {
    },
  • "txid": "7978c0c97ea847e78e8849634473c1f1",
  • "revisao": 1,
  • "loc": {
    },
  • "location": "pix.example.com/qr/v1/9d36b84fc70b478fb95c12729b90ca25",
  • "status": "ATIVA",
  • "devedor": {
    },
  • "valor": {
    },
  • "chave": "a1f4102e-a446-4a57-bcce-6fa48899c1d1",
  • "solicitacaoPagador": "Cobrança dos serviços prestados."
}

Consultar cobrança imediata.

Endpoint para consultar uma cobrança através de um determinado txid.

Authorizations:
OAuth2 (cob.read)
path Parameters
txid
required
string (Id da Transação) [a-zA-Z0-9]{26,35}

Identificador da transação

O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.

Na pacs.008, é referenciado como TransactionIdentification <txId> ou idConciliacaoRecebedor.

Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.

O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.

query Parameters
revisao
integer <int32> (Revisão)

O campo revisao

Denota a revisão da cobrança. Sempre começa em zero. Sempre varia em acréscimos de 1.

O incremento em uma cobrança deve ocorrer sempre que um objeto da cobrança em questão for alterado. O campo loc é uma exceção a esta regra.

Se em uma determinada alteração em uma cobrança, o único campo alterado for o campo loc, então esta operação não incrementa a revisão da cobrança.

O campo loc não ocasiona uma alteração na cobrança em si. Não é necessário armazenar histórico das alterações do campo loc para uma determinada cobrança. Para os outros campos da cobrança, registra-se histórico.

Responses

Response samples

Content type
application/json
Example
{
  • "calendario": {
    },
  • "txid": "7978c0c97ea847e78e8849634473c1f1",
  • "revisao": 0,
  • "loc": {
    },
  • "location": "pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25",
  • "status": "ATIVA",
  • "devedor": {
    },
  • "valor": {
    },
  • "chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
  • "solicitacaoPagador": "Serviço realizado.",
  • "infoAdicionais": [
    ]
}

Criar cobrança imediata.

Endpoint para criar uma cobrança imediata, neste caso, o txid deve ser definido pelo PSP.

Authorizations:
OAuth2 (cob.write)
Request Body schema: application/json

Dados para geração da cobrança imediata.

required
object (Calendário)

Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.

Pessoa Física (object) or Pessoa Jurídica (object)

Os campos aninhados sob o objeto devedor são opcionais e identificam o devedor, ou seja, a pessoa ou a instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar, efetivamente, o pagamento do documento. Não é permitido que o campo devedor.cpf e campo devedor.cnpj estejam preenchidos ao mesmo tempo. Se o campo devedor.cnpj está preenchido, então o campo devedor.cpf não pode estar preenchido, e vice-versa. Se o campo devedor.nome está preenchido, então deve existir ou um devedor.cpf ou um campo devedor.cnpj preenchido.

object

Identificador da localização do payload.

required
object

valores monetários referentes à cobrança.

chave
required
string (Chave DICT do recebedor) <= 77 characters

Formato do campo chave

  • O campo chave determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.
  • Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.
  • O formato das chaves pode ser encontrado na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para iniciação do Pix.
solicitacaoPagador
string (Solicitação ao pagador) <= 140 characters

O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation . O tamanho do campo na pacs.008 está limitado a 140 caracteres.

Array of objects (Informações adicionais) <= 50

Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.

Responses

Request samples

Content type
application/json
Example
{
  • "calendario": {
    },
  • "devedor": {
    },
  • "valor": {
    },
  • "chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
  • "solicitacaoPagador": "Serviço realizado.",
  • "infoAdicionais": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "calendario": {
    },
  • "txid": "7978c0c97ea847e78e8849634473c1f1",
  • "revisao": 0,
  • "loc": {
    },
  • "location": "pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25",
  • "status": "ATIVA",
  • "devedor": {
    },
  • "valor": {
    },
  • "chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
  • "solicitacaoPagador": "Serviço realizado.",
  • "infoAdicionais": [
    ]
}

Consultar lista de cobranças imediatas.

Endpoint para consultar cobranças imediatas através de parâmetros como início, fim, cpf, cnpj e status.

Authorizations:
OAuth2 (cob.read)
query Parameters
inicio
required
string <date-time> (Data de início)

Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.

fim
required
string <date-time> (Data de fim)

Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.

cpf
string (CPF) /^\d{11}$/

Filtro pelo CPF do devedor. Não pode ser utilizado ao mesmo tempo que o CNPJ.

cnpj
string (CNPJ) /^\d{14}$/

Filtro pelo CNPJ do devedor. Não pode ser utilizado ao mesmo tempo que o CPF.

locationPresente
boolean
status
string (Status do registro da cobrança)

Filtro pelo status da cobrança.

paginacao.paginaAtual
integer <int32> (Página atual) >= 0
Default: 0

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.

paginacao.itensPorPagina
integer <int32> (Itens por Página) [ 1 .. 1000 ]
Default: 100

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

Responses

Response samples

Content type
application/json
Example
{
  • "parametros": {
    },
  • "cobs": [
    ]
}

Gerenciamento de cobranças com vencimento

Reúne endpoints destinados a lidar com gerenciamento de cobranças com vencimento.

Criar cobrança com vencimento.

Endpoint para criar uma cobrança com vencimento.

Authorizations:
OAuth2 (cobv.write)
path Parameters
txid
required
string (Id da Transação) [a-zA-Z0-9]{26,35}

Identificador da transação

O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.

Na pacs.008, é referenciado como TransactionIdentification <txId> ou idConciliacaoRecebedor.

Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.

O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.

Request Body schema: application/json

Dados para geração da cobrança com vencimento.

required
object (Calendário)

Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.

required
Pessoa Física (object) or Pessoa Jurídica (object)

O objeto devedor organiza as informações sobre o devedor da cobrança.

object

Identificador da localização do payload.

required
object

Valores monetários.

chave
required
string (Chave DICT do recebedor) <= 77 characters

Formato do campo chave

  • O campo chave determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.
  • Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.
  • O formato das chaves pode ser encontrado na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para iniciação do Pix.
solicitacaoPagador
string (Solicitação ao pagador) <= 140 characters

O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation . O tamanho do campo na pacs.008 está limitado a 140 caracteres.

Array of objects (Informações adicionais) <= 50

Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.

Responses

Request samples

Content type
application/json
{
  • "calendario": {
    },
  • "loc": {
    },
  • "devedor": {
    },
  • "valor": {
    },
  • "chave": "5f84a4c5-c5cb-4599-9f13-7eb4d419dacc",
  • "solicitacaoPagador": "Cobrança dos serviços prestados."
}

Response samples

Content type
application/json
{
  • "calendario": {
    },
  • "txid": "7978c0c97ea847e78e8849634473c1f1",
  • "revisao": 0,
  • "loc": {
    },
  • "status": "ATIVA",
  • "devedor": {
    },
  • "recebedor": {
    },
  • "valor": {
    },
  • "chave": "5f84a4c5-c5cb-4599-9f13-7eb4d419dacc",
  • "solicitacaoPagador": "Cobrança dos serviços prestados."
}

Revisar cobrança com vencimento.

Authorizations:
OAuth2 (cobv.write)
path Parameters
txid
required
string (Id da Transação) [a-zA-Z0-9]{26,35}

Identificador da transação

O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.

Na pacs.008, é referenciado como TransactionIdentification <txId> ou idConciliacaoRecebedor.

Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.

O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.

Request Body schema: application/json

Dados para geração da cobrança.

object (Calendário)

Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.

Pessoa Física (object) or Pessoa Jurídica (object)

O objeto devedor organiza as informações sobre o devedor da cobrança.

object

Identificador da localização do payload.

status
string (Status do registro da cobrança)
Value: "REMOVIDA_PELO_USUARIO_RECEBEDOR"
object (Valor da cobrança com vencimento)

Valores monetários.

chave
string (Chave DICT do recebedor) <= 77 characters

Formato do campo chave

  • O campo chave determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.
  • Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.
  • O formato das chaves pode ser encontrado na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para iniciação do Pix.
solicitacaoPagador
string (Solicitação ao pagador) <= 140 characters

O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation . O tamanho do campo na pacs.008 está limitado a 140 caracteres.

Array of objects (Informações adicionais) <= 50

Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.

Responses

Request samples

Content type
application/json
Example
{
  • "loc": {
    },
  • "devedor": {
    },
  • "valor": {
    },
  • "solicitacaoPagador": "Cobrança dos serviços prestados."
}

Response samples

Content type
application/json
{
  • "calendario": {
    },
  • "txid": "7978c0c97ea847e78e8849634473c1f1",
  • "revisao": 0,
  • "loc": {
    },
  • "status": "ATIVA",
  • "devedor": {
    },
  • "recebedor": {
    },
  • "valor": {
    },
  • "chave": "5f84a4c5-c5cb-4599-9f13-7eb4d419dacc",
  • "solicitacaoPagador": "Cobrança dos serviços prestados."
}

Consultar cobrança com vencimento.

Endpoint para consultar uma cobrança com vencimento através de um determinado txid.

Authorizations:
OAuth2 (cobv.read)
path Parameters
txid
required
string (Id da Transação) [a-zA-Z0-9]{26,35}

Identificador da transação

O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.

Na pacs.008, é referenciado como TransactionIdentification <txId> ou idConciliacaoRecebedor.

Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.

O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.

query Parameters
revisao
integer <int32> (Revisão)

O campo revisao

Denota a revisão da cobrança. Sempre começa em zero. Sempre varia em acréscimos de 1.

O incremento em uma cobrança deve ocorrer sempre que um objeto da cobrança em questão for alterado. O campo loc é uma exceção a esta regra.

Se em uma determinada alteração em uma cobrança, o único campo alterado for o campo loc, então esta operação não incrementa a revisão da cobrança.

O campo loc não ocasiona uma alteração na cobrança em si. Não é necessário armazenar histórico das alterações do campo loc para uma determinada cobrança. Para os outros campos da cobrança, registra-se histórico.

Responses

Response samples

Content type
application/json
{
  • "calendario": {
    },
  • "txid": "7978c0c97ea847e78e8849634473c1f1",
  • "revisao": 0,
  • "loc": {
    },
  • "status": "ATIVA",
  • "devedor": {
    },
  • "recebedor": {
    },
  • "valor": {
    },
  • "chave": "5f84a4c5-c5cb-4599-9f13-7eb4d419dacc",
  • "solicitacaoPagador": "Cobrança dos serviços prestados."
}

Consultar lista de cobranças com vencimento.

Endpoint para consultar cobranças com vencimento através de parâmetros como início, fim, cpf, cnpj e status.

Authorizations:
OAuth2 (cobv.read)
query Parameters
inicio
required
string <date-time> (Data de início)

Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.

fim
required
string <date-time> (Data de fim)

Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.

cpf
string (CPF) /^\d{11}$/

Filtro pelo CPF do devedor. Não pode ser utilizado ao mesmo tempo que o CNPJ.

cnpj
string (CNPJ) /^\d{14}$/

Filtro pelo CNPJ do devedor. Não pode ser utilizado ao mesmo tempo que o CPF.

locationPresente
boolean
status
string (Status do registro da cobrança)

Filtro pelo status da cobrança.

loteCobVId
integer <int32> (Id do lote de cobrança com vencimento)

Id do lote de cobrança com vencimento.

paginacao.paginaAtual
integer <int32> (Página atual) >= 0
Default: 0

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.

paginacao.itensPorPagina
integer <int32> (Itens por Página) [ 1 .. 1000 ]
Default: 100

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

Responses

Response samples

Content type
application/json
{
  • "parametros": {
    },
  • "cobs": [
    ]
}

Gerenciamento de cobranças com vencimento em lote

Reúne endpoints destinados a lidar com gerenciamento de cobranças com vencimento em lote.

Criar/Alterar lote de cobranças com vencimento.

Endpoint utilizado para criar ou alterar um lote de cobranças com vencimento.

Para o caso de uso de alteração de cobranças, o array a ser atribuído na requisicão deve ser composto pelas exatas requisições de criação de cobranças que constaram no array atribuído na requisição originária.

Não se pode utilizar este endpoint para alterar um lote de cobranças com vencimento agregando ou removendo cobranças já existentes dentro do conjunto de cobranças criadas na requisição originária do lote.

Em outras palavras, se originalmente criou-se um lote, por exemplo, com as cobranças [a, b e c], não se pode alterar esse conjunto de cobranças original que o lote representa para [a, b, c, d], ou para [a, b]. Por outro lado, pode-se alterar, em lote as cobranças [a, b, c], conforme originalmente constam na requisição originária do lote.

Uma solicitação de criação de cobrança com status "EM_PROCESSAMENTO" ou "NEGADA" está associada a uma cobrança não existe de fato, portanto não será listada em GET /cobv ou GET /cobv/{txid}.

Uma cobrança, uma vez criada via PUT /cobv/{txid}, não pode ser associada a um lote posteriormente.

Uma cobrança, uma vez criada via PUT /lotecobv/{id}, não pode ser associada a um novo lote posteriormente.

Authorizations:
OAuth2 (lotecobv.write)
path Parameters
id
required
string (Id do lote de cobranças com vencimento)
Request Body schema: application/json

Dados para geração de lote de cobranças com vencimento.

descricao
required
string (Descrição do lote)
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "descricao": "Cobranças dos alunos do turno vespertino",
  • "cobsv": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "title": "Lote de cobranças inválido.",
  • "status": 400,
  • "detail": "A requisição que busca alterar ou criar um lote de cobranças com vencimento não respeita o _schema_ ou está semanticamente errada.",
  • "violacoes": [
    ]
}

Utilizado para revisar cobranças específicas dentro de um lote de cobranças com vencimento.

Endpoint utilizado para revisar cobranças específicas dentro de um lote de cobranças com vencimento.

A diferença deste endpoint para o endpoint PUT correlato é que este endpoint admite um array cobsv com menos solicitações de criação ou alteração de cobranças do que o array atribuído na requisição originária do lote.

Não se pode, entretanto, utilizar esse endpoint para agregar ou remover solicitações de alteração ou criação de cobranças conforme constam na requisição originária do lote.

Authorizations:
OAuth2 (lotecobv.write)
path Parameters
id
required
string (Id do lote de cobranças com vencimento)
Request Body schema: application/json

Dados para geração de lote de cobranças com vencimento.

descricao
string (Descrição do lote)
Array of objects

Responses

Request samples

Content type
application/json
{
  • "cobsv": [
    ]
}

Response samples

Content type
application/problem+json
{}

Consultar um lote específico de cobranças com vencimento.

Endpoint para consultar um lote de cobranças com vencimento.

Authorizations:
OAuth2 (lotecobv.read)
path Parameters
id
required
string (Id do lote de cobranças com vencimento)

Responses

Response samples

Content type
application/json
{
  • "descricao": "Cobranças dos alunos do turno vespertino",
  • "criacao": "2020-11-01T20:15:00.358Z",
  • "cobsv": [
    ]
}

Consultar lotes de cobranças com vencimento.

Endpoint para consultar lista de lotes de cobranças com vencimento.

Authorizations:
OAuth2 (lotecobv.read)
query Parameters
inicio
required
string <date-time> (Data de início)

Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.

fim
required
string <date-time> (Data de fim)

Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.

paginacao.paginaAtual
integer <int32> (Página atual) >= 0
Default: 0

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.

paginacao.itensPorPagina
integer <int32> (Itens por Página) [ 1 .. 1000 ]
Default: 100

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

Responses

Response samples

Content type
application/json
{
  • "parametros": {
    },
  • "lotes": [
    ]
}

Configuração de locations para payloads

Reúne endpoints destinados a lidar com configuração e remoção de locations para uso dos payloads

Criar location do payload.

Criar location do payload

Authorizations:
OAuth2 (payloadlocation.write)
Request Body schema: application/json

Dados para geração da location.

tipoCob
required
string (Tipo da cobrança)
Enum: "cob" "cobv"

Responses

Request samples

Content type
application/json
{
  • "tipoCob": "cob"
}

Response samples

Content type
application/json
Example
{
  • "id": 7716,
  • "location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
  • "tipoCob": "cob",
  • "criacao": "2020-03-11T21:19:51.013Z"
}

Consultar locations cadastradas.

Endpoint para consultar locations cadastradas

Authorizations:
OAuth2 (payloadlocation.read)
query Parameters
inicio
required
string <date-time> (Data de início)

Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.

fim
required
string <date-time> (Data de fim)

Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.

txIdPresente
boolean
tipoCob
string
Enum: "cob" "cobv"
paginacao.paginaAtual
integer <int32> (Página atual) >= 0
Default: 0

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.

paginacao.itensPorPagina
integer <int32> (Itens por Página) [ 1 .. 1000 ]
Default: 100

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

Responses

Response samples

Content type
application/json
{
  • "parametros": {
    },
  • "loc": [
    ]
}

Recuperar location do payload.

Recupera a location do payload

Authorizations:
OAuth2 (payloadlocation.read)
path Parameters
id
required
string (Id da location cadastrada para servir um payload)

Responses

Response samples

Content type
application/json
Example
{
  • "id": 7716,
  • "txid": "fda9460fe04e4f129b72863ae57ee22f",
  • "location": "pix.example.com/qr/v2/cobv/2353c790eefb11eaadc10242ac120002",
  • "tipoCob": "cobv",
  • "criacao": "2020-03-11T21:19:51.013Z"
}

Desvincular uma cobrança de uma location.

Endpoint utilizado para desvincular uma cobrança de uma location.

Se executado com sucesso, a entidade loc não apresentará mais um txid, se apresentava anteriormente à chamada. Adicionalmente, a entidade cob ou cobv associada ao txid desvinculado também passará a não mais apresentar um location. Esta operação não altera o status da cob ou cobv em questão.

Authorizations:
OAuth2 (payloadlocation.write)
path Parameters
id
required
string (Id da location cadastrada para servir um payload)

Responses

Response samples

Content type
application/json
{
  • "id": 2316,
  • "location": "pix.example.com/qr/v2/a8534e273ecb47d3ac30613104544466",
  • "tipoCob": "cob",
  • "criacao": "2020-05-31T19:39:54.013Z"
}

Gerenciamento de Pix recebidos

reúne endpoints destinados a lidar com gerenciamento de Pix recebidos.

Consultar Pix.

Endpoint para consultar um Pix através de um e2eid.

Authorizations:
OAuth2 (pix.read)
path Parameters
e2eid
required
string (Id fim a fim da transação) 32 characters [a-zA-Z0-9]{32}

EndToEndIdentification que transita na PACS002, PACS004 e PACS008

Responses

Response samples

Content type
application/json
Example
{
  • "endToEndId": "E12345678202009091221abcdef12345",
  • "txid": "cd1fe328c875481285a6f233ae41b662",
  • "valor": "100.00",
  • "horario": "2020-09-10T13:03:33.902Z",
  • "infoPagador": "Reforma da casa",
  • "devolucoes": [
    ]
}

Consultar Pix recebidos.

Endpoint para consultar Pix recebidos

Authorizations:
OAuth2 (pix.read)
query Parameters
inicio
required
string <date-time> (Data de início)

Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.

fim
required
string <date-time> (Data de fim)

Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.

txid
string[a-zA-Z0-9]{26,35}

Identificador da transação

O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.

Na pacs.008, é referenciado como TransactionIdentification <txId> ou idConciliacaoRecebedor.

Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.

O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.

txIdPresente
boolean
devolucaoPresente
boolean
cpf
string (CPF) /^\d{11}$/

Filtro pelo CPF do pagador. Não pode ser utilizado ao mesmo tempo que o CNPJ.

cnpj
string (CNPJ) /^\d{14}$/

Filtro pelo CNPJ do pagador. Não pode ser utilizado ao mesmo tempo que o CPF.

paginacao.paginaAtual
integer <int32> (Página atual) >= 0
Default: 0

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.

paginacao.itensPorPagina
integer <int32> (Itens por Página) [ 1 .. 1000 ]
Default: 100

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

Responses

Response samples

Content type
application/json
{
  • "parametros": {
    },
  • "pix": [
    ]
}

Solicitar devolução.

Endpoint para solicitar uma devolução através de um e2eid do Pix e do ID da devolução. O motivo que será atribuído à PACS.004 será "MD06" ou "SL02" de acordo com a aba RTReason da PACS.004 que consta no Catálogo de Mensagens do Pix a depender da natureza da devolução (Vide a descrição deste campo).

Authorizations:
OAuth2 (pix.write)
path Parameters
e2eid
required
string (Id fim a fim da transação) 32 characters [a-zA-Z0-9]{32}

EndToEndIdentification que transita na PACS002, PACS004 e PACS008

id
required
string (Id da Devolução) [a-zA-Z0-9]{1,35}

Id gerado pelo cliente para representar unicamente uma devolução.

Request Body schema: application/json

Dados para pedido de devolução.

valor
required
string (Valor) \d{1,10}\.\d{2}

Valor solicitado para devolução. A soma dos valores de todas as devolucões não podem ultrapassar o valor total do Pix.

natureza
string (Natureza da Devolução Solicitada)
Enum: "ORIGINAL" "RETIRADA"

Indica qual é a natureza da devolução solicitada. Uma solicitação de devolução pelo usuário recebedor pode ser relacionada a um Pix comum (com código: MD06 da pacs.004), ou a um Pix de Saque ou Troco (com códigos possíveis: MD06 e SL02 da pacs.004). Na ausência deste campo a natureza deve ser interpretada como sendo de um Pix comum (ORIGINAL).

As naturezas são assim definidas:

  • ORIGINAL: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix comum ou ao valor da compra em um Pix Troco (MD06);
  • RETIRADA: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix Saque ou ao valor do troco em um Pix Troco (SL02).

Os valores de devoluções são sempre limitados aos valores máximos a seguir:

  • Pix comum: o valor da devolução é limitado ao valor do próprio Pix (a natureza nesse caso deve ser: ORIGINAL);
  • Pix Saque: o valor da devolução é limitado ao valor da retirada (a natureza nesse caso deve ser: RETIRADA); e
  • Pix Troco: o valor da devolução é limitado ao valor relativo à compra ou ao troco:
    • Quando a devolução for referente à compra, o valor limita-se ao valor da compra (a natureza nesse caso deve ser ORIGINAL); e
    • Quando a devolução for referente ao troco, o valor limita-se ao valor do troco (a natureza nesse caso deve ser RETIRADA).
descricao
string (Mensagem ao pagador relativa à devolução.) <= 140 characters

O campo descricao, opcional, determina um texto a ser apresentado ao pagador contendo informações sobre a devolução. Esse texto será preenchido, na pacs.004, pelo PSP do recebedor, no campo RemittanceInformation. O tamanho do campo na pacs.004 está limitado a 140 caracteres.

Responses

Request samples

Content type
application/json
{
  • "valor": "7.89"
}

Response samples

Content type
application/json
{
  • "id": "123456",
  • "rtrId": "D12345678202009091000abcde123456",
  • "valor": "7.89",
  • "horario": {
    },
  • "status": "EM_PROCESSAMENTO"
}

Consultar devolução.

Endpoint para consultar uma devolução através de um End To End ID do Pix e do ID da devolução

Authorizations:
OAuth2 (pix.read)
path Parameters
e2eid
required
string (Id fim a fim da transação) 32 characters [a-zA-Z0-9]{32}

EndToEndIdentification que transita na PACS002, PACS004 e PACS008

id
required
string (Id da Devolução) [a-zA-Z0-9]{1,35}

Id gerado pelo cliente para representar unicamente uma devolução.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "123456",
  • "rtrId": "D12345678202009091000abcde123456",
  • "valor": "7.89",
  • "horario": {
    },
  • "status": "EM_PROCESSAMENTO"
}

Gerenciamento de notificações

Reúne endpoints para gerenciamento de notificações por parte do PSP recebedor ao usuário recebedor.

Configurar o Webhook Pix.

Endpoint para configuração do serviço de notificações acerca de Pix recebidos. Somente Pix associados a um txid serão notificados.

Authorizations:
OAuth2 (webhook.write)
path Parameters
chave
required
string (Chave DICT do recebedor) <= 77 characters
Request Body schema: application/json
webhookUrl
required
string <uri>

Responses

Callbacks

Request samples

Content type
application/json

Response samples

Content type
application/problem+json
{}

Callback payload samples

Callback
POST: O callback deve ser acionado sempre que um ou mais
Content type
application/json
{
  • "pix": [
    ]
}

Exibir informações acerca do Webhook Pix.

Endpoint para recuperação de informações sobre o Webhook Pix.

Authorizations:
OAuth2 (webhook.read)
path Parameters
chave
required
string (Chave DICT do recebedor) <= 77 characters

Responses

Response samples

Content type
application/json
{}

Cancelar o webhook Pix.

Endpoint para cancelamento do webhook. Não é a única forma pela qual um webhook pode ser removido.

O PSP recebedor está livre para remover unilateralmente um webhook que esteja associado a uma chave que não pertence mais a este usuário recebedor.

Authorizations:
OAuth2 (webhook.write)
path Parameters
chave
required
string (Chave DICT do recebedor) <= 77 characters

Responses

Response samples

Content type
application/problem+json
{}

Consultar webhooks cadastrados.

Endpoint para consultar Webhooks cadastrados

Authorizations:
OAuth2 (webhook.read)
query Parameters
inicio
string <date-time> (Data de início)

Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.

fim
string <date-time> (Data de fim)

Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.

paginacao.paginaAtual
integer <int32> (Página atual) >= 0
Default: 0

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.

paginacao.itensPorPagina
integer <int32> (Itens por Página) [ 1 .. 1000 ]
Default: 100

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

Responses

Response samples

Content type
application/json
{
  • "parametros": {
    },
  • "webhooks": [
    ]
}