{"id":"cc328d33-06d3-424e-86de-f35a6aa10899","description":"<details>\r\n<summary><b>Vis\u00e3o Geral<\/b><\/summary><br>\r\n\r\nA API de Liquida\u00e7\u00f5es do Banco B3 atua como um facilitador nos processos operacionais di\u00e1rios de liquida\u00e7\u00e3o, proporcionando ganhos de escala, mitiga\u00e7\u00e3o de riscos operacionais e servindo como uma ponte entre diferentes plataformas e sistemas. Ela assegura a integridade, seguran\u00e7a e efici\u00eancia na troca de informa\u00e7\u00f5es e dados transacionados.\r\n\r\nAs principais funcionalidades da API s\u00e3o descritas a seguir:\r\n- **Consulta o saldo de uma conta banc\u00e1ria:** Permite consultar o saldo a partir do n\u00famero da conta banc\u00e1ria do Banco B3.\r\n- **Consulta o extrato PIX da conta informada:** Disponibiliza o extrato de opera\u00e7\u00f5es do tipo PIX a partir do n\u00famero da conta banc\u00e1ria do Banco B3, com op\u00e7\u00e3o de selecionar uma data espec\u00edfica ou um per\u00edodo, para ambos, de at\u00e9 30 dias.\r\n- **Solicita\u00e7\u00e3o de pagamento via PIX (QR Code):** Permite a gera\u00e7\u00e3o de cobran\u00e7as PIX, retornando o QR Code e o c\u00f3digo \"copia e cola\" para pagamento.\r\n- **Consulta de status de cobran\u00e7as PIX:** Permite consultar o status de uma cobran\u00e7a PIX previamente gerada.\r\n- **Solicita\u00e7\u00e3o e consulta de devolu\u00e7\u00e3o PIX:** Permite solicitar a devolu\u00e7\u00e3o de valores de uma transa\u00e7\u00e3o PIX e consultar o status da devolu\u00e7\u00e3o.\r\n\r\nPara mais informa\u00e7\u00f5es, entre em contato com a equipe do Banco B3 pelos canais abaixo:\r\n\r\n- BB3Liquidacao@b3.com.br\r\n- +55 11 2565-4176\r\n- bancob3sales@b3.com.br\r\n- [www.bancob3.com.br](https:\/\/www.bancob3.com.br)\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Regras e Boas Pr\u00e1ticas<\/b><\/summary><br\/><p>\r\n\r\nComo boas praticas seguimos com alguns padr\u00f5es de dados:\r\n\r\n- **Datas:** no formato AAAA-MM-DD. Ex.: `2024-01-01`.\r\n- **N\u00fameros:** formato double com at\u00e9 12 casas decimais antes e 12 depois do ponto. Ex.: `999999999999.9`, `0.999999999999`.\r\n- **Identificadores internos:** sempre em formato UUID\/GUID com h\u00edfen. Ex.: `e79e3c5e-a3bd-4175-a230-ab69c92711db`, `D6CD9E9C-2A08-4360-8979-90DD6186ADC9`.\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details>\r\n<summary><b>Exemplos de Payloads<\/b><\/summary><br>\r\n<details style=\"margin-left: 20px;\">\r\n<summary><b>Consulta Saldos<\/b><\/summary><br>\r\n\r\nConsulta o saldo de uma conta banc\u00e1ria\r\n\r\n```json\r\nGET ...\/api\/settlements\/v1\/public\/bank-accounts\/balance?accountNumber=123456789\r\n\r\n**Resposta:**\r\n\r\n\"links\": {\r\n  \"self\": \"\/api\/settlements\/v1\/public\/bank-accounts\/balance?accountNumber=0000031889\"\r\n},\r\n\"data\": {\r\n  \"accountHolderName\": \"Jo\u00e3o da Silva\",\r\n  \"totalBalanceAmount\": 1500.75,\r\n  \"blockedBalanceAmount\": 500.00,\r\n  \"availableBalanceAmount\": 1000.75,\r\n  \"blockedAmount\": 200.00\r\n}\r\n\r\n```\r\n<\/details><br>\r\n<details style=\"margin-left: 20px;\">\r\n<summary><b>Consulta Extrato Pix<\/b><\/summary><br>\r\n\r\nConsulta o extrato PIX da conta informada\r\n\r\n```json\r\nGET \/public\/statements\/pix?accountNumber=1234567890123&startDate=2025-04-01&endDate=2025-04-28&page=1&page-size=2\r\n\r\n**Resposta:**\r\n\r\n\"data\": [\r\n  {\r\n    \"pixKeyCode\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n    \"endToEndCode\": \"E1234567890123456789012345678901\",\r\n    \"transactionDate\": \"2025-04-10T14:30:00\",\r\n    \"transactionDescription\": \"Pagamento de fatura\",\r\n    \"refundIndicator\": false,\r\n    \"eligibleForRefundIndicator\": true,\r\n    \"originalEndToEndCode\": null,\r\n    \"transactionAmount\": 150.75,\r\n    \"refundAmount\": null,\r\n    \"bankName\": \"Banco do Brasil\",\r\n    \"bankIspbCode\": \"00000000\",\r\n    \"bankAgencyCode\": \"1234\",\r\n    \"bankAccountNumber\": \"123456-7\",\r\n    \"beneficiaryName\": \"Jo\u00e3o da Silva\",\r\n    \"beneficiaryDocumentCode\": \"123.456.789-00\",\r\n    \"financialNatureName\": \"Cr\u00e9dito\",\r\n    \"freeFieldDescription\": \"Pagamento referente ao m\u00eas de abril\"\r\n  },\r\n  {\r\n    \"pixKeyCode\": \"223e4567-e89b-12d3-a456-426614174000\",\r\n    \"endToEndCode\": \"E2234567890123456789012345678902\",\r\n    \"transactionDate\": \"2025-04-15T09:00:00\",\r\n    \"transactionDescription\": \"Recebimento de transfer\u00eancia\",\r\n    \"refundIndicator\": false,\r\n    \"eligibleForRefundIndicator\": false,\r\n    \"originalEndToEndCode\": null,\r\n    \"transactionAmount\": 200.00,\r\n    \"refundAmount\": null,\r\n    \"bankName\": \"Banco do Brasil\",\r\n    \"bankIspbCode\": \"00000000\",\r\n    \"bankAgencyCode\": \"1234\",\r\n    \"bankAccountNumber\": \"123456-7\",\r\n    \"beneficiaryName\": \"Jo\u00e3o da Silva\",\r\n    \"beneficiaryDocumentCode\": \"123.456.789-00\",\r\n    \"financialNatureName\": \"Cr\u00e9dito\",\r\n    \"freeFieldDescription\": \"Transfer\u00eancia recebida\"\r\n  }\r\n],\r\n\"links\": {\r\n  \"self\": \"\/api\/settlements\/v1\/public\/statements\/pix?page=1&startDate=2025-04-01T00:00:00&accountNumber=1234567890123&endDate=2025-04-28T00:00:00&page-size=2\",\r\n  \"first\": \"\/api\/settlements\/v1\/public\/statements\/pix?page=1&startDate=2025-04-01T00:00:00&accountNumber=1234567890123&endDate=2025-04-28T00:00:00&page-size=2\",\r\n  \"prev\": \"\/api\/settlements\/v1\/public\/statements\/pix?page=1&startDate=2025-04-01T00:00:00&accountNumber=1234567890123&endDate=2025-04-28T00:00:00&page-size=2\",\r\n  \"next\": \"\/api\/settlements\/v1\/public\/statements\/pix?page=2&startDate=2025-04-01T00:00:00&accountNumber=1234567890123&endDate=2025-04-28T00:00:00&page-size=2\",\r\n  \"last\": \"\/api\/settlements\/v1\/public\/statements\/pix?page=7&startDate=2025-04-01T00:00:00&accountNumber=1234567890123&endDate=2025-04-28T00:00:00&page-size=2\"\r\n},\r\n\"meta\": {\r\n  \"totalPages\": 7,\r\n  \"totalRecords\": 13\r\n}\r\n```\r\n\r\n<\/details><br>\r\n<details style=\"margin-left: 20px;\">\r\n<summary><b>Solicita\u00e7\u00e3o de Pagamento PIX (QR Code)<\/b><\/summary><br>\r\n\r\nSolicita\u00e7\u00e3o de Pagamento PIX\r\n\r\n```json\r\nPOST \/api\/settlements\/v1\/public\/payment\/qrcode\r\n\r\n**Requisi\u00e7\u00e3o:**\r\n\r\n{\r\n  \"data\": {\r\n    \"referenceCode\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n    \"pixKey\": \"joao.silva@banco.com\",\r\n    \"amount\": 150.75,\r\n    \"expirationDateTime\": \"2025-04-30T23:59:59\",\r\n    \"history\": \"Pagamento de servi\u00e7os\",\r\n    \"notificationUrl\": \"https:\/\/meusistema.com\/notificacoes\"\r\n  }\r\n}\r\n\r\n**Resposta**\r\n\r\n{\r\n  \"data\": {\r\n    \"requestCode\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n    \"referenceCode\": \"abc123\",\r\n    \"txId\": \"abcdefghi1234567890jklmnopqrs\",\r\n    \"creationDate\": \"2025-04-28T14:30:00\",\r\n    \"status\": \"PENDING\",\r\n    \"amount\": 150.75,\r\n    \"client\": {\r\n      \"clientName\": \"Jo\u00e3o da Silva\",\r\n      \"emailName\": \"joao.silva@email.com\",\r\n      \"documentCode\": \"12345678901\",\r\n      \"clientPhone\": {\r\n        \"countryCode\": \"55\",\r\n        \"phoneAreaCode\": \"11\",\r\n        \"phoneNumber\": \"987654321\",\r\n        \"phoneTypeCode\": \"MOBILE\"\r\n      }\r\n    },\r\n    \"qrCode\": {\r\n      \"copyAndPasteText\": \"00020101021226820014br.gov.bcb.pix2573qrcodes-pix.com.br\/qr\/v2\/12345678901234567890123456789052040000530398654041.005802BR5913Jo\u00e3o da Silva6009Sao Paulo62070503***63041D3B\",\r\n      \"image\": {\r\n        \"imagePng\": {\r\n          \"pngHref\": \"https:\/\/example.com\/qrcode.png\",\r\n          \"pngFormat\": \"image\/png\",\r\n          \"pngRequestMethod\": \"GET\"\r\n        },\r\n        \"imageBase64\": {\r\n          \"base64Href\": \"https:\/\/example.com\/qrcode-base64\",\r\n          \"base64Format\": \"image\/png\",\r\n          \"base64RequestMethod\": \"GET\"\r\n        }\r\n      }\r\n    },\r\n    \"paymentMethod\": {\r\n      \"endToEndId\": \"E123456789012345678901234567890\",\r\n      \"holder\": {\r\n        \"holderName\": \"Jo\u00e3o da Silva\",\r\n        \"holderDocumentCode\": \"12345678901\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n<\/details><br>\r\n<details style=\"margin-left: 20px;\">\r\n<summary><b>Solicita\u00e7\u00e3o de Pagamento PIX (QR Code em Base64)<\/b><\/summary><br>\r\n\r\nObt\u00e9m o QrCode no formato base64 para pagamento via pix.\r\n\r\n```json\r\nGET \/public\/payment\/qrcode\/{requestCode}\/base-code\r\n\r\n**Requisi\u00e7\u00e3o:**\r\n\r\nGET \/public\/payment\/qrcode\/123e4567-e89b-12d3-a456-426614174000\/base-code\r\n\r\n**Resposta:**\r\n\r\n{\r\n  \"data\": {\r\n    \"base64QrCode\": \"iVBORw0KGgoAAAANSUhEUgA4JgGGBAkeyUYIo...\"\r\n  }\r\n}\r\n```\r\n<\/details><br>\r\n<details style=\"margin-left: 20px;\">\r\n<summary><b>Consulta Solicita\u00e7\u00e3o de QrCode Pix<\/b><\/summary><br>\r\n\r\nConsulta os detalhes completos de uma solicita\u00e7\u00e3o de QrCode Pix j\u00e1 criada, incluindo status, valor, cliente, m\u00e9todo de pagamento e dados do QrCode.\r\n\r\n```json\r\nGET \/public\/payment\/qrcode\/{requestCode}\r\n\r\n**Requisi\u00e7\u00e3o:**\r\n\r\nGET \/public\/payment\/qrcode\/123e4567-e89b-12d3-a456-426614174000\r\nAccept: application\/json\r\n\r\n**Resposta:*\r\n\r\n{\r\n  \"data\": {\r\n    \"requestCode\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n    \"referenceCode\": \"abc123\",\r\n    \"txId\": \"abcdefghi1234567890jklmnopqrs\",\r\n    \"creationDate\": \"2025-04-28T14:30:00\",\r\n    \"status\": \"PENDING\",\r\n    \"amount\": 150.75,\r\n    \"client\": {\r\n      \"clientName\": \"Jo\u00e3o da Silva\",\r\n      \"emailName\": \"joao.silva@email.com\",\r\n      \"documentCode\": \"12345678901\",\r\n      \"clientPhone\": {\r\n        \"countryCode\": \"55\",\r\n        \"phoneAreaCode\": \"11\",\r\n        \"phoneNumber\": \"987654321\",\r\n        \"phoneTypeCode\": \"MOBILE\"\r\n      }\r\n    },\r\n    \"qrCode\": {\r\n      \"copyAndPasteText\": \"00020101021226820014br.gov.bcb.pix2573qrcodes-pix.com.br\/qr\/v2\/12345678901234567890123456789052040000530398654041.005802BR5913Jo\u00e3o da Silva6009Sao Paulo62070503***63041D3B\",\r\n      \"image\": {\r\n        \"imagePng\": {\r\n          \"pngHref\": \"https:\/\/example.com\/qrcode.png\",\r\n          \"pngFormat\": \"image\/png\",\r\n          \"pngRequestMethod\": \"GET\"\r\n        },\r\n        \"imageBase64\": {\r\n          \"base64Href\": \"https:\/\/example.com\/qrcode-base64\",\r\n          \"base64Format\": \"image\/png\",\r\n          \"base64RequestMethod\": \"GET\"\r\n        }\r\n      }\r\n    },\r\n    \"paymentMethod\": {\r\n      \"endToEndId\": \"E123456789012345678901234567890\",\r\n      \"holder\": {\r\n        \"holderName\": \"Jo\u00e3o da Silva\",\r\n        \"holderDocumentCode\": \"12345678901\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n<\/details><br>\r\n<details style=\"margin-left: 20px;\">\r\n<summary><b>Solicita\u00e7\u00e3o de Devolu\u00e7\u00e3o PIX<\/b><\/summary><br>\r\n\r\nSolicita a devolu\u00e7\u00e3o de um pagamento Pix j\u00e1 realizado, informando o valor a ser devolvido.\r\n\r\n```json\r\nPUT \/public\/refund\/qrcode\/{requestCode}\r\n\r\n**Requisi\u00e7\u00e3o:**\r\n\r\n{\r\n  \"data\": {\r\n    \"refundAmount\": 150.75\r\n  }\r\n}\r\n\r\n**Resposta:**\r\n\r\n{\r\n  \"data\": {\r\n    \"refundId\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n    \"refundStatusCode\": \"COMPLETED\",\r\n    \"refundAmount\": 150.75,\r\n    \"refundDate\": \"2025-04-28T14:30:00\",\r\n    \"refundDescription\": \"Devolu\u00e7\u00e3o de pagamento duplicado\"\r\n  }\r\n}\r\n```\r\n\r\n<\/details><br>\r\n<details style=\"margin-left: 20px;\">\r\n<summary><b>Consultar Solicita\u00e7\u00e3o de Devolu\u00e7\u00e3o PIX<\/b><\/summary><br>\r\n\r\nConsulta os detalhes de uma devolu\u00e7\u00e3o Pix j\u00e1 solicitada, retornando todas as informa\u00e7\u00f5es da solicita\u00e7\u00e3o de devolu\u00e7\u00e3o.\r\n\r\n```json\r\nGET \/public\/refund\/qrcode?refundId={refundId}\r\n\r\n**Requisi\u00e7\u00e3o:**\r\n\r\nGET \/public\/refund\/qrcode?refundId=123e4567-e89b-12d3-a456-426614174000\r\n\r\n**Resposta:**\r\n\r\n{\r\n  \"data\": {\r\n    \"refundId\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n    \"refundStatusCode\": \"COMPLETED\",\r\n    \"refundAmount\": 150.75,\r\n    \"refundDate\": \"2025-04-28T14:30:00\",\r\n    \"refundDescription\": \"Devolu\u00e7\u00e3o de pagamento duplicado\"\r\n  }\r\n}\r\n```\r\n\r\n<\/details><br>\r\n<\/details><br>\r\n \r\n<details><summary><b>Host<\/b><\/summary><br\/><p>\r\n\r\n**Acesso por meio da Internet:**\r\n\r\n- Certifica\u00e7\u00e3o: https:\/\/api-hom.bancob3.com.br\r\n- Produ\u00e7\u00e3o: https:\/\/api.bancob3.com.br\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Modelo de Autentica\u00e7\u00e3o<\/b><\/summary><br\/><p>\r\n\r\nSegue o [Modelo de Autentica\u00e7\u00e3o](\/index.php?option=com_content&view=article&id=62) utilizado.\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Changelog<\/b><\/summary><br\/><p>\r\n\r\n<table border=\"1\">\r\n    <tr>\r\n        <th style=\"padding:10px;background-color:#003475;color:white;text-align:center\"><b>Publica\u00e7\u00e3o<\/th>\r\n        <th style=\"padding:10px;background-color:#003475;color:white;text-align:center\"><b>Certifica\u00e7\u00e3o<\/th>\r\n        <th style=\"padding:10px;background-color:#003475;color:white;text-align:center\"><b>Produ\u00e7\u00e3o<\/th>\r\n        <th style=\"padding:10px;background-color:#003475;color:white;text-align:center\"><b>Vers\u00e3o<\/th>\r\n        <th style=\"padding:10px;background-color:#003475;color:white;text-align:left\"><b>Descri\u00e7\u00e3o<\/th>\r\n     <\/tr>\r\n    <tr>\r\n        <td style=\"padding:10px;color:#666E7A;text-align:center\";WIDTH=\"46%\" VALIGN=\"TOP\">25\/06\/2025<\/td>\r\n        <td style=\"padding:10px;color:#666E7A;text-align:center\";WIDTH=\"46%\" VALIGN=\"TOP\">04\/02\/2025<\/td>\r\n        <td style=\"padding:10px;color:#666E7A;text-align:center\";WIDTH=\"46%\" VALIGN=\"TOP\">25\/06\/2025<\/td>\r\n         <td nowrap style=\"padding:10px;color:#40444D;text-align:center\";WIDTH=\"100%\" VALIGN=\"TOP\"><b>v1.0.0-rc1<\/td>\r\n         <td style=\"padding:10px;color:#40444D\" ><b>Vers\u00e3o Inicial<\/b>\r\n             <br>\u2022 Consulta Saldos\r\n             <br>- Veja o exemplo de payload no menu Exemplos de Payloads, cen\u00e1rio \"Consulta Saldos\" \r\n             <br>\u2022 Consulta Extrato Pix\r\n             <br>- Veja o exemplo de payload no menu Exemplos de Payloads, cen\u00e1rio \"Consulta Extrato Pix\"\r\n          <\/td>\r\n    <\/tr>\r\n    <tr>\r\n        <td style=\"padding:10px;color:#666E7A;text-align:center\";WIDTH=\"46%\" VALIGN=\"TOP\">23\/01\/2026<\/td>\r\n        <td style=\"padding:10px;color:#666E7A;text-align:center\";WIDTH=\"46%\" VALIGN=\"TOP\">01\/12\/2025<\/td>\r\n        <td style=\"padding:10px;color:#666E7A;text-align:center\";WIDTH=\"46%\" VALIGN=\"TOP\">12\/12\/2025<\/td>\r\n        <td nowrap style=\"padding:10px;color:#40444D;text-align:center\";WIDTH=\"100%\" VALIGN=\"TOP\"><b>v1.0.0-rc8<\/td>\r\n        <td style=\"padding:10px;color:#40444D\" ><b>Vers\u00e3o QrCode<\/b>\r\n             <br>\u2022 Solicita\u00e7\u00e3o e consulta de Pagamento\r\n             <br>- Exemplos de payload no menu Exemplos de Payloads \r\n             <br>\u2022 Solicita\u00e7\u00e3o e consulta de Devolu\u00e7\u00e3o de pagamento efetivado\r\n             <br>- Veja o exemplo de payload no menu Exemplos de Payloads\r\n          <\/td>\r\n    <\/tr>\r\n  <\/table>\r\n\r\n\r\n","deprecated":false,"apiVersion":"1.0.0-rc8","swaggerVersion":"1.1","basePath":"https:\/\/developers.b3.com.br:8065","resourcePath":"\/api\/settlements\/v1","models":{"QrCodeFileResultResponseData":{"required":["data","links"],"type":"object","properties":{"links":{"required":["self"],"type":"object","properties":{"self":{"maxLength":2000,"type":"string","description":"Link para a p\u00e1gina atual.","example":"cabixynkiczkjbtxqxdwtknsmwooivwaqucxlzwhgxvzfekegd","exampleSetFlag":true},"first":{"maxLength":2000,"type":"string","description":"Link para a primeira p\u00e1gina.","example":"cdkdwwhqyxvarpjzsptdmrvatuozvcurttjozaagtoixzqhjil","exampleSetFlag":true},"prev":{"maxLength":2000,"type":"string","description":"Link para a p\u00e1gina anterior.","example":"hvgnycctvjxgarugnivnichxjmjpuhdeklbwqcwrvpndpwjimb","exampleSetFlag":true},"next":{"maxLength":2000,"type":"string","description":"Link para a pr\u00f3xima p\u00e1gina.","example":"jgwhxykdayhamnkjdwxwxcrjkhozgjxqcegetjdyffyyssoyug","exampleSetFlag":true},"last":{"maxLength":2000,"type":"string","description":"Link para a \u00faltima p\u00e1gina.","example":"wiaaclaattjcpwyvlafzniotzfcvjjdomcoqfyfoesyatcsbqd","exampleSetFlag":true}},"exampleSetFlag":false},"data":{"required":["contentType","fileContents","fileDownloadName"],"type":"object","properties":{"fileContents":{"type":"string","description":"Conte\u00fado do arquivo","format":"binary","exampleSetFlag":false},"contentType":{"maxLength":50,"minLength":1,"type":"string","description":"Tipo de conte\u00fado do arquivo","example":"image\/png","exampleSetFlag":true},"fileDownloadName":{"maxLength":100,"minLength":1,"type":"string","description":"Nome do arquivo","example":"qrcode.png","exampleSetFlag":true}},"description":"Representa o resultado de um arquivo de QR Code.","exampleSetFlag":false}},"exampleSetFlag":false},"WebhookPixResult":{"required":["privateKeyCode"],"type":"object","properties":{"privateKeyCode":{"maxLength":1000,"minLength":1,"type":"string","description":"Chave privada RSA do cliente.","example":"-----BEGIN PRIVATE KEY-----\\\\nMIIEpgIBAAKCAQEA7v8k1k2k3k4k5k6k\\\\nk7k8k9k0k1k2k3k4k5k6k7k8k9k0k1k\\\\nk2k3k4k5k6k7k8k9k0k1k2k3k4k5k6k\\\\n-----END PRIVATE KEY-----","exampleSetFlag":true}},"exampleSetFlag":false},"Meta":{"required":["totalPages","totalRecords"],"type":"object","properties":{"totalPages":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"N\u00famero total de p\u00e1ginas.","format":"int32","example":100,"exampleSetFlag":true},"totalRecords":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"N\u00famero total de registros.","format":"int32","example":100,"exampleSetFlag":true}},"exampleSetFlag":false},"Base64":{"required":["base64Format","base64Href","base64RequestMethod"],"type":"object","properties":{"base64Href":{"maxLength":250,"minLength":1,"type":"string","description":"Link para baixar a imagem em Base64.","example":"https:\/\/example.com\/qrcode-base64","exampleSetFlag":true},"base64Format":{"maxLength":250,"minLength":1,"type":"string","description":"Formato da imagem.","example":"image\/png","exampleSetFlag":true},"base64RequestMethod":{"maxLength":250,"minLength":1,"type":"string","description":"M\u00e9todo de gera\u00e7\u00e3o do QR Code.","example":"GET","exampleSetFlag":true}},"description":"Representa o QR Code em formato Base64.","exampleSetFlag":false},"Base64Result":{"required":["base64QrCode"],"type":"object","properties":{"base64QrCode":{"maxLength":200000,"minLength":1,"type":"string","description":"Campo com o QrCode em base64","format":"binary","exampleSetFlag":false}},"exampleSetFlag":false},"Png":{"required":["pngFormat","pngHref","pngRequestMethod"],"type":"object","properties":{"pngHref":{"maxLength":250,"minLength":1,"type":"string","description":"Link para baixar a imagem em PNG.","example":"https:\/\/example.com\/qrcode.png","exampleSetFlag":true},"pngFormat":{"maxLength":250,"minLength":1,"type":"string","description":"Formato da imagem.","example":"image\/png","exampleSetFlag":true},"pngRequestMethod":{"maxLength":250,"minLength":1,"type":"string","description":"M\u00e9todo de gera\u00e7\u00e3o do QR Code.","example":"GET","exampleSetFlag":true}},"description":"Representa o QR Code em formato PNG.","exampleSetFlag":false},"QrCodeResultResponsePost":{"required":["data"],"type":"object","properties":{"data":{"required":["amount","creationDate","referenceCode","requestCode","status"],"type":"object","properties":{"requestCode":{"type":"string","description":"C\u00f3digo da solicita\u00e7\u00e3o.","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","exampleSetFlag":true},"referenceCode":{"maxLength":36,"minLength":1,"type":"string","description":"C\u00f3digo de refer\u00eancia da transa\u00e7\u00e3o.","example":"abc123","exampleSetFlag":true},"txId":{"maxLength":35,"minLength":26,"type":"string","description":"Identificador da Transa\u00e7\u00e3o de uma cobran\u00e7a Pix.","example":"abcdefghi1234567890jklmnopqrs","exampleSetFlag":true},"creationDate":{"type":"string","description":"Data e hora em que o pedido foi criado. (Formato : YYYY-MM-DDTHH:MM:SSZ)","format":"date-time","exampleSetFlag":false},"status":{"maxLength":32,"minLength":1,"type":"string","description":"Status da transa\u00e7\u00e3o = PENDING COMPLETED CANCELLED.","example":"PENDING","exampleSetFlag":true},"amount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor da transa\u00e7\u00e3o.","format":"double","example":150.75,"exampleSetFlag":true},"client":{"required":["clientName","documentCode"],"type":"object","properties":{"clientName":{"maxLength":250,"type":"string","description":"Nome completo do cliente.","example":"Jo\u00e3o da Silva","exampleSetFlag":true},"emailName":{"maxLength":250,"minLength":1,"type":"string","description":"Endere\u00e7o de e-mail do cliente.","example":"joao.silva@email.com","exampleSetFlag":true},"documentCode":{"maxLength":14,"minLength":1,"type":"string","description":"Documento do cliente (CPF ou CNPJ) sem formata\u00e7\u00e3o.","example":"12345678901","exampleSetFlag":true},"clientPhone":{"type":"object","properties":{"countryCode":{"maxLength":3,"type":"string","description":"C\u00f3digo do pa\u00eds para telefone.","example":"55","exampleSetFlag":true},"phoneAreaCode":{"maxLength":3,"type":"string","description":"C\u00f3digo de \u00e1rea telef\u00f4nica.","example":"11","exampleSetFlag":true},"phoneNumber":{"maxLength":20,"type":"string","description":"N\u00famero do telefone.","example":"987654321","exampleSetFlag":true},"phoneTypeCode":{"maxLength":10,"pattern":"^(MOBILE|LANDLINE)$","type":"string","description":"Tipo de telefone.","example":"MOBILE","exampleSetFlag":true}},"description":"Telefone do cliente.","exampleSetFlag":false}},"description":"Representa um cliente associado ao QR Code.","exampleSetFlag":false},"qrCode":{"required":["copyAndPasteText","image"],"type":"object","properties":{"copyAndPasteText":{"maxLength":250,"minLength":1,"type":"string","description":"C\u00f3digo que pode ser copiado e colado para realizar a transa\u00e7\u00e3o.","example":"00020101021226820014br.gov.bcb.pix2573qrcodes-pix.com.br\/qr\/v2\/12345678901234567890123456789052040000530398654041.005802BR5913Jo\u00e3o da Silva6009Sao Paulo62070503***63041D3B","exampleSetFlag":true},"image":{"required":["imageBase64","imagePng"],"type":"object","properties":{"imagePng":{"required":["pngFormat","pngHref","pngRequestMethod"],"type":"object","properties":{"pngHref":{"maxLength":250,"minLength":1,"type":"string","description":"Link para baixar a imagem em PNG.","example":"https:\/\/example.com\/qrcode.png","exampleSetFlag":true},"pngFormat":{"maxLength":250,"minLength":1,"type":"string","description":"Formato da imagem.","example":"image\/png","exampleSetFlag":true},"pngRequestMethod":{"maxLength":250,"minLength":1,"type":"string","description":"M\u00e9todo de gera\u00e7\u00e3o do QR Code.","example":"GET","exampleSetFlag":true}},"description":"Representa o QR Code em formato PNG.","exampleSetFlag":false},"imageBase64":{"required":["base64Format","base64Href","base64RequestMethod"],"type":"object","properties":{"base64Href":{"maxLength":250,"minLength":1,"type":"string","description":"Link para baixar a imagem em Base64.","example":"https:\/\/example.com\/qrcode-base64","exampleSetFlag":true},"base64Format":{"maxLength":250,"minLength":1,"type":"string","description":"Formato da imagem.","example":"image\/png","exampleSetFlag":true},"base64RequestMethod":{"maxLength":250,"minLength":1,"type":"string","description":"M\u00e9todo de gera\u00e7\u00e3o do QR Code.","example":"GET","exampleSetFlag":true}},"description":"Representa o QR Code em formato Base64.","exampleSetFlag":false}},"description":"Representa a imagem do QR Code em diferentes formatos.","exampleSetFlag":false}},"description":"Representa um QR Code utilizado para transa\u00e7\u00f5es financeiras.","exampleSetFlag":false},"paymentMethod":{"type":"object","properties":{"endToEndId":{"maxLength":250,"type":"string","description":"Identificador \u00fanico do pagamento (End to End).","example":"E123456789012345678901234567890","exampleSetFlag":true},"holder":{"type":"object","properties":{"holderName":{"maxLength":250,"type":"string","description":"Nome do respons\u00e1vel pelo pagamento.","example":"Jo\u00e3o da Silva","exampleSetFlag":true},"holderDocumentCode":{"maxLength":250,"type":"string","description":"Documento do respons\u00e1vel pelo pagamento (CPF ou CNPJ).","example":"12345678901","exampleSetFlag":true}},"description":"Representa o benefici\u00e1rio do pagamento.","exampleSetFlag":false}},"description":"Representa o m\u00e9todo de pagamento utilizado.","exampleSetFlag":false}},"exampleSetFlag":false}},"exampleSetFlag":false},"Image":{"required":["imageBase64","imagePng"],"type":"object","properties":{"imagePng":{"required":["pngFormat","pngHref","pngRequestMethod"],"type":"object","properties":{"pngHref":{"maxLength":250,"minLength":1,"type":"string","description":"Link para baixar a imagem em PNG.","example":"https:\/\/example.com\/qrcode.png","exampleSetFlag":true},"pngFormat":{"maxLength":250,"minLength":1,"type":"string","description":"Formato da imagem.","example":"image\/png","exampleSetFlag":true},"pngRequestMethod":{"maxLength":250,"minLength":1,"type":"string","description":"M\u00e9todo de gera\u00e7\u00e3o do QR Code.","example":"GET","exampleSetFlag":true}},"description":"Representa o QR Code em formato PNG.","exampleSetFlag":false},"imageBase64":{"required":["base64Format","base64Href","base64RequestMethod"],"type":"object","properties":{"base64Href":{"maxLength":250,"minLength":1,"type":"string","description":"Link para baixar a imagem em Base64.","example":"https:\/\/example.com\/qrcode-base64","exampleSetFlag":true},"base64Format":{"maxLength":250,"minLength":1,"type":"string","description":"Formato da imagem.","example":"image\/png","exampleSetFlag":true},"base64RequestMethod":{"maxLength":250,"minLength":1,"type":"string","description":"M\u00e9todo de gera\u00e7\u00e3o do QR Code.","example":"GET","exampleSetFlag":true}},"description":"Representa o QR Code em formato Base64.","exampleSetFlag":false}},"description":"Representa a imagem do QR Code em diferentes formatos.","exampleSetFlag":false},"PublicWebhookPixKeyRspPost":{"required":["data"],"type":"object","properties":{"data":{"required":["privateKeyCode"],"type":"object","properties":{"privateKeyCode":{"maxLength":1000,"minLength":1,"type":"string","description":"Chave privada RSA do cliente.","example":"-----BEGIN PRIVATE KEY-----\\\\nMIIEpgIBAAKCAQEA7v8k1k2k3k4k5k6k\\\\nk7k8k9k0k1k2k3k4k5k6k7k8k9k0k1k\\\\nk2k3k4k5k6k7k8k9k0k1k2k3k4k5k6k\\\\n-----END PRIVATE KEY-----","exampleSetFlag":true}},"exampleSetFlag":false}},"exampleSetFlag":false},"QrCode":{"required":["copyAndPasteText","image"],"type":"object","properties":{"copyAndPasteText":{"maxLength":250,"minLength":1,"type":"string","description":"C\u00f3digo que pode ser copiado e colado para realizar a transa\u00e7\u00e3o.","example":"00020101021226820014br.gov.bcb.pix2573qrcodes-pix.com.br\/qr\/v2\/12345678901234567890123456789052040000530398654041.005802BR5913Jo\u00e3o da Silva6009Sao Paulo62070503***63041D3B","exampleSetFlag":true},"image":{"required":["imageBase64","imagePng"],"type":"object","properties":{"imagePng":{"required":["pngFormat","pngHref","pngRequestMethod"],"type":"object","properties":{"pngHref":{"maxLength":250,"minLength":1,"type":"string","description":"Link para baixar a imagem em PNG.","example":"https:\/\/example.com\/qrcode.png","exampleSetFlag":true},"pngFormat":{"maxLength":250,"minLength":1,"type":"string","description":"Formato da imagem.","example":"image\/png","exampleSetFlag":true},"pngRequestMethod":{"maxLength":250,"minLength":1,"type":"string","description":"M\u00e9todo de gera\u00e7\u00e3o do QR Code.","example":"GET","exampleSetFlag":true}},"description":"Representa o QR Code em formato PNG.","exampleSetFlag":false},"imageBase64":{"required":["base64Format","base64Href","base64RequestMethod"],"type":"object","properties":{"base64Href":{"maxLength":250,"minLength":1,"type":"string","description":"Link para baixar a imagem em Base64.","example":"https:\/\/example.com\/qrcode-base64","exampleSetFlag":true},"base64Format":{"maxLength":250,"minLength":1,"type":"string","description":"Formato da imagem.","example":"image\/png","exampleSetFlag":true},"base64RequestMethod":{"maxLength":250,"minLength":1,"type":"string","description":"M\u00e9todo de gera\u00e7\u00e3o do QR Code.","example":"GET","exampleSetFlag":true}},"description":"Representa o QR Code em formato Base64.","exampleSetFlag":false}},"description":"Representa a imagem do QR Code em diferentes formatos.","exampleSetFlag":false}},"description":"Representa um QR Code utilizado para transa\u00e7\u00f5es financeiras.","exampleSetFlag":false},"SolicitarDevolucaoRequest":{"required":["refundAmount"],"type":"object","properties":{"refundAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor a ser devolvido","format":"double","example":150.75,"exampleSetFlag":true}},"description":"Classe de requisi\u00e7\u00e3o da solicita\u00e7\u00e3o de QrCode","exampleSetFlag":false},"PixStatementResultIEnumerableResponseGet":{"required":["data","links"],"type":"object","properties":{"data":{"type":"array","exampleSetFlag":false,"items":{"type":"object","properties":{"pixKeyCode":{"maxLength":250,"minLength":1,"type":"string","description":"C\u00f3digo Chave Pix utilizada para identificar a transa\u00e7\u00e3o.","example":"123e4567-e89b-12d3-a456-426614174000","exampleSetFlag":true},"endToEndCode":{"maxLength":250,"type":"string","description":"C\u00f3digo EndToEnd que identifica unicamente a transa\u00e7\u00e3o no sistema do banco.","example":"E1234567890123456789012345678901","exampleSetFlag":true},"transactionDate":{"type":"string","description":"Data em que a transa\u00e7\u00e3o foi realizada. (Formato : YYYY-MM-DDTHH:MM:SSZ)","format":"date-time","exampleSetFlag":false},"transactionDescription":{"maxLength":250,"type":"string","description":"Descri\u00e7\u00e3o detalhada da transa\u00e7\u00e3o.","example":"Pagamento de fatura","exampleSetFlag":true},"refundIndicator":{"type":"boolean","description":"Indicador que mostra se a transa\u00e7\u00e3o \u00e9 uma devolu\u00e7\u00e3o.","example":true,"exampleSetFlag":true},"eligibleForRefundIndicator":{"type":"boolean","description":"Indicador que mostra se a transa\u00e7\u00e3o \u00e9 eleg\u00edvel para devolu\u00e7\u00e3o.","example":false,"exampleSetFlag":true},"originalEndToEndCode":{"maxLength":250,"type":"string","description":"C\u00f3digo EndToEnd original da transa\u00e7\u00e3o em caso de devolu\u00e7\u00e3o.","example":"E0987654321098765432109876543210","exampleSetFlag":true},"transactionAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor monet\u00e1rio da transa\u00e7\u00e3o.","format":"double","example":150.75,"exampleSetFlag":true},"refundAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor monet\u00e1rio da devolu\u00e7\u00e3o, se aplic\u00e1vel.","format":"double","example":50.25,"exampleSetFlag":true},"bankName":{"maxLength":250,"type":"string","description":"Nome do banco envolvido na transa\u00e7\u00e3o.","example":"Banco do Brasil","exampleSetFlag":true},"bankIspbCode":{"maxLength":50,"type":"string","description":"C\u00f3digo ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.","example":"00000000","exampleSetFlag":true},"bankAgencyCode":{"maxLength":50,"type":"string","description":"C\u00f3digo da ag\u00eancia banc\u00e1ria onde a conta est\u00e1 registrada.","example":"1234","exampleSetFlag":true},"bankAccountNumber":{"maxLength":50,"type":"string","description":"N\u00famero da conta banc\u00e1ria associada \u00e0 transa\u00e7\u00e3o.","example":"123456-7","exampleSetFlag":true},"beneficiaryName":{"maxLength":250,"type":"string","description":"Nome do favorecido pela transa\u00e7\u00e3o.","example":"Jo\u00e3o da Silva","exampleSetFlag":true},"beneficiaryDocumentCode":{"maxLength":50,"type":"string","description":"N\u00famero do documento de identifica\u00e7\u00e3o do favorecido.","example":"123.456.789-00","exampleSetFlag":true},"financialNatureName":{"maxLength":250,"type":"string","description":"Natureza ou prop\u00f3sito da opera\u00e7\u00e3o financeira. D\u00e9bito, cr\u00e9dito, etc.","example":"Cr\u00e9dito","exampleSetFlag":true},"freeFieldDescription":{"maxLength":500,"type":"string","description":"Campo livre para informa\u00e7\u00f5es adicionais sobre a transa\u00e7\u00e3o.","example":"Pagamento referente ao m\u00eas de abril","exampleSetFlag":true},"qrRequestCode":{"type":"string","description":"C\u00f3digo da solicita\u00e7\u00e3o de pagamento via QrCode","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","exampleSetFlag":true},"qrReferenceCode":{"maxLength":36,"type":"string","description":"C\u00f3digo de refer\u00eancia da solicita\u00e7\u00e3o de pagamento via QrCode.","example":"abc123","exampleSetFlag":true}},"exampleSetFlag":false}},"links":{"required":["self"],"type":"object","properties":{"self":{"maxLength":2000,"type":"string","description":"Link para a p\u00e1gina atual.","example":"cabixynkiczkjbtxqxdwtknsmwooivwaqucxlzwhgxvzfekegd","exampleSetFlag":true},"first":{"maxLength":2000,"type":"string","description":"Link para a primeira p\u00e1gina.","example":"cdkdwwhqyxvarpjzsptdmrvatuozvcurttjozaagtoixzqhjil","exampleSetFlag":true},"prev":{"maxLength":2000,"type":"string","description":"Link para a p\u00e1gina anterior.","example":"hvgnycctvjxgarugnivnichxjmjpuhdeklbwqcwrvpndpwjimb","exampleSetFlag":true},"next":{"maxLength":2000,"type":"string","description":"Link para a pr\u00f3xima p\u00e1gina.","example":"jgwhxykdayhamnkjdwxwxcrjkhozgjxqcegetjdyffyyssoyug","exampleSetFlag":true},"last":{"maxLength":2000,"type":"string","description":"Link para a \u00faltima p\u00e1gina.","example":"wiaaclaattjcpwyvlafzniotzfcvjjdomcoqfyfoesyatcsbqd","exampleSetFlag":true}},"exampleSetFlag":false},"meta":{"required":["totalPages","totalRecords"],"type":"object","properties":{"totalPages":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"N\u00famero total de p\u00e1ginas.","format":"int32","example":100,"exampleSetFlag":true},"totalRecords":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"N\u00famero total de registros.","format":"int32","example":100,"exampleSetFlag":true}},"exampleSetFlag":false}},"exampleSetFlag":false},"Phone":{"type":"object","properties":{"countryCode":{"maxLength":3,"type":"string","description":"C\u00f3digo do pa\u00eds para telefone.","example":"55","exampleSetFlag":true},"phoneAreaCode":{"maxLength":3,"type":"string","description":"C\u00f3digo de \u00e1rea telef\u00f4nica.","example":"11","exampleSetFlag":true},"phoneNumber":{"maxLength":20,"type":"string","description":"N\u00famero do telefone.","example":"987654321","exampleSetFlag":true},"phoneTypeCode":{"maxLength":10,"pattern":"^(MOBILE|LANDLINE)$","type":"string","description":"Tipo de telefone.","example":"MOBILE","exampleSetFlag":true}},"description":"Telefone do cliente.","exampleSetFlag":false},"QrCodeResultResponseData":{"required":["data","links"],"type":"object","properties":{"links":{"required":["self"],"type":"object","properties":{"self":{"maxLength":2000,"type":"string","description":"Link para a p\u00e1gina atual.","example":"cabixynkiczkjbtxqxdwtknsmwooivwaqucxlzwhgxvzfekegd","exampleSetFlag":true},"first":{"maxLength":2000,"type":"string","description":"Link para a primeira p\u00e1gina.","example":"cdkdwwhqyxvarpjzsptdmrvatuozvcurttjozaagtoixzqhjil","exampleSetFlag":true},"prev":{"maxLength":2000,"type":"string","description":"Link para a p\u00e1gina anterior.","example":"hvgnycctvjxgarugnivnichxjmjpuhdeklbwqcwrvpndpwjimb","exampleSetFlag":true},"next":{"maxLength":2000,"type":"string","description":"Link para a pr\u00f3xima p\u00e1gina.","example":"jgwhxykdayhamnkjdwxwxcrjkhozgjxqcegetjdyffyyssoyug","exampleSetFlag":true},"last":{"maxLength":2000,"type":"string","description":"Link para a \u00faltima p\u00e1gina.","example":"wiaaclaattjcpwyvlafzniotzfcvjjdomcoqfyfoesyatcsbqd","exampleSetFlag":true}},"exampleSetFlag":false},"data":{"required":["refundAmount","refundDate","refundId","refundStatusCode"],"type":"object","properties":{"refundId":{"type":"string","description":"C\u00f3digo \u00fanico que identifica a solicita\u00e7\u00e3o de devolu\u00e7\u00e3o. Deve ser um GUID v\u00e1lido.","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","exampleSetFlag":true},"refundStatusCode":{"maxLength":32,"minLength":1,"type":"string","description":"Status da devolu\u00e7\u00e3o = PENDING COMPLETED CANCELLED.","example":"COMPLETED","exampleSetFlag":true},"refundAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor devolvido.","format":"double","example":150.75,"exampleSetFlag":true},"refundDate":{"type":"string","description":"Data e hora em que a devolu\u00e7\u00e3o foi realizada. (Formato : YYYY-MM-DDTHH:MM:SSZ)","format":"date-time","exampleSetFlag":false},"refundDescription":{"maxLength":250,"type":"string","description":"Descri\u00e7\u00e3o da devolu\u00e7\u00e3o.","example":"Devolu\u00e7\u00e3o de pagamento duplicado","exampleSetFlag":true}},"description":"Classe de retorno\/resultado da solicita\u00e7\u00e3o de devolu\u00e7\u00e3o de pagamento.","exampleSetFlag":false}},"exampleSetFlag":false},"BankAccountBalanceResult":{"type":"object","properties":{"accountHolderName":{"maxLength":250,"type":"string","description":"Nome completo do titular da conta banc\u00e1ria.","example":"Jo\u00e3o da Silva","exampleSetFlag":true},"totalBalanceAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Saldo total da conta banc\u00e1ria, incluindo todos os valores dispon\u00edveis e bloqueados.","format":"double","example":1500.75,"exampleSetFlag":true},"blockedBalanceAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Saldo bloqueado da conta banc\u00e1ria, que n\u00e3o est\u00e1 dispon\u00edvel para uso imediato.","format":"double","example":500,"exampleSetFlag":true},"availableBalanceAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Saldo dispon\u00edvel na conta banc\u00e1ria, que pode ser utilizado para transa\u00e7\u00f5es.","format":"double","example":1000.75,"exampleSetFlag":true},"blockedAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor espec\u00edfico bloqueado na conta banc\u00e1ria, que n\u00e3o pode ser utilizado at\u00e9 que o bloqueio seja removido.","format":"double","example":200,"exampleSetFlag":true}},"exampleSetFlag":false},"RefundResult":{"required":["refundAmount","refundDate","refundId","refundStatusCode"],"type":"object","properties":{"refundId":{"type":"string","description":"C\u00f3digo \u00fanico que identifica a solicita\u00e7\u00e3o de devolu\u00e7\u00e3o. Deve ser um GUID v\u00e1lido.","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","exampleSetFlag":true},"refundStatusCode":{"maxLength":32,"minLength":1,"type":"string","description":"Status da devolu\u00e7\u00e3o = PENDING COMPLETED CANCELLED.","example":"COMPLETED","exampleSetFlag":true},"refundAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor devolvido.","format":"double","example":150.75,"exampleSetFlag":true},"refundDate":{"type":"string","description":"Data e hora em que a devolu\u00e7\u00e3o foi realizada. (Formato : YYYY-MM-DDTHH:MM:SSZ)","format":"date-time","exampleSetFlag":false},"refundDescription":{"maxLength":250,"type":"string","description":"Descri\u00e7\u00e3o da devolu\u00e7\u00e3o.","example":"Devolu\u00e7\u00e3o de pagamento duplicado","exampleSetFlag":true}},"description":"Classe de retorno\/resultado da solicita\u00e7\u00e3o de devolu\u00e7\u00e3o de pagamento.","exampleSetFlag":false},"Client":{"required":["clientName","documentCode"],"type":"object","properties":{"clientName":{"maxLength":250,"type":"string","description":"Nome completo do cliente.","example":"Jo\u00e3o da Silva","exampleSetFlag":true},"emailName":{"maxLength":250,"minLength":1,"type":"string","description":"Endere\u00e7o de e-mail do cliente.","example":"joao.silva@email.com","exampleSetFlag":true},"documentCode":{"maxLength":14,"minLength":1,"type":"string","description":"Documento do cliente (CPF ou CNPJ) sem formata\u00e7\u00e3o.","example":"12345678901","exampleSetFlag":true},"clientPhone":{"type":"object","properties":{"countryCode":{"maxLength":3,"type":"string","description":"C\u00f3digo do pa\u00eds para telefone.","example":"55","exampleSetFlag":true},"phoneAreaCode":{"maxLength":3,"type":"string","description":"C\u00f3digo de \u00e1rea telef\u00f4nica.","example":"11","exampleSetFlag":true},"phoneNumber":{"maxLength":20,"type":"string","description":"N\u00famero do telefone.","example":"987654321","exampleSetFlag":true},"phoneTypeCode":{"maxLength":10,"pattern":"^(MOBILE|LANDLINE)$","type":"string","description":"Tipo de telefone.","example":"MOBILE","exampleSetFlag":true}},"description":"Telefone do cliente.","exampleSetFlag":false}},"description":"Representa um cliente associado ao QR Code.","exampleSetFlag":false},"PixStatementResult":{"type":"object","properties":{"pixKeyCode":{"maxLength":250,"minLength":1,"type":"string","description":"C\u00f3digo Chave Pix utilizada para identificar a transa\u00e7\u00e3o.","example":"123e4567-e89b-12d3-a456-426614174000","exampleSetFlag":true},"endToEndCode":{"maxLength":250,"type":"string","description":"C\u00f3digo EndToEnd que identifica unicamente a transa\u00e7\u00e3o no sistema do banco.","example":"E1234567890123456789012345678901","exampleSetFlag":true},"transactionDate":{"type":"string","description":"Data em que a transa\u00e7\u00e3o foi realizada. (Formato : YYYY-MM-DDTHH:MM:SSZ)","format":"date-time","exampleSetFlag":false},"transactionDescription":{"maxLength":250,"type":"string","description":"Descri\u00e7\u00e3o detalhada da transa\u00e7\u00e3o.","example":"Pagamento de fatura","exampleSetFlag":true},"refundIndicator":{"type":"boolean","description":"Indicador que mostra se a transa\u00e7\u00e3o \u00e9 uma devolu\u00e7\u00e3o.","example":true,"exampleSetFlag":true},"eligibleForRefundIndicator":{"type":"boolean","description":"Indicador que mostra se a transa\u00e7\u00e3o \u00e9 eleg\u00edvel para devolu\u00e7\u00e3o.","example":false,"exampleSetFlag":true},"originalEndToEndCode":{"maxLength":250,"type":"string","description":"C\u00f3digo EndToEnd original da transa\u00e7\u00e3o em caso de devolu\u00e7\u00e3o.","example":"E0987654321098765432109876543210","exampleSetFlag":true},"transactionAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor monet\u00e1rio da transa\u00e7\u00e3o.","format":"double","example":150.75,"exampleSetFlag":true},"refundAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor monet\u00e1rio da devolu\u00e7\u00e3o, se aplic\u00e1vel.","format":"double","example":50.25,"exampleSetFlag":true},"bankName":{"maxLength":250,"type":"string","description":"Nome do banco envolvido na transa\u00e7\u00e3o.","example":"Banco do Brasil","exampleSetFlag":true},"bankIspbCode":{"maxLength":50,"type":"string","description":"C\u00f3digo ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.","example":"00000000","exampleSetFlag":true},"bankAgencyCode":{"maxLength":50,"type":"string","description":"C\u00f3digo da ag\u00eancia banc\u00e1ria onde a conta est\u00e1 registrada.","example":"1234","exampleSetFlag":true},"bankAccountNumber":{"maxLength":50,"type":"string","description":"N\u00famero da conta banc\u00e1ria associada \u00e0 transa\u00e7\u00e3o.","example":"123456-7","exampleSetFlag":true},"beneficiaryName":{"maxLength":250,"type":"string","description":"Nome do favorecido pela transa\u00e7\u00e3o.","example":"Jo\u00e3o da Silva","exampleSetFlag":true},"beneficiaryDocumentCode":{"maxLength":50,"type":"string","description":"N\u00famero do documento de identifica\u00e7\u00e3o do favorecido.","example":"123.456.789-00","exampleSetFlag":true},"financialNatureName":{"maxLength":250,"type":"string","description":"Natureza ou prop\u00f3sito da opera\u00e7\u00e3o financeira. D\u00e9bito, cr\u00e9dito, etc.","example":"Cr\u00e9dito","exampleSetFlag":true},"freeFieldDescription":{"maxLength":500,"type":"string","description":"Campo livre para informa\u00e7\u00f5es adicionais sobre a transa\u00e7\u00e3o.","example":"Pagamento referente ao m\u00eas de abril","exampleSetFlag":true},"qrRequestCode":{"type":"string","description":"C\u00f3digo da solicita\u00e7\u00e3o de pagamento via QrCode","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","exampleSetFlag":true},"qrReferenceCode":{"maxLength":36,"type":"string","description":"C\u00f3digo de refer\u00eancia da solicita\u00e7\u00e3o de pagamento via QrCode.","example":"abc123","exampleSetFlag":true}},"exampleSetFlag":false},"RefundResultResponsePost":{"required":["data"],"type":"object","properties":{"data":{"required":["refundAmount","refundDate","refundId","refundStatusCode"],"type":"object","properties":{"refundId":{"type":"string","description":"C\u00f3digo \u00fanico que identifica a solicita\u00e7\u00e3o de devolu\u00e7\u00e3o. Deve ser um GUID v\u00e1lido.","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","exampleSetFlag":true},"refundStatusCode":{"maxLength":32,"minLength":1,"type":"string","description":"Status da devolu\u00e7\u00e3o = PENDING COMPLETED CANCELLED.","example":"COMPLETED","exampleSetFlag":true},"refundAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor devolvido.","format":"double","example":150.75,"exampleSetFlag":true},"refundDate":{"type":"string","description":"Data e hora em que a devolu\u00e7\u00e3o foi realizada. (Formato : YYYY-MM-DDTHH:MM:SSZ)","format":"date-time","exampleSetFlag":false},"refundDescription":{"maxLength":250,"type":"string","description":"Descri\u00e7\u00e3o da devolu\u00e7\u00e3o.","example":"Devolu\u00e7\u00e3o de pagamento duplicado","exampleSetFlag":true}},"description":"Classe de retorno\/resultado da solicita\u00e7\u00e3o de devolu\u00e7\u00e3o de pagamento.","exampleSetFlag":false}},"exampleSetFlag":false},"QrCodeFileResult":{"required":["contentType","fileContents","fileDownloadName"],"type":"object","properties":{"fileContents":{"type":"string","description":"Conte\u00fado do arquivo","format":"binary","exampleSetFlag":false},"contentType":{"maxLength":50,"minLength":1,"type":"string","description":"Tipo de conte\u00fado do arquivo","example":"image\/png","exampleSetFlag":true},"fileDownloadName":{"maxLength":100,"minLength":1,"type":"string","description":"Nome do arquivo","example":"qrcode.png","exampleSetFlag":true}},"description":"Representa o resultado de um arquivo de QR Code.","exampleSetFlag":false},"Holder":{"type":"object","properties":{"holderName":{"maxLength":250,"type":"string","description":"Nome do respons\u00e1vel pelo pagamento.","example":"Jo\u00e3o da Silva","exampleSetFlag":true},"holderDocumentCode":{"maxLength":250,"type":"string","description":"Documento do respons\u00e1vel pelo pagamento (CPF ou CNPJ).","example":"12345678901","exampleSetFlag":true}},"description":"Representa o benefici\u00e1rio do pagamento.","exampleSetFlag":false},"BankAccountBalanceResultResponseData":{"required":["data","links"],"type":"object","properties":{"links":{"required":["self"],"type":"object","properties":{"self":{"maxLength":2000,"type":"string","description":"Link para a p\u00e1gina atual.","example":"cabixynkiczkjbtxqxdwtknsmwooivwaqucxlzwhgxvzfekegd","exampleSetFlag":true},"first":{"maxLength":2000,"type":"string","description":"Link para a primeira p\u00e1gina.","example":"cdkdwwhqyxvarpjzsptdmrvatuozvcurttjozaagtoixzqhjil","exampleSetFlag":true},"prev":{"maxLength":2000,"type":"string","description":"Link para a p\u00e1gina anterior.","example":"hvgnycctvjxgarugnivnichxjmjpuhdeklbwqcwrvpndpwjimb","exampleSetFlag":true},"next":{"maxLength":2000,"type":"string","description":"Link para a pr\u00f3xima p\u00e1gina.","example":"jgwhxykdayhamnkjdwxwxcrjkhozgjxqcegetjdyffyyssoyug","exampleSetFlag":true},"last":{"maxLength":2000,"type":"string","description":"Link para a \u00faltima p\u00e1gina.","example":"wiaaclaattjcpwyvlafzniotzfcvjjdomcoqfyfoesyatcsbqd","exampleSetFlag":true}},"exampleSetFlag":false},"data":{"type":"object","properties":{"accountHolderName":{"maxLength":250,"type":"string","description":"Nome completo do titular da conta banc\u00e1ria.","example":"Jo\u00e3o da Silva","exampleSetFlag":true},"totalBalanceAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Saldo total da conta banc\u00e1ria, incluindo todos os valores dispon\u00edveis e bloqueados.","format":"double","example":1500.75,"exampleSetFlag":true},"blockedBalanceAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Saldo bloqueado da conta banc\u00e1ria, que n\u00e3o est\u00e1 dispon\u00edvel para uso imediato.","format":"double","example":500,"exampleSetFlag":true},"availableBalanceAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Saldo dispon\u00edvel na conta banc\u00e1ria, que pode ser utilizado para transa\u00e7\u00f5es.","format":"double","example":1000.75,"exampleSetFlag":true},"blockedAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor espec\u00edfico bloqueado na conta banc\u00e1ria, que n\u00e3o pode ser utilizado at\u00e9 que o bloqueio seja removido.","format":"double","example":200,"exampleSetFlag":true}},"exampleSetFlag":false}},"exampleSetFlag":false},"Error":{"required":["code","detail","title"],"type":"object","properties":{"code":{"maxLength":10,"minLength":1,"type":"string","description":"C\u00f3digo do erro de neg\u00f3cio.","example":"pzdvzcvto","exampleSetFlag":true},"title":{"maxLength":100,"minLength":1,"type":"string","description":"Mensagem sucinta do erro de neg\u00f3cio.","example":"qepzrnigdwekncuxicmxbyzodanlzrnwfhcrcxltrkxljbebni","exampleSetFlag":true},"detail":{"maxLength":2000,"minLength":1,"type":"string","description":"Informa\u00e7\u00f5es complementares a respeito do erro de neg\u00f3cio.","example":"fefaciyampzsantuwpjeemwecphipymwzejspxlafzgowfwnzq","exampleSetFlag":true}},"description":"Dados de Erro","exampleSetFlag":false},"Base64ResultResponseData":{"required":["data","links"],"type":"object","properties":{"links":{"required":["self"],"type":"object","properties":{"self":{"maxLength":2000,"type":"string","description":"Link para a p\u00e1gina atual.","example":"cabixynkiczkjbtxqxdwtknsmwooivwaqucxlzwhgxvzfekegd","exampleSetFlag":true},"first":{"maxLength":2000,"type":"string","description":"Link para a primeira p\u00e1gina.","example":"cdkdwwhqyxvarpjzsptdmrvatuozvcurttjozaagtoixzqhjil","exampleSetFlag":true},"prev":{"maxLength":2000,"type":"string","description":"Link para a p\u00e1gina anterior.","example":"hvgnycctvjxgarugnivnichxjmjpuhdeklbwqcwrvpndpwjimb","exampleSetFlag":true},"next":{"maxLength":2000,"type":"string","description":"Link para a pr\u00f3xima p\u00e1gina.","example":"jgwhxykdayhamnkjdwxwxcrjkhozgjxqcegetjdyffyyssoyug","exampleSetFlag":true},"last":{"maxLength":2000,"type":"string","description":"Link para a \u00faltima p\u00e1gina.","example":"wiaaclaattjcpwyvlafzniotzfcvjjdomcoqfyfoesyatcsbqd","exampleSetFlag":true}},"exampleSetFlag":false},"data":{"required":["base64QrCode"],"type":"object","properties":{"base64QrCode":{"maxLength":200000,"minLength":1,"type":"string","description":"Campo com o QrCode em base64","format":"binary","exampleSetFlag":false}},"exampleSetFlag":false}},"exampleSetFlag":false},"SolicitarQrCodeRequest":{"required":["amount","expirationDateTime","notificationUrl","pixKey","referenceCode"],"type":"object","properties":{"referenceCode":{"maxLength":36,"minLength":1,"type":"string","description":"C\u00f3digo de refer\u00eancia da transa\u00e7\u00e3o.","example":"123e4567-e89b-12d3-a456-426614174000","exampleSetFlag":true},"pixKey":{"maxLength":50,"minLength":1,"type":"string","description":"Chave Pix do remetente.","example":"joao.silva@banco.com","exampleSetFlag":true},"amount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor da transa\u00e7\u00e3o.","format":"double","example":150.75,"exampleSetFlag":true},"expirationDateTime":{"type":"string","description":"Data e hora de expira\u00e7\u00e3o da transa\u00e7\u00e3o. (Formato : YYYY-MM-DDTHH:MM:SSZ)","format":"date-time","exampleSetFlag":false},"history":{"maxLength":140,"type":"string","description":"Hist\u00f3rico da transa\u00e7\u00e3o.","example":"Pagamento de servi\u00e7os","exampleSetFlag":true},"notificationUrl":{"maxLength":255,"minLength":1,"type":"string","description":"URL para notifica\u00e7\u00f5es sobre a transa\u00e7\u00e3o.","example":"https:\/\/meusistema.com\/notificacoes","exampleSetFlag":true}},"description":"Classe de requisi\u00e7\u00e3o da solicita\u00e7\u00e3o de QrCode.","exampleSetFlag":false},"SolicitarDevolucaoRequestRequestData":{"required":["data"],"type":"object","properties":{"data":{"required":["refundAmount"],"type":"object","properties":{"refundAmount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor a ser devolvido","format":"double","example":150.75,"exampleSetFlag":true}},"description":"Classe de requisi\u00e7\u00e3o da solicita\u00e7\u00e3o de QrCode","exampleSetFlag":false}},"exampleSetFlag":false},"SolicitarQrCodeRequestRequestData":{"required":["data"],"type":"object","properties":{"data":{"required":["amount","expirationDateTime","notificationUrl","pixKey","referenceCode"],"type":"object","properties":{"referenceCode":{"maxLength":36,"minLength":1,"type":"string","description":"C\u00f3digo de refer\u00eancia da transa\u00e7\u00e3o.","example":"123e4567-e89b-12d3-a456-426614174000","exampleSetFlag":true},"pixKey":{"maxLength":50,"minLength":1,"type":"string","description":"Chave Pix do remetente.","example":"joao.silva@banco.com","exampleSetFlag":true},"amount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor da transa\u00e7\u00e3o.","format":"double","example":150.75,"exampleSetFlag":true},"expirationDateTime":{"type":"string","description":"Data e hora de expira\u00e7\u00e3o da transa\u00e7\u00e3o. (Formato : YYYY-MM-DDTHH:MM:SSZ)","format":"date-time","exampleSetFlag":false},"history":{"maxLength":140,"type":"string","description":"Hist\u00f3rico da transa\u00e7\u00e3o.","example":"Pagamento de servi\u00e7os","exampleSetFlag":true},"notificationUrl":{"maxLength":255,"minLength":1,"type":"string","description":"URL para notifica\u00e7\u00f5es sobre a transa\u00e7\u00e3o.","example":"https:\/\/meusistema.com\/notificacoes","exampleSetFlag":true}},"description":"Classe de requisi\u00e7\u00e3o da solicita\u00e7\u00e3o de QrCode.","exampleSetFlag":false}},"exampleSetFlag":false},"PaymentMethod":{"type":"object","properties":{"endToEndId":{"maxLength":250,"type":"string","description":"Identificador \u00fanico do pagamento (End to End).","example":"E123456789012345678901234567890","exampleSetFlag":true},"holder":{"type":"object","properties":{"holderName":{"maxLength":250,"type":"string","description":"Nome do respons\u00e1vel pelo pagamento.","example":"Jo\u00e3o da Silva","exampleSetFlag":true},"holderDocumentCode":{"maxLength":250,"type":"string","description":"Documento do respons\u00e1vel pelo pagamento (CPF ou CNPJ).","example":"12345678901","exampleSetFlag":true}},"description":"Representa o benefici\u00e1rio do pagamento.","exampleSetFlag":false}},"description":"Representa o m\u00e9todo de pagamento utilizado.","exampleSetFlag":false},"QrCodeResult2":{"required":["amount","creationDate","referenceCode","requestCode","status"],"type":"object","properties":{"requestCode":{"type":"string","description":"C\u00f3digo da solicita\u00e7\u00e3o.","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","exampleSetFlag":true},"referenceCode":{"maxLength":36,"minLength":1,"type":"string","description":"C\u00f3digo de refer\u00eancia da transa\u00e7\u00e3o.","example":"abc123","exampleSetFlag":true},"txId":{"maxLength":35,"minLength":26,"type":"string","description":"Identificador da Transa\u00e7\u00e3o de uma cobran\u00e7a Pix.","example":"abcdefghi1234567890jklmnopqrs","exampleSetFlag":true},"creationDate":{"type":"string","description":"Data e hora em que o pedido foi criado. (Formato : YYYY-MM-DDTHH:MM:SSZ)","format":"date-time","exampleSetFlag":false},"status":{"maxLength":32,"minLength":1,"type":"string","description":"Status da transa\u00e7\u00e3o = PENDING COMPLETED CANCELLED.","example":"PENDING","exampleSetFlag":true},"amount":{"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","type":"number","description":"Valor da transa\u00e7\u00e3o.","format":"double","example":150.75,"exampleSetFlag":true},"client":{"required":["clientName","documentCode"],"type":"object","properties":{"clientName":{"maxLength":250,"type":"string","description":"Nome completo do cliente.","example":"Jo\u00e3o da Silva","exampleSetFlag":true},"emailName":{"maxLength":250,"minLength":1,"type":"string","description":"Endere\u00e7o de e-mail do cliente.","example":"joao.silva@email.com","exampleSetFlag":true},"documentCode":{"maxLength":14,"minLength":1,"type":"string","description":"Documento do cliente (CPF ou CNPJ) sem formata\u00e7\u00e3o.","example":"12345678901","exampleSetFlag":true},"clientPhone":{"type":"object","properties":{"countryCode":{"maxLength":3,"type":"string","description":"C\u00f3digo do pa\u00eds para telefone.","example":"55","exampleSetFlag":true},"phoneAreaCode":{"maxLength":3,"type":"string","description":"C\u00f3digo de \u00e1rea telef\u00f4nica.","example":"11","exampleSetFlag":true},"phoneNumber":{"maxLength":20,"type":"string","description":"N\u00famero do telefone.","example":"987654321","exampleSetFlag":true},"phoneTypeCode":{"maxLength":10,"pattern":"^(MOBILE|LANDLINE)$","type":"string","description":"Tipo de telefone.","example":"MOBILE","exampleSetFlag":true}},"description":"Telefone do cliente.","exampleSetFlag":false}},"description":"Representa um cliente associado ao QR Code.","exampleSetFlag":false},"qrCode":{"required":["copyAndPasteText","image"],"type":"object","properties":{"copyAndPasteText":{"maxLength":250,"minLength":1,"type":"string","description":"C\u00f3digo que pode ser copiado e colado para realizar a transa\u00e7\u00e3o.","example":"00020101021226820014br.gov.bcb.pix2573qrcodes-pix.com.br\/qr\/v2\/12345678901234567890123456789052040000530398654041.005802BR5913Jo\u00e3o da Silva6009Sao Paulo62070503***63041D3B","exampleSetFlag":true},"image":{"required":["imageBase64","imagePng"],"type":"object","properties":{"imagePng":{"required":["pngFormat","pngHref","pngRequestMethod"],"type":"object","properties":{"pngHref":{"maxLength":250,"minLength":1,"type":"string","description":"Link para baixar a imagem em PNG.","example":"https:\/\/example.com\/qrcode.png","exampleSetFlag":true},"pngFormat":{"maxLength":250,"minLength":1,"type":"string","description":"Formato da imagem.","example":"image\/png","exampleSetFlag":true},"pngRequestMethod":{"maxLength":250,"minLength":1,"type":"string","description":"M\u00e9todo de gera\u00e7\u00e3o do QR Code.","example":"GET","exampleSetFlag":true}},"description":"Representa o QR Code em formato PNG.","exampleSetFlag":false},"imageBase64":{"required":["base64Format","base64Href","base64RequestMethod"],"type":"object","properties":{"base64Href":{"maxLength":250,"minLength":1,"type":"string","description":"Link para baixar a imagem em Base64.","example":"https:\/\/example.com\/qrcode-base64","exampleSetFlag":true},"base64Format":{"maxLength":250,"minLength":1,"type":"string","description":"Formato da imagem.","example":"image\/png","exampleSetFlag":true},"base64RequestMethod":{"maxLength":250,"minLength":1,"type":"string","description":"M\u00e9todo de gera\u00e7\u00e3o do QR Code.","example":"GET","exampleSetFlag":true}},"description":"Representa o QR Code em formato Base64.","exampleSetFlag":false}},"description":"Representa a imagem do QR Code em diferentes formatos.","exampleSetFlag":false}},"description":"Representa um QR Code utilizado para transa\u00e7\u00f5es financeiras.","exampleSetFlag":false},"paymentMethod":{"type":"object","properties":{"endToEndId":{"maxLength":250,"type":"string","description":"Identificador \u00fanico do pagamento (End to End).","example":"E123456789012345678901234567890","exampleSetFlag":true},"holder":{"type":"object","properties":{"holderName":{"maxLength":250,"type":"string","description":"Nome do respons\u00e1vel pelo pagamento.","example":"Jo\u00e3o da Silva","exampleSetFlag":true},"holderDocumentCode":{"maxLength":250,"type":"string","description":"Documento do respons\u00e1vel pelo pagamento (CPF ou CNPJ).","example":"12345678901","exampleSetFlag":true}},"description":"Representa o benefici\u00e1rio do pagamento.","exampleSetFlag":false}},"description":"Representa o m\u00e9todo de pagamento utilizado.","exampleSetFlag":false}},"exampleSetFlag":false},"Link":{"required":["self"],"type":"object","properties":{"self":{"maxLength":2000,"type":"string","description":"Link para a p\u00e1gina atual.","example":"cabixynkiczkjbtxqxdwtknsmwooivwaqucxlzwhgxvzfekegd","exampleSetFlag":true},"first":{"maxLength":2000,"type":"string","description":"Link para a primeira p\u00e1gina.","example":"cdkdwwhqyxvarpjzsptdmrvatuozvcurttjozaagtoixzqhjil","exampleSetFlag":true},"prev":{"maxLength":2000,"type":"string","description":"Link para a p\u00e1gina anterior.","example":"hvgnycctvjxgarugnivnichxjmjpuhdeklbwqcwrvpndpwjimb","exampleSetFlag":true},"next":{"maxLength":2000,"type":"string","description":"Link para a pr\u00f3xima p\u00e1gina.","example":"jgwhxykdayhamnkjdwxwxcrjkhozgjxqcegetjdyffyyssoyug","exampleSetFlag":true},"last":{"maxLength":2000,"type":"string","description":"Link para a \u00faltima p\u00e1gina.","example":"wiaaclaattjcpwyvlafzniotzfcvjjdomcoqfyfoesyatcsbqd","exampleSetFlag":true}},"exampleSetFlag":false},"errors":{"type":"object","properties":{"errors":{"type":"array","exampleSetFlag":false,"items":{"required":["code","detail","title"],"type":"object","properties":{"code":{"maxLength":10,"minLength":1,"type":"string","description":"C\u00f3digo do erro de neg\u00f3cio.","example":"pzdvzcvto","exampleSetFlag":true},"title":{"maxLength":100,"minLength":1,"type":"string","description":"Mensagem sucinta do erro de neg\u00f3cio.","example":"qepzrnigdwekncuxicmxbyzodanlzrnwfhcrcxltrkxljbebni","exampleSetFlag":true},"detail":{"maxLength":2000,"minLength":1,"type":"string","description":"Informa\u00e7\u00f5es complementares a respeito do erro de neg\u00f3cio.","example":"fefaciyampzsantuwpjeemwecphipymwzejspxlafzgowfwnzq","exampleSetFlag":true}},"description":"Dados de Erro","exampleSetFlag":false}}},"exampleSetFlag":false}},"consumes":[],"produces":[],"authorizations":{"_default":{"scopes":[{"scope":"resource.WRITE"},{"scope":"resource.READ"}],"grantTypes":{"clientCredentials":{"url":"https:\/\/localhost:8089\/api\/oauth\/token","tokenName":"access_token"}},"type":"oauth2"}},"name":"Banco B3 - API de Liquida\u00e7\u00e3o","summary":"Esta API possui as funcionalidade consulta de extrato pix no Banco B3.","securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"basePaths":["https:\/\/developers.b3.com.br:8065"],"state":"published","cors":true,"expired":false,"retirementDate":0,"retired":false,"tags":{"Tipo":["PUBLICA"],"Grupo":["BANCOB3"]},"availableApiDefinitions":{"OAS 3.0":"\/discovery\/swagger\/api\/id\/cc328d33-06d3-424e-86de-f35a6aa10899?swaggerVersion=3.0&filename=Banco%2BB3%2B-%2BAPI%2Bde%2BLiquida%25C3%25A7%25C3%25A3o.json"},"availableSDK":{"ios-swift":"\/discovery\/sdk\/cc328d33-06d3-424e-86de-f35a6aa10899\/ios-swift","android":"\/discovery\/sdk\/cc328d33-06d3-424e-86de-f35a6aa10899\/android","nodejs":"\/discovery\/sdk\/cc328d33-06d3-424e-86de-f35a6aa10899\/nodejs"},"apis":[{"path":"\/api\/settlements\/v1\/public\/payment\/qrcode","name":"\/public\/payment\/qrcode","operations":[{"id":"f950b06b-a01c-4d21-8bfd-d11b26c68a14","description":"","httpMethod":"POST","nickname":"Publicpaymentqrcodereqpost","summary":"Solicita a cria\u00e7\u00e3o de um novo QrCode contendo as informa\u00e7\u00f5es para realiza\u00e7\u00e3o do pagamento.","responseClass":"void","errorResponses":[{"code":201,"reason":"Created"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":["application\/json"],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"","required":false,"properties":{"data":{"description":"Classe de requisi\u00e7\u00e3o da solicita\u00e7\u00e3o de QrCode.","required":["amount","expirationDateTime","notificationUrl","pixKey","referenceCode"],"properties":{"notificationUrl":{"description":"URL para notifica\u00e7\u00f5es sobre a transa\u00e7\u00e3o.","example":"https:\/\/meusistema.com\/notificacoes","maxLength":255,"minLength":1,"allowEmptyValue":false,"type":"string"},"expirationDateTime":{"description":"Data e hora de expira\u00e7\u00e3o da transa\u00e7\u00e3o. (Formato : YYYY-MM-DDTHH:MM:SSZ)","format":"date-time","allowEmptyValue":false,"type":"string"},"amount":{"description":"Valor da transa\u00e7\u00e3o.","format":"double","example":150.75,"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","allowEmptyValue":false,"type":"number"},"history":{"description":"Hist\u00f3rico da transa\u00e7\u00e3o.","example":"Pagamento de servi\u00e7os","maxLength":140,"allowEmptyValue":false,"type":"string"},"referenceCode":{"description":"C\u00f3digo de refer\u00eancia da transa\u00e7\u00e3o.","example":"123e4567-e89b-12d3-a456-426614174000","maxLength":36,"minLength":1,"allowEmptyValue":false,"type":"string"},"pixKey":{"description":"Chave Pix do remetente.","example":"joao.silva@banco.com","maxLength":50,"minLength":1,"allowEmptyValue":false,"type":"string"}},"allowEmptyValue":false,"type":"object"}},"allowEmptyValue":false,"name":"body","dataType":"SolicitarQrCodeRequestRequestData","paramType":"body","allowMultiple":false}]}]},{"path":"\/api\/settlements\/v1\/public\/payment\/qrcode\/{requestCode}","name":"\/public\/payment\/qrcode\/{requestCode}","operations":[{"id":"5a84d656-c1e6-497b-bf79-d743ddfcf952","description":"","httpMethod":"GET","nickname":"PublicPaymentQrcodeRequestCodeReqGet","summary":"Consulta a Solicita\u00e7\u00e3o de QrCode atrav\u00e9s do c\u00f3digo da requisi\u00e7\u00e3o.","responseClass":"void","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"C\u00f3digo \u00fanico que identifica a solicita\u00e7\u00e3o de pagamento. Deve ser um GUID v\u00e1lido.","format":"uuid","required":true,"name":"requestCode","dataType":"string","paramType":"path","allowMultiple":false}]}]},{"path":"\/api\/settlements\/v1\/public\/webhook\/{pixKey}","name":"\/public\/webhook\/{pixKey}","operations":[{"id":"3b905c80-e041-44ab-839a-7910cce50e54","description":"","httpMethod":"PUT","nickname":"PublicWebhookPixKeyReqPut","summary":"Inativa a chave pix do cliente para envio de notifica\u00e7\u00f5es.","responseClass":"void","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"Chave Pix do remetente.","required":true,"maxLength":50,"minLength":1,"name":"pixKey","dataType":"string","paramType":"path","allowMultiple":false}]},{"id":"4c6a2dc0-1d4f-48e2-a31d-7b4ab05e3c02","description":"","httpMethod":"POST","nickname":"PublicWebhookPixKeyReqPost","summary":"Cadastra chave pix do cliente que deseja receber mensagens criando uma chave RSA Publica e Privada para o cliente (n\u00e3o salvamos a chave Privada).","responseClass":"void","errorResponses":[{"code":201,"reason":"Created"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"Chave Pix do remetente.","required":true,"maxLength":50,"minLength":1,"name":"pixKey","dataType":"string","paramType":"path","allowMultiple":false}]}]},{"path":"\/api\/settlements\/v1\/public\/payment\/qrcode\/{requestCode}\/png","name":"\/public\/payment\/qrcode\/{requestCode}\/png","operations":[{"id":"1f283413-e2a7-4401-a9d5-0ac947a2e74c","description":"","httpMethod":"GET","nickname":"PublicPaymentQrcodeRequestCodePngReqGet","summary":"Obt\u00e9m o QrCode no formato png para pagamento via pix.","responseClass":"void","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["image\/png"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"C\u00f3digo \u00fanico que identifica a solicita\u00e7\u00e3o de pagamento. Deve ser um GUID v\u00e1lido.","format":"uuid","required":true,"name":"requestCode","dataType":"string","paramType":"path","allowMultiple":false}]}]},{"path":"\/api\/settlements\/v1\/public\/statements\/pix","name":"\/public\/statements\/pix","operations":[{"id":"41df89e3-ebf9-4257-b3d7-9e0ad92f35d1","description":"","httpMethod":"GET","nickname":"Publicstatementspixreqget","summary":"Consulta o extrato PIX da conta informada.","responseClass":"void","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"N\u00famero da conta banc\u00e1ria associada \u00e0 consulta.","required":true,"maxLength":13,"name":"accountNumber","dataType":"string","paramType":"query","allowMultiple":false},{"description":"Documento de identifica\u00e7\u00e3o da contraparte envolvida na transa\u00e7\u00e3o.","required":false,"maxLength":50,"name":"counterpartyDocumentCode","dataType":"string","paramType":"query","allowMultiple":false},{"description":"N\u00famero de dias a serem considerados na consulta.","format":"int32","required":false,"name":"queryDayNumber","dataType":"int","paramType":"query","allowMultiple":false},{"description":"Data inicial para o per\u00edodo da consulta no formato: AAAA-MM-DD HH:mm:ss. (Formato : YYYY-MM-DD)","format":"date","required":false,"name":"startDate","dataType":"string","paramType":"query","allowMultiple":false},{"description":"Data final para o per\u00edodo da consulta no formato: AAAA-MM-DD HH:mm:ss. (Formato : YYYY-MM-DD)","format":"date","required":false,"name":"endDate","dataType":"string","paramType":"query","allowMultiple":false},{"description":"N\u00famero da p\u00e1gina que est\u00e1 sendo requisitada (o valor da primeira p\u00e1gina \u00e9 1).","format":"int32","required":false,"name":"page","dataType":"int","paramType":"query","allowMultiple":false},{"description":"Quantidade total de registros por p\u00e1ginas.","format":"int32","required":false,"name":"page-size","dataType":"int","paramType":"query","allowMultiple":false}]}]},{"path":"\/api\/settlements\/v1\/public\/bank-accounts\/balance","name":"\/public\/bank-accounts\/balance","operations":[{"id":"6c628434-6637-436c-9540-b79fcb3ba25e","description":"","httpMethod":"GET","nickname":"Publicbankaccountsbalancereqget","summary":"Consulta o saldo de uma conta banc\u00e1ria.","responseClass":"void","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.READ","resource.WRITE"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"N\u00famero da conta banc\u00e1ria associada \u00e0 consulta","required":true,"maxLength":13,"name":"accountNumber","dataType":"string","paramType":"query","allowMultiple":false}]}]},{"path":"\/api\/settlements\/v1\/public\/refund\/qrcode\/{requestCode}","name":"\/public\/refund\/qrcode\/{requestCode}","operations":[{"id":"2347bad3-3b5f-4f26-b628-1bf7d642fa60","description":"","httpMethod":"PUT","nickname":"PublicRefundQcodeRequestCodeReqPut","summary":"Solicita a devolu\u00e7\u00e3o de pagamento pix com base no requestCode informado.","responseClass":"void","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":["application\/json"],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"C\u00f3digo \u00fanico que identifica a solicita\u00e7\u00e3o de devolu\u00e7\u00e3o. Deve ser um GUID v\u00e1lido.","format":"uuid","required":true,"name":"requestCode","dataType":"string","paramType":"path","allowMultiple":false},{"description":"","required":false,"properties":{"data":{"description":"Classe de requisi\u00e7\u00e3o da solicita\u00e7\u00e3o de QrCode","required":["refundAmount"],"properties":{"refundAmount":{"description":"Valor a ser devolvido","format":"double","example":150.75,"pattern":"(\\d{1,12})(\\.\\d{1,12})?$","allowEmptyValue":false,"type":"number"}},"allowEmptyValue":false,"type":"object"}},"allowEmptyValue":false,"name":"body","dataType":"SolicitarDevolucaoRequestRequestData","paramType":"body","allowMultiple":false}]}]},{"path":"\/api\/settlements\/v1\/public\/refund\/qrcode","name":"\/public\/refund\/qrcode","operations":[{"id":"c8799f12-f471-423f-8f39-d4f8a4183ff3","description":"","httpMethod":"GET","nickname":"Publicrefundqrcodereqget","summary":"Consulta a Devolu\u00e7\u00e3o de Pix recebido atrav\u00e9s do c\u00f3digo da devolu\u00e7\u00e3o.","responseClass":"void","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.READ","resource.WRITE"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"C\u00f3digo \u00fanico que identifica a solicita\u00e7\u00e3o de devolu\u00e7\u00e3o. Deve ser um GUID v\u00e1lido.","format":"uuid","required":false,"name":"refundId","dataType":"string","paramType":"query","allowMultiple":false}]}]},{"path":"\/api\/settlements\/v1\/public\/payment\/qrcode\/{requestCode}\/base-code","name":"\/public\/payment\/qrcode\/{requestCode}\/base-code","operations":[{"id":"a9f15111-bf38-43d3-af82-63264c0ab25e","description":"","httpMethod":"GET","nickname":"PublicPaymentQrcodeRequestCodeBaseCodeReqGet","summary":"Obt\u00e9m o QrCode no formato base64 para pagamento via pix.","responseClass":"void","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"C\u00f3digo \u00fanico que identifica a solicita\u00e7\u00e3o de pagamento. Deve ser um GUID v\u00e1lido.","format":"uuid","required":true,"name":"requestCode","dataType":"string","paramType":"path","allowMultiple":false}]}]}],"createDate":1773234177332,"accessGrantedDate":1773234178803,"type":"rest","enableInlineTryIt":true}