Informar dados conforme modelo
| pin required | number PIN do usuário |
| username required | string Email do usuário |
| password required | string Senha do usuário |
{- "pin": 30,
- "password": "Arv@9627"
}{- "Token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwaW4iOjMwLCJuYW1lIjoiTU9EQVBBWSBSRVBSRVNFTlRBQ09FUyBDT01FUkNJQUlTIExUREEiLCJ0eXBlIjoiSiIsImlhdCI6MTcxNDczNjI4NywiZXhwIjoxNzE0NzY1MDg3fQ.ok3H5JdPciDRApOy4e-YKFswV6Moab3Y64A17e7Io7U",
- "expires_at": "2024-05-03T19:38:07.229Z"
}| Authorization required | string Example: Bearer 123 Token de autenticação |
Informar dados conforme modelo
| pin required | number PIN do usuário |
| password required | string Senha antiga do usuário |
| newPassword required | string Nova senha do usuário |
{- "pin": 1,
- "password": "Arv@9627",
- "newPassword": "Arv@9627"
}| e2eid required | string Example: F4DPDURMKJSIBR016442641715001006631 e2eid da transação COB |
| Authorization required | string Example: Bearer 123 Token de autenticação |
{- "txid": "TQ3YFRAO4LUGJF016442641712874114625",
- "valor": 10,
- "horario": "2024-04-11T22:23:16.099Z",
- "infoPagador": "ModaPAY",
- "nomePagador": "Allana Nascimento Silva",
- "pagador": {
- "nome": "Allana Nascimento Silva",
- "cpf": "11162269448"
}, - "devolucoes": [ ]
}| Authorization required | string Example: Bearer 123 Token de autenticação |
Informar dados conforme modelo
| e2eid required | string Id fim a fim da transação |
| value required | number Valor da devolução |
{- "e2eid": "E18236120202405101308s0467885db9",
- "value": 10.99
}{- "id": "Bg0Jgm0XD7Rl1sgedzwaneWzPsbYM3f7",
- "e2eid": "E18236120202405101308s0467885db9",
- "status": "DEVOLVIDO",
- "solicitacao": "2024-05-21T13:44:10.482Z",
- "hash": "FsqAYaZFXfdVN3DGDrKFMOcgOySXjN//scn5LWetN4s="
}| id required | string Example: id=Bg0Jgm0XD7Rl1sgedzwaneWzPsbYM3f7 ID da devolução |
| e2eid required | string Example: e2eid=E18236120202405101308s0467885db9 Id fim a fim da transação |
| Authorization required | string Example: Bearer 123 Token de autenticação |
{- "id": "Bg0Jgm0XD7Rl1sgedzwaneWzPsbYM3gi",
- "e2eid": "E18236120202405101308s0467885da7",
- "valor": 0.01,
- "status": "DEVOLVIDO",
- "solicitacao": "2024-05-21T13:44:11.636Z",
- "liquidacao": "2024-05-21T13:44:11.636Z"
}| Authorization required | string Example: Bearer 123 Token de autenticação |
Informar dados conforme modelo
| expiration | number Tempo de expiração do PIX |
| amount required | number Valor do PIX |
| description required | string Descrição do PIX |
| cpf | string CPF do pagador |
| name | string Nome do pagador |
| id_externo | string ID exclusivo da sua aplicação |
{- "expiration": 3600,
- "amount": 0.01,
- "description": "Serviço realizado.",
- "cpf": "30317513028",
- "name": "Fulano de Tal",
- "id_externo": "848299f2-0e41-4dc7-8acd-53ee5494fd9d"
}{- "chave": "1b25d41c-5161-4a5a-be4d-3a50bdc992b3",
- "pixCopiaECola": "00020101021226900014br.gov.bcb.pix2568pix.sicoob.com.br/qr/payload/v2/45b46e24-1ba2-4b18-9cf7-b13ea287817f5204000053039865802BR5925ANA MARIA DE OLIVEIRA BAR6013Nao_informado62070503***6304CC5B",
- "calendario": {
- "criacao": "2024-05-06T13:10:06.655Z",
- "expiracao": 3600
}, - "valor": {
- "original": 0.01
}, - "txid": "F4DPDURMKJSIBR016442641715001006631",
- "location": "pix.sicoob.com.br/qr/payload/v2/45b46e24-1ba2-4b18-9cf7-b13ea287817f",
- "status": "ATIVA",
- "id_externo": "848299f2-0e41-4dc7-8acd-53ee5494fd9d",
- "hash": "FsqAYaZFXfdVN3DGDrKFMOcgOySXjN//scn5LWetN4s="
}| txid required | string Example: txid=F4DPDURMKJSIBR016442641715001006631 txid da transação COB |
| Authorization required | string Example: Bearer 123 Token de autenticação |
{- "chave": "1b25d41c-5161-4a5a-be4d-3a50bdc992b3",
- "solicitacaoPagador": "ModaPAY",
- "calendario": {
- "criacao": "2024-04-11T22:21:54.630Z",
- "expiracao": 3600
}, - "devedor": {
- "cpf": "11162269448",
- "nome": "Alana Silva"
}, - "valor": {
- "original": "10.00"
}, - "txid": "TQ3YFRAO4LUGJF016442641712874114625",
- "status": "CONCLUIDA"
}| inicio required | string Example: inicio=2024-04-11T22:21:54Z Data de início da busca |
| fim required | string Example: fim=2024-04-11T22:21:54Z Data de fim da busca |
| cpf | string Example: cpf=11162269448 CPF do pagador |
| status | string Example: status=CONCLUIDA Status do PIX |
| paginaAtual | number Example: paginaAtual=1 Página atual |
| itensPorPagina | number Example: itensPorPagina=10 Itens por página |
| Authorization required | string Example: Bearer 123 Token de autenticação |
[- {
- "parametros": {
- "inicio": "2024-04-26T00:00:00Z",
- "fim": "2024-04-27T00:00:00Z",
- "paginacao": {
- "paginaAtual": 0,
- "itensPorPagina": "2",
- "quantidadeDePaginas": 5,
- "quantidadeTotalDeItens": 9
}
}, - "cobrancas": [
- {
- "chave": "1b25d41c-5161-4a5a-be4d-3a50bdc992b3",
- "solicitacaoPagador": "ModaPAY",
- "calendario": {
- "criacao": "2024-04-11T22:21:54.630Z",
- "expiracao": 3600
}, - "devedor": {
- "cpf": "11162269448",
- "nome": "Alana Silva"
}, - "valor": {
- "original": "10.00"
}, - "txid": "TQ3YFRAO4LUGJF016442641712874114625",
- "status": "CONCLUIDA"
}
]
}
]| inicio | string Example: inicio=2024-04-11 Data de início da busca |
| fim | string Example: fim=2024-04-11 Data de fim da busca |
| cpf required | string Example: cpf=11162269448 CPF do pagador |
| txid | string Example: txid=2913GXOMYCEZIZ016442641717505388669 Txid do PIX |
| paginaAtual | number Example: paginaAtual=1 Página atual, se não informado, será 1 |
| itensPorPagina | number Example: itensPorPagina=10 Itens por página, se não informado, será 100 |
| Authorization required | string Example: Bearer 123 Token de autenticação |
[- [
- {
- "chave": "1b25d41c-5161-4a5a-be4d-3a50bdc992b3",
- "pixCopiaECola": "00020101021226900014br.gov.bcb.pix2568pix.sicoob.com.br/qr/payload/v2/bd1d9d6f-2847-4df1-b4c6-254fb49afabb5204000053039865802BR5925ANA MARIA DE OLIVEIRA BAR6013Nao_informado62070503***6304436B",
- "calendario": {
- "criacao": "2024-06-04T12:49:49.000Z",
- "expiracao": 3600
}, - "valor": {
- "original": 1
}, - "txid": "2913GXOMYCEZIZ016442641717505388669",
- "location": "pix.sicoob.com.br/qr/payload/v2/bd1d9d6f-2847-4df1-b4c6-254fb49afabb",
- "status": "ATIVA"
}
]
]| Authorization required | string Example: Bearer 123 Token de autenticação |
Informar dados conforme modelo
| name required | string Nome do pagador |
| cpf required | string CPF do pagador |
| description | string Descrição da cobrança |
| amount required | number Valor do PIX |
| tipo_desconto required | number Tipo de desconto ( 0 - Nenhum desconto, 1 - Valor fixo até a data informada, 2 - Percentual até a data informada, 3 - Valor por antecipação até o dia corrido, 4 - Valor por antecipação dia útil, 5 - Percentual por antecipação até o dia corrido, 6 - Percentual por antecipação dia útil) |
| valor_desconto required | number Valor do desconto |
| tipo_juros required | number Tipo de juros (0 - Nenhum juro aplicado, 1 - Valor (dias corridos), 2 - Percentual ao dia (dias corridos), 3 - Percentual ao mês (dias corridos), 4 - Percentual ao ano (dias corridos), 5 - Valor (dias corridos), 6 - Percentual ao dia (dias úteis) |
| valor_juros required | number Valor do juros |
| tipo_multa required | number Tipo de multa (0 - Nenhum, 1 - Valor fixo, 2 - Percentual) |
| valor_multa required | number Valor da multa |
| vencimento required | string Data de vencimento do PIX |
| dias required | number Dias para vencimento |
| id_externo | string ID exclusivo da sua aplicação |
{- "name": "Fulano de Tal",
- "cpf": "08000000000",
- "description": "Serviço realizado",
- "amount": 250.2,
- "tipo_desconto": 1,
- "valor_desconto": 20,
- "tipo_juros": 2,
- "valor_juros": 2,
- "tipo_multa": 1,
- "valor_multa": 10,
- "vencimento": "20/05/2024",
- "dias": 7,
- "id_externo": "848299f2-0e41-4dc7-8acd-53ee5494fd9d"
}{- "chave": "60cf8bfa-5624-4572-aabd-c0a498a8e4e2",
- "solicitacaoPagador": "ModaPAY",
- "pixCopiaECola": "00020101021226950014br.gov.bcb.pix2573pix.sicoob.com.br/qr/payload/v2/cobv/f14bfa13-63b0-420b-8a24-11d45c9fbbdb5204000053039865802BR5925ANA MARIA DE OLIVEIRA BAR6013Nao_informado62070503***6304D940",
- "calendario": {
- "criacao": "2024-05-14T12:56:15.099Z",
- "dataDeVencimento": "2024-05-20",
- "validadeAposVencimento": 7
}, - "devedor": {
- "cpf": "08000000000",
- "nome": "Fulano de Tal"
}, - "recebedor": {
- "cnpj": "00000000000000",
- "nome": "Nome da empresa",
- "logradouro": "Nao_informado",
- "cidade": "Nao_informado",
- "cep": "00000000",
- "uf": "NA"
}, - "valor": {
- "original": "250.20",
- "desconto": {
- "modalidade": 1,
- "descontoDataFixa": [
- {
- "data": "2024-05-20",
- "valorPerc": "20.00"
}
]
}, - "juros": {
- "modalidade": 2,
- "valorPerc": "2.00"
}, - "multa": {
- "modalidade": 1,
- "valorPerc": "10.00"
}
}, - "txid": "7F0QW6VY6WIKTROOSKWX4KVYU7OJSR6H",
- "revisao": 0,
- "status": "ATIVA",
- "id_externo": "848299f2-0e41-4dc7-8acd-53ee5494fd9d",
- "hash": "FsqAYaZFXfdVN3DGDrKFMOcgOySXjN//scn5LWetN4s="
}| txid required | string Example: txid=7F0QW6VY6WIKTROOSKWX4KVYU7OJSR6H Id da transação |
| Authorization required | string Example: Bearer 123 Token de autenticação |
{- "chave": "60cf8bfa-5624-4572-aabd-c0a498a8e4e2",
- "solicitacaoPagador": "ModaPAY",
- "pixCopiaECola": "00020101021226950014br.gov.bcb.pix2573pix.sicoob.com.br/qr/payload/v2/cobv/f14bfa13-63b0-420b-8a24-11d45c9fbbdb5204000053039865802BR5925ANA MARIA DE OLIVEIRA BAR6013Nao_informado62070503***6304D940",
- "calendario": {
- "criacao": "2024-05-14T12:56:15.099Z",
- "dataDeVencimento": "2024-05-20",
- "validadeAposVencimento": 7
}, - "devedor": {
- "cpf": "08000000000",
- "nome": "Fulano de Tal"
}, - "recebedor": {
- "cnpj": "00000000000000",
- "nome": "Nome da empresa",
- "logradouro": "Nao_informado",
- "cidade": "Nao_informado",
- "cep": "00000000",
- "uf": "NA"
}, - "valor": {
- "original": "250.20",
- "desconto": {
- "modalidade": 1,
- "descontoDataFixa": [
- {
- "data": "2024-05-20",
- "valorPerc": "20.00"
}
]
}, - "juros": {
- "modalidade": 2,
- "valorPerc": "2.00"
}, - "multa": {
- "modalidade": 1,
- "valorPerc": "10.00"
}
}, - "txid": "7F0QW6VY6WIKTROOSKWX4KVYU7OJSR6H",
- "revisao": 0,
- "status": "ATIVA"
}| inicio required | string Example: inicio=2024-04-11T22:21:54Z Data de início da busca |
| fim required | string Example: fim=2024-04-11T22:21:54Z Data de fim da busca |
| cpf | string Example: cpf=11162269448 CPF do pagador |
| status | string Example: status=CONCLUIDA Status do PIX |
| paginaAtual | number Example: paginaAtual=1 Página atual |
| itensPorPagina | number Example: itensPorPagina=10 Itens por página |
| Authorization required | string Example: Bearer 123 Token de autenticação |
[- {
- "parametros": {
- "inicio": "2024-05-13T00:00:00Z",
- "fim": "2024-05-15T00:00:00Z",
- "paginacao": {
- "paginaAtual": 0,
- "itensPorPagina": "1",
- "quantidadeDePaginas": 128,
- "quantidadeTotalDeItens": 128
}
}, - "cobrancas": [
- {
- "chave": "1b25d41c-5161-4a5a-be4d-3a50bdc992b3",
- "solicitacaoPagador": "ModaPAY",
- "pixCopiaECola": "00020101021226950014br.gov.bcb.pix2573pix.sicoob.com.br/qr/payload/v2/cobv/cd6dcb8a-6594-4d21-aae3-ba7a71a1172a5204000053039865802BR5925ANA MARIA DE OLIVEIRA BAR6013Nao_informado62070503***6304791D",
- "calendario": {
- "criacao": "2024-05-13T12:27:16.585Z",
- "dataDeVencimento": "2024-05-20",
- "validadeAposVencimento": 90
}, - "devedor": {
- "cpf": "08000000000",
- "nome": "Fulano de Tal"
}, - "recebedor": {
- "cnpj": "00000000000000",
- "nome": "Nome da empresa",
- "logradouro": "Nao_informado",
- "cidade": "Nao_informado",
- "cep": "00000000",
- "uf": "NA"
}, - "valor": {
- "original": "270.00",
- "desconto": {
- "modalidade": 1,
- "descontoDataFixa": [
- {
- "data": "2024-05-20",
- "valorPerc": "30.00"
}
]
}, - "juros": {
- "modalidade": 3,
- "valorPerc": "1.00"
}, - "multa": {
- "modalidade": 2,
- "valorPerc": "10.00"
}
}, - "txid": "C0CAB594D4674906B5F9BE3883FD956D",
- "revisao": 0,
- "status": "ATIVA"
}
]
}
]| inicio | string Example: inicio=2024-04-11 Data de início da busca |
| fim | string Example: fim=2024-04-11 Data de fim da busca |
| cpf required | string Example: cpf=11162269448 CPF do pagador |
| txid | string Example: txid=2913GXOMYCEZIZ016442641717505388669 Txid do PIX |
| paginaAtual | number Example: paginaAtual=1 Página atual, se não informado, será 1 |
| itensPorPagina | number Example: itensPorPagina=10 Itens por página, se não informado, será 100 |
| Authorization required | string Example: Bearer 123 Token de autenticação |
[- [
- {
- "chave": "1b25d41c-5161-4a5a-be4d-3a50bdc992b3",
- "pixCopiaECola": "00020101021226900014br.gov.bcb.pix2568pix.sicoob.com.br/qr/payload/v2/bd1d9d6f-2847-4df1-b4c6-254fb49afabb5204000053039865802BR5925ANA MARIA DE OLIVEIRA BAR6013Nao_informado62070503***6304436B",
- "calendario": {
- "criacao": "2024-06-04T12:49:49.000Z",
- "expiracao": 3600
}, - "valor": {
- "original": 1
}, - "txid": "2913GXOMYCEZIZ016442641717505388669",
- "location": "pix.sicoob.com.br/qr/payload/v2/bd1d9d6f-2847-4df1-b4c6-254fb49afabb",
- "status": "ATIVA"
}
]
]| Authorization required | string Example: Bearer 123 Token de autenticação |
| description | string Descrição da cobrança |
| id_externo | string ID externo da cobrança |
{- "description": "Descrição da cobrança",
- "id_externo": "848299f2-0e41-4dc7-8acd-53ee5494fd9d"
}{- "txId": "c56a6934ed284e6d1f8661bf5",
- "pixCopiaECola": "00020126760014br.gov.bcb.pix0136fd31ba6d-f5bc-42c5-9e7f-20b4f6498c9b0214teste estático5204000053039865802BR5907RAIZBET6008TORITAMA62290525c56a8934ed984e5d8f1662bf46304CF16"
}| Authorization required | string Example: Bearer 123 Token de autenticação |
Informar dados conforme modelo
| password | string Senha de transação, (requerido em caso de login de usuário) |
| amount required | number Valor do PIX |
| description | string Descrição do PIX |
| method required | string Método de pagamento (cpf, cnpj, email, phone, evp) |
| key required | string Chave PIX - modelos aceitos: (cpf: '12345678901', cnpj: '12345678912345', phone: '+5521991864525', email: 'email@email.com', evp: '4bb4fdc5-6836-4f1a-aa7e-036100195a84') |
| name | string Nome do recebedor |
| cpf | string CPF do recebedor |
| id_externo | string ID exclusivo da sua aplicação |
{- "password": "Senha@19",
- "amount": 0.05,
- "description": "teste integracao",
- "method": "phone",
- "key": "+5511999999999",
- "name": "Fulano de tal",
- "cpf": "08030013000",
- "id_externo": "848299f2-0e41-4dc7-8acd-53ee5494fd9d"
}{- "transfer_request_id": "128629C780F849D28221040B66E655CA",
- "created_at": "2024-05-06T10:27:16-03:00",
- "amount_cents": 13,
- "transfer_type": "pix",
- "end_to_end_id": "E151119752024050613272449ea4737c",
- "external_reference": null,
- "status": "processing",
- "id_externo": "848299f2-0e41-4dc7-8acd-53ee5494fd9d",
- "hash": "FsqAYaZFXfdVN3DGDrKFMOcgOySXjN//scn5LWetN4s="
}| id required | string Example: id=F4DPDURMKJSIBR016442641715001006631 Id da transação |
| Authorization required | string Example: Bearer 123 Token de autenticação |
{- "id_transacao": "128629C780F849D28221040B66E655CA",
- "end_to_end_id": "E151119752024050613272449ea4737c",
- "nome": "Fullano de tal",
- "cpf": "***.052.654-**",
- "descricao": "teste integracao",
- "method": "cpf",
- "chave": "080052654000",
- "valor": 5,
- "conclusao": "2024-05-06T10:27:19-03:00",
- "status": "executed",
- "rejected": null
}{- "pin": 0,
- "id_transacao": "128629C780F849D28221040B66E65",
- "endToEndId": "E151119752024050613272449ea4701c",
- "nome": "Fullano de tal",
- "cpf": "080052654000",
- "descricao": "teste integracao",
- "chave": "080052654000",
- "valor": 19000,
- "taxa_total": 0.1,
- "conclusao": "2024-03-22T00:19:52.000Z",
- "status": "executed",
- "sender_account": {
- "name": "Fulano de Tal",
- "cpf_cnpj": "080052654000",
- "account_type": "checking_account",
- "account_number": "0000000000",
- "bank": "000",
- "bank_agency": "0000"
}, - "receiver_account": {
- "name": "Fulano de Tal",
- "cpf_cnpj": "080052654000",
- "compe": "000",
- "ispb": "00000",
- "bank": "Banco Tal",
- "account_type": "checking_account",
- "bank_account": "0000000000",
- "bank_agency": "0000",
- "pix_key_type": "CPF",
- "pix_key": "080052654000"
}, - "erroDescricao": "Motivo do erro",
- "id_externo": "848299f2-0e41-4dc7-8acd-53ee5494fd9d",
- "hash": "FsqAYaZFXfdVN3DGDrKFMOcgOySXjN//scn5LWetN4s="
}{- "txid": "TQ3YFRAO4LUGJF016442641712874114625",
- "status": "CONCLUIDA",
- "data_pagamento": "2024-05-10T13:08:40.000Z",
- "amount_paid": 10.55,
- "total_fee": 0.1,
- "end_to_end_id": "E151119752024050613272449ea4737c",
- "payer_name": "FULANO DE TAL",
- "payer_document": "00000000000",
- "devolutions": [
- {
- "txid": "236c586ca172440b9e2ff4e68b",
- "end_to_end_id": "526c586ca181440b9e2ff4e12b",
- "valor": 5,
- "status": "DEVOLVIDO",
- "conclusao": "2024-10-14T02:52:43.044Z"
}
], - "id_externo": "848299f2-0e41-4dc7-8acd-53ee5494fd9d",
- "hash": "FsqAYaZFXfdVN3DGDrKFMOcgOySXjN//scn5LWetN4s="
}Compara o hash
| Authorization required | string Example: Bearer token Token de autenticação |
| hash required | string Hash a ser comparado |
| campos | string substitua 'campos' pelos campos que compoem o hash |
{- "hash": "FsqAYaZFXfdVN3DGDrKFMOcgOySXjN//scn5LWetN4s=",
- "campos": "substitua 'campos' pelos campos que compoem o hash"
}true