{"info":{"_postman_id":"d5d0693e-ca9a-406e-bd00-8ce01845ab74","name":"API PIX | BMB","description":"

Abra sua conta PJ e solicite suas credenciais.
https://conta.bmb.app.br

Credenciais

Utilizamos a autenticação \"Basic Auth\", que consiste em nome de usuário e senha para o primeiro acesso. Habilitamos a API e liberamos o client_id e client_secret após formalização com um gerente.
Obs: Usuário e Senha serão o email cadastrado e sua senha de acesso

Exemplo usando Postman

1 - Na aba “autorização”, basta configurar o TIPO para “Basic Auth” no lado esquerdo.
2 - Do lado direito, preencha o campo “USERNAME” com seu “EMAIL” e o campo “SENHA” com sua senha de acesso.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15468772","collectionId":"d5d0693e-ca9a-406e-bd00-8ce01845ab74","publishedId":"2sAYQdjVDS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"000","highlight":"ff9800"},"publishDate":"2025-06-16T00:52:09.000Z"},"item":[{"name":"Conta","item":[{"name":"Saldo","id":"54fde413-ee91-40be-bcfb-1b6c909ca1db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"client-id","value":"client_id","type":"text"},{"key":"client-secret","value":"client_secret","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://conta.bmb.app.br/api/GetSaldo","description":"

Tenha o extrato detalhado de suas operações.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atributo	Descrição	Exemplo	Tipo
client_id Obrigatório	Fornecido pelo emissor	Header	String
client_secret Obrigatório	Fornecido pelo emissor	Header	String

","urlObject":{"path":["GetSaldo"],"host":["https://conta.bmb.app.br/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"54fde413-ee91-40be-bcfb-1b6c909ca1db"}],"id":"d86257cb-9d30-4573-a847-ff8ab850af1d","_postman_id":"d86257cb-9d30-4573-a847-ff8ab850af1d","description":""},{"name":"Pix In","item":[{"name":"Consulta QRCode","id":"c2a46fb1-48ee-4a2e-9a8d-18adeee05a3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"client-id","value":"client_id","type":"text"},{"key":"client-secret","value":"client_secret","type":"text"}],"body":{"mode":"raw","raw":"{\n \"txId\": \"aba8509c957baa9cda0b81cb0\"\n}","options":{"raw":{"language":"json"}}},"url":"https://conta.bmb.app.br/api/consultaQRCode","description":"

Este endpoint tem o objetivo de consultar um QRCode pelo txId

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atributo	Descrição	Exemplo	Tipo
txId Obrigatório	Passar o valor do txId	aba8509c957baa9cda0b81cb0	string

","urlObject":{"path":["consultaQRCode"],"host":["https://conta.bmb.app.br/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2a46fb1-48ee-4a2e-9a8d-18adeee05a3f"},{"name":"Gerar QRCode","id":"8362bd0b-7e36-4749-8ff9-589243382c60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"client-id","value":"client-id","type":"text"},{"key":"client-secret","value":"client-secret","type":"text"}],"body":{"mode":"raw","raw":"{\n \"valor\": 10,\n \"descricao\": \"Pedido de perfume\", \n \"pagador\": {\n \"documento\": \"CPF ou CNPJ válido\",\n \"nome\": \"Fulano\"\n },\n \"finalBeneficiary\": {\n \"name\": \"Loja do Joao\",\n \"document\": \"CNPJ válido\",\n \"cityName\": \"Cidade do beneficiário\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://conta.bmb.app.br/api/GerarQRCode","description":"

Este endpoint tem o objetivo de gerar um QRCode com um valor único podendo ser pago apenas uma unica vez pelo próprio emissor.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atributo	Descrição	Exemplo	Tipo
client_id Obrigatório	Fornecido pelo emissor	Header	String
client_secret Obrigatório	Fornecido pelo emissor	Header	String
valor Obrigatório	Passar o valor inteiro em formato decimal.	R$ 10,50 passar 10.50	decimal
descricao	Passar detalhe da venda		String
Pagador: nome Obrigatório	Passar o nome do pagador		String
Pagador: documento Obrigatório	Passar o CPF ou CNPJ de quem irá efetuar o pagamento		String

MODELO WEBHOOK:

{\n    \"idempotencyKey\": \"E18236120202411090102s1490d6dfe5\",\n    \"endToEndId\": \"E18236120202411090102s1480E6dfe5\",\n    \"initiationType\": \"MANUAL\",\n    \"operationType\": \"RECEIPT\",\n    \"amount\": 4.43,\n    \"createdAt\": \"2024-11-09T01:02:49.773Z\",\n    \"payer\": {\n        \"number\": \"8888888\",\n        \"branch\": \"0001\",\n        \"type\": \"PAYMENT\",\n        \"participant\": {\n            \"name\": \"NU PAGAMENTOS - IP\",\n            \"ispb\": \"18236120\"\n        },\n        \"holder\": {\n            \"name\": \"FULANO DE TAL\",\n            \"document\": \"98765432100\",\n            \"type\": \"NATURAL\"\n        }\n    },\n    \"beneficiary\": {\n        \"number\": \"10000000\",\n        \"branch\": \"0001\",\n        \"type\": \"PAYMENT\",\n        \"participant\": {\n            \"name\": \"BMB PAGAMENTOS\",\n            \"ispb\": \"13372874\"\n        },\n        \"holder\": {\n            \"document\": \"12345678910\",\n            \"type\": \"NATURAL\"\n        }\n    }\n}\n\n

\n","urlObject":{"path":["GerarQRCode"],"host":["https://conta.bmb.app.br/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"8362bd0b-7e36-4749-8ff9-589243382c60"}],"id":"3b771fec-39b4-473e-9679-529ed267e1e4","_postman_id":"3b771fec-39b4-473e-9679-529ed267e1e4","description":""},{"name":"Pix Out","item":[{"name":"Consultar Chave","id":"6f3889c7-773d-4faf-b4d8-5c167b04ef1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"client-id","value":"client_id","type":"text"},{"key":"client-secret","value":"client_secret","type":"text"}],"body":{"mode":"raw","raw":"{\n \"chavePix\": \"chave pix da consulta\"\n}","options":{"raw":{"language":"json"}}},"url":"https://conta.bmb.app.br/api/GetPixKey","description":"

Este endpoint tem o objetivo de consultar uma chave e com os dados efetuar um envio de pix.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atributo	Descrição	Exemplo	Tipo
client_id Obrigatório	Fornecido pelo emissor	Header	String
client_secret Obrigatório	Fornecido pelo emissor	Header	String
valor Obrigatório	Passar o valor inteiro em formato decimal.	R$ 10,50 passar 10.50

","urlObject":{"path":["GetPixKey"],"host":["https://conta.bmb.app.br/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f3889c7-773d-4faf-b4d8-5c167b04ef1b"},{"name":"Enviar Pix","id":"78060895-7e4b-4db8-b181-5914f4c5a091","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"client-id","value":"client_id","type":"text"},{"key":"client-secret","value":"client_secret","type":"text"},{"key":"Idempotency","value":"87f70c25-0ed9-4363-b044-93b6e05b587b","type":"text"}],"body":{"mode":"raw","raw":"{\n \"valor\": 1,\n \"Chave\": \"chavepix\",\n \"descricao\": \"Teste API\",\n \"ENDTOEND\": \"endToend\",\n \"Beneficiario\": {\n \"number\": \"numero da conta\",\n \"branch\": \"0001\",\n \"type\": \"tipo da conta\",\n \"participantIspb\": \"numero do participante\",\n \"holder\": {\n \"document\": \"documento do beneficario\",\n \"name\": \"nome beneficiario\",\n \"type\": \"tipo beneficiario\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://conta.bmb.app.br/api/EnviarPixChave","description":"

Este endpoint tem o objetivo de enviar um pix pelos dados consultados no endpoint anterior.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Exemplo	Descrição
valor	number	1	Valor a ser transferido
Chave	string	\"chavepix\"	Chave PIX do destinatário
descricao	string	\"Teste API\"	Observação ou descrição da transação
ENDTOEND	string	\"endToend\"	Identificador único para rastreamento da transação
Beneficiario	object	{ ... }	Objeto contendo informações do beneficiário

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Exemplo	Descrição
number	string	\"numero da conta\"	Número da conta do beneficiário
branch	string	\"0001\"	Agência do beneficiário
type	string	\"tipo da conta\"	Tipo de conta (ex.: conta corrente, poupança)
participantIspb	string	\"numero do participante\"	Número identificador do participante conforme ISPB
holder	object	{ ... }	Objeto com informações do titular do beneficiário

","urlObject":{"path":["EnviarPixChave"],"host":["https://conta.bmb.app.br/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"78060895-7e4b-4db8-b181-5914f4c5a091"}],"id":"6eac5e5a-5956-468e-8dab-c6e9937d70be","_postman_id":"6eac5e5a-5956-468e-8dab-c6e9937d70be","description":""}],"event":[{"listen":"prerequest","script":{"id":"5daf9c19-de53-40d0-b079-d1fef38dcae5","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"873c4fa8-6312-4ad4-82cc-f2a2c55046ba","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"baseUrlApi","value":"https://conta.bmb.app.br/api"}]}