{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"03556699-5f99-4226-9c6c-ce7a1bce061a","name":"Documentação PIX HN Bank","description":"# Autenticação\n\nSão geradas chaves CI e CS pelo suporte para a autenticação, as chaves devem ser enviadas juntos da requisição no cabeçalho HTTP das mesmas com os nomes **ci** para _Client ID_ e **cs** para _Client Secret._\n\n# Variável de ambiente\n\n**Sandbox**\n\nhost: [https://sandbox.ws.hnbank.app](https://)\n\n**Produção**\n\nhost: [https://ws.hnbank.app](https://)\n\n# Retornos\n\n200 - Sucesso.\n\n401 - Falha na autenticação.\n\n400 - Erro na solicitação, verifique o response do retorno.\n\n500 - Erro interno.\n\n# Webhook\n\nVocê pode validar se as chamadas para o seu webhook são válidas, caso venha dos seguintes IP's:\n\n3.132.137.46\n\n### Webhook (PIX Cash-in)\n\nÉ necessário a criação de um webhook para o recebimento dos status das transações em seu sistema.\n\nO webhook deve ser do tipo Rest, aceitar requisições POST e receber os seguintes dados no Request (JSON):\n\n<table><tbody><tr><th>Variável</th><th>Type</th><th>Descrição</th></tr><tr><td><div>idTransaction</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>ID da transação.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>typeTransaction</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Tipo da transação (PIX).</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>statusTransaction</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Status da transação (PAID_OUT, CHARGEBACK)</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>value</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Number</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Valor do pagamento</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>payerName</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Nome do pagador</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>payerTaxId</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Documento do pagador</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>paymentDate</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Data e hora do pagamento. (dd/MM/yyyy HH:mm:ss)</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>paymentCode</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Código de pagamento</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>requestNumber</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>requestNumber enviado na requisição</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>hash</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Código hash do conteúdo do JSON</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n**statusTransaction:**\n\nPAID_OUT - Transação paga  \nCHARGEBACK - Estorno\n\n**hash:**\n\nEste código de segurança é uma verificação de integridade, para garantir que o Webhook que você recebeu foi gerado e enviado pelo sistema da HN Bank. Para validá-lo, siga as etapas abaixo:\n\n1. Concatene todos os valores dos campos (exceto o próprio hash) em uma única string. Mantenha a ordem dos valores contidos consistente com a ordem dos valores recebidos no JSON.\n    \n2. Concatene seu ClientSecret (cs) com o resultado da etapa 1.\n    \n3. Calcule o hash SHA-256 da string resultante da etapa 2.\n    \n4. Compare o hash SHA-256 resultante com o campo hash na carga recebida. Se corresponder, o JSON que você recebeu é válido.\n    \n\n### Webhook (PIX Cash-out)\n\nÉ necessário a criação de um webhook para o recebimento dos status das transações em seu sistema.\n\nO webhook deve ser do tipo Rest, aceitar requisições POST e receber os seguintes dados no Request (JSON):\n\n<table><tbody><tr><th>Variável</th><th>Type</th><th>Descrição</th></tr><tr><td><div>idTransaction</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>ID da transação.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>typeTransaction</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Tipo da transação (PIX_CASHOUT).</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>statusTransaction</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Status da transação (PAID_OUT, CANCELED)</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>value</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Number</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Valor enviado.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>destinationName</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Nome do destinatário.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>destinationTaxId</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Documento do destinatário.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>destinationBank</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Nome do banco destinatário.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>hash</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Código hash do conteúdo do JSON</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n**statusTransaction:**\n\nPAID_OUT - Transação paga  \nCANCELED - Transação cancelada (Pagamento cancelado ou devolvido)\n\n**hash:**\n\nEste código de segurança é uma verificação de integridade, para garantir que o Webhook que você recebeu foi gerado e enviado pelo sistema da HN Bank. Para validá-lo, siga as etapas abaixo:\n\n1. Concatene todos os valores dos campos (exceto o próprio hash) em uma única string. Mantenha a ordem dos valores contidos consistente com a ordem dos valores recebidos no JSON.\n    \n2. Concatene seu ClientSecret (cs) com o resultado da etapa 1.\n    \n3. Calcule o hash SHA-256 da string resultante da etapa 2.\n    \n4. Compare o hash SHA-256 resultante com o campo hash na carga recebida. Se corresponder, o JSON que você recebeu é válido.\n    \n\n# Endpoints","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14064322","team":1487097,"collectionId":"03556699-5f99-4226-9c6c-ce7a1bce061a","publishedId":"2sB3dQtoZK","public":true,"publicUrl":"https://pix.hnbank.app","privateUrl":"https://go.postman.co/documentation/14064322-03556699-5f99-4226-9c6c-ce7a1bce061a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/becb2c57-8a81-404a-a2c6-343c36e02bd5/bG9nb19henVsLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/becb2c57-8a81-404a-a2c6-343c36e02bd5/bG9nb19henVsLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2025-12-07T23:36:31.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/becb2c57-8a81-404a-a2c6-343c36e02bd5/bG9nb19henVsLnBuZw==","logoDark":"https://content.pstmn.io/becb2c57-8a81-404a-a2c6-343c36e02bd5/bG9nb19henVsLnBuZw=="}},"statusCode":200},"environments":[{"name":"HN Bank Sandbox","id":"04bb31fa-e6f1-4987-ba99-3f1633dde4c7","owner":"14064322","values":[{"key":"host","value":"https://sandbox.ws.hnbank.app","enabled":true,"type":"default"},{"key":"ci","value":"testesandbox_1687443996536","enabled":true,"type":"default"},{"key":"cs","value":"5b7d6ed3407bc8c7efd45ac9d4c277004145afb96752e1252c2082d3211fe901177e09493c0d4f57b650d2b2fc1b062d","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/ec6e9c861bd42bfff2031aedad220fe8eae50bc19f62a97597b3f25cba8887d5","favicon":"https://hnbank.app/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"HN Bank Sandbox","value":"14064322-04bb31fa-e6f1-4987-ba99-3f1633dde4c7"}],"canonicalUrl":"https://pix.hnbank.app/view/metadata/2sB3dQtoZK"}