Download

Baixe o arquivo de configuração do POSTMAN se preferir e ir acompanhando.

Download

ChatGPT

Utilize o chatgpt para criar o seu código de forma rápida e fácil!.

Acessar

Autenticação

Aqui você encontrará tudo que precisa para ter sua melhor integração possível com as nossas APIs.
Venha conosco e conduza seu negócio ao próximo nível!

Token

Utilizamos Token Bearer para validar todas as transações. Exemplo de como solicitar e retorno.

URL:

v1/{ambiente}/token

CURL:

curl --request POST \
--url https://urlmaster/v1/sandbox/token \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"client_system": "Caixa1",
"client_id": "5as8d7sa8475dfg4f5gf332.sandbox.peghcaopi.v1",
"grant_type": "MTkuNTMxLjQxNi8wdasd5d9sa78d784ggTctMDgtNDI=",
"client_secret": "878s7d8a7sd8as7d8as7d8as7d8as7dsa54g5f45g78"
}
'

JSON:

{"client_system": "Caixa1", "client_id": "5as8d7sa8475dfg4f5gf332.sandbox.peghcaopi.v1", "grant_type": "MTkuNTMxLjQxNi8wdasd5d9sa78d784ggTctMDgtNDI=","client_secret": "878s7d8a7sd8as7d8as7d8as7d8as7dsa54g5f45g78"}

Resposta:

Se tudo tiver correto você receberá:

{"access_token":"VmpCa2QySlhWbFZYYTNCcVVsVndVMXBITVZkaFJYaHhVbTE0YUZZd1dr cFpiWGh1WlZVd2QxcEZPVkJXVlhBd1ZHMTBWMVpHVm5WWGJYUlBaV3hKZDFaRVNrdGtNVkpZWVVad1 ZsZEhUak5YYWs1eVRrWk9XVlJ0Um1sU1dGSjRWR3hTV21ReVVraFhiVFZhVlZRd09RPT0","expires_in": 2400, "token_type": "bearer"}

Se preencheu alguma coisa errada você vai receber:

{"error": true,"mensagem": "Informacoes Invalidas"}

QR Code

Utilize nossa api de QR Code e integre tudo dentro do seu ERP.

Gerar QR Code com Valor

Utilize a chamada abaixo e gere um qrcode com valor.

URL:

v1/{ambiente}/pix/novoqr

CURL:

curl --request POST \
--url https://urlmaster/v1/sandbox/pix/novoqr \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer tokenrecebidonarequisicaoanterior' \
--data '{"valor":"3.00","observacao":"Informacao de resposta"}'

Json:

{"valor":"3.00","observacao":"Informacao de resposta"}

Resposta:

{{"error": false, "emvqrcps": "00020101021226930014br.gov.bcb.pix2571qrcode-h.pix.celcoin.com.br/pixqrcode/v2/af384b88fb19933281de6f7493af325204000053039865802BR5924Nome da empresa6003Uba62070503***63045A17", "base64": "iVBORw0KGgoAAAANSUhEUgAABbQAAAW0AQAAAAA22bh6AAAKNklEQVR4nO3XQY7stg4FUO3A+9+ld1A fQcpNipT7BX+g2MG5g4LLlshDzTQ+r8w5/m3B/xfuveHeG+694d4b7r3h3hvuveHeG+694d4b7r3h3hvu veHeG+694d4b7r3h3hvuveHeG+694d4b7r3h3hvuveHeG+694d4b7r3h3hvuveHeG+694d4b7r3h3hvuv eHeG+69ye5Rc/z17vh++Gvt3+/m/SM/XX/zjjGmHlGv51t+qlJA3Nzc3Nzc3Nzc3Nzc3C9wH4si5al0PHP ZwC/6jECtn1bz3YC4ubm5ubm5ubm5ubm5H++OjlGzGae26/lunsYiZbT2M1ojbm5ubm5ubm5ubm5u7ve5P 4sivy+ZZs68OIIbaLkhc3Nzc3Nzc3Nzc3Nzc/9n3NExFz4+PdOteSwS7lY5vpYl3Nzc3Nzc3Nzc3Nzc3G91 r8cY6+p525mrR6nVEcRP7C0FbkHc3Nzc3Nzc3Nzc3NzcL3CXHHPbf+Gng7i5ubm5ubm5ubm5ubkf714n7qz j5zZ85iLx4ftUvh75Qz6lI+/N9+Ix/oGKm5ubm5ubm5ubm5ub+7nuixcpH8oYcYXN2psq5b5boLG3lZqOgJ ubm5ubm5ubm5ubm/vx7gxdaT+5RTOuyEdtNjJ+qlJOpB1Q9ODm5ubm5ubm5ubm5uZ+gzt2xbLWbDRArFvtz eQJlctPh5YLFDI3Nzc3Nzc3Nzc3Nzf3G9z5KS6pZX/5UCY42+C/9ygT/MhG+Zm/cnNzc3Nzc3Nzc3Nzcz/X PaEKJefIY5QhM/7TZin49d9jnq8cCzc3Nzc3Nzc3Nzc3N/dr3D8fU6JFqRmo1mzMBaYLbh43zub4U1Fubm5 ubm5ubm5ubm7ux7tjbd4QY0zJLfoE+accSy/wbTXN0pZMe7m5ubm5ubm5ubm5ubmf7M4rouOZa0bKuK3jyA XKhwadquRSfXpubm5ubm5ubm5ubm7ux7tLx5hgPVBZcjVrE9zcdxu0HN/tfNzc3Nzc3Nzc3Nzc3NyPd1/Gx hvt76r6aqBWviyeWuYxzjxpLsrNzc3Nzc3Nzc3Nzc39BnesKL0DH/tX2hgoD9lHyztK5T5BOTlubm5ubm5u bm5ubm7uJ7sz9Jw3lBvtOaNW+D5k3IFj25/2Fi03Nzc3Nzc3Nzc3Nzf3G9zhyUWOuVxMFZQrK0Abt+wtlT9 tqlV5bm5ubm5ubm5ubm5u7ie7y/5AtZrXu9Zi4rW25d2Rh8w9js8nq472xM3Nzc3Nzc3Nzc3Nzf0W9/lLs+ KOHblKDH7MvfvXXw5o2sbNzc3Nzc3Nzc3Nzc39FvdVJOOnti3R58hVxk/K+qjXvk7Trw5yXszNzc3Nzc3Nz c3Nzc39XHdPKVw6ZuPkjsXlqXjyGMd8cmXSZuHm5ubm5ubm5ubm5uZ+tPtb7noq5Dzfkevk3mPRtrtzgXPu O73L2/IObm5ubm5ubm5ubm5u7qe6M3Qao3xoS0qf1iKlGPO4ZfDVtizl5ubm5ubm5ubm5ubmfqq77FqTz2+ zcMelt7Ro9aYdGVUEcYm+PTRubm5ubm5ubm5ubm7uJ7t7zVzpk59iR5kq9ylP189Kux7tmKfn5ubm5ubm5u bm5ubmfo37tuOq2ag58o7bn2+p1VR9jPzEzc3Nzc3Nzc3Nzc3N/Qb3t2b35KlWAx13Y8QsU/lizDffM3dbV +Hm5ubm5ubm5ubm5uZ+vLtUnwq3ZjFVaRY7YtxP/lv2th5dUJ64ubm5ubm5ubm5ubm5n+xeVVq7x0/hc/SU vWH85B2lXnwt51Wac3Nzc3Nzc3Nzc3Nzcz/e/f14uWN/I49F9aCsCkxn0xb3vaVAecfNzc3Nzc3Nzc3Nzc3 9eHfLkZu1/Z8fcqDKjkCVxdPMq3VRr4Wbm5ubm5ubm5ubm5v7ue5c5Ph5d5XLheP2Ou48pWPfFjvi63odNz c3Nzc3Nzc3Nzc397vcAfjuCvzKeN79Peaf4IXxeiqL413ZsajCzc3Nzc3Nzc3Nzc3N/VT3+Mm3ermkTmOUc rnZdK3NpT6LgUqj69DKu0UPbm5ubm5ubm5ubm5u7ue6p3KxoUzV1pWBYnHMV7Sl5erDyOPmJ25ubm5ubm5u bm5ubu6Hu2NF6Zg/FPyRB2rkT6uSeecs+7QJMp6bm5ubm5ubm5ubm5v7Re7zB3CuZTFQNq6ql+mn0VZnk79 eE+S/g5ubm5ubm5ubm5ubm/tl7ihy87dlkuXRVjummdcTrI6qzMLNzc3Nzc3Nzc3Nzc39XPctOW8d6+q5QC jGr1VKpvmCkf/m6bm5ubm5ubm5ubm5ubmf6i6X1LxrouRL74pc6k0d21T9aytayNzc3Nzc3Nzc3Nzc3NyPd 1/NvrvGd4zcbHpaDdm0ZcibKm2CsTg5bm5ubm5ubm5ubm5u7je4V7zys/qwwue20xgNWgpMxji5vI6bm5ub m5ubm5ubm5v74e7c4nqa105/p3cNeszGsiRQPWXS9pebm5ubm5ubm5ubm5v74e686/huiK153ZHbrgeKete OUiCGbJOO+d2qBzc3Nzc3Nzc3Nzc3N/eT3Ve5giraUqSMEdr89fdzGPmoZt6IJXl0bm5ubm5ubm5ubm5u7j e44yfajvv0jmvFTaNArerdDcTNzc3Nzc3Nzc3Nzc39VHcmX0Va9cKb+rRJo+PIBUrLqNJOrjDyNm5ubm5ub m5ubm5ubu43uMuuz0/NaV12d8Uqt7w88zTG6ry4ubm5ubm5ubm5ubm5n+3uqDzBkavndTfVc4GbnzbGdEAZ f9ST4+bm5ubm5ubm5ubm5n6Je/Xhm1Kuv4t88eVEJmj++vmpd2U1EDc3Nzc3Nzc3Nzc3N/fj3bF2XtbJpfr UsUxf1hXKP4CWw+Dm5ubm5ubm5ubm5uZ+srtdV89FuYmyanH77hfjOZbJlhJubm5ubm5ubm5ubm7u57pz9S O3XQP6kGvFdJOOAnlx/7oeg5ubm5ubm5ubm5ubm/sd7p7YEIpWfdV2mnk1RunRhiwFjnp83Nzc3Nzc3Nzc3 Nzc3E91j5pVi6PNEpfjNlXp2C/RpXxrdLQe3Nzc3Nzc3Nzc3Nzc3C9w/9GYi0yX4zJGlIqvZcfKUw6tHAY3 Nzc3Nzc3Nzc3Nzf3i9yxK35KcqVV22MGTPVaqTBO9VqBwc3Nzc3Nzc3Nzc3Nzf16d66+qnnkAqtbcyFnxbn 4eiyWcHNzc3Nzc3Nzc3Nzc7/cPX6uq/3OGjV/mWXkba3KNWlrNE1fLuDc3Nzc3Nzc3Nzc3Nzcj3evx7iBfm quPuVrxpcT6Vndi7m5ubm5ubm5ubm5ublf5S450rLUtvHOvGP9dMxVRn5aH8sxDzkdKTc3Nzc3Nzc3Nzc3N /eT3W8K995w7w333nDvDffecO8N995w7w333nDvDffecO8N995w7w333nDvDffecO8N995w7w333nDvDff ecO8N995w7w333nDvDffecO8N995w7w333nDvDffecO8N995w7w333rzW/T/DDRsbOg3vrAAAAABJRU5ErkJggg==", "autenticacao": "AUT3PIXDEP80"}}

Informações
Campo Informação
emvqrcps Copia e Cola
base64 Código da Imagem em base64
Autenticação Informação para pesquisa
Resposta:

Se tudo tiver correto você receberá:

{"error": false}

Se preencheu alguma coisa errada você vai receber:

{"error": true, "mensagem": "confira o json enviado"}

Status

Utilize para verificar o status do pagamento.

URL:

v1/{ambiente}/pix/statusqr

CURL:

curl --request POST \
--url https://urlmaster/v1/sandbox/pix/statusqr \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer tokenrecebidonarequisicaoanterior' \
--data '{"autenticacao":"AUT3PIXDEP80"}'

JSON:

{"autenticacao":"AUT3PIXDEP80"}

Resposta:

Se tudo tiver correto você receberá:

{"data":"16/12/2024","status":"0","valor":"R$ 3,00","observacao":"Informacao de resposta","transationid":"kk6g232xel65a0daee4dd13kk4000136687"}

Informações
Campo Valor Informação
Status 0 Não está pago
Status 5 Está pago
Status 3 Devolvido

Se preencheu alguma coisa errada você vai receber:

{"error": false, "mensagem": "Autenticacao nao localizada"}

Confirmar o Pagamento

Utilize para confirmar o status do pagamento para Pago.

* Recurso somente em sandbox.

URL:

v1/sandbox/pix/confirmarqr

CURL:

curl --request POST \
--url https://urlmaster/v1/sandbox/pix/confirmarqr \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer tokenrecebidonarequisicaoanterior' \
--data '{"autenticacao":"AUT3PIXDEP80"}'

JSON:

{"autenticacao":"AUT3PIXDEP80"}

Resposta:

Se tudo tiver correto você receberá:

{"error":false,"mensagem":"Pagamento confirmado com sucesso"}

Se preencheu alguma coisa errada você vai receber:

{"error": false, "mensagem": "Nao e possivel confirmar esse qrcode"}

Webhook enviado confirmando o pagamento

Utilize o layout abaixo para desenvolvimento.

Resposta Pago:

{"entity":"pix-payment-in","createTimeStamp":"2026-01-05T10:15:52.4832663","status":"CONFIRMED", "body":{"id":"0be7d655-de02-4568-1245-27391547db9d","amount":70,"transactionIdentification":"QRCODE","endToEndId":"E18A45ASD02601051315s076bfbda84", "initiationType":"STATIC_QRCODE","paymentType":"IMMEDIATE","urgency":"HIGH","transactionType":"RECEIVEPIX", "debitParty":{"bank":"18236120","account":"638268796","branch":"0001","taxId":"14565462613","name":"Raissa", "accountType":"TRAN"},"creditParty":{"bank":"73935893","key":"7e451d02-085d-456a-8839-fdbbc17f3402", "account":"757026318","branch":"0001","taxId":"59012354000122","name":"COMERCIO LTDA","accountType":"TRAN"}, "remittanceInformation":null,"currentBalance":0.97,"oldBalance":0.97,"transactionIdBRCode":"1780087067"}, "webhookId":"1245d655-de02-4568-a1a5-27391547db9d"}

Informações
Campo Informação
id Devolvido o código enviado

Boleto com QR

Utilize nossa api de boleto e integre tudo dentro do seu ERP.

Gerar Boleto com QR Code

Utilize a chamada abaixo e gere um boleto qrcode.

URL:

v1/{ambiente}/boleto/novoboleto

CURL:

curl --request POST \
--url https://urlmaster/v1/sandbox/boleto/novoboleto \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer tokenrecebidonarequisicaoanterior' \
--data '{"total":1,"faturas":[{"nome":"Jean Carlos de Souza Ferreira","tipodocumento":"01","documento":"075861*****","datavencimento":"22/07/2025","datadesconto":"12/07/2025","datacarencia":"22/07/2025","valor":"15.00", "multa":"5","juros":"0.33","parcela":"1","desconto":"0.00","mensagem1":"Teste Via API","mensagem2":"Obrigado por utilizar nossos servicos","mensagem3":"","mensagem4":"","endereco":"Av Farmaceutico","numero":"158","bairro":"Centro","cidade":"Uba", "estado":"MG","cep":"36505002","nossonumero":"0002000062","controle":"19477","devolucao":"0010023001"}]}'

Json:

{"total":1,"faturas":[{"nome":"Jean Carlos de Souza Ferreira","tipodocumento":"01","documento":"075861*****","datavencimento":"22/07/2025","datadesconto":"12/07/2025","datacarencia":"22/07/2025","valor":"15.00", "multa":"5","juros":"0.33","parcela":"1","desconto":"0.00","mensagem1":"Teste Via API","mensagem2":"Obrigado por utilizar nossos servicos","mensagem3":"","mensagem4":"","endereco":"Av Farmaceutico","numero":"158","bairro":"Centro","cidade":"Uba", "estado":"MG","cep":"36505002","nossonumero":"0002000062","controle":"19477","devolucao":"0010023001"}]}

Informações
Pode enviar até 48 parcelas de uma única vez. Só colocar , e adicionar em "faturas". Informe o "total" para conferência.
Campo Informação
nome Nome que deseja no boleto
tipodocumento 01 > PF | 02 > PJ
documento CPF OU CNPJ Sem pontuações
datavencimento Exemplo: 01/05/2025
datadesconto Exemplo: 30/04/2025
datacarencia Exemplo: 01/05/2025
valor Exemplo: 5.00, 100.00, 1000.00, 10000.00
multa% Exemplo: 2, 5
juros Exemplo: 0.11
parcela Exemplo: 1, 12
desconto Exemplo: 10.00
endereco Logradouro
numero Número
bairro Bairro
cidade Cidade
estado Exemplo: MG, SP, RJ
cep Exemplo: 36505001
nossonumero Solicite ao seu gerente
controle Devolvivo no WH
devolucao Devolvivo no WH
Resposta:

{"total":1,"faturas":[{"nossonumero":"0002000062","linhadigitavel":"23793.09400 90000.200007 62000.236406 111500000001500", "qrcode":"00020101021226910014BR.GOV.BCB.PIX2569qrpix.bradesco.com.br/qr/v2/cobv/b3c14df9-9a29-44c4-b391-a5b9bb683f1b520400005303986540515.005802BR5924UZMI BANK INSTITUICAO DE6003UBA62070503***63049B56"}]}

Informações
Campo Informação
qrcode Copia e Cola
linhadigitavell Linha para pagamento
Resposta:

Se tudo tiver correto você receberá:

{"error": false}

Se preencheu alguma coisa errada você vai receber:

{"error": true, "mensagem": "confira o json enviado"}

Informações do Boleto e Status do Pagamento

Utilize a chamada abaixo e gere um boleto qrcode.

URL:

v1/{ambiente}/boleto/informacoes

CURL:

curl --request POST \
--url https://urlmaster/v1/sandbox/boleto/informacoes \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer tokenrecebidonarequisicaoanterior' \
--data '{"nossonumero":"00000000000"}'

Json:

{"nossonumero":"0002000062"}

Resposta Não Pago:

{"error": false,"datavencimento":"2025-07-27","remessa":"50","valor":"15.00","multa":"5","juros":"0.33","desconto":"0.00", "datacarencia":"2025-07-27","mensagem1":"Teste Via API","mensagem2":"Obrigado por utilizar nossos servicos", "controle":"","devolucao":"0002000076","status":"0"}

Resposta Pago:

{"error": false,"datavencimento":"2025-02-11","remessa":"10","valor":"10.00","multa":"0","juros":"0.00","desconto":"0.00", "datacarencia":"2025-02-11","mensagem1":"Teste","mensagem2":"Montar","controle":"","devolucao":"", "datapagamento":"2025-02-12","valorpago":"10.00","descontopago":"0.00","multapago":"0.00","jurospago":"0.00","status":"1"}

Informações
Campo Informação
status 0 - Não Pago | 1 - Pago
datapagamento Se tiver pago vai aparecer
valorpago Se tiver pago vai aparecer
descontopago Se tiver pago vai aparecer
multapago Se tiver pago vai aparecer
jurospago Se tiver pago vai aparecer
Resposta:

Se tudo tiver correto você receberá:

{"error": false}

Se preencheu alguma coisa errada você vai receber:

{"error": true, "mensagem": "Nao localizei o boleto"}

Webhook enviado confirmando o pagamento

Utilize o layout abaixo para desenvolvimento.

Resposta Pago:

{"createTimestamp":"2025-01-03T07:29:34","entity":"charge-in","status":"CONFIRMED","body":{"dataPagamento":"2025-01-03", "dataVencimento":"2025-01-07","controle":"controle","devolver":"controle","status":"Pago","tipoPagamento":"Boleto", "nossonumero":"********","valorOriginal":3000,"valorPago":3000}}

Informações
Campo Informação
status Pago
controle Devolve o valor enviado
devolver Devolve o valor enviado

Informações do Boleto e Status do Pagamento

Utilize a chamada abaixo e gere um boleto qrcode.

URL:

v1/{ambiente}/boleto/informacoes

CURL:

curl --request POST \
--url https://urlmaster/v1/sandbox/boleto/informacoes \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer tokenrecebidonarequisicaoanterior' \
--data '{"nossonumero":"00000000000"}'

Json:

{"nossonumero":"0002000062"}

Resposta Não Pago:

{"error": false,"datavencimento":"2025-07-27","remessa":"50","valor":"15.00","multa":"5","juros":"0.33","desconto":"0.00", "datacarencia":"2025-07-27","mensagem1":"Teste Via API","mensagem2":"Obrigado por utilizar nossos servicos", "controle":"","devolucao":"0002000076","status":"0"}

Resposta Pago:

{"error": false,"datavencimento":"2025-02-11","remessa":"10","valor":"10.00","multa":"0","juros":"0.00","desconto":"0.00", "datacarencia":"2025-02-11","mensagem1":"Teste","mensagem2":"Montar","controle":"","devolucao":"", "datapagamento":"2025-02-12","valorpago":"10.00","descontopago":"0.00","multapago":"0.00","jurospago":"0.00","status":"1"}

Informações
Campo Informação
status 0 - Não Pago | 1 - Pago
datapagamento Se tiver pago vai aparecer
valorpago Se tiver pago vai aparecer
descontopago Se tiver pago vai aparecer
multapago Se tiver pago vai aparecer
jurospago Se tiver pago vai aparecer
Resposta:

Se tudo tiver correto você receberá:

{"error": false}

Se preencheu alguma coisa errada você vai receber:

{"error": true, "mensagem": "Nao localizei o boleto"}