Download OpenAPI specification:Download
A API Pix padroniza serviços oferecidos pelo PSP recebedor no contexto do arranjo Pix, direcionando:
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.
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:
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:
A API Pix retorna códigos de status HTTP para indicar sucesso ou falhas das requisições, são eles:
2xx
indicam sucesso; 4xx
indicam falhas causadas pelas
informações enviadas pelo cliente ou pelo estado atual das entidades e;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.
Convém reforçar que a API Pix contempla uma lista de produtos e respectivas funcionalidades ofertadas pelo PSP recebedor.
Cabe à relação contratual com cada usuário recebedor a concessão da totalidade ou de um subconjunto de acessos
relacionados aos produtos ofertados. Por exemplo, o usuário recebedor, ao acessar uma funcionalidade não contemplada
no seu escopo contratual, receberá o erro geral AcessoNegado
descrito na próxima seção.
Abaixo estão listados os tipos de erro e possíveis violações da API Pix.
Esta seção reúne erros que poderiam ser retornados por quaisquer endpoints listados na API Pix.
RequisicaoInvalida
AcessoNegado
NaoEncontrado
PermanentementeRemovido
ErroInternoDoServidor
ServicoIndisponivel
IndisponibilidadePorTempoEsgotado
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
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
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.Payload
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
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
GET /rec/{recUrlAccessToken}
.Violações para o endpoint GET /rec/{recUrlAccessToken}
:
recUrlAccessToken
referencia uma recorrência encerrada, rejeitada ou cancelada.Esta seção reúne erros retornados pelos endpoints organizados sob a tag Rec
.
Esses erros indicam problemas no gerenciamento de uma recorrência.
RecNaoEncontrada
[GET|PATCH] /rec/{idRec}
.RecOperacaoInvalida
POST /rec
e PATCH /rec/{idRec}
.Violações para o endpoint POST /rec
:
rec.vinculo
não respeita o schema.rec.calendario.dataInicial
é anterior à data de criação da recorrência.rec.calendario.dataFinal
é anterior ao campo rec.calendario.dataInicial
.rec.calendario.periodicidade
não respeita o schema.rec.valor
não respeita o schema.rec.valor.valorRec
não respeita o schema.rec.valor.valorMinimoRecebedor
não respeita o schema.rec.valor.valorRec
e rec.valor.valorMinimoRecebedor
estão preenchidos.rec.recebedor
não respeita o schema.rec.politicaRetentativa
não respeita o schema.rec.loc
inexiste.rec.loc
já está sendo utilizado por outra recorrência.rec.recebedor.convenio
não é aceito pelo PSP Recebedor.Violações para o endpoint PATCH /rec/{idRec}
:
rec.calendario.dataInicial
é anterior à data de criação da recorrência.rec.loc
inexiste.rec.loc
já está sendo utilizado por outra recorrência.rec.status
não respeita o schema.rec.loc
somente pode ser alterado quando a recorrência apresentar-se com o status CRIADA.rec.calendario.dataInicial
somente pode ser alterado quando a recorrência apresentar-se com o status CRIADA.rec.dadosJornada.txid
não pode ser alterado quando a recorrência apresentar-se com o status REJEITADA ou CANCELADA.RecConsultaInvalida
GET /rec
e GET /rec/{idRec}
.Violações específicas para o endpoint GET /rec
:
fim
é anterior ao timestamp
representado pelo parâmetro inicio
.cpf
e cnpj
estão preenchidos.paginacao.paginaAtual
é negativo.paginacao.itensPorPagina
é negativo.Violações específicas para o endpoint GET /rec/{idRec}
:
txid
não corresponde a uma cobrança compatível com o campo ativacao.tipoJornada
. (Exemplo: txid
correspondente a uma CobV e ativação.tipoJornada
igual a JORNADA_3.)txid
corresponde a uma cobrança imediata diferente da informada no campo ativação.dadosJornada.txid
. Esta violação não ocorre caso o parâmetro txid corresponda a uma cobrança com vencimento.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
[GET] /solicrec/{idSolicRec}
.SolicRecOperacaoInvalida
[POST] /solicrec
e PATCH /solicrec/{idSolicRec}
.Violações para o endpoint POST /solicrec
:
solicrec.calendario
não respeita o schema.solicrec.calendario.dataExpiracaoSolicitacao
é anterior à data de criação da solicitação da recorrência.solicrec.destinatario
não respeita o schema.solicrec.idRec
.Violações para o endpoint PATCH /solicrec/{idSolicRec}
:
R
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
[GET|PATCH] /cobr/{txid}
e [POST] /cobr/{txid}/retentativa/{data}
.CobROperacaoInvalida
[POST|PUT|PATCH] /cobr/{txid}
e [POST] /cobr/{txid}/retentativa/{data}
.Violações para o endpoint POST|PUT /cobr/{txid}
:
cobr.infoAdicional
não respeita o schema.cobr.status
não respeita o schema.cobr.calendario
não respeita o schema.cobr.calendario.dataDeVencimento
é anterior à data de criação da cobrança.cobr.valor
não respeita o schema.cobr.recebedor
não respeita o schema.cobr.recebedor.conta
e cobr.recebedor.agencia
correspondem a uma conta que não pertence a este usuário recebedor.cobr.devedor
não respeita o schema.cobr.txid
encontra-se em uso.cobr.idRec
com calendario.dataDeVencimento
no mesmo ciclo.Violações para o endpoint PATCH /cobr/{txid}
:
Violações para o endpoint POST /cobr/{txid}/retentativa/{data}
:
SOLICITADA
ou AGENDADA
.data
informada.data
não corresponde a uma data futura.CobRConsultaInvalida
GET /cobr
e GET /cobr/{txid}
.Violações específicas para o endpoint GET /cobr
:
fim
é anterior ao timestamp
representado pelo parâmetro inicio
.cpf
e cnpj
estão preenchidos.paginacao.paginaAtual
é negativo.paginacao.itensPorPagina
é negativo.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
[GET|PATCH] /cob/{txid}
.CobOperacaoInvalida
[POST|PUT|PATCH] /cob/{txid}
.Violações para os endpoints PUT|PATCH /cob/{txid}
:
cob.calendario.expiracao
é igual ou menor que zero
.cob.valor.original
não respeita o schema.cob.valor.original
é zero
.cob.devedor
não respeita o schema.cob.chave
não respeita o schema.cob.chave
corresponde a uma conta que não pertence a este usuário recebedor.solicitacaoPagador
não respeita o schema.infoAdicionais
não respeita o schema.location
referenciado por loc.id
inexiste.location
referenciado por loc.id
já está sendo utilizado por outra cobrança.location
referenciado por cob.loc.id
apresenta tipo "cobv" (deveria ser "cob").Violações específicas para o endpoint PUT /cob/{txid}
:
Violações específicas para o endpoint PATCH /cob/{txid}
:
cob.status
não respeita o schema.CobConsultaInvalida
GET /cob
e GET /cob/{txid}
.Violações específicas para o endpoint GET /cob
:
fim
é anterior ao timestamp
representado pelo parâmetro inicio
.cpf
e cnpj
estão preenchidos.paginacao.paginaAtual
é negativo.paginacao.itensPorPagina
é negativo.Violações específicas para o endpoint GET /cob/{txid}
:
revisao
corresponde a uma revisão inexistente para a cobrança
apontada pelo parâmetro txid
.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
[GET|PATCH] /cobv/{txid}
.CobVOperacaoInvalida
[PUT|PATCH] /cobv/{txid}
.Violações para os endpoints PUT|PATCH /cobv/{txid}
:
txid
está associado a um lote e no referido lote, o status desta cobrança está atribuído como
"EM_PROCESSAMENTO" ou "NEGADA".cobv.calendario.dataDeVencimento
é anterior à data de criação da cobrança.cobv.calendario.validadeAposVencimento
é menor do que zero.cobv.devedor
não respeita o schema.cobv.devedor
não respeita o schema.cobv.chave
não respeita o schema.cobv.chave
corresponde a uma conta que não pertence a este usuário recebedor.solicitacaoPagador
não respeita o schema.infoAdicionais
não respeita o schema.cobv.loc.id
inexiste.cobv.loc.id
já está sendo utilizado por outra cobrança.cobv.loc.id
apresenta tipo "cob" (deveria ser "cobv").cobv.valor.original
não respeita o schema.cobv.valor.original
apresenta o valor zero
.cobv.valor.multa
não respeita o schema.cobv.valor.juros
não respeita o schema.cobv.valor.abatimento
não respeita o schema.cobv.valor.desconto
não respeita o schema.cobv.valor.abatimento
representa um valor maior ou igual ao valor da
cobrança original ou maior ou igual a 100%.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%.cobv.valor.desconto
apresenta algum elemento cuja data seja posterior à data de vencimento
representada por calendario.dataDeVencimento
.cobv.valor.desconto
apresenta modalidade no valor 1
ou 2
,
porém cobv.valor.desconto.valorPerc
encontra-se preenchidocobv.valor.desconto
apresenta modalidade no valor 1
ou 2
, porém
o array cobv.valor.desconto.descontoDataFixa
está vazio ou nulo.cobv.valor.desconto
apresenta modalidade nos valores de 3
a 6
, porém
o elemento cobv.valor.desconto.valorPerc
não está preenchido.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}
:
Violações específicas para o endpoint PATCH /cobv/{txid}
:
cob.status
não respeita o schema.CobVConsultaInvalida
GET /cobv
e GET /cobv/{txid}
.Violações específicas para o endpoint GET /cobv
:
fim
é anterior ao timestamp
representado pelo parâmetro inicio
.cpf
e cnpj
estão preenchidos.paginacao.paginaAtual
é negativo.paginacao.itensPorPagina
é negativo.Violações específicas para o endpoint GET /cobv/{txid}
:
revisao
corresponde a uma revisão inexistente para a cobrança
apontada pelo parâmetro txid
.Esta seção reúne erros referentes a endpoints que tratam do gerenciamento de lotes de cobrança.
LoteCobVNaoEncontrado
id
informado.[GET|PATCH] /lotecobv/{id}
.LoteCobVOperacaoInvalida
[PUT|PATCH] /lotecobv/{id}
.Violações para os endpoints PUT|PATCH /lotecobv/{id}
:
loteCobV.descricao
não respeita o schema.loteCobV.cobsV
não respeita o schema.Violações para o endpoint PUT /lotecobv/{id}
:
Violações para o endpoint PATCH /lotecobv/{id}
:
array
de cobranças representado por cobsv
, uma cobrança não existente no array de cobranças
atribuído pela requisição original que criou o lote.
Uma vez criado um lote, não se pode remover ou adicionar cobranças a este lote.Violações para os endpoints GET /lotecobv/{id}
:
cobsv
, retornado por este endpoint, caso a requisição de criação de cobrança esteja em
status "NEGADA", o atributo problema
deste elemento deve ser preenchido respeitando
o schema referenciado pela API Pix.problema
, conforme descrito acima, segue o mesmo regramento dos
erros especificados para os endpoints [PUT/PATCH /cobv/{txid}]
, de maneira a possibilitar, ao
usuário recebedor, entender qual foi a violação cometida ao se tentar criar
a cobrança referenciada por este elemento do array cobsv
.LoteCobVConsultaInvalida
GET /lotecobv
e GET /lotecobv/{id}
.Violações específicas para o endpoint GET /lotecobv
:
fim
é anterior ao timestamp
representado pelo parâmetro inicio
.paginacao.paginaAtual
é negativo.paginacao.itensPorPagina
é negativo.Esta seção reúne erros referentes a endpoints que tratam do gerenciamento de locations.
PayloadLocationNaoEncontrado
id
informado.[GET|PATCH] /loc/{id}
, DELETE /loc/{id}/txid
.PayloadLocationOperacaoInvalida
POST /loc
.Violações para o endpoint POST /loc
:
tipoCob
não respeita o schema.PayloadLocationConsultaInvalida
GET /loc
e GET /loc/{id}
.Violações específicas para o endpoint GET /loc
:
fim
é anterior ao timestamp
representado pelo parâmetro inicio
.paginacao.paginaAtual
é negativo.paginacao.itensPorPagina
é negativo.Esta seção reúne erros referentes a endpoints que tratam do gerenciamento de locations de uma recorrência.
PayloadLocationRecNaoEncontrado
id
informado.[GET] /locrec/{id}
, DELETE /locrec/{id}/idRec
.PayloadLocationRecConsultaInvalida
GET /locrec
e GET /locrec/{id}
.Violações específicas para o endpoint GET /locrec
:
fim
é anterior ao timestamp
representado pelo parâmetro inicio
.paginacao.paginaAtual
é negativo.paginacao.itensPorPagina
é negativo.Reúne erros em endpoints de gestão de Pix recebidos e solicitação de devoluções.
PixNaoEncontrado
e2eid
informado.GET /pix/{e2eid}
PixDevolucaoNaoEncontrada
e2eid
informado.GET /pix/{e2eid}/devolucao/{id}
PixConsultaInvalida
GET /pix
.Violações específicas para o endpoint GET /pix
:
fim
é anterior ao timestamp
representado pelo parâmetro inicio
.cpf
e cnpj
estão preenchidos.paginacao.paginaAtual
é negativo.paginacao.itensPorPagina
é negativo.PixDevolucaoInvalida
PUT /pix/{e2eid}/devolucao/{id}
.Violações específicas para o endpoint PUT /pix/{e2eid}/devolucao/{id}
:
devolucao.valor
não respeita o schema.{id}
já utilizado por outra requisição de
devolução para o {e2eid}
em questão.Reúne erros dos endpoints que tratam do gerenciamento dos Webhooks da API Pix.
WebhookOperacaoInvalida
PUT /webhook/{chave}
.Violações para o endpoint PUT /webhook/{chave}
:
WebhookNaoEncontrado
GET /webhook/{chave}
, DELETE /webhook/{chave}
WebhookConsultaInvalida
GET /webhook
.Violações específicas para o endpoint GET /webhook
:
fim
é anterior ao timestamp
representado pelo parâmetro inicio
.paginacao.paginaAtual
é negativo.paginacao.itensPorPagina
é negativo.Reúne erros dos endpoints que tratam do gerenciamento dos Webhooks de recorrências da API Pix.
WebhookRecOperacaoInvalida
PUT /webhookrec
.Violações para o endpoint PUT /webhookrec
:
webhookUrl
não respeita o schema.WebhookRecConsultaInvalida
GET /webhookrec
.Violações específicas para o endpoint GET /webhookrec
:
fim
é anterior ao timestamp
representado pelo parâmetro inicio
.paginacao.paginaAtual
é negativo.paginacao.itensPorPagina
é negativo.Reúne erros dos endpoints que tratam do gerenciamento dos Webhooks de cobranças recorrentes da API Pix.
WebhookCobROperacaoInvalida
PUT /webhookcobr
.Violações para o endpoint PUT /webhookcobr
:
webhookUrl
não respeita o schema.WebhookCobRConsultaInvalida
GET /webhookcobr
.Violações específicas para o endpoint GET /webhookcobr
:
fim
é anterior ao timestamp
representado pelo parâmetro inicio
.paginacao.paginaAtual
é negativo.paginacao.itensPorPagina
é negativo.Reúne endpoints (locations) utilizados pelo software do PSP pagador para recuperar o payload JSON que representa uma cobrança.
Os endpoints listados nesta Tag apresentam requisitos de autenticação e autorização diferenciados em relação aos outros endpoints listados na presente API.
São endpoints abertos para que qualquer cliente da internet possa se conectar. Cada location é uma url de capacidade, funcionalidade implementada via o fragmento {pixUrlAccessToken}
.
Para mais informações, consultar o Manual de Padrões para iniciação do Pix.
No momento que o usuário devedor efetua a leitura de um QR Code dinâmico gerado pelo recebedor, esta URL será acessada e seu conteúdo consiste em uma estrutura JWS. As informações sobre a segurança no acesso às urls encontram-se no Manual de Segurança do Pix disponível em nesse link.
pixUrlAccessToken required | string |
{ "calendario": { "criacao": "2020-09-15T19:39:54.013Z", "apresentacao": "2020-04-01T18:00:00Z", "expiracao": 3600 }, "txid": "fc9a4366ff3d4964b5dbc6c91a8722d3", "revisao": 3, "status": "ATIVA", "valor": { "original": "500.00", "modalidadeAlteracao": 0 }, "chave": "7407c9c8-f78b-11ea-adc1-0242ac120002", "solicitacaoPagador": "Informar cartao fidelidade", "infoAdicionais": [ { "nome": "quantidade", "valor": "2" } ] }
No momento que o usuário devedor efetua a leitura de um QR Code dinâmico gerado pelo recebedor, esta URL será acessada e seu conteúdo consiste em uma estrutura JWS. As informações sobre a segurança no acesso às urls encontram-se no Manual de Segurança do Pix disponível em nesse link.
pixUrlAccessToken required | string |
codMun | string (Código do município) /^\d{7}$/ Código baseado na Tabela de Códigos de Municípios do IBGE que apresenta a lista dos municípios brasileiros associados a um código composto de 7 dígitos, sendo os dois primeiros referentes ao código da Unidade da Federação. |
DPP | string <date> Example: DPP=2021-04-01 Data de pagamento pretendida. Trata-se de uma data, no formato |
{ "calendario": { "criacao": "2020-09-15T19:39:54.013Z", "apresentacao": "2020-04-01T18:00:00Z", "dataDeVencimento": "2020-12-31", "validadeAposVencimento": 30 }, "devedor": { "cnpj": "56989000019533", "nome": "Empresa de Alimentos SA" }, "recebedor": { "logradouro": "Rua 20 Numero 70, Bairro Luz", "cidade": "Belo Horizonte", "uf": "MG", "cep": "55120750", "cnpj": "58900633120711", "nome": "Empresa de Abastecimento SA" }, "txid": "fc9a4366ff3d4964b5dbc6c91a8722d3", "revisao": 3, "status": "ATIVA", "valor": { "original": "123.45", "multa": "15.00", "juros": "2.00", "final": "140.45" }, "chave": "7407c9c8-f78b-11ea-adc1-0242ac120002", "solicitacaoPagador": "Informar cartao fidelidade", "infoAdicionais": [ { "nome": "quantidade", "valor": "2" } ] }
Reúne endpoints (locations) utilizados pelo software do PSP pagador para recuperar o payload JSON que representa uma recorrência.
Os endpoints listados nesta Tag apresentam requisitos de autenticação e autorização diferenciados em relação aos outros endpoints listados na presente API.
São endpoints abertos para que qualquer cliente da internet possa se conectar. Cada location é uma url de capacidade, funcionalidade implementada via o fragmento {recUrlAccessToken}
.
Para mais informações, consultar o Manual de Padrões para iniciação do Pix.
No momento em que o usuário pagador efetua a leitura de um QR Code composto gerado pelo recebedor, esta URL será acessada e seu conteúdo consiste em uma estrutura JWS. As informações sobre a segurança no acesso às urls encontram-se no Manual de Segurança do Pix disponível nesse link.
recUrlAccessToken required | string |
{ "idRec": "RN123456782024011577825445612", "vinculo": { "contrato": "5582610", "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", "valor": { "valorRec": "35.00" }, "recebedor": { "cnpj": "28765007802371", "nome": "Startup Musical", "ispbParticipante": "12345678" }, "atualizacao": [ { "status": "CRIADA", "data": "2024-03-20T10:12:07.567Z" } ] }
Consultar recorrência.
idRec required | string (Id da location cadastrada para servir um payload) |
txid | string (TxId da cobrança associada a recorrência.) |
{- "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.
idRec required | string (Id da location cadastrada para servir um payload) |
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. |
{- "loc": 108,
- "vinculo": {
- "devedor": {
- "nome": "Fulano de Tal"
}
}, - "calendario": {
- "dataInicial": "2024-04-01"
}, - "ativacao": {
- "dadosJornada": {
- "txid": "33beb661beda44a8928fef47dbeb2dc5"
}
}
}
{- "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.
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. |
{- "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
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. |
{- "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"
}
}
}
{- "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"
}
]
}
Reúne endpoints destinados a lidar com gerenciamento de solicitações de recorrências.
Criar solicitação de confirmação de recorrência.
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ênciaRegra de formação:
Dessa forma, o ID da recorrência deve ser formado de acordo com um dos tipos a seguir:
|
required | object (Informações de Calendário da Solicitação da Recorrência) |
required | Pessoa Física (object) or Pessoa Jurídica (object) |
{- "idRec": "RN123456782024011577825445612",
- "calendario": {
- "dataExpiracaoSolicitacao": "2023-12-20T12:17:11.926Z"
}, - "destinatario": {
- "agencia": "2569",
- "conta": "550689",
- "cpf": "15231470190",
- "ispbParticipante": "91193552"
}
}
{- "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.
idSolicRec required | string (Id da solicitação da recorrência) |
{- "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.
idSolicRec required | string (Id da solicitação da recorrência) |
Dados para revisão da solicitação da recorrência.
status required | string (Status do registro da solicitação de recorrência) Value: "CANCELADA" |
{- "status": "CANCELADA"
}
{- "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"
}
]
}
}
Reúne endpoints destinados a lidar com gerenciamento de cobranças associadas a uma recorrência.
Endpoint para criar uma cobrança recorrente.
txid required | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo Na pacs.008, é referenciado como 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. |
Dados para geração da cobrança recorrente.
idRec required | string (ID Recorrência) = 29 characters [a-zA-Z0-9]{29} Identificador da RecorrênciaRegra de formação:
Dessa forma, o ID da recorrência deve ser formado de acordo com um dos tipos a seguir:
|
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. |
{- "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",
- "logradouro": "Alameda Franco 1056",
- "uf": "MG"
}, - "recebedor": {
- "agencia": "9708",
- "conta": "012682",
- "tipoConta": "CORRENTE"
}
}
{- "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",
- "logradouro": "Alameda Franco 1056",
- "uf": "MG"
}, - "recebedor": {
- "agencia": "9708",
- "conta": "012682",
- "tipoConta": "CORRENTE"
}, - "atualizacao": [
- {
- "data": "2024-04-01T14:47:29.470Z",
- "status": "CRIADA"
}
]
}
txid required | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo Na pacs.008, é referenciado como 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. |
Dados para geração da cobrança.
status | string (Status do registro da cobrança) Value: "CANCELADA" |
{- "status": "CANCELADA"
}
{- "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",
- "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"
}
]
}
Endpoint para consultar uma cobrança recorrente através de um determinado txid.
txid required | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo Na pacs.008, é referenciado como 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. |
{- "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",
- "logradouro": "Alameda Franco 1056",
- "uf": "MG"
}, - "recebedor": {
- "agencia": "9708",
- "conta": "012682",
- "tipoConta": "CORRENTE"
}, - "atualizacao": [
- {
- "data": "2024-04-01T14:47:29.470Z",
- "status": "CRIADA"
}
]
}
Endpoint para criar uma cobrança recorrente, neste caso, o txid deve ser definido pelo PSP.
Dados para geração da cobrança recorrente.
idRec required | string (ID Recorrência) = 29 characters [a-zA-Z0-9]{29} Identificador da RecorrênciaRegra de formação:
Dessa forma, o ID da recorrência deve ser formado de acordo com um dos tipos a seguir:
|
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. |
{- "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",
- "logradouro": "Alameda Franco 1056",
- "uf": "MG"
}, - "recebedor": {
- "agencia": "9708",
- "conta": "012682",
- "tipoConta": "CORRENTE"
}
}
{- "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",
- "logradouro": "Alameda Franco 1056",
- "uf": "MG"
}, - "recebedor": {
- "agencia": "9708",
- "conta": "012682",
- "tipoConta": "CORRENTE"
}, - "atualizacao": [
- {
- "data": "2024-04-01T14:47:29.470Z",
- "status": "CRIADA"
}
]
}
Endpoint para consultar cobranças recorrentes através de parâmetros como início, fim, idRec, cpf, cnpj, status e convênio.
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. |
{- "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",
- "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"
}
]
}
]
}
Endpoint para solicitar retentativa de uma cobrança recorrente.
txid required | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo Na pacs.008, é referenciado como 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 |
{- "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",
- "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"
}
]
}
Reúne endpoints destinados a lidar com gerenciamento de cobranças imediatas.
Endpoint para criar uma cobrança imediata.
txid required | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo Na pacs.008, é referenciado como 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. |
Dados para geração da cobrança imediata.
required | object (Calendário) Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança. |
Pessoa Física (object) or Pessoa Jurídica (object) Os campos aninhados sob o objeto devedor são opcionais e identificam o devedor, ou seja, a pessoa ou a instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar, efetivamente, o pagamento do documento. Não é permitido que o campo | |
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
|
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 |
Array of objects (Informações adicionais) <= 50 Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador. |
{- "calendario": {
- "expiracao": 3600
}, - "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"
}
]
}
{- "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"
}
]
}
txid required | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo Na pacs.008, é referenciado como 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. |
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 | |
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
|
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 |
Array of objects (Informações adicionais) <= 50 Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador. |
{- "loc": {
- "id": 7768
}, - "devedor": {
- "cpf": "12345678909",
- "nome": "Francisco da Silva"
}, - "valor": {
- "original": "123.45"
}, - "solicitacaoPagador": "Cobrança dos serviços prestados."
}
{- "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."
}
Endpoint para consultar uma cobrança através de um determinado txid.
txid required | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo Na pacs.008, é referenciado como 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. |
revisao | integer <int32> (Revisão) O campo
|
{- "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"
}
]
}
Endpoint para criar uma cobrança imediata, neste caso, o txid deve ser definido pelo PSP.
Dados para geração da cobrança imediata.
required | object (Calendário) Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança. |
Pessoa Física (object) or Pessoa Jurídica (object) Os campos aninhados sob o objeto devedor são opcionais e identificam o devedor, ou seja, a pessoa ou a instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar, efetivamente, o pagamento do documento. Não é permitido que o campo | |
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
|
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 |
Array of objects (Informações adicionais) <= 50 Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador. |
{- "calendario": {
- "expiracao": 3600
}, - "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"
}
]
}
{- "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"
}
]
}
Endpoint para consultar cobranças imediatas através de parâmetros como início, fim, cpf, cnpj e status.
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. |
{- "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"
}
]
}
]
}
Reúne endpoints destinados a lidar com gerenciamento de cobranças com vencimento.
Endpoint para criar uma cobrança com vencimento.
txid required | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo Na pacs.008, é referenciado como 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. |
Dados para geração da cobrança com vencimento.
required | object (Calendário) Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança. |
required | Pessoa Física (object) or Pessoa Jurídica (object) O objeto devedor organiza as informações sobre o devedor da cobrança. |
object (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
|
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 |
Array of objects (Informações adicionais) <= 50 Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador. |
{- "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."
}
{- "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."
}
txid required | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo Na pacs.008, é referenciado como 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. |
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
|
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 |
Array of objects (Informações adicionais) <= 50 Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador. |
{- "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."
}
{- "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."
}
Endpoint para consultar uma cobrança com vencimento através de um determinado txid.
txid required | string (Id da Transação) [a-zA-Z0-9]{26,35} Identificador da transaçãoO campo Na pacs.008, é referenciado como 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. |
revisao | integer <int32> (Revisão) O campo
|
{- "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."
}
Endpoint para consultar cobranças com vencimento através de parâmetros como início, fim, cpf, cnpj e status.
inicio required | string <date-time> (Data de início) Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339. |
fim required | string <date-time> (Data de fim) Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339. |
cpf | string (CPF) /^\d{11}$/ Filtro pelo CPF do devedor. Não pode ser utilizado ao mesmo tempo que o CNPJ. |
cnpj | string (CNPJ) /^\d{14}$/ Filtro pelo CNPJ do devedor. Não pode ser utilizado ao mesmo tempo que o CPF. |
locationPresente | boolean |
status | string (Status do registro da cobrança) Filtro pelo status da cobrança. |
loteCobVId | integer <int32> (Id do lote de cobrança com vencimento) Id do lote de cobrança com vencimento. |
paginacao.paginaAtual | integer <int32> (Página atual) >= 0 Default: 0 Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0. |
paginacao.itensPorPagina | integer <int32> (Itens por Página) [ 1 .. 1000 ] Default: 100 Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros. |
{- "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"
}
]
}
]
}
Reúne endpoints destinados a lidar com gerenciamento de cobranças com vencimento em lote.
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.
id required | string (Identificador do lote de cobranças com vencimento, em formato de texto.) |
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) |
{- "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"
}
]
}
{- "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"
}
]
}
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.
id required | string (Identificador do lote de cobranças com vencimento, em formato de texto.) |
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) |
{- "cobsv": [
- {
- "calendario": {
- "dataDeVencimento": "2020-01-10"
}, - "txid": "fb2761260e554ad593c7226beb5cb650",
- "valor": {
- "original": "110.00"
}
}, - {
- "calendario": {
- "dataDeVencimento": "2020-01-10"
}, - "txid": "7978c0c97ea847e78e8849634473c1f1",
- "valor": {
- "original": "110.00"
}
}
]
}
{- "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."
}
Endpoint para consultar um lote de cobranças com vencimento.
id required | string (Identificador do lote de cobranças com vencimento, em formato de texto.) |
{- "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": {
- "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"
}
]
}
}
]
}
Endpoint para consultar lista de lotes de cobranças com vencimento.
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. |
{- "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"
}
]
}
]
}
Reúne endpoints destinados a lidar com configuração e remoção de locations para uso dos payloads
Criar location do payload
Dados para geração da location.
tipoCob required | string (Tipo da cobrança) Enum: "cob" "cobv" |
{- "tipoCob": "cob"
}
{- "id": 7716,
- "location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
- "tipoCob": "cob",
- "criacao": "2020-03-11T21:19:51.013Z"
}
Endpoint para consultar locations cadastradas
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. |
{- "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"
}
]
}
]
}
Recupera a location do payload
id required | string (Id da location cadastrada para servir um payload) |
{- "id": 7716,
- "txid": "fda9460fe04e4f129b72863ae57ee22f",
- "location": "pix.example.com/qr/v2/cobv/2353c790eefb11eaadc10242ac120002",
- "tipoCob": "cobv",
- "criacao": "2020-03-11T21:19:51.013Z"
}
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.
id required | string (Id da location cadastrada para servir um payload) |
{- "id": 2316,
- "location": "pix.example.com/qr/v2/a8534e273ecb47d3ac30613104544466",
- "tipoCob": "cob",
- "criacao": "2020-05-31T19:39:54.013Z"
}
Reúne endpoints destinados a lidar com configuração e remoção de locations para uso dos payloads de recorrências
Endpoint para consultar locations cadastradas
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. |
{- "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"
}
]
}
Recupera a location do payload
id required | string (Id da location cadastrada para servir um payload) |
{- "id": 12069,
- "location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
- "criacao": "2023-12-20T12:38:28.774Z",
- "idRec": "RR123456782024011510056892226"
}
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.
id required | string (Id da location cadastrada para servir um payload) |
{- "id": 12069,
- "location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
- "criacao": "2023-12-20T12:38:28.774Z"
}
reúne endpoints destinados a lidar com gerenciamento de Pix recebidos.
Endpoint para consultar um Pix através de um e2eid.
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 |
{- "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"
}
]
}
Endpoint para consultar Pix recebidos
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çãoO campo Na pacs.008, é referenciado como 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. |
{- "parametros": {
- "inicio": "2020-04-01T00:00:00Z",
- "fim": "2020-04-01T23:59:59Z",
- "paginacao": {
- "paginaAtual": 0,
- "itensPorPagina": 100,
- "quantidadeDePaginas": 1,
- "quantidadeTotalDeItens": 2
}
}, - "pix": [
- {
- "allOf": [
- {
- "$ref": "#/components/examples/pixResponse1/value"
}
]
}, - {
- "allOf": [
- {
- "$ref": "#/components/examples/pixResponse2/value"
}
]
}, - {
- "allOf": [
- {
- "$ref": "#/components/examples/pixResponse3/value"
}
]
}
]
}
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).
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. |
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: As naturezas são assim definidas:
Os valores de devoluções são sempre limitados aos valores máximos a seguir:
|
descricao | string (Mensagem ao pagador relativa à devolução.) <= 140 characters O campo |
{- "valor": "7.89"
}
{- "id": "123456",
- "rtrId": "D12345678202009091000abcde123456",
- "valor": "7.89",
- "horario": {
- "solicitacao": "2020-09-11T15:25:59.411Z"
}, - "status": "EM_PROCESSAMENTO"
}
Endpoint para consultar uma devolução através de um End To End ID do Pix e do ID da devolução
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. |
{- "id": "123456",
- "rtrId": "D12345678202009091000abcde123456",
- "valor": "7.89",
- "horario": {
- "solicitacao": "2020-09-11T15:25:59.411Z"
}, - "status": "EM_PROCESSAMENTO"
}
Reúne endpoints para gerenciamento de notificações por parte do PSP recebedor ao usuário recebedor.
Endpoint para configuração do serviço de notificações acerca de Pix recebidos. Somente Pix associados a um txid serão notificados.
chave required | string (Chave DICT do recebedor) <= 77 characters |
webhookUrl required | string <uri> |
{
}
{- "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."
}
{- "pix": [
- {
- "allOf": [
- {
- "$ref": "#/components/examples/pixWebhook1/value"
}
]
}, - {
- "allOf": [
- {
- "$ref": "#/components/examples/pixWebhook2/value"
}
]
}
]
}
Endpoint para recuperação de informações sobre o Webhook Pix.
chave required | string (Chave DICT do recebedor) <= 77 characters |
{- "chave": "40a0932d-1918-4eee-845d-35a2da1690dc",
- "criacao": "2020-11-11T10:15:00.358Z"
}
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.
chave required | string (Chave DICT do recebedor) <= 77 characters |
{- "title": "Acesso Negado",
- "status": 403,
- "detail": "Requisição de participante autenticado que viola alguma regra de autorização."
}
Endpoint para consultar Webhooks cadastrados
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. |
{- "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/recWebhookResponse1"
}
]
}
]
}
Reúne endpoints para gerenciamento de notificações de recorrências por parte do PSP recebedor ao usuário recebedor.
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.
webhookUrl required | string <uri> (URL Webhook) |
{
}
{- "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."
}
{- "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"
}
}
}
]
}
Endpoint para cancelamento do webhook. Não é a única forma pela qual um webhook pode ser removido.
{- "title": "Acesso Negado",
- "status": 403,
- "detail": "Requisição de participante autenticado que viola alguma regra de autorização."
}
Reúne endpoints para gerenciamento de notificações de cobranças recorrentes por parte do PSP recebedor ao usuário recebedor.
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.
webhookUrl required | string <uri> (URL Webhook) |
{
}
{- "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."
}
{- "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"
}
]
}
]
}
Endpoint para cancelamento do webhook. Não é a única forma pela qual um webhook pode ser removido.
{- "title": "Acesso Negado",
- "status": 403,
- "detail": "Requisição de participante autenticado que viola alguma regra de autorização."
}