QRCodes API

Download OpenAPI specification:Download

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

Pix Automático

Para implementar recorrências e cobranças automáticas, consulte o guia completo das Jornadas de Autorização do Pix Automático. Este guia apresenta passo a passo as 4 jornadas de autorização definidas pelo Banco Central do Brasil, incluindo exemplos de uso dos endpoints e a ordem de execução necessária para cada jornada.

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`

Significado: Requisição inválida.
HTTP Status Code: 400 Bad Request.

`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`

Significado: Condição inesperada ao processar requisição.
HTTP Status Code: 500 Internal Server Error.

`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 CobR

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

`CobRNaoEncontrado`

Significado: Cobrança não encontrada para o txid informado.
HTTP Status Code: 404.
endpoints: [GET|PATCH] /cobr/{txid} e [POST] /cobr/{txid}/retentativa/{data}.

`CobROperacaoInvalida`

Significado: a requisição que busca alterar ou criar uma cobrança recorrente não respeita o schema ou está semanticamente errada.
HTTP Status Code: 400.
endpoints: [POST|PUT|PATCH] /cobr/{txid} e [POST] /cobr/{txid}/retentativa/{data}.

Violações para o endpoint POST|PUT /cobr/{txid}:

O campo cobr.infoAdicional não respeita o schema.
O campo cobr.status não respeita o schema.
O objeto cobr.calendario não respeita o schema.
O campo cobr.calendario.dataDeVencimento é anterior à data de criação da cobrança.
O campo cobr.valor não respeita o schema.
O objeto cobr.recebedor não respeita o schema.
Os campos cobr.recebedor.conta e cobr.recebedor.agencia correspondem a uma conta que não pertence a este usuário recebedor.
O objeto cobr.devedor não respeita o schema.
O campo cobr.txid encontra-se em uso.
Existe uma CobR com status diferente de REJEITADA e CANCELADA referente ao mesmo cobr.idRec com calendario.dataDeVencimento no mesmo ciclo.

Violações para o endpoint PATCH /cobr/{txid}:

Não é possível cancelar uma cobrança em uma data igual ou maior que a data prevista da primeira tentativa de liquidação.

Violações para o endpoint POST /cobr/{txid}/retentativa/{data}:

Existe uma tentativa com status SOLICITADA ou AGENDADA.
Existe uma tentativa em andamento.
Existe uma tentativa ativa.
Existe uma tentativa não finalizada.
Existe uma tentativa vigente para a data informada.
O parâmetro data não corresponde a uma data futura.
A política configurada na recorrência não permite retentativa de cobrança.

`CobRConsultaInvalida`

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

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

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.

Tag RecPayload

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

`RecPayloadNaoEncontrado`

Significado: a recorrência em questão não foi encontrada para a location requisitada.
HTTP Status Code: 404 ou 410.
endpoint: GET /rec/{recUrlAccessToken}.

Se a presente location exibia uma recorrência, 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 recorrência, pode-se utilizar o HTTP status code 404.

Uma recorrência pode estar encerrada, cancelada ou rejeitada, 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 recorrência.

`RecPayloadOperacaoInvalida`

Significado: a recorrência em questão encontra-se encerrada, rejeitada ou cancelada para a location requisitada.
HTTP Status Code: 400.
endpoint: GET /rec/{recUrlAccessToken}.

Violações para o endpoint GET /rec/{recUrlAccessToken}:

O campo recUrlAccessToken referencia uma recorrência encerrada, rejeitada ou cancelada.

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 SolicRec

Esta seção reúne erros retornados pelos endpoints organizados sob a tag SolicRec. Esses erros indicam problemas no gerenciamento de uma solicitação de confirmação de recorrência.

`SolicRecNaoEncontrada`

Significado: Solicitação de recorrência não encontrada para o idSolicRec informado.
HTTP Status Code: 404.
endpoints: [GET] /solicrec/{idSolicRec}.

`SolicRecOperacaoInvalida`

Significado: a requisição que busca criar ou alterar uma solicitação de confirmação de recorrência não respeita o schema ou está semanticamente errada.
HTTP Status Code: 400.
endpoints: [POST] /solicrec e PATCH /solicrec/{idSolicRec}.

Violações para o endpoint POST /solicrec:

O objeto solicrec.calendario não respeita o schema.
O campo solicrec.calendario.dataExpiracaoSolicitacao é anterior à data de criação da solicitação da recorrência.
O objeto solicrec.destinatario não respeita o schema.
Existe uma solicitação ativa referente ao mesmo solicrec.idRec.

Violações para o endpoint PATCH /solicrec/{idSolicRec}:

Não é possível cancelar uma solicitação de recorrência com o status diferente de CRIADA, ENVIADA ou RECEBIDA.

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 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.

Tag WebhookRec

Reúne erros dos endpoints que tratam do gerenciamento dos Webhooks de recorrências da API Pix.

`WebhookRecOperacaoInvalida`

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 /webhookrec.

Violações para o endpoint PUT /webhookrec:

o campo webhookUrl não respeita o schema.

`WebhookRecConsultaInvalida`

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 /webhookrec.

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

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.

Tag WebhookCobR

Reúne erros dos endpoints que tratam do gerenciamento dos Webhooks de cobranças recorrentes da API Pix.

`WebhookCobROperacaoInvalida`

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 /webhookcobr.

Violações para o endpoint PUT /webhookcobr:

o campo webhookUrl não respeita o schema.

`WebhookCobRConsultaInvalida`

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 /webhookcobr.

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

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.

Autenticação

Reúne endpoints destinados à autenticação e autorização de clientes da API Pix.

Obter token de acesso

Request Body schema: application/x-www-form-urlencoded
required

client_id required	string Identificador do cliente
client_secret required	string Chave secreta do cliente
grant_type required	string Default: "client_credentials" Tipo de concessão, utilizar: `client_credentials`
scope	string Scopos de autorização

Responses

Response samples

201
401

Content type

application/json

{"access_token": "string",
"expires_in": 0,
"refresh_expires_in": 0,
"token_type": "bearer",
"not-before-policy": 0,
"scope": "string"
}

Gerenciamento de recorrências

Reúne endpoints destinados a lidar com gerenciamento de recorrências.

Consultar recorrência.

Authorizations:

OAuth2

path Parameters

idRec

required

string (Id da location cadastrada para servir um payload)

query Parameters

txid	string (TxId da cobrança associada a recorrência.)

Responses

Response samples

200
403
404
503

Content type

application/json

Example

Exemplo de Recorrência Completa com Dados QR Jornada 2

{"idRec": "RN1234567820240115abcdefghijk",
"status": "APROVADA",
"valor": {"valorRec": "300.00"
},
"vinculo": {"contrato": "98625023",
"devedor": {"cpf": "87734514122",
"nome": "Fulano de Tal"
},
"objeto": "Serviços de Gestão de Imóveis"
},
"calendario": {"dataFinal": "2028-09-01",
"dataInicial": "2024-02-01",
"periodicidade": "MENSAL"
},
"politicaRetentativa": "NAO_PERMITE",
"loc": {"criacao": "2023-12-19T12:28:05.230Z",
"id": 5100,
"location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
"idRec": "RN1234567820240115abcdefghijk"
},
"pagador": {"codMun": "2673833",
"cpf": "75633122216",
"ispbParticipante": "81102623"
},
"recebedor": {"cnpj": "92221288310574",
"nome": "Imobiliária Bom Sucesso"
},
"atualizacao": [{"data": "2024-01-03T08:30:02.050Z",
"nome": "CRIADA"
},
{"data": "2024-01-04T09:40:42.210Z",
"nome": "APROVADA"
}
],
"dadosQR": {"jornada": "JORNADA_2",
"pixCopiaECola": "00020126180014br.gov.bcb.pix5204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***80800014br.gov.bcb.pix2558pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002630462C9"
}
}

Revisar recorrência.

Authorizations:

OAuth2

path Parameters

idRec

required

string (Id da location cadastrada para servir um payload)

Request Body schema: application/json

Dados para revisão da recorrência.

status	string (Status do registro da recorrência) Value: "CANCELADA"
	object
loc	integer <int64> (Id da location) Identificador da location a ser informada na criação de uma recorrência .
	object (Informações sobre calendário da recorrência) Informações sobre calendário da recorrência
	object (Dados relacionados à confirmação da ativação da recorrência.) Dados relacionados à confirmação da ativação da recorrência.

Responses

Request samples

Payload

Content type

application/json

{"loc": 108,
"vinculo": {"devedor": {"nome": "Fulano de Tal"
}
},
"calendario": {"dataInicial": "2024-04-01"
},
"ativacao": {"dadosJornada": {"txid": "33beb661beda44a8928fef47dbeb2dc5"
}
}
}

Response samples

200
400
403
404
503

Content type

application/json

{"idRec": "RN1234567820240115abcdefghijk",
"vinculo": {"contrato": "63100862",
"devedor": {"cpf": "45164632481",
"nome": "Fulano de Tal"
},
"objeto": "Serviço de Streamming de Música."
},
"calendario": {"dataFinal": "2025-04-01",
"dataInicial": "2024-04-01",
"periodicidade": "MENSAL"
},
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {"cnpj": "01602606113708",
"nome": "Empresa de Serviços SA"
},
"valor": {"valorRec": "35.00"
},
"status": "CRIADA",
"loc": {"criacao": "2023-12-10T07:10:05.115Z",
"id": 108,
"location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
"idRec": "RN1234567820240115abcdefghijk"
},
"ativacao": {"dadosJornada": {"tipoJornada": "JORNADA_3",
"txid": "33beb661beda44a8928fef47dbeb2dc5"
}
},
"atualizacao": [{"data": "2023-12-19T12:28:05.230Z",
"nome": "CRIADA"
}
]
}

Consultar lista de recorrências.

Authorizations:

OAuth2

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 recorrência) Filtro pelo status da recorrência.
convenio	string (Convênio) <= 60 characters Filtro pelo convênio associado.
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

200
403
503

Content type

application/json

{"parametros": {"inicio": "2024-04-01T00:00:00Z",
"fim": "2024-04-01T23:59:59Z",
"paginacao": {"paginaAtual": 0,
"itensPorPagina": 100,
"quantidadeDePaginas": 1,
"quantidadeTotalDeItens": 1
}
},
"recs": [{"idRec": "RN1234567820240115abcdefghijk",
"status": "APROVADA",
"valor": {"valorRec": "300.00"
},
"vinculo": {"contrato": "98625023",
"devedor": {"cpf": "87734514122",
"nome": "Fulano de Tal"
},
"objeto": "Serviços de Gestão de Imóveis"
},
"calendario": {"dataFinal": "2028-09-01",
"dataInicial": "2024-02-01",
"periodicidade": "MENSAL"
},
"politicaRetentativa": "NAO_PERMITE",
"loc": {"criacao": "2023-12-19T12:28:05.230Z",
"id": 5100,
"location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
"idRec": "RN1234567820240115abcdefghijk"
},
"pagador": {"codMun": "2673833",
"cpf": "75633122216",
"ispbParticipante": "81102623"
},
"recebedor": {"cnpj": "92221288310574",
"nome": "Imobiliária Bom Sucesso"
},
"atualizacao": [{"data": "2024-01-03T08:30:02.050Z",
"nome": "CRIADA"
},
{"data": "2024-01-04T09:40:42.210Z",
"nome": "APROVADA"
}
]
}
]
}

Criar recorrência.

Criar recorrência

Authorizations:

OAuth2

Request Body schema: application/json

Dados para geração da recorrência.

required	object (Descrição do Objeto da Recorrência) Informações sobre o objeto da recorrência.
required	object (Informações sobre calendário da recorrência) Informações sobre calendário da recorrência
	object
	object
politicaRetentativa required	string (Política de retentativa pós vencimento da recorrência) Enum: "NAO_PERMITE" "PERMITE_3R_7D"
loc	integer <int64> (Id da location) Identificador da location a ser informada na criação de uma recorrência .
	object (Dados relacionados à confirmação da ativação da recorrência.) Dados relacionados à confirmação da ativação da recorrência.

Responses

Request samples

Payload

Content type

application/json

Example

Exemplo de Recorrência 1

{"vinculo": {"contrato": "63100862",
"devedor": {"cpf": "45164632481",
"nome": "Fulano de Tal"
},
"objeto": "Serviço de Streamming de Música."
},
"calendario": {"dataFinal": "2025-04-01",
"dataInicial": "2024-04-01",
"periodicidade": "MENSAL"
},
"valor": {"valorRec": "35.00"
},
"politicaRetentativa": "NAO_PERMITE",
"loc": 108,
"ativacao": {"dadosJornada": {"txid": "33beb661beda44a8928fef47dbeb2dc5"
}
}
}

Response samples

201
400
403
503

Content type

application/json

Example

Exemplo de Recorrência 1

{"idRec": "RN1234567820240115abcdefghijk",
"vinculo": {"contrato": "63100862",
"devedor": {"cpf": "45164632481",
"nome": "Fulano de Tal"
},
"objeto": "Serviço de Streamming de Música."
},
"calendario": {"dataFinal": "2025-04-01",
"dataInicial": "2024-04-01",
"periodicidade": "MENSAL"
},
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {"cnpj": "01602606113708",
"nome": "Empresa de Serviços SA"
},
"valor": {"valorRec": "35.00"
},
"status": "CRIADA",
"loc": {"criacao": "2023-12-10T07:10:05.115Z",
"id": 108,
"location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
"idRec": "RN1234567820240115abcdefghijk"
},
"ativacao": {"dadosJornada": {"tipoJornada": "JORNADA_3",
"txid": "33beb661beda44a8928fef47dbeb2dc5"
}
},
"atualizacao": [{"data": "2023-12-19T12:28:05.230Z",
"nome": "CRIADA"
}
]
}

Gerenciamento de solicitações de recorrências

Reúne endpoints destinados a lidar com gerenciamento de solicitações de recorrências.

Criar solicitação de confirmação de recorrência.

Authorizations:

OAuth2

Request Body schema: application/json

Dados para geração da solicitação da recorrência.

idRec required	string (ID Recorrência) = 29 characters [a-zA-Z0-9]{29} Identificador da Recorrência Regra de formação: RAxxxxxxxxyyyyMMddkkkkkkkkkkk (29 caracteres; "case sensitive", isso é, diferencia letras maiúsculas e minúsculas), sendo: "R": fixo (1 caractere). "R" para a recorrência criada dentro do Pix; "A": identificação da possibilidade de novas tentativas, sendo possíveis os valores "R" ou "N" (1 caractere). "R" caso a recorrência permita novas tentativas de pagamento pós vencimento, ou "N" caso não permita novas tentativas. "xxxxxxxx": identificação do agente que presta serviço para o usuário recebedor que gerou o , podendo ser: o ISPB do participante direto, o ISPB do participante indireto ou os 8 primeiros dígitos do CNPJ do prestador de serviço de iniciação (8 caracteres numéricos [0-9]); "yyyyMMdd": data (8 caracteres) de criação da recorrência; "kkkkkkkkkkk": sequencial criado pelo agente que gerou o (11 caracteres alfanuméricos [a-z\|A-Z\|0-9]). Deve ser único dentro de cada "yyyyMMdd". Dessa forma, o ID da recorrência deve ser formado de acordo com um dos tipos a seguir: "RRxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que permite novas tentativas de pagamento pós vencimento; ou "RNxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que não permite novas tentativas de pagamento pós vencimento.”
required	object (Informações de Calendário da Solicitação da Recorrência)
required	Pessoa Física (object) or Pessoa Jurídica (object)

Responses

Request samples

Payload

Content type

application/json

{"idRec": "RN123456782024011577825445612",
"calendario": {"dataExpiracaoSolicitacao": "2023-12-20T12:17:11.926Z"
},
"destinatario": {"agencia": "2569",
"conta": "550689",
"cpf": "15231470190",
"ispbParticipante": "91193552"
}
}

Response samples

201
400
403
404
503

Content type

application/json

{"idSolicRec": "SC876456782024021577825445312",
"idRec": "RN123456782024011577825445612",
"calendario": {"dataExpiracaoSolicitacao": "2023-12-20T12:17:11.926Z"
},
"status": "CRIADA",
"destinatario": {"agencia": "2569",
"conta": "550689",
"cpf": "15231470190",
"ispbParticipante": "91193552"
},
"atualizacao": [{"data": "2023-12-20T12:18:18.618Z",
"status": "CRIADA"
}
],
"recPayload": {"idRec": "RN123456782024011577825445612",
"vinculo": {"contrato": "561238008",
"devedor": {"cpf": "15231470190",
"nome": "Fulano de Tal"
},
"objeto": "Serviços de Telecomunicações"
},
"calendario": {"dataFinal": "2023-12-01",
"dataInicial": "2024-04-01",
"periodicidade": "MENSAL"
},
"recebedor": {"cnpj": "94370926517368",
"nome": "Empresa de Serviços SA"
},
"valor": {"valorRec": "1200.09"
},
"atualizacao": [{"data": "2023-12-15T08:30:07.115Z",
"status": "CRIADA"
}
]
}
}

Consultar solicitação de confirmação de recorrência.

Consultar solicitação.

Authorizations:

OAuth2

path Parameters

idSolicRec

required

string (Id da solicitação da recorrência)

Responses

Response samples

200
403
404
503

Content type

application/json

Example

Exemplo de solicitação de confirmação de recorrência 1

{"idSolicRec": "SC876456782024021577825445312",
"idRec": "RN123456782024011577825445612",
"calendario": {"dataExpiracaoSolicitacao": "2023-12-20T12:17:11.926Z"
},
"status": "CRIADA",
"destinatario": {"agencia": "2569",
"conta": "550689",
"cpf": "15231470190",
"ispbParticipante": "91193552"
},
"atualizacao": [{"data": "2023-12-20T12:18:18.618Z",
"status": "CRIADA"
}
],
"recPayload": {"idRec": "RN123456782024011577825445612",
"vinculo": {"contrato": "561238008",
"devedor": {"cpf": "15231470190",
"nome": "Fulano de Tal"
},
"objeto": "Serviços de Telecomunicações"
},
"calendario": {"dataFinal": "2023-12-01",
"dataInicial": "2024-04-01",
"periodicidade": "MENSAL"
},
"recebedor": {"cnpj": "94370926517368",
"nome": "Empresa de Serviços SA"
},
"valor": {"valorRec": "1200.09"
},
"atualizacao": [{"data": "2023-12-15T08:30:07.115Z",
"status": "CRIADA"
}
]
}
}

Revisar solicitação de confirmação de recorrência.

Authorizations:

OAuth2

path Parameters

idSolicRec

required

string (Id da solicitação da recorrência)

Request Body schema: application/json

Dados para revisão da solicitação da recorrência.

status

required

string (Status do registro da solicitação de recorrência)

Value: "CANCELADA"

Responses

Request samples

Payload

Content type

application/json

{"status": "CANCELADA"
}

Response samples

201
400
403
404
503

Content type

application/json

{"idSolicRec": "SC876456782024021577825445312",
"idRec": "RN123456782024011577825445612",
"calendario": {"dataExpiracaoSolicitacao": "2024-06-11T07:17:11.008Z"
},
"status": "CANCELADA",
"destinatario": {"agencia": "2569",
"conta": "550689",
"cpf": "15231470190",
"ispbParticipante": "91193552"
},
"atualizacao": [{"data": "2024-05-16T17:01:06.781Z",
"status": "CRIADA"
},
{"data": "2024-05-30T10:18:18.618Z",
"status": "CANCELADA"
}
],
"recPayload": {"idRec": "RN123456782024011577825445612",
"vinculo": {"contrato": "Banda Larga Fibra Ótica",
"devedor": {"cpf": "15231470190",
"nome": "Fulano de Tal"
},
"objeto": "Serviços de Telecomunicações"
},
"valor": {"valorRec": "1200.09"
},
"calendario": {"dataFinal": "2025-05-01",
"dataInicial": "2024-05-01",
"periodicidade": "MENSAL"
},
"recebedor": {"cnpj": "94370926517368",
"nome": "Empresa de Serviços SA"
},
"atualizacao": [{"data": "2023-12-08T16:24:35.233Z",
"status": "CRIADA"
}
]
}
}

Gerenciamento de cobranças associadas a uma recorrência

Reúne endpoints destinados a lidar com gerenciamento de cobranças associadas a uma recorrência.

Criar cobrança recorrente.

Endpoint para criar uma cobrança recorrente.

Authorizations:

OAuth2

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
required

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

idRec required	string (ID Recorrência) = 29 characters [a-zA-Z0-9]{29} Identificador da Recorrência Regra de formação: RAxxxxxxxxyyyyMMddkkkkkkkkkkk (29 caracteres; "case sensitive", isso é, diferencia letras maiúsculas e minúsculas), sendo: "R": fixo (1 caractere). "R" para a recorrência criada dentro do Pix; "A": identificação da possibilidade de novas tentativas, sendo possíveis os valores "R" ou "N" (1 caractere). "R" caso a recorrência permita novas tentativas de pagamento pós vencimento, ou "N" caso não permita novas tentativas. "xxxxxxxx": identificação do agente que presta serviço para o usuário recebedor que gerou o , podendo ser: o ISPB do participante direto, o ISPB do participante indireto ou os 8 primeiros dígitos do CNPJ do prestador de serviço de iniciação (8 caracteres numéricos [0-9]); "yyyyMMdd": data (8 caracteres) de criação da recorrência; "kkkkkkkkkkk": sequencial criado pelo agente que gerou o (11 caracteres alfanuméricos [a-z\|A-Z\|0-9]). Deve ser único dentro de cada "yyyyMMdd". Dessa forma, o ID da recorrência deve ser formado de acordo com um dos tipos a seguir: "RRxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que permite novas tentativas de pagamento pós vencimento; ou "RNxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que não permite novas tentativas de pagamento pós vencimento.”
infoAdicional	string (Informações adicionais da fatura.) <= 140 characters Informações adicionais da fatura.
required	object (Informações sobre calendário da cobrança)
required	object (Valor da cobrança recorrente) Valor da cobrança recorrente
ajusteDiaUtil required	boolean (Ajuste data prevista para liquidação para próximo dia útil) Default: true Campo de ativação do ajuste da data prevista para liquidação para próximo dia útil caso o vencimento corrente seja um dia não útil. O PSP Recebedor deverá considerar os feriados locais com base no código município do usuário pagador.
required	object O objeto recebedor organiza as informações sobre o recebedor da cobrança.
	object O objeto devedor organiza as informações sobre o devedor da recorrência.

Responses

Request samples

Payload

Content type

application/json

{"idRec": "RR1234567820240115abcdefghijk",
"infoAdicional": "Serviços de Streamming de Música e Filmes.",
"calendario": {"dataDeVencimento": "2024-04-15"
},
"valor": {"original": "106.07"
},
"ajusteDiaUtil": true,
"devedor": {"cep": "89256-140",
"cidade": "Uberlândia",
"email": "[email protected]",
"logradouro": "Alameda Franco 1056",
"uf": "MG"
},
"recebedor": {"agencia": "9708",
"conta": "012682",
"tipoConta": "CORRENTE"
}
}

Response samples

201
400
403
404
503

Content type

application/json

{"idRec": "RR1234567820240115abcdefghijk",
"txid": "3136957d93134f2184b369e8f1c0729d",
"infoAdicional": "Serviços de Streamming de Música e Filmes.",
"calendario": {"criacao": "2024-04-01",
"dataDeVencimento": "2024-04-15"
},
"valor": {"original": "106.07"
},
"status": "CRIADA",
"politicaRetentativa": "PERMITE_3R_7D",
"ajusteDiaUtil": true,
"devedor": {"cep": "89256-140",
"cidade": "Uberlândia",
"email": "[email protected]",
"logradouro": "Alameda Franco 1056",
"uf": "MG"
},
"recebedor": {"agencia": "9708",
"conta": "012682",
"tipoConta": "CORRENTE"
},
"atualizacao": [{"data": "2024-04-01T14:47:29.470Z",
"status": "CRIADA"
}
]
}

Revisar cobrança recorrente.

Authorizations:

OAuth2

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
required

Dados para geração da cobrança.

status

string (Status do registro da cobrança)

Value: "CANCELADA"

Responses

Request samples

Payload

Content type

application/json

{"status": "CANCELADA"
}

Response samples

200
400
403
404
503

Content type

application/json

{"idRec": "RN985156112024071999000566354",
"txid": "517bd858b59d458a841280b0f0a60bfa",
"calendario": {"criacao": "2024-05-20",
"dataDeVencimento": "2024-06-20"
},
"valor": {"original": "210.00"
},
"status": "CANCELADA",
"politicaRetentativa": "NAO_PERMITE",
"ajusteDiaUtil": true,
"devedor": {"cep": "26901-340",
"cidade": "São Luís",
"email": "[email protected]",
"logradouro": "Alameda Cardoso 1007",
"uf": "MA"
},
"recebedor": {"cnpj": "31166575201770",
"conta": "107262",
"nome": "Empresa de Telecomunicações SA",
"tipoConta": "POUPANÇA"
},
"tentativas": [{"dataLiquidacao": "2024-06-20",
"tipo": "AGND",
"endToEndId": "E12345678202406201221abcdef12345",
"status": "CANCELADA"
}
],
"encerramento": {"cancelamento": {"solicitante": "USUARIO_RECEBEDOR",
"codigo": "SLCR",
"descricao": "Cancelamento de agendamento solicitado pelo usuário recebedor"
}
},
"atualizacao": [{"data": "2024-05-20T14:47:29.470Z",
"status": "CRIADA"
},
{"data": "2024-05-21T10:18:20.120Z",
"status": "ATIVA"
},
{"data": "2024-05-26T10:18:20.120Z",
"status": "CANCELADA"
}
]
}

Consultar cobrança recorrente.

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

Authorizations:

OAuth2

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.

Responses

Response samples

200
403
404
503

Content type

application/json

Example

Exemplo de cobrança recorrente 1

{"idRec": "RR1234567820240115abcdefghijk",
"txid": "3136957d93134f2184b369e8f1c0729d",
"infoAdicional": "Serviços de Streamming de Música e Filmes.",
"calendario": {"criacao": "2024-04-01",
"dataDeVencimento": "2024-04-15"
},
"valor": {"original": "106.07"
},
"status": "CRIADA",
"politicaRetentativa": "PERMITE_3R_7D",
"ajusteDiaUtil": true,
"devedor": {"cep": "89256-140",
"cidade": "Uberlândia",
"email": "[email protected]",
"logradouro": "Alameda Franco 1056",
"uf": "MG"
},
"recebedor": {"agencia": "9708",
"conta": "012682",
"tipoConta": "CORRENTE"
},
"atualizacao": [{"data": "2024-04-01T14:47:29.470Z",
"status": "CRIADA"
}
]
}

Criar cobrança recorrente.

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

Authorizations:

OAuth2

Request Body schema: application/json
required

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

idRec required	string (ID Recorrência) = 29 characters [a-zA-Z0-9]{29} Identificador da Recorrência Regra de formação: RAxxxxxxxxyyyyMMddkkkkkkkkkkk (29 caracteres; "case sensitive", isso é, diferencia letras maiúsculas e minúsculas), sendo: "R": fixo (1 caractere). "R" para a recorrência criada dentro do Pix; "A": identificação da possibilidade de novas tentativas, sendo possíveis os valores "R" ou "N" (1 caractere). "R" caso a recorrência permita novas tentativas de pagamento pós vencimento, ou "N" caso não permita novas tentativas. "xxxxxxxx": identificação do agente que presta serviço para o usuário recebedor que gerou o , podendo ser: o ISPB do participante direto, o ISPB do participante indireto ou os 8 primeiros dígitos do CNPJ do prestador de serviço de iniciação (8 caracteres numéricos [0-9]); "yyyyMMdd": data (8 caracteres) de criação da recorrência; "kkkkkkkkkkk": sequencial criado pelo agente que gerou o (11 caracteres alfanuméricos [a-z\|A-Z\|0-9]). Deve ser único dentro de cada "yyyyMMdd". Dessa forma, o ID da recorrência deve ser formado de acordo com um dos tipos a seguir: "RRxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que permite novas tentativas de pagamento pós vencimento; ou "RNxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que não permite novas tentativas de pagamento pós vencimento.”
infoAdicional	string (Informações adicionais da fatura.) <= 140 characters Informações adicionais da fatura.
required	object (Informações sobre calendário da cobrança)
required	object (Valor da cobrança recorrente) Valor da cobrança recorrente
ajusteDiaUtil required	boolean (Ajuste data prevista para liquidação para próximo dia útil) Default: true Campo de ativação do ajuste da data prevista para liquidação para próximo dia útil caso o vencimento corrente seja um dia não útil. O PSP Recebedor deverá considerar os feriados locais com base no código município do usuário pagador.
required	object O objeto recebedor organiza as informações sobre o recebedor da cobrança.
	object O objeto devedor organiza as informações sobre o devedor da recorrência.

Responses

Request samples

Payload

Content type

application/json

{"idRec": "RR1234567820240115abcdefghijk",
"infoAdicional": "Serviços de Streamming de Música e Filmes.",
"calendario": {"dataDeVencimento": "2024-04-15"
},
"valor": {"original": "106.07"
},
"ajusteDiaUtil": true,
"devedor": {"cep": "89256-140",
"cidade": "Uberlândia",
"email": "[email protected]",
"logradouro": "Alameda Franco 1056",
"uf": "MG"
},
"recebedor": {"agencia": "9708",
"conta": "012682",
"tipoConta": "CORRENTE"
}
}

Response samples

201
400
403
503

Content type

application/json

{"idRec": "RR1234567820240115abcdefghijk",
"txid": "3136957d93134f2184b369e8f1c0729d",
"infoAdicional": "Serviços de Streamming de Música e Filmes.",
"calendario": {"criacao": "2024-04-01",
"dataDeVencimento": "2024-04-15"
},
"status": "CRIADA",
"valor": {"original": "106.07"
},
"politicaRetentativa": "PERMITE_3R_7D",
"ajusteDiaUtil": true,
"devedor": {"cep": "89256-140",
"cidade": "Uberlândia",
"email": "[email protected]",
"logradouro": "Alameda Franco 1056",
"uf": "MG"
},
"recebedor": {"agencia": "9708",
"conta": "012682",
"tipoConta": "CORRENTE"
},
"atualizacao": [{"data": "2024-04-01T14:47:29.470Z",
"status": "CRIADA"
}
]
}

Consultar lista de cobranças recorrentes.

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

Authorizations:

OAuth2

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.
idRec	string (ID Recorrência) = 29 characters [a-zA-Z0-9]{29} Filtro pelo Identificador da Recorrência.
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.
status	string (Status do registro da recorrência) Filtro pelo status da recorrência.
convenio	string (Convênio) <= 60 characters Filtro pelo convênio associado.
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

200
403
503

Content type

application/json

{"parametros": {"inicio": "2024-04-01T00:00:00Z",
"fim": "2024-12-01T23:59:59Z",
"paginacao": {"paginaAtual": 0,
"itensPorPagina": 100,
"quantidadeDePaginas": 1,
"quantidadeTotalDeItens": 1
}
},
"cobsr": [{"idRec": "RR123456782024061999000566354",
"txid": "7f733863543b4a16b516d839bd4bc34e",
"calendario": {"criacao": "2024-05-20",
"dataDeVencimento": "2024-06-20"
},
"valor": {"original": "50.33"
},
"status": "ATIVA",
"ajusteDiaUtil": false,
"politicaRetentativa": "PERMITE_3R_7D",
"devedor": {"cep": "63259-740",
"cidade": "Campinas",
"email": "[email protected]",
"logradouro": "Rua Gonçalves Dias 605",
"uf": "SP"
},
"recebedor": {"conta": "997182",
"tipoConta": "CORRENTE"
},
"tentativas": [{"dataLiquidacao": "2024-06-20",
"tipo": "AGND",
"status": "AGENDADA",
"endToEndId": "E12345678202406201221abcdef12345",
"atualizacao": [{"data": "2024-05-21T10:40:16.730Z",
"status": "SOLICITADA"
},
{"data": "2024-05-21T17:08:00.520Z",
"status": "AGENDADA"
}
]
}
],
"atualizacao": [{"data": "2024-05-20T14:47:29.470Z",
"status": "CRIADA"
},
{"data": "2024-05-21T10:18:20.120Z",
"status": "ATIVA"
}
]
}
]
}

Solicitar retentativa de cobrança.

Endpoint para solicitar retentativa de uma cobrança recorrente.

Authorizations:

OAuth2

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.

data

required

string <date>

Example: 2023-04-01

Data prevista para liquidação da ordem de pagamento correspondente. Trata-se de uma data, no formato YYYY-MM-DD, segundo ISO 8601.

Responses

Response samples

201
400
403
404
503

Content type

application/json

{"idRec": "RR123456782024061999000566354",
"txid": "7f733863543b4a16b516d839bd4bc34e",
"calendario": {"criacao": "2024-05-20",
"dataDeVencimento": "2024-06-20"
},
"valor": {"original": "50.33"
},
"status": "ATIVA",
"politicaRetentativa": "PERMITE_3R_7D",
"ajusteDiaUtil": true,
"devedor": {"cep": "63259-740",
"cidade": "Campinas",
"email": "[email protected]",
"logradouro": "Rua Gonçalves Dias 605",
"uf": "SP"
},
"recebedor": {"cnpj": "58966551101210",
"conta": "997182",
"tipoConta": "CORRENTE"
},
"tentativas": [{"dataLiquidacao": "2024-06-22",
"tipo": "AGND",
"endToEndId": "E12345678202406201221abcdef12345",
"status": "EXPIRADA"
},
{"dataLiquidacao": "2024-06-24",
"tipo": "NTAG",
"endToEndId": "E12345678202406201221abcdef12345",
"status": "AGENDADA"
}
],
"atualizacao": [{"data": "2024-05-20T14:47:29.470Z",
"status": "CRIADA"
},
{"data": "2024-05-21T10:18:20.120Z",
"status": "ATIVA"
}
]
}

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

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
required

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

	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 (Location do Payload) Identificador da localização do payload.
required	object (Valor da cobrança imediata) 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

Payload

Content type

application/json

Example

Exemplo de criação de cobrança imediata 1

{"calendario": {"expiracao": 3600
},
"devedor": {"cnpj": "12345678000195",
"nome": "Empresa de Serviços SA",
"contas": [{"numero": "123456",
"agencia": "0001",
"ispb": "11112222"
}
]
},
"valor": {"original": "37.00",
"modalidadeAlteracao": 1
},
"chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
"solicitacaoPagador": "Serviço realizado.",
"infoAdicionais": [{"nome": "Campo 1",
"valor": "Informação Adicional1 do PSP-Recebedor"
},
{"nome": "Campo 2",
"valor": "Informação Adicional2 do PSP-Recebedor"
}
]
}

Response samples

201
400
403
404
503

Content type

application/json

Example

Exemplo de cobrança imediata 1

{"calendario": {"criacao": "2020-09-09T20:15:00.358Z",
"expiracao": 3600
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"revisao": 0,
"loc": {"id": 789,
"location": "pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25",
"tipoCob": "cob"
},
"location": "pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25",
"status": "ATIVA",
"devedor": {"cnpj": "12345678000195",
"nome": "Empresa de Serviços SA"
},
"valor": {"original": "37.00",
"modalidadeAlteracao": 1
},
"chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
"solicitacaoPagador": "Serviço realizado.",
"infoAdicionais": [{"nome": "Campo 1",
"valor": "Informação Adicional1 do PSP-Recebedor"
},
{"nome": "Campo 2",
"valor": "Informação Adicional2 do PSP-Recebedor"
}
]
}

Revisar cobrança imediata.

Authorizations:

OAuth2

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
required

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 (Location do Payload) 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

Payload

Content type

application/json

Example

Exemplo de revisão de cobrança 1

{"loc": {"id": 7768
},
"devedor": {"cpf": "12345678909",
"nome": "Francisco da Silva"
},
"valor": {"original": "123.45"
},
"solicitacaoPagador": "Cobrança dos serviços prestados."
}

Response samples

200
400
403
404
503

Content type

application/json

{"calendario": {"criacao": "2020-09-09T20:15:00.358Z",
"expiracao": 3600
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"revisao": 1,
"loc": {"id": 7768,
"location": "pix.example.com/qr/b1/9d36b84fc70b478fb95c12729b90ca25",
"tipoCob": "cob"
},
"location": "pix.example.com/qr/v1/9d36b84fc70b478fb95c12729b90ca25",
"status": "ATIVA",
"devedor": {"cpf": "12345678909",
"nome": "Francisco da Silva"
},
"valor": {"original": "123.45",
"modalidadeAlteracao": 0
},
"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

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

200
403
404
503

Content type

application/json

Example

Exemplo de cobrança imediata 1

{"calendario": {"criacao": "2020-09-09T20:15:00.358Z",
"expiracao": 3600
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"revisao": 0,
"loc": {"id": 789,
"location": "pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25",
"tipoCob": "cob"
},
"location": "pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25",
"status": "ATIVA",
"devedor": {"cnpj": "12345678000195",
"nome": "Empresa de Serviços SA"
},
"valor": {"original": "37.00",
"modalidadeAlteracao": 1
},
"chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
"solicitacaoPagador": "Serviço realizado.",
"infoAdicionais": [{"nome": "Campo 1",
"valor": "Informação Adicional1 do PSP-Recebedor"
},
{"nome": "Campo 2",
"valor": "Informação Adicional2 do PSP-Recebedor"
}
]
}

Criar cobrança imediata.

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

Authorizations:

OAuth2

Request Body schema: application/json
required

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

	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 (Location do Payload) Identificador da localização do payload.
required	object (Valor da cobrança imediata) 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

Payload

Content type

application/json

Example

Exemplo de criação de cobrança imediata 1

{"calendario": {"expiracao": 3600
},
"devedor": {"cnpj": "12345678000195",
"nome": "Empresa de Serviços SA",
"contas": [{"numero": "123456",
"agencia": "0001",
"ispb": "11112222"
}
]
},
"valor": {"original": "37.00",
"modalidadeAlteracao": 1
},
"chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
"solicitacaoPagador": "Serviço realizado.",
"infoAdicionais": [{"nome": "Campo 1",
"valor": "Informação Adicional1 do PSP-Recebedor"
},
{"nome": "Campo 2",
"valor": "Informação Adicional2 do PSP-Recebedor"
}
]
}

Response samples

201
400
403
503

Content type

application/json

Example

Exemplo de cobrança imediata 1

{"calendario": {"criacao": "2020-09-09T20:15:00.358Z",
"expiracao": 3600
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"revisao": 0,
"loc": {"id": 789,
"location": "pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25",
"tipoCob": "cob"
},
"location": "pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25",
"status": "ATIVA",
"devedor": {"cnpj": "12345678000195",
"nome": "Empresa de Serviços SA"
},
"valor": {"original": "37.00",
"modalidadeAlteracao": 1
},
"chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
"solicitacaoPagador": "Serviço realizado.",
"infoAdicionais": [{"nome": "Campo 1",
"valor": "Informação Adicional1 do PSP-Recebedor"
},
{"nome": "Campo 2",
"valor": "Informação Adicional2 do PSP-Recebedor"
}
]
}

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

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

200
403
503

Content type

application/json

Example

Exemplo de retorno da consulta de cobranças 1

{"parametros": {"inicio": "2020-04-01T00:00:00Z",
"fim": "2020-04-02T10:00:00Z",
"paginacao": {"paginaAtual": 0,
"itensPorPagina": 100,
"quantidadeDePaginas": 1,
"quantidadeTotalDeItens": 2
}
},
"cobs": [{"allOf": [{"$ref": "#/components/examples/cobResponse1/value"
}
]
},
{"allOf": [{"$ref": "#/components/examples/cobResponse2/value"
}
]
},
{"allOf": [{"$ref": "#/components/examples/cobResponse5/value"
}
]
},
{"allOf": [{"$ref": "#/components/examples/cobResponse6/value"
}
]
},
{"allOf": [{"$ref": "#/components/examples/cobResponse7/value"
}
]
}
]
}

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

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
required

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

	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 (Location do Payload) Identificador da localização do payload.
required	object (Valor da cobrança com vencimento) 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

Payload

Content type

application/json

{"calendario": {"dataDeVencimento": "2020-12-31",
"validadeAposVencimento": 30
},
"loc": {"id": 789
},
"devedor": {"logradouro": "Alameda Souza, Numero 80, Bairro Braz",
"cidade": "Recife",
"uf": "PE",
"cep": "70011750",
"cpf": "12345678909",
"nome": "Francisco da Silva"
},
"valor": {"original": "123.45",
"multa": {"modalidade": "2",
"valorPerc": "15.00"
},
"juros": {"modalidade": "2",
"valorPerc": "2.00"
},
"desconto": {"modalidade": "1",
"descontoDataFixa": [{"data": "2020-11-30",
"valorPerc": "30.00"
}
]
}
},
"chave": "5f84a4c5-c5cb-4599-9f13-7eb4d419dacc",
"solicitacaoPagador": "Cobrança dos serviços prestados."
}

Response samples

201
400
403
404
503

Content type

application/json

{"calendario": {"criacao": "2020-09-09T20:15:00.358Z",
"dataDeVencimento": "2020-12-31",
"validadeAposVencimento": 30
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"revisao": 0,
"loc": {"id": 789,
"location": "pix.example.com/qr/c2/cobv/9d36b84fc70b478fb95c12729b90ca25",
"tipoCob": "cobv"
},
"status": "ATIVA",
"devedor": {"logradouro": "Alameda Souza, Numero 80, Bairro Braz",
"cidade": "Recife",
"uf": "PE",
"cep": "70011750",
"cpf": "12345678909",
"nome": "Francisco da Silva"
},
"recebedor": {"logradouro": "Rua 15 Numero 1200, Bairro São Luiz",
"cidade": "São Paulo",
"uf": "SP",
"cep": "70800100",
"cnpj": "56989000019533",
"nome": "Empresa de Logística SA"
},
"valor": {"original": "123.45"
},
"chave": "5f84a4c5-c5cb-4599-9f13-7eb4d419dacc",
"solicitacaoPagador": "Cobrança dos serviços prestados."
}

Revisar cobrança com vencimento.

Authorizations:

OAuth2

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
required

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 (Location do Payload) 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

Payload

Content type

application/json

Example

Exemplo de revisão de cobrança com vencimento 1

{"loc": {"id": 789
},
"devedor": {"logradouro": "Alameda Souza, Numero 80, Bairro Braz",
"cidade": "Recife",
"uf": "PE",
"cep": "70011750",
"cpf": "12345678909",
"nome": "Francisco da Silva"
},
"valor": {"original": "123.45"
},
"solicitacaoPagador": "Cobrança dos serviços prestados."
}

Response samples

200
400
403
404
503

Content type

application/json

{"calendario": {"criacao": "2020-09-09T20:15:00.358Z",
"dataDeVencimento": "2020-12-31",
"validadeAposVencimento": 30
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"revisao": 0,
"loc": {"id": 789,
"location": "pix.example.com/qr/c2/cobv/9d36b84fc70b478fb95c12729b90ca25",
"tipoCob": "cobv"
},
"status": "ATIVA",
"devedor": {"logradouro": "Alameda Souza, Numero 80, Bairro Braz",
"cidade": "Recife",
"uf": "PE",
"cep": "70011750",
"cpf": "12345678909",
"nome": "Francisco da Silva"
},
"recebedor": {"logradouro": "Rua 15 Numero 1200, Bairro São Luiz",
"cidade": "São Paulo",
"uf": "SP",
"cep": "70800100",
"cnpj": "56989000019533",
"nome": "Empresa de Logística SA"
},
"valor": {"original": "123.45"
},
"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

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

200
403
404
503

Content type

application/json

{"calendario": {"criacao": "2020-09-09T20:15:00.358Z",
"dataDeVencimento": "2020-12-31",
"validadeAposVencimento": 30
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"revisao": 0,
"loc": {"id": 789,
"location": "pix.example.com/qr/c2/cobv/9d36b84fc70b478fb95c12729b90ca25",
"tipoCob": "cobv"
},
"status": "ATIVA",
"devedor": {"logradouro": "Alameda Souza, Numero 80, Bairro Braz",
"cidade": "Recife",
"uf": "PE",
"cep": "70011750",
"cpf": "12345678909",
"nome": "Francisco da Silva"
},
"recebedor": {"logradouro": "Rua 15 Numero 1200, Bairro São Luiz",
"cidade": "São Paulo",
"uf": "SP",
"cep": "70800100",
"cnpj": "56989000019533",
"nome": "Empresa de Logística SA"
},
"valor": {"original": "123.45"
},
"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

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

200
403
503

Content type

application/json

{"parametros": {"inicio": "2020-04-01T00:00:00Z",
"fim": "2020-04-01T23:59:59Z",
"paginacao": {"paginaAtual": 0,
"itensPorPagina": 100,
"quantidadeDePaginas": 1,
"quantidadeTotalDeItens": 1
}
},
"cobs": [{"allOf": [{"$ref": "#/components/examples/cobResponse4/value"
}
]
}
]
}

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

Request Body schema: application/json
required

Dados para geração da location.

tipoCob

required

string (Tipo da cobrança)

Enum: "cob" "cobv"

Responses

Request samples

Payload

Content type

application/json

{"tipoCob": "cob"
}

Response samples

201
400
403
503

Content type

application/json

Example

Exemplo de Payload Location 1

{"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

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

200
403
503

Content type

application/json

{"parametros": {"inicio": "2020-04-01T00:00:00Z",
"fim": "2020-04-01T23:59:59Z",
"paginacao": {"paginaAtual": 0,
"itensPorPagina": 100,
"quantidadeDePaginas": 1,
"quantidadeTotalDeItens": 3
}
},
"loc": [{"allOf": [{"$ref": "#/components/examples/payloadLocationResponse1/value"
}
]
},
{"allOf": [{"$ref": "#/components/examples/payloadLocationResponse2/value"
}
]
},
{"allOf": [{"$ref": "#/components/examples/payloadLocationResponse3/value"
}
]
}
]
}

Recuperar location do payload.

Recupera a location do payload

Authorizations:

OAuth2

path Parameters

id

required

string (Id da location cadastrada para servir um payload)

Responses

Response samples

200
403
404
503

Content type

application/json

Example

Exemplo de Payload Location 1

{"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

path Parameters

id

required

string (Id da location cadastrada para servir um payload)

Responses

Response samples

200
403
404
503

Content type

application/json

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

Configuração de locations para payloads de recorrências

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

Criar location do payload.

Criar location do payload

Authorizations:

OAuth2

Responses

Response samples

201
403
503

Content type

application/json

{"id": 12069,
"location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
"criacao": "2023-12-20T12:38:28.774Z"
}

Consultar locations cadastradas.

Endpoint para consultar locations cadastradas

Authorizations:

OAuth2

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.
idRecPresente	boolean
convenio	string (Convênio) <= 60 characters Filtro pelo convênio associado.
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

200
403
503

Content type

application/json

{"parametros": {"inicio": "2023-12-01T00:00:00Z",
"fim": "2024-04-01T23:59:59Z",
"paginacao": {"paginaAtual": 0,
"itensPorPagina": 100,
"quantidadeDePaginas": 1,
"quantidadeTotalDeItens": 1
}
},
"loc": [{"id": 12069,
"location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
"criacao": "2023-12-20T12:38:28.774Z",
"idRec": "RR123456782024011510056892226"
}
]
}

Recuperar location do payload.

Recupera a location do payload

Authorizations:

OAuth2

path Parameters

id

required

string (Id da location cadastrada para servir um payload)

Responses

Response samples

200
403
404
503

Content type

application/json

{"id": 12069,
"location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
"criacao": "2023-12-20T12:38:28.774Z",
"idRec": "RR123456782024011510056892226"
}

Desvincular uma recorrência de uma location.

Endpoint utilizado para desvincular uma recorrência de uma location.

Se executado com sucesso, a entidade loc não apresentará mais uma recorrência, se apresentava anteriormente à chamada. Adicionalmente, a entidade associada ao recurso desvinculado também passará a não mais apresentar um location. Esta operação não altera o status do recurso em questão.

Authorizations:

OAuth2

path Parameters

id

required

string (Id da location cadastrada para servir um payload)

Responses

Response samples

200
403
404
503

Content type

application/json

{"id": 12069,
"location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
"criacao": "2023-12-20T12:38:28.774Z"
}

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

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

200
403
404
503

Content type

application/json

Example

Exemplo de Pix 1

{"endToEndId": "E12345678202009091221abcdef12345",
"txid": "cd1fe328c875481285a6f233ae41b662",
"valor": "100.00",
"horario": "2020-09-10T13:03:33.902Z",
"infoPagador": "Reforma da casa",
"devolucoes": [{"id": "000AAA111",
"rtrId": "D12345678202009091000abcde123456",
"valor": "11.00",
"horario": {"solicitacao": "2020-09-10T13:03:33.902Z"
},
"status": "EM_PROCESSAMENTO"
}
]
}

Consultar Pix recebidos.

Endpoint para consultar Pix recebidos

Authorizations:

OAuth2

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 (Id da Transação) [a-zA-Z0-9]{1,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

200
403
503

Content type

application/json

Example

Exemplo de retorno da consulta de Pix 1

{"parametros": {"inicio": "2020-04-01T00:00:00Z",
"fim": "2020-04-01T23:59:59Z",
"paginacao": {"paginaAtual": 0,
"itensPorPagina": 100,
"quantidadeDePaginas": 1,
"quantidadeTotalDeItens": 2
}
},
"pix": {"endToEndId": "E12345678202009091221abcdef12345",
"txid": "cd1fe328c875481285a6f233ae41b662",
"valor": "100.00",
"horario": "2020-09-10T13:03:33.902Z",
"infoPagador": "Reforma da casa",
"devolucoes": [{"id": "000AAA111",
"rtrId": "D12345678202009091000abcde123456",
"valor": "11.00",
"horario": {"solicitacao": "2020-09-10T13:03:33.902Z"
},
"status": "EM_PROCESSAMENTO"
}
]
}
}

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

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
required

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

Payload

Content type

application/json

{"valor": "7.89"
}

Response samples

201
400
403
404
503

Content type

application/json

{"id": "123456",
"rtrId": "D12345678202009091000abcde123456",
"valor": "7.89",
"horario": {"solicitacao": "2020-09-11T15:25:59.411Z"
},
"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

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

200
403
404
503

Content type

application/json

Example

Exemplo de devolução 1

{"id": "123456",
"rtrId": "D12345678202009091000abcde123456",
"valor": "7.89",
"horario": {"solicitacao": "2020-09-11T15:25:59.411Z"
},
"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

path Parameters

chave

required

string (Chave DICT do recebedor) <= 77 characters

Request Body schema: application/json
required

webhookUrl

required

string <uri>

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"webhookUrl": "https://pix.example.com/api/webhook/"
}

Response samples

200
400
403
404
503

Content type

application/json

{"webhookUrl": "https://pix.example.com/api/webhook/",
"chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
"criacao": "2020-09-09T20:15:00.358Z"
}

Callback payload samples

Callback

POST: O callback deve ser acionado sempre que um ou mais

Content type

application/json

Example

Exemplo de Webhook Pix

{"txid": "971122d8f37211eaadc10242ac120002",
"valor": "110.00",
"horario": "2020-09-09T20:15:00.358Z",
"pagador": {"cpf": "0123456789",
"nome": "Nome Pagador"
},
"endToEndId": "E12345678202009091221abcdef12345"
}

Exibir informações acerca do Webhook Pix.

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

Authorizations:

OAuth2

path Parameters

chave

required

string (Chave DICT do recebedor) <= 77 characters

Responses

Response samples

200
403
404
503

Content type

application/json

{"webhookUrl": "https://pix.example.com/api/webhook/",
"chave": "40a0932d-1918-4eee-845d-35a2da1690dc",
"criacao": "2020-11-11T10:15:00.358Z"
}

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

path Parameters

chave

required

string (Chave DICT do recebedor) <= 77 characters

Responses

Response samples

403
404
503

Content type

application/problem+json

{"type": "https://pix.bcb.gov.br/api/v2/error/AcessoNegado",
"title": "Acesso Negado",
"status": 403,
"detail": "Requisição de participante autenticado que viola alguma regra de autorização."
}

Consultar webhooks cadastrados.

Endpoint para consultar Webhooks cadastrados

Authorizations:

OAuth2

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

200
403
503

Content type

application/json

{"parametros": {"inicio": "2020-04-01T00:00:00Z",
"fim": "2020-04-01T23:59:59Z",
"paginacao": {"paginaAtual": 0,
"itensPorPagina": 100,
"quantidadeDePaginas": 1,
"quantidadeTotalDeItens": 1
}
},
"webhooks": [{"allOf": [{"$ref": "#/components/examples/webhookResponse1/value"
}
]
}
]
}

Gerenciamento de notificações de recorrências

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

Configurar Webhook.

Endpoint para configuração do serviço de notificações acerca de recorrências. Somente recorrências associadas a chave e conta serão notificadas.

Authorizations:

OAuth2

Request Body schema: application/json
required

webhookUrl

required

string <uri> (URL Webhook)

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"webhookUrl": "https://usuario.recebedor.com/api/webhookrec/"
}

Response samples

400
403
404
503

Content type

application/problem+json

{"type": "https://pix.bcb.gov.br/api/v2/error/WebhookOperacaoInvalida",
"title": "Webhook inválido.",
"status": 400,
"detail": "A presente requisição busca criar um webhook sem respeitar o _schema_ ou, ainda, com sentido semanticamente inválido."
}

Callback payload samples

Callback

POST: {$request.body#/webhookUrl}/rec

Content type

application/json

{"recs": [{"idRec": "RR1026652320240821lab77511abf",
"status": "APROVADA",
"atualizacao": [{"status": "CRIADA",
"data": "2024-08-20T10:12:07.567Z"
},
{"status": "APROVADA",
"data": "2024-08-22T12:43:53.337Z"
}
],
"ativacao": {"tipoJornada": "JORNADA_3",
"dadosJornada": {"txid": "r9eFIFmwcZ55Nm4RsKZAAtIvvCrlcNN6"
}
}
}
]
}

Exibir informações acerca do Webhook.

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

Authorizations:

OAuth2

Responses

Response samples

200
403
404
503

Content type

application/json

{"webhookUrl": "https://usuario.recebedor.com/api/webhookrec/",
"criacao": "2023-12-20T12:51:16.485Z"
}

Cancelar o Webhook.

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

Authorizations:

OAuth2

Responses

Response samples

403
404
503

Content type

application/problem+json

{"type": "https://pix.bcb.gov.br/api/v2/error/AcessoNegado",
"title": "Acesso Negado",
"status": 403,
"detail": "Requisição de participante autenticado que viola alguma regra de autorização."
}

Gerenciamento de notificações de cobranças recorrentes

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

Configurar Webhook.

Endpoint para configuração do serviço de notificações acerca de cobranças recorrentes. Somente cobranças recorrentes associadas ao usuário recebedor serão notificadas.

Authorizations:

OAuth2

Request Body schema: application/json
required

webhookUrl

required

string <uri> (URL Webhook)

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"webhookUrl": "https://usuario.recebedor.com/api/webhookcobr/"
}

Response samples

400
403
404
503

Content type

application/problem+json

{"type": "https://pix.bcb.gov.br/api/v2/error/WebhookOperacaoInvalida",
"title": "Webhook inválido.",
"status": 400,
"detail": "A presente requisição busca criar um webhook sem respeitar o _schema_ ou, ainda, com sentido semanticamente inválido."
}

Callback payload samples

Callback

POST: {$request.body#/webhookUrl}/cobr

Content type

application/json

{"cobsr": [{"idRec": "RR1234567820240115abcdefghijk",
"txid": "3136957d93134f2184b369e8f1c0729d",
"status": "ATIVA",
"atualizacao": [{"status": "ATIVA",
"data": "2024-08-20T12:34:21.300Z"
}
],
"tentativas": [{"dataLiquidacao": "2024-20-08",
"tipo": "AGND",
"status": "SOLICITADA",
"endToEndId": "E12345678202406201221abcdef12345"
}
]
}
]
}

Exibir informações acerca do Webhook.

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

Authorizations:

OAuth2

Responses

Response samples

200
403
404
503

Content type

application/json

{"webhookUrl": "https://usuario.recebedor.com/api/webhookcobr/",
"criacao": "2023-12-20T12:51:16.485Z"
}

Cancelar o Webhook.

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

Authorizations:

OAuth2

Responses

Response samples

403
404
503

Content type

application/problem+json

{"type": "https://pix.bcb.gov.br/api/v2/error/AcessoNegado",
"title": "Acesso Negado",
"status": 403,
"detail": "Requisição de participante autenticado que viola alguma regra de autorização."
}

LoteCobV

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

path Parameters

id

required

string (Identificador do lote de cobranças com vencimento, em formato de texto.)

Request Body schema: application/json
required

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

descricao required	string (Descrição do lote)
required	Array of objects (Cobrança com vencimento solicitada)

Responses

Request samples

Payload

Content type

application/json

{"descricao": "Cobranças dos alunos do turno vespertino",
"cobsv": [{"calendario": {"dataDeVencimento": "2020-12-31",
"validadeAposVencimento": 30
},
"txid": "fb2761260e554ad593c7226beb5cb650",
"loc": {"id": 789
},
"devedor": {"logradouro": "Alameda Souza, Numero 80, Bairro Braz",
"cidade": "Recife",
"uf": "PE",
"cep": "70011750",
"cpf": "08577095428",
"nome": "João Souza"
},
"valor": {"original": "100.00"
},
"chave": "7c084cd4-54af-4172-a516-a7d1a12b75cc",
"solicitacaoPagador": "Informar matrícula"
},
{"calendario": {"dataDeVencimento": "2020-12-31",
"validadeAposVencimento": 30
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"loc": {"id": 57221
},
"devedor": {"logradouro": "Rua 15, Numero 1, Bairro Campo Grande",
"cidade": "Recife",
"uf": "PE",
"cep": "70055751",
"cpf": "15311295449",
"nome": "Manoel Silva"
},
"valor": {"original": "100.00"
},
"chave": "7c084cd4-54af-4172-a516-a7d1a12b75cc",
"solicitacaoPagador": "Informar matrícula"
}
]
}

Response samples

400
403
404
503

Content type

application/problem+json

{"type": "https://pix.bcb.gov.br/api/v2/error/LoteCobVOperacaoInvalida",
"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": [{"razao": "O objeto loteCobV.cobsV não respeita o _schema_.",
"propriedade": "loteCobV.cobsV"
},
{"razao": "O campo loteCobV.descricao não respeita o _schema_.",
"propriedade": "loteCobV.descricao"
}
]
}

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

path Parameters

id

required

string (Identificador do lote de cobranças com vencimento, em formato de texto.)

Request Body schema: application/json
required

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

descricao	string (Descrição do lote)
	Array of objects (Cobrança com vencimento revisada)

Responses

Request samples

Payload

Content type

application/json

{"cobsv": [{"calendario": {"dataDeVencimento": "2020-01-10"
},
"txid": "fb2761260e554ad593c7226beb5cb650",
"valor": {"original": "110.00"
}
},
{"calendario": {"dataDeVencimento": "2020-01-10"
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"valor": {"original": "110.00"
}
}
]
}

Response samples

400
403
404
503

Content type

application/problem+json

{"type": "https://pix.bcb.gov.br/api/v2/error/CobVOperacaoInvalida",
"title": "Operação inválida.",
"status": 400,
"detail": "Cobrança não encontra-se mais com o status ATIVA, somente cobranças ativas podem ser revisadas."
}

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

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

Authorizations:

OAuth2

path Parameters

id

required

string (Identificador do lote de cobranças com vencimento, em formato de texto.)

Responses

Response samples

200
403
404
503

Content type

application/json

{"descricao": "Cobranças dos alunos do turno vespertino",
"criacao": "2020-11-01T20:15:00.358Z",
"cobsv": [{"criacao": "2020-11-01T20:15:00.358Z",
"txid": "fb2761260e554ad593c7226beb5cb650",
"status": "CRIADA"
},
{"txid": "7978c0c97ea847e78e8849634473c1f1",
"status": "NEGADA",
"problema": {"type": "https://pix.bcb.gov.br/api/v2/error/CobVOperacaoInvalida",
"title": "Cobrança inválida.",
"status": 400,
"detail": "A requisição que busca alterar ou criar uma cobrança com vencimento não respeita o _schema_ ou está semanticamente errada.",
"violacoes": [{"razao": "O objeto cobv.devedor não respeita o _schema_.",
"propriedade": "cobv.devedor"
}
]
}
}
]
}

Consultar lotes de cobranças com vencimento.

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

Authorizations:

OAuth2

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

200
403
503

Content type

application/json

{"parametros": {"inicio": "2020-01-01T00:00:00Z",
"fim": "2020-12-01T23:59:59Z",
"paginacao": {"paginaAtual": 0,
"itensPorPagina": 100,
"quantidadeDePaginas": 1,
"quantidadeTotalDeItens": 2
}
},
"lotes": [{"allOf": [{"$ref": "#/components/examples/loteCobVResponse1/value"
}
]
},
{"allOf": [{"$ref": "#/components/examples/loteCobVResponse2/value"
}
]
}
]
}

QRCodes API

Evolução da API Pix

Pix Automático

Tratamento de erros

Gerais

RequisicaoInvalida

AcessoNegado

NaoEncontrado

PermanentementeRemovido

ErroInternoDoServidor

ServicoIndisponivel

IndisponibilidadePorTempoEsgotado

Tag CobR

CobRNaoEncontrado

CobROperacaoInvalida

CobRConsultaInvalida

Tag RecPayload

RecPayloadNaoEncontrado

RecPayloadOperacaoInvalida

Tag CobPayload

CobPayloadNaoEncontrado

CobPayloadOperacaoInvalida

Tag SolicRec

SolicRecNaoEncontrada

SolicRecOperacaoInvalida

Tag Cob

CobNaoEncontrado

CobOperacaoInvalida

CobConsultaInvalida

Tag CobV

CobVNaoEncontrada

CobVOperacaoInvalida

CobVConsultaInvalida

Tag PayloadLocation

PayloadLocationNaoEncontrado

PayloadLocationOperacaoInvalida

PayloadLocationConsultaInvalida

Tag Pix

PixNaoEncontrado

PixDevolucaoNaoEncontrada

PixConsultaInvalida

PixDevolucaoInvalida

Tag Webhook

WebhookOperacaoInvalida

WebhookNaoEncontrado

WebhookConsultaInvalida

Tag WebhookRec

WebhookRecOperacaoInvalida

WebhookRecConsultaInvalida

Tag WebhookCobR

WebhookCobROperacaoInvalida

WebhookCobRConsultaInvalida

Autenticação

Obter token de acesso

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Gerenciamento de recorrências

Consultar recorrência.

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Revisar recorrência.

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Consultar lista de recorrências.

Authorizations:

query Parameters

Responses

Response samples

Criar recorrência.

Authorizations:

Request Body schema: application/json

Responses

`RequisicaoInvalida`

`AcessoNegado`

`NaoEncontrado`

`PermanentementeRemovido`

`ErroInternoDoServidor`

`ServicoIndisponivel`

`IndisponibilidadePorTempoEsgotado`

`CobRNaoEncontrado`

`CobROperacaoInvalida`

`CobRConsultaInvalida`

`RecPayloadNaoEncontrado`

`RecPayloadOperacaoInvalida`

`CobPayloadNaoEncontrado`

`CobPayloadOperacaoInvalida`

`SolicRecNaoEncontrada`

`SolicRecOperacaoInvalida`

`CobNaoEncontrado`

`CobOperacaoInvalida`

`CobConsultaInvalida`

`CobVNaoEncontrada`

`CobVOperacaoInvalida`

`CobVConsultaInvalida`

`PayloadLocationNaoEncontrado`

`PayloadLocationOperacaoInvalida`

`PayloadLocationConsultaInvalida`

`PixNaoEncontrado`

`PixDevolucaoNaoEncontrada`

`PixConsultaInvalida`

`PixDevolucaoInvalida`

`WebhookOperacaoInvalida`

`WebhookNaoEncontrado`

`WebhookConsultaInvalida`

`WebhookRecOperacaoInvalida`

`WebhookRecConsultaInvalida`

`WebhookCobROperacaoInvalida`

`WebhookCobRConsultaInvalida`

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required