Esta documentação tem como objetivo fornecer informações abrangentes sobre a implementação e utilização dos produtos bancários da MT Bank, permitindo que desenvolvedores, instituições financeiras e empresas integrem esse sistema em suas aplicações e serviços.
\nPensando na facilidade de integração com as APIs da MT Bank, todos os retornos da requisição possuem um retorno padrão, exceto a API de geração de token de acesso.
\n{\n \"StatusCode\": 200,\n \"Title\": \"Success\",\n \"Type\" : \"https://tools.ietf.org/html/rfc7231#section-6.3.1\",\n \"Extensions\": {\n \"message\": \"Consulta realizada com sucesso\",\n \"data\" : \"object\"\n }\n}\n\nStatusCode: indica o código de status HTTP da resposta. No exemplo, é \"200\", o que indica que a solicitação foi bem-sucedida.
Title: fornece uma descrição textual do status da resposta. No exemplo, é \"Success\", indicando que a operação foi realizada com êxito.
Type: fornece um link para uma especificação ou documentação que descreve o tipo de resposta. No exemplo, é uma referência à seção 6.3.1 da RFC 7231, que é a especificação para códigos de status HTTP.
Extensions: inclui informações adicionais na resposta. No exemplo, há um atributo message que exibe a mensagem indicando que a requisição foi bem sucedida e também o atributo data associada a um objeto, que seria a carga útil da resposta, contendo os dados relevantes para a operação realizada.
{\n \"StatusCode\": 400,\n \"Title\": \"Bad Request\",\n \"Type\" : \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"Extensions\": {\n \"errors\" : [\n \"O campo 'Name' não pode ser vazio\" ,\n \"O campo 'Age' não pode ser menos que 18 anos\"\n ]\n }\n}\n\nExtensions: no exemplo, há uma chave chamada \"errors\" associada a uma lista de mensagens de erro. Essas mensagens de erro fornecem detalhes específicos sobre o motivo pelo qual a solicitação foi considerada como requisição inválida.
O ambiente refere-se ao local em que o software será operado. Disponibilizamos o ambiente de sandbox como ambiente para testes e homologação.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introdução","slug":"introducao"},{"content":"Princípios básicos","slug":"principios-basicos"}],"owner":"36274419","collectionId":"f0d7d765-c86d-4b61-9c4d-df221f87c989","publishedId":"2sAYQdjVHx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-22T14:49:08.000Z"},"item":[{"name":"Autenticação","item":[{"name":"Gerar token de acesso","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"a79582e9-69d0-43f3-82cd-20c99022dfa8"}}],"id":"3a047ac0-b0a9-4a28-bd47-f878a3ce59c6","protocolProfileBehavior":{"disabledSystemHeaders":{"connection":true,"accept":true,"accept-encoding":true,"user-agent":true,"host":true},"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Tipo de concessão do token. Utilizar \"client_credentials\".
\n","type":"text"},{"key":"client_id","value":"client_secret_teste","description":"Número identificador do cliente, fornecido pela MT Bank.
\n","type":"text"},{"key":"scope","value":"clients_api/big_pix","description":"São ações que podem ser realizadas com base nos escopos enviados pela MT Bank. É composto por \"servidor_de_recurso/recurso\".
\n","type":"text"}]},"url":"{{auth-url}}/token","description":"Retorna o token de acesso, utilizado para autenticação das APIs.
\nO método de autenticação utilizado é o Basic, que consiste em um método simples de autenticação em que o nome de usuário e a senha, convertidos em Base64, são enviados como parte do cabeçalho da solicitação.
\nPara converter em Base64, é necessario concatenar o usuário e senha, tendo como separador o caracter \":\".
\nExemplo:
\nClientId : \"cliente-teste\"
ClientSecret : \"segredo-teste\"
Texto concatenado: \"cliente-teste:segredo-teste\".
\nBase64: \"Y2xpZW50ZS10ZXN0ZTpzZWdyZWRvLXRlc3Rl\" (conversor texto para Base64).
\n","urlObject":{"path":["token"],"host":["{{auth-url}}"],"query":[],"variable":[]}},"response":[{"id":"4d4f2567-369a-4839-8bf4-7eb8081d2b73","name":"Sucesso","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"url":"https://sandbox-token.mtbank.com.br/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\r\n \"access_token\": \"eyJra1example\",\r\n \"id_token\": \"eyJra2example\",\r\n \"refresh_token\": \"eyJj3example\",\r\n \"token_type\": \"Bearer\",\r\n \"expires_in\": 300\r\n}"}],"_postman_id":"3a047ac0-b0a9-4a28-bd47-f878a3ce59c6"}],"id":"0a49ec32-8aed-4599-b00e-c244d1dead5c","description":"O objetivo da autenticação é garantir que apenas integradores autorizados tenham acesso aos recursos e funcionalidades disponibilizados pela API de Pix.
\nO método de autenticação para a API de Pix é por meio de um token de acesso, que utiliza o padrão OAuth 2.0, com um tempo de vida de 5 minutos, que garante ao integrador acesso às funcionalidades de forma segura.
\nPara que possa realizar a integração, é preciso solicitar junto ao time de integração da MT Bank o ClientId , ClientSecret e Scope, para que com estas informações possa ser possível gerar o token JWT.
Em posse das informações necessárias, conforme indicado na etapa 1, poderá ser gerado o token de acesso no padrão OAuth 2.0, tornando possível o acesso às APIs da MT Bank. Para tal, é necessário utilizar a API de Autenticação, que gerará o token, que deverá ser utilizado até a expiração do seu tempo de vida.
\nVeja a API Gerar Token de Acesso.
\nEm posse do token gerado, deverá enviá-lo no cabeçalho da solicitação da API, conforme o exemplo abaixo:
\nContent-Type: application/json\nAuthorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL3NlcnZpbmRlci1hdXRvcml6YWN0aW9uLmNvbSIsInN1YiI6ImlkLWRvLXVzdWFyaW8iLCJhdWQiOiJjbGllbnRlLWlkIiwiaWF0IjoxNjQxOTA0ODAwLCJleHAiOjE2NDE5MDg0MDAsInNjb3BlIjoibGVhdXRhIGVzY3JpcHRhIiwiaWF0IjoxNjQxOTA0ODAwfQ.LsJ0-8D7Pw40T4dODCMLz4MNt3XVbwbPKUSe_9hFn8E\n\nRealiza a solicitação de uma devolução.
\nO atributo Reason podem ser os seguintes motivos:
2→transaction-error
3→unauthorized-transaction
4→fraud
5→trade-disagreement
6→withdrawal-purchase
7→contractual-divergence
8→operational-error
9→duplicate-payment
O atributo Status podem ser as seguintes situações:
1→send
3→confirmed
5→rejected
Realiza a consulta da devolução, através do Identificador gerado pelo integrador ou EndToEnd gerado pelo Bacen.
\nPara saber as opções possível dos atributos Status e Initiation, veja o endpoint Consulta Pagamentos.
Para saber as opções possível do atributo Reason e Status, veja o endpoint Devolver Pagamento.
Identificador da cobrança pelo integrador, sendo o mesmo enviado na geração do QR-Code.
\n","type":"text/plain"},"key":"identifier","value":"{{identificador-integrador}}"},{"disabled":true,"description":{"content":"Número identificador da transação, gerado pelo Bacen.
\n","type":"text/plain"},"key":"end-to-end","value":"{{end-to-end-bacen}}"}],"variable":[]}},"response":[{"id":"02e2bc94-e19f-4515-abb2-9606e959ac31","name":"Sucesso","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://sandbox.mtbank.com.br/pix/refund?end-to-end=E982962769268481738548042697108","protocol":"https","host":["sandbox","mtbank","com","br"],"path":["pix","refund"],"query":[{"key":"end-to-end","value":"E982962769268481738548042697108"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"statusCode\": 200,\r\n \"title\": \"Success\",\r\n \"type\" : \"https://tools.ietf.org/html/rfc7231#section-6.3.1\",\r\n \"extensions\": {\r\n \"message\": \"Consulta realizada com sucesso\",\r\n \"data\" : {\r\n \"payerName\": \"Rogério da Silva Gomes\",\r\n \"payerBankCode\": \"001\",\r\n \"payerBankBranch\": \"1328\",\r\n \"payerBankAccount\": \"12598639\",\r\n \"payerTaxNumber\": \"90609844040\",\r\n \"payerISPB\": \"26060719\",\r\n \"receiverPixKey\": \"+5512958635412\",\r\n \"receiverName\": \"Jorge da Silva Ramos\",\r\n \"receiverBankCode\": \"001\",\r\n \"receiverBankBranch\": \"1328\",\r\n \"receiverBankAccount\": \"12598639\",\r\n \"receiverTaxNumber\": \"90609844040\",\r\n \"receiverISPB\": \"26060719\",\r\n \"transactionDate\": \"2024-01-18T17:04:58\",\r\n \"inicialization\": \"pix-key\",\r\n \"valueOrigin\": 9.87,\r\n \"identifierOrigin\": \"7e69adad-3ed1-48b4-98d0-b9d6ca15f5df\",\r\n \"endToEndOrigin\": \"E421726176606948427330315768697\",\r\n \"messageOrigin\": \"Pagamento da NF. 12569\",\r\n \"identifierRefund\": \"9200deae-6150-440b-8288-23fa059dbbaa\",\r\n \"endToEndRefund\": \"E982962769268481738548042697108\",\r\n \"messageRefund\": \"Processo Bacen 12.125/2023-89\",\r\n \"description\": \"Devolução por mandato judicial.\",\r\n \"reason\": \"fraud\",\r\n \"reasonId\": 4,\r\n \"status\": \"send\",\r\n \"statusId\": 1\r\n }\r\n }\r\n}"},{"id":"8e0b7f87-74e2-415c-8e7d-68d0a467107f","name":"Erro","originalRequest":{"method":"GET","header":[],"url":"{{pix-url}}/refund"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"StatusCode\": 400,\r\n \"Title\": \"Bad Request\",\r\n \"Type\" : \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\r\n \"Extensions\" : {\r\n \"Errors\" : [ \r\n \"Esperado o parâmetro identifier ou end-to-end\"\r\n ]\r\n }\r\n}"}],"_postman_id":"7bad2512-de1d-40fb-8a59-ac8ce01f0fb2"}],"id":"5ee9951f-13e1-4e97-88c2-ad05d5d43e54","description":"Devolução Pix refere-se à reversão de uma transação realizada por meio desse sistema de pagamento instantâneo.
\nA devolução Pix pode ocorrer em situações específicas, como quando há um problema em uma transação, como um pagamento indevido, um valor incorreto ou uma transação não autorizada.
\nPara realizar a devolução, é preciso solicitar a devolução e aguardar um webhook que retornará a confirmação da devolução.
\nVeja a API Devolver Pagamento.
\n","_postman_id":"5ee9951f-13e1-4e97-88c2-ad05d5d43e54"},{"name":"EDI","item":[{"name":"Operações bancárias - v1.0.0","id":"00d814ea-dfb6-43f4-8425-26d86a4ec5c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"clients\": [\r\n {\r\n \"name\": \"\",\r\n \"taxNumber\": \"\",\r\n \"operations\": [\r\n {\r\n \"operationReference\": \"00000000-0000-0000-0000-000000000000\",\r\n \"operationType\": 1,\r\n \"operationDate\": \"2000-01-01T00:00:00\",\r\n \"operationValue\": 0.00,\r\n \"operationRate\": 0.00,\r\n \"clientIdentifier\": \"\",\r\n \"originName\": \"\",\r\n \"originTaxNumber\": \"\",\r\n \"originBankCode\": \"\",\r\n \"originBranch\": \"\",\r\n \"originAccount\": \"\",\r\n \"originIspb\": \"\",\r\n \"destinationName\": \"\",\r\n \"destinationTaxNumber\": \"\",\r\n \"destinationBankCode\": \"\",\r\n \"destinationBranch\": \"\",\r\n \"destinationAccount\": \"\",\r\n \"destinationIspb\": \"\",\r\n \"flow\": 0,\r\n \"pixOperation\": 0,\r\n \"pixKey\": \"\",\r\n \"pixEndToEnd\": \"\",\r\n \"pixQrCodeIdentifier\": \"\",\r\n \"pixSplitOriginOperationReference\": \"00000000-0000-0000-0000-000000000000\",\r\n \"pixRefundOriginOperationReference\": \"00000000-0000-0000-0000-000000000000\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{webhook-url}}/edi/bank-operation/v1.0.0","description":"Envio de um EDI de operações bancárias para o integrador.
\nO atributo operationType pode ser um dos seguintes domínios:
1→ pix
2→ ted
3→ internal-transfer
O atributo flow pode ser um dos seguintes domínios:
1→ in-flow
2→ out-flow
O atributo pixOperation pode ser um dos seguintes domínios:
1→ payment
2→ redund
EDI (Electronic Data Interchange) ou Intercâmbio Eletrônico de Dados, é uma tecnologia que permite a troca eletrônica de informações comerciais e documentos padronizados entre empresas de maneira automatizada e segura, reduzindo a necessidade de intervenção humana.
\nMesmo que muitas transações realizadas são reportadas ao integrador por meio de webhooks específicos, a MT Bank disponiliza o envio destas informações para o integrador, em webhook previamente disponibilizado, em determinado horário definido para o integrador. Nesta requisição, segue junto um arquivo texto no formato JSON, compactado em formato .zip. Este arquivo texto contêm em detalhe todas as transações realizadas no dia anterior, permitindo assim que o integrador realize a conciliação das informações em seus respectivos sistema de informações.
\nO integrador deve sempre implementar algum método de autenticação em seus webhooks para receber as requisições da MT Bank. Veja a seção de Autenticação do webhook.
\n","_postman_id":"d9adb1a2-0171-46e0-8774-9d6d805f664a"},{"name":"Financeiro","item":[{"name":"Saldo da Conta","id":"b13b7531-ca42-4944-9685-886b934d286c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"{{accout-url}}/account-holder/balance","description":"Realizar a consulta do saldo da conta do cliente correntista, conforme o tipo de conta, se informado.
\nTipo de conta bancária (opcional), sendo:\n1 - Conta Corrente.\nSe não enviado, o saldo retornando é da conta corrente do cliente correntista.
\n","type":"text/plain"},"key":"account-type-id","value":"{{tipo-conta}}"}],"variable":[]}},"response":[{"id":"70e0c4bf-af8b-479e-91c5-c1aef7c542c1","name":"Sucesso","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://sandbox.mtbank.com.br/account/account-holder/balance?account-type-id=1","protocol":"https","host":["sandbox","mtbank","com","br"],"path":["account","account-holder","balance"],"query":[{"key":"account-type-id","value":"1"},{"key":"","value":null,"disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"StatusCode\": 200,\r\n \"Title\": \"Success\",\r\n \"Type\" : \"https://tools.ietf.org/html/rfc7231#section-6.3.1\",\r\n \"Extensions\": {\r\n \"Data\" : {\r\n \"availableBalance\": 25895.24\r\n },\r\n \"Message\": \"Saldo obtidos com sucesso\"\r\n }\r\n}"},{"id":"5edfb340-ce5e-4dcc-8c39-4a008e932b29","name":"Erro","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.mtbank.com.br/account/account-holder/balance?account-type-id=3","protocol":"https","host":["sandbox","mtbank","com","br"],"path":["account","account-holder","balance"],"query":[{"key":"account-type-id","value":"3"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"StatusCode\": 400,\r\n \"Title\": \"Bad Request\",\r\n \"Type\" : \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\r\n \"Extensions\" : {\r\n \"Errors\" : [ \r\n \"account-type-id inválido.\"\r\n ]\r\n }\r\n}"}],"_postman_id":"b13b7531-ca42-4944-9685-886b934d286c"}],"id":"d806e86b-af00-410b-91ed-7348df926469","description":"Esta seção destina ao conjunto de endpoints relacionados com aspectos financeiros ou contábil das transações realizadas por Pix, no que se refere às movimentações financeiras realizadas.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"10d8ed1a-7ceb-42c5-b2da-97c5b842dbab"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e5074e8f-0e27-4df5-a3d6-62c9f64211f4"}}],"_postman_id":"d806e86b-af00-410b-91ed-7348df926469"},{"name":"Pagamento","item":[{"name":"Realizar Pagamento com chave","id":"2a8ec8d4-c066-4fc3-97c3-cb93b160182a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Jose Carlos da Silva\",\r\n \"pixKey\": \"josecarlos@gmail.com\",\r\n \"taxNumber\": \"55663130004\",\r\n \"value\": 1.23,\r\n \"message\": \"Transferência por Pix\",\r\n \"identifier\": \"b12a98ca-5293-47f5-88bb-a5db6729d0e2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{pix-url}}/payments/key","description":"Realiza um pagamento para determinada chave Pix do Recebedor.
\nRealiza um pagamento utilizando dados bancários do Recebedor.
\nRealiza a consulta do pagamento, através do Identificador gerado pelo integrador ou EndToEnd gerado pelo Bacen.
\nO atributo Initiation podem ser os seguintes formas de iniciação de pagamento:
1→manual
2→pix-key
3→static-qrcode
4→dynamic-qrcode
O atributo Status pode ser as seguintes situações de pagamento:
1→send
2→registered
3→confirmed
4→returned
5→rejected
6→returned-automatic
Identificador da cobrança pelo integrador, sendo o mesmo enviado na geração do QR-Code.
\n","type":"text/plain"},"key":"identifier","value":"{{identificador-integrador}}"},{"disabled":true,"description":{"content":"Número identificador da transação, gerado pelo Bacen.
\n","type":"text/plain"},"key":"end-to-end","value":"{{end-to-end-bacen}}"}],"variable":[]}},"response":[{"id":"a643ef4a-75c6-4b46-950a-a4a00ed642dc","name":"Successo","originalRequest":{"method":"GET","header":[],"url":{"raw":"/payment?identifier=d77965b6-d1d8-4478-b091-464e57655e49","path":["payment"],"query":[{"key":"identifier","value":"d77965b6-d1d8-4478-b091-464e57655e49"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"StatusCode\": 200,\r\n \"Title\": \"Success\",\r\n \"Type\" : \"https://tools.ietf.org/html/rfc7231#section-6.3.1\",\r\n \"Extensions\": {\r\n \"Message\": \"Consulta realizada com sucesso\",\r\n \"Data\" : {\r\n \"payerName\": \"Maria Clara Caravaggio\",\r\n \"payerBankCode\": \"001\",\r\n \"payerBankBranch\": \"1328\",\r\n \"payerBankAccount\": \"12598639\",\r\n \"payerTaxNumber\": \"90609844040\",\r\n \"payerISPB\": \"26060719\",\r\n \"receiverPixKey\": \"+5512958635412\",\r\n \"receiverName\": \"Jorge da Silva Ramos\",\r\n \"receiverBankCode\": \"001\",\r\n \"receiverBankBranch\": \"1328\",\r\n \"receiverBankAccount\": \"12598639\",\r\n \"receiverTaxNumber\": \"90609844040\",\r\n \"receiverISPB\": \"26060719\",\r\n \"value\": 1.56,\r\n \"message\": \"Ref. NF 125.897\",\r\n \"transactionDate\": \"2024-01-16T17:15:23\",\r\n \"initiation\": \"pix-key\",\r\n \"initiationId\": 2,\r\n \"status\": \"confirmed\",\r\n \"statusId\": 3,\r\n \"identifier\": \"d77965b6-d1d8-4478-b091-464e57655e49\",\r\n \"endToEnd\": \"E421726176606948427330315768697\"\r\n }\r\n }\r\n}"}],"_postman_id":"7589d723-6ba0-4d21-9c53-83a93c9050be"}],"id":"610a1127-becb-4a69-9bf6-8eae4962ce5d","description":"No contexto Pix, o pagamento envolve um Pagador portador de um QR-Code, Pix copia e cola, chave Pix ou dados bancários, realizar a transferência de recursos de sua instituição financeira para determinado Recebedor.
\nQuando o Pagador realizar o pagamento, é realizada uma ordem de pagamento, que é enviada para o Sistema de Pagamentos Instantâneo (SPI), que processa e autoriza a transferência do recurso.
\nO valor é transferido eletronicamente entre as instituições financeiras do Pagador e do Recebedor por meio do Sistema Brasileiro de Pagamentos (SBP), que notifica as partes sobre a conclusão da confirmação.
\nPara realizar o pagamento, é preciso solicitar o pagamento e aguardar um webhook que retornará a confirmação do pagamento.
Nossas APIs permitem que seja realizados pagamentos, onde o Pagador realizará o débito de sua conta transacional para um Recebedor.
Veja as APIs
\n\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ef23138e-3592-46f4-8d01-7fa5eee31ae5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"3092c2f0-cbd2-43c0-ae37-b547897802c5"}}],"_postman_id":"610a1127-becb-4a69-9bf6-8eae4962ce5d"},{"name":"QR-Code","item":[{"name":"Gerar QR-Code Dinâmico","id":"6e67e0ba-b298-4666-b77a-4ea89109308e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"pixKey\": \"55663130004\",\r\n \"value\": 1.23,\r\n \"expirationDate\": \"2024-01-10T17:22:00\",\r\n \"allowChangeValue\": false,\r\n \"message\": \"Referente a compra de teclado\",\r\n \"identifier\": \"a5829b3c-df49-4570-8d08-b1d0f6a0848a\",\r\n \"payerPhysicalPerson\": true,\r\n \"allowedPayerTaxNumber\": null,\r\n \"qrCodeFormat\": \"image\",\r\n \"split\": \r\n {\r\n \"splitType\": \"\",\r\n \"beneficiaries\":[\r\n {\r\n \"taxNumber\": \"\",\r\n \"value\": 0.00,\r\n \"pixKey\": \"\",\r\n \"name\": \"\",\r\n \"bankCode\": \"\",\r\n \"branch\": \"\",\r\n \"account\": \"\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{pix-url}}/qr-code/dynamic","description":"Gera um QR-Code dinâmico e retorna as informações para o pagamento.
\nO atributo QRCodeFormat pode ser os seguintes formatos de retorno:
1→copy-paste
2→image
3→both
Caso o cliente tenha ativado o produto de Split Pix, é possível transferir automaticamente valores para contas bancárias de beneficiários previamente cadastrados. Neste caso, quando é realizada a confirmação do recebimento do valor pago pelo Pagador, o sistema automaticamente envia os valores, seja um valor monetário fixo ou percentual do valor recebido, aos respectivos beneficiários.
\nOs valores podem ser enviado para uma chave Pix ou dados bancários dos beneficiários.
\nPara que o split seja realizado, deverão ser enviados os seguintes atributos:
\nObjeto Beneficiaries
\nGera um QR-Code estático e retorna as informações para o pagamento.
\nPara saber as opções possível do atributo QRCodeFormat, veja o endpoint Gerar QR-Code Dinâmico.
Caso o cliente tenha ativado o produto de Split Pix, veja o endpoint Gerar QR-Code Dinâmico.
\nPara saber os atributos do payload de retorno, veja o endpoint Gerar QR-Code Dinâmico.
\n","urlObject":{"path":["qr-code","static"],"host":["{{pix-url}}"],"query":[],"variable":[]}},"response":[{"id":"931feab7-d47e-4eb0-8d62-cd0aeca18b23","name":"Sucesso","originalRequest":{"method":"GET","header":[],"url":"/qr-code/static"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"statusCode\": 200,\r\n \"title\": \"Success\",\r\n \"type\" : \"https://tools.ietf.org/html/rfc7231#section-6.3.1\",\r\n \"extensions\": {\r\n \"message\": \"QR-Code registrado com sucesso\",\r\n \"data\" : {\r\n \"identifier\": \"75991d08-836c-453b-8720-e7c8eea61b83\",\r\n \"pixKey\": \"55663130004\",\r\n \"value\": 1.23,\r\n \"message\": \"Doação para a campanha do agasalho\",\r\n \"qrCodeFormat\": \"CopyPaste\",\r\n \"qrCodeFormatId\": 1,\r\n \"qrCodeReturn\": {\r\n \"pixCopyPaste\": \"00020101021126580014br.gov.bcb.pix0136137ead71-a56c-4928-93be-9b7bf14beeab5204000053039865802BR5922JOSE DA SILVA SANTOS6009Sao Paulo62070503***6304D12D\",\r\n \"image\": null\r\n },\r\n \"split\": {\r\n \"splitType\": \"\",\r\n \"splitTypeId\": 0,\r\n \"beneficiaries\":[\r\n {\r\n \"taxNumber\": \"\",\r\n \"value\": 0.00,\r\n \"pixKey\": \"\",\r\n \"bankCode\": \"\",\r\n \"branch\": \"\",\r\n \"account\": \"\",\r\n \"name\": \"\"\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n}"},{"id":"9760cfc1-123c-4ef1-8974-1faf7a9d1097","name":"Erro","originalRequest":{"method":"GET","header":[],"url":"/qr-code/static"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"StatusCode\": 401,\r\n \"Title\": \"Unauthorized\",\r\n \"Type\" : \"https://tools.ietf.org/html/rfc7235#section-3.1\",\r\n \"Extensions\" : {\r\n \"Errors\" : [ \r\n \"Não autorizado\"\r\n ]\r\n }\r\n}"}],"_postman_id":"872f2bbb-7b92-4fa6-93c7-bdf7245c1b6f"},{"name":"Cancelar QR-Code","id":"1e7ab211-a4e3-447e-a894-610181925d44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[],"url":"{{pix-url}}/qr-code?identifier={{identificador-integrador}}","description":"Cancela um QR-Code previamente registrado no Bacen, através do Identificador gerado pelo integrador.
\nDocumentação dos atributos, verificar o endpoint Gerar QR-Code Dinâmico.
\n","urlObject":{"path":["qr-code"],"host":["{{pix-url}}"],"query":[{"description":{"content":"Identificador da cobrança pelo integrador, sendo o mesmo enviado na geração do QR-Code.
\n","type":"text/plain"},"key":"identifier","value":"{{identificador-integrador}}"}],"variable":[]}},"response":[{"id":"45660ebe-6023-495f-8ed1-9e4c1145a473","name":"Sucesso","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/qr-code?identifier=205c6e94-9a51-40ab-9bfd-b8e21830c7ac","path":["qr-code"],"query":[{"key":"identifier","value":"205c6e94-9a51-40ab-9bfd-b8e21830c7ac"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"StatusCode\": 200,\r\n \"Title\": \"Success\",\r\n \"Type\" : \"https://tools.ietf.org/html/rfc7231#section-6.3.1\",\r\n \"Extensions\": {\r\n \"Message\": \"Cancelamento do QR-Code realizado com sucesso\",\r\n \"Data\" : {\r\n \"PixKey\": \"55663130004\",\r\n \"Value\": 1.23,\r\n \"ExpirationDate\": \"2024-01-10T17:22:00\",\r\n \"PayerChangeValue\": false,\r\n \"Message\": \"Referente a compra de teclado\",\r\n \"Identifier\": \"a5829b3c-df49-4570-8d08-b1d0f6a0848a\",\r\n \"PayerPhysicalPerson\": true,\r\n \"AllowedPayerTaxNumber\": null,\r\n \"QRCodeFormat\": \"copy-paste\",\r\n \"QRCodeFormatId\": 1,\r\n \"QRCodeReturn\": {\r\n \"PixCopyPaste\": \"00020101021126580014br.gov.bcb.pix0136137ead71-a56c-4928-93be-9b7bf14beeab5204000053039865802BR5922JOSE DA SILVA SANTOS6009Sao Paulo62070503***6304D12D\",\r\n \"Imagem\": null\r\n } \r\n }\r\n }\r\n}"},{"id":"5aa0832c-4446-4b2b-ada6-ea66f492a34c","name":"Erro","originalRequest":{"method":"DELETE","header":[],"url":"{{pix-url}}/qr-code"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"StatusCode\": 400,\r\n \"Title\": \"Bad Request\",\r\n \"Type\" : \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\r\n \"Extensions\" : {\r\n \"Errors\" : [ \r\n \"Parâmetro 'identificador' não enviado\"\r\n ]\r\n }\r\n}"}],"_postman_id":"1e7ab211-a4e3-447e-a894-610181925d44"},{"name":"Consulta de QR-Code","id":"9dde4ddb-88f4-4e6d-843d-63719be926ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"{{pix-url}}/qr-code?identifier={{identificador-integrador}}","description":"Realiza a consulta do QR-Code, através do Identificador gerado pelo integrador.
\nDocumentação dos demais atributos, verificar o endpoint Gerar QR-Code Dinâmico.
\nO atributo Status pode ser as seguintes situações:
1→ saved-record
2→awaiting-payment
3→problem-generation
4→expired
5→received
6→partial-received
7→payment-rejected
8→chargeback-receipt
9→problem-cancellation
10→cancelled
Identificador da cobrança pelo integrador, sendo o mesmo enviado na geração do QR-Code.
\n","type":"text/plain"},"key":"identifier","value":"{{identificador-integrador}}"}],"variable":[]}},"response":[{"id":"9f00664c-3e9a-4f48-a16b-9698b1458751","name":"Sucesso","originalRequest":{"method":"GET","header":[],"url":{"raw":"/qr-code?identifier=2393fea2-d48a-4322-ad29-3e577962cf1e","path":["qr-code"],"query":[{"key":"identifier","value":"2393fea2-d48a-4322-ad29-3e577962cf1e"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"StatusCode\": 200,\r\n \"Title\": \"Success\",\r\n \"Type\" : \"https://tools.ietf.org/html/rfc7231#section-6.3.1\",\r\n \"Extensions\": {\r\n \"Message\": \"Consulta realizada com sucesso\",\r\n \"Data\" : {\r\n \"pixKey\": \"55663130004\",\r\n \"value\": 1.23,\r\n \"expirationDate\": \"2024-01-10T17:22:00\",\r\n \"payerChangeValue\": false,\r\n \"message\": \"Referente a NF 125.896\",\r\n \"identifier\": \"2393fea2-d48a-4322-ad29-3e577962cf1e\",\r\n \"payerPhysicalPerson\": true,\r\n \"allowPayerChangeValue\": null,\r\n \"status\": \"awaiting-payment\",\r\n \"statusId\": 2,\r\n \"qrCodeFormat\": \"copy-paste\",\r\n \"qrCodeFormatId\": 1,\r\n \"qrCodeReturn\": {\r\n \"pixCopyPaste\": \"00020101021126580014br.gov.bcb.pix0136137ead71-a56c-4928-93be-9b7bf14beeab5204000053039865802BR5922JOSE DA SILVA SANTOS6009Sao Paulo62070503***6304D12D\",\r\n \"image\": null\r\n }\r\n }\r\n }\r\n}"},{"id":"32f8a5dc-cfb8-4078-88d2-da2f40fa0fb0","name":"Erro","originalRequest":{"method":"GET","header":[],"url":"{{pix-url}}/qr-code"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"StatusCode\": 400,\r\n \"Title\": \"Bad Request\",\r\n \"Type\" : \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\r\n \"Extensions\" : {\r\n \"Errors\" : [ \r\n \"Parâmetro 'identificador' não enviado\"\r\n ]\r\n }\r\n}"}],"_postman_id":"9dde4ddb-88f4-4e6d-843d-63719be926ab"}],"id":"0dc2e986-dd35-4366-bc85-e580ee11d18a","description":"A geração de QR-Code para cobranças Pix, envolve a criação de um código bidimensional, que contém as informações necessárias para que o Pagador efetue um pagamento. Pode-se criar um QR-Code estático ou dinâmico.
\nÉ utilizado para receber múltiplos pagamentos sem a necessidade de gerar um novo código a cada transação. Ele contém informações fixas, como a chave Pix do recebedor, nome do recebedor e outras. Essas informações são configuradas uma única vez e permanecem constantes para todos os pagamentos recebidos.
\nVeja a API Gerar QR-Code Estático.
\nEssa modalidade destina-se às cobranças com um Pagador especificado, incluindo sua identificação e o motivo da cobrança. O QR-Code gerado para esse fim é de uso único, expirando após um pagamento bem-sucedido. Se a cobrança não for liquidada até a data de vencimento, o QR-Code também expira, não sendo mais possível o pagamento pelo Pagador.
\nVeja a API Gerar QR-Code Dinâmico.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8f4ecb6f-7434-48ba-9be5-d82164b03aa0"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e916d58a-bea5-4546-82cb-e63a2191e2b2"}}],"_postman_id":"0dc2e986-dd35-4366-bc85-e580ee11d18a"},{"name":"Webhook","item":[{"name":"Pix","item":[{"name":"Recebimento com QR-Code","id":"ac076088-a729-4a7a-964f-9d9276a0bd28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"identifier\": \"a5829b3c-df49-4570-8d08-b1d0f6a0848a\",\r\n \"endToEnd\": \"E421726176606948427330315768697\",\r\n \"receiptOriginalValue\": 4.56,\r\n \"receiptValue\": 4.56,\r\n \"receiptDate\": \"2024-01-12T08:45:33\",\r\n \"payerName\": \"José Carlos da Silva\",\r\n \"payerTaxNumber\": \"55663130004\",\r\n \"payerBankCode\": \"001\",\r\n \"payerBankBranch\": \"1256\",\r\n \"payerBankAccount\": \"00124568\",\r\n \"payerISPB\": \"01234567\",\r\n \"payerMessage\": \"Pagamento da compra de teclado\",\r\n \"receiverName\": \"Maria Clara Ramos\",\r\n \"receiverTaxNumber\": \"96668850006\",\r\n \"receiverBankCode\": \"033\",\r\n \"receiverBankBranch\": \"5689\",\r\n \"receiverBankAccount\": \"005698529\",\r\n \"receiverISPB\": \"01234888\",\r\n \"status\": \"confirmed\",\r\n \"statusId\": 3,\r\n \"splitBeneficiaries\": [\r\n {\r\n \"taxNumber\": \"\",\r\n \"value\": 0.00,\r\n \"endToEnd\": \"\",\r\n \"status\": \"\",\r\n \"statusId\": 0,\r\n \"errorMessage\": \"\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{webhook-url}}/qrcode/cash-in","description":"Envia uma notificação quando é realizado o recebimento cuja cobrança foi gerada anteriormente por meio de um QR-Code.
\nPara saber as opções possível do atributo Status do recebimento, veja o endpoint Consulta de Pagamento.
Se estiver ativado o produto Split Pix e gerado o QR-Code com tais informações, retorna também as informações dos beneficiários do split, no atributo SplitBeneficiaries.
Envia uma notificação quando é realizado o recebimento sem qualquer vínculo com um QR-Code gerado previamente.
\nPara saber as opções possível do atributo Status, veja o endpoint Consulta de Pagamento.
Envia uma notificação informando a efetivação de um pagamento previamente solicitado e o débito do valor na conta do Pagador.
\nPara saber as opções possível do atributo Status, veja o endpoint Consulta de Pagamentos.
Envia uma notificação informando a efetivação de uma solicitação de devolução de pagamento.
\nDocumentação dos atributos, verificar o endpoint Consulta de Devolução.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bca2eead-5390-4ea4-8d2c-3d8fa276bb7e","id":"bca2eead-5390-4ea4-8d2c-3d8fa276bb7e","name":"Webhook","type":"folder"}},"urlObject":{"path":["refunds"],"host":["{{webhook-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a25a95ca-4334-43d0-a709-86d8cd53340f"}],"id":"64235688-174c-45b7-a1e2-67f52a11f8b1","description":"Webhook relacionado com o produto BigPix.
\n","_postman_id":"64235688-174c-45b7-a1e2-67f52a11f8b1","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bca2eead-5390-4ea4-8d2c-3d8fa276bb7e","id":"bca2eead-5390-4ea4-8d2c-3d8fa276bb7e","name":"Webhook","type":"folder"}}}],"id":"bca2eead-5390-4ea4-8d2c-3d8fa276bb7e","description":"Um webhook é uma forma de comunicação entre sistemas na web, permitindo que aplicativos enviem automaticamente informações em tempo real quando ocorrem eventos específicos. Em vez de depender de uma solicitação manual para obter dados, os webhooks permitem que um sistema envie automaticamente dados para outro assim que um evento ocorre. Esse modelo é frequentemente utilizado para integração entre diferentes serviços online.
\nAlgumas notificações específicas, como o pagamento de uma cobrança previamente realizada por meio de um QR-Code ou a confirmação de transferência de recursos para determinado Recebedor, são algumas das notificações que nossa aplicação realiza, permitindo assim, que os integradores da MT Bank sejam notificados de maneira confiável.
\nPara que o integrador receba tais notificações, é preciso que seja exposta uma API com os métodos detalhados a seguir e enviado o endereço da mesma para o time de integração da MT Bank, para que nossa aplicação possa destinar as mensagens.
\nO integrador deve sempre implementar algum método de autenticação em seus webhooks para receber as requisições da MT Bank. Atualmente, suportamos os principais métodos de autenticação utilizados pelo mercado, incluindo:
\nOauth 2.0 - o integrador deve disponibilizar um método e credenciais para a MT Bank gerar o token e enviar no Header Authorization junto às requisições dos webhooks. Mais detalhes, verificar a seção de Autenticação.
\nBasic - o integrador enviará um clientId e secret e para a MT Bank, que codificará estas informações em Base64 e enviará junto ao Header Authorization às requisições dos webhooks.
\nAPI Key - o integrador deve gerar uma string única que serve como uma credencial para MT Bank enviar junto às requisições dos webhooks.
\n