Gestão de Pix
Consultar Pix
Endpoint para consultar um Pix através de um e2eId
.
Este endpoint retorna apenas informações sobre Pix recebidos.
GET /v2/pix/:e2eId
pix.read
Respostas
As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.
- 🟢 200
- 🟢 200
- 🔴 400
- 🔴 500
{
"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"
}
]
}
{
"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."
}
{
"endToEndId": "E12345678202009091221ghijk78901234",
"txid": "5b933948f3224266b1050ac54319e775",
"valor": "200.00",
"horario": "2020-09-10T13:03:33.902Z",
"infoPagador": "Revisão do carro"
}
{
"nome": "pix_nao_encontrado",
"mensagem": "Nenhum pix encontrado para o identificador informado"
}
{
"nome": "erro_aplicacao",
"mensagem": "Ocorreu um erro ao buscar o pix"
}
Consultar Pix recebidos
Endpoint para consultar vários Pix recebidos.
GET /v2/pix
pix.read
Requisição
Este endpoint dispõe de filtros para afunilar os resultados. Todos os filtros são do tipo query params, portanto devem ser enviados pela URL, como exemplificado no trecho de código abaixo./v2/pix?inicio=2020-04-01T00:00:00Z&fim=2020-04-01T23:59:59Z
Os filtros
inicio
e fim
definem um intervalo de datas em que os Pix devem estar compreendidos para serem retornados. Esses filtros são obrigatórios.Respostas
As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.
- 🟢 200
- 🔴 400
- 🔴 500
{
"parametros": {
"inicio": "2022-01-01T00:00:00.000Z",
"fim": "2022-12-31T23:00:00.000Z",
"paginacao": {
"paginaAtual": 0,
"itensPorPagina": 100,
"quantidadeDePaginas": 2,
"quantidadeTotalDeItens": 150
}
},
"pix": [
{
"endToEndId": "E182361232022110114206014506ed00",
"txid": "465669b3847d4a30ae14848c5d4d1683",
"valor": "0.01",
"chave": "5f84a4c5-c5cb-4599-9f13-7eb4d419dacc",
"horario": "2022-11-01T14:20:41.425Z"
},
{
"endToEndId": "E18236129202210311159s01f572d8b1",
"txid": "0002712070000000000000209BONAE2",
"valor": "5.00",
"chave": "5f84a4c5-c5cb-4599-9f13-7eb4d419dacc",
"horario": "2022-10-31T11:59:13.220Z"
},
{
"endToEndId": "E18236126202210091755s13093ea838",
"txid": "fc9a4386fefdh964b5dbc6c91a8722d5",
"valor": "0.02",
"chave": "5f84a4c5-c5cb-4590-9f13-7eb4d419dacc",
"horario": "2022-10-19T17:56:09.173Z",
"devolucoes": [
{
"id": "fc9a4386fefdh964b5dbc6c91a8722d5",
"rtrId": "D09089556202210191757eeb3cf6972c",
"valor": "0.01",
"horario": {
"solicitacao": "2022-10-19T17:57:02.000Z",
"liquidacao": "2022-10-19T17:57:03.000Z"
},
"status": "DEVOLVIDO"
},
{
"id": "fc9a4386fefdh964b5dbc6c91a8722d6",
"rtrId": "D09089356002210191757c95a3620972",
"valor": "0.01",
"horario": {
"solicitacao": "2022-10-19T17:57:33.000Z",
"liquidacao": "2022-10-19T17:57:35.000Z"
},
"status": "DEVOLVIDO"
}
]
}
]
}
{
"nome": "valor_invalido",
"mensagem": "Campo de data fim deve ser maior ou igual ao campo de data inicio"
}
{
"nome": "erro_aplicacao",
"mensagem": "Ocorreu um erro ao buscar pix recebidos"
}
Solicitar devolução
Este é o endpoint usado para solicitar uma devolução usando o e2eId
do Pix e o ID da devolução
. O motivo atribuído à PACS.004 será “Devolução solicitada pelo usuário recebedor do pagamento original”, com a sigla “MD06”, conforme consta na aba RTReason da PACS.004 no Catálogo de Mensagens do Pix.
PUT /v2/pix/:e2eId/devolucao/:id
pix.write
Requisição
- Exemplo
{
"valor": "7.89"
}
Respostas
As respostas abaixo representam Sucesso(201) e Falhas/erros do consumo.
- 🟢 201
- 🔴 400
- 🔴 409
- 🔴 500
{
"id": "123456",
"rtrId": "D12345678202009091000abcde123456",
"valor": "7.89",
"horario": {
"solicitacao": "2020-09-11T15:25:59.411Z"
},
"status": "EM_PROCESSAMENTO"
}
{
"nome": "pix_nao_encontrado",
"mensagem": "Nenhum pix encontrado para o identificador informado"
}
{
"nome": "devolucao_id_duplicado",
"mensagem": "O id informado já foi utilizado em outra devolução"
}
{
"nome": "erro_aplicacao",
"mensagem": "Ocorreu um erro ao solicitar devolução"
}
Envio da Devolução pelo id
através do endpoint PUT/v2/pix/:e2eId/devolucao/:id
.
Você pode simular a rejeição da devolução usando o valor de R$ 0,01. Essas devoluções serão rejeitadas e notificadas para simular o fluxo de produção. Devoluções com valores diferentes de R$ 0,01, seguirão o fluxo normal de devolução com várias outras validações. Se estiverem em conformidade, serão confirmadas e notificadas, simulando o fluxo de produção.
OBS: Não é possível realizar devoluções de cobranças que foram repassadas a outras contas por meio do split.
Consultar devolução
Endpoint para consultar uma devolução através de um e2eId
do Pix e do ID da devolução
.
GET /v2/pix/:e2eId/devolucao/:id
pix.read
Respostas
As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.
- 🟢 200
- 🟢 200
- 🔴 400
- 🔴 500
{
"id": "123456",
"rtrId": "D12345678202009091000abcde123456",
"valor": "7.89",
"horario": {
"solicitacao": "2020-09-11T15:25:59.411Z"
},
"status": "EM_PROCESSAMENTO"
}
{
"id": "502",
"rtrId": "D12345678202011111000fghij789012",
"valor": "20.00",
"horario": {
"solicitacao": "2020-09-11T15:25:59.411Z"
},
"status": "NAO_REALIZADO",
"motivo": "Negado por timeout"
}
{
"nome": "devolucao_nao_encontrada",
"mensagem": "Nenhuma devolução encontrada para o identificador informado"
}
OU
{
"nome": "pix_nao_encontrado",
"mensagem": "Nenhum pix encontrado para o identificador informado"
}
{
"nome": "erro_aplicacao",
"mensagem": "Ocorreu um erro ao buscar devolução"
}
Consulta da Devolução Enviada pelo id
através do endpoint GET/v2/pix/:e2eId/devolucao/:id
.
É possível consultar informações de uma devolução simulada pelo endpoint de Envio de Devolução no ambiente de homologação.
A funcionalidade ocorre exatamente como no ambiente de produção.