API Documentation for Our Products
\nWithin this documentation, you will find detailed information about the available APIs for our products. Should you have any inquiries or wish to report an issue, please contact us via email at the following address:
\n\nWe are committed to providing prompt assistance and appreciate your feedback.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"35321848","collectionId":"7af0120b-6a9b-4b32-89eb-d94facc7cdd1","publishedId":"2sA3drHEUr","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-11-28T18:22:58.000Z"},"item":[{"name":"Authentication","item":[{"name":"Create JWKS","id":"84d8684c-edc5-4a06-b943-cde52efb9a2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientId\": \"{{client_id}}\",\n \"publicKey\": \"{{public_key}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/auth/jwks","description":"For the public key, we use the ES512 algorithm. To generate this key, you can use OpenSSL as shown in the example below:
\nopenssl ecparam -name secp521r1 -genkey -noout -out ec-p512-private.pem\nopenssl ec -in ec-p512-private.pem -pubout -out ec-p512-public.pem\n\nAnd send the content of the ec-p512-public.pem file in the publicKey attribute.
The clientId will be sent to the integrator during the initial setup.
\nThe clientAssertion will be generated in the pre-request script, but we also have this example below in PHP if you want create by yourself.
\n$secretKey = 'YOUR_PRIVATE_KEY';\n$alg = 'ES512';\n$payload = [\n 'iat' => Carbon::now()->timestamp,\n 'exp' => Carbon::now()->addDay()->timestamp,\n 'aud' => 'https://auth.kanastra.com.br/realms/{{realm_name}}/protocol/openid-connect/token',\n 'iss' => 'your-client-id',\n 'sub' => 'your-client-id',\n 'jti' => Uuid::uuid4()->toString(),\n];\n$jwt_signed = JWT::encode($payload, $secretKey, $alg);\n\nYou should be authenticated after this steps, the post-request script will set the access_token on every api call, and if you have the scope permission to use you be able to test it.
\n","urlObject":{"path":["api","v1","auth","token"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2ff13683-77f7-4789-99a7-4b6d98177da9","name":"OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client_id\": \"client_id\",\n \"client_assertion\": \"eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6ImxNdEc3NWJLazJvdmhXaVFxVjBpYnRtQW1WY3VUenBNN1R4SWRWQUYyOTQifQ.eyJpYXQiOjE3MTE5ODkzMzcsImV4cCI6MTk3MTE4OTMzNywiYXVkIjoiaHR0cHM6Ly9rZXljbG9hay5rYW5hc3RyYS5kZXYvcmVhbG1zL3RlY2gtaHViL3Byb3RvY29sL29wZW5pZC1jb25uZWN0L3Rva2VuIiwiaXNzIjoidGVjaC1odWItY2xpZW50Iiwic3ViIjoidGVjaC1odWItY2xpZW50IiwianRpIjoiMmY2ODA1YmItNThjMC00OWVkLWFjOTEtN2NkODA3ZTgzZTViIn0.AX51Z0y4oZFhLTgMBUCptkcM1C-LE4Y23Uc-9RO1xi3yPweatjhKVGT9e6vEsOZG_JW3tQ4nu97YH8wRtyeqGAczAU0b_ry803Z2UbrPpFTfTuMjUeFi6oqfw6bgrkPLkIjSsRq2M493PJlJPxpZyrZBYVHjzNqpvRm9c3D_N-DMfMtu\"\n}","options":{"raw":{"language":"json"}}},"url":"https://banking-sandbox.kanastra.com.br/api/v1/auth/token"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtb0JQbndkcmRzamQ0alRJNmZqenZMdG1mb3Q4MUJhM2dId19rNjhDRmNBIn0.eyJleHAiOjE3MTIwMjUzMzgsImlhdCI6MTcxMTk4OTMzOSwianRpIjoiOGQyNjJkOWYtMWEyYi00MjRjLTkzMTItNmU2MzhmNWI3MDkwIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5rYW5hc3RyYS5kZXYvcmVhbG1zL3RlY2gtaHViIiwic3ViIjoiZDM3YzE5YTQtNTIzOS00MTYyLThlZjgtNTMxMmNkY2IzYmYxIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoidGVjaC1odWItY2xpZW50Iiwic2NvcGUiOiJ3ZWJob29rIGJhbmtfc2xpcCBiYW5rX3NsaXA6Y3JlYXRlIGZpbmFuY2lhbF9hY2NvdW50IGNvbW1lcmNpYWxfcGFwZXIiLCJjbGllbnRIb3N0IjoiMTAuMTMwLjEzLjIzNyIsIm9yaWdpbmF0b3JfaWQiOiI3NGU2ZjdjZi02MTA5LTRmZTktODk4Yy04OGRiNjBmZGE4ZWIiLCJjbGllbnRBZGRyZXNzIjoiMTAuMTMwLjEzLjIzNyIsImNsaWVudF9pZCI6InRlY2gtaHViLWNsaWVudCJ9.vBP35w7Lsz_sE4J10rrui5VT_MKkJe4toN8H7iP15hzOSGYAdpWGvJqHP3jiT5EGpdrwbuexQnbHcdAdIjYmM8dExwkYM2X1menlvSBJ4dEugRi1KJyrgJvPVzBlF2mtHsJNYJ3zc2FK3aG2KwZhnc0OLHFCGJhysJAEjhH3iDrPf-SBolCFHqznD5f1MVFgctb28xjyaYnD6WFnHT4U61T9H0z_BZ9l8SvdusdQcQI7EYw0eAPUgd5SNhdWXxMVwC-px-2x_dS8WbC4nbVMdqsaKO8ZCbcwqjOh6QUh-6woy7Tl9rsnCUWM9ODdFOjM3aejHbEdL6eCAoVLGy0x3A\",\n \"expiresIn\": 35999,\n \"refreshExpiresIn\": 0,\n \"tokenType\": \"Bearer\",\n \"not-before-policy\": 0,\n \"scope\": \"webhook bank_slip bank_slip:create financial_account commercial_paper\"\n}"}],"_postman_id":"8840f11e-7878-431d-86d3-0c21a73a4999"}],"id":"39f233a8-04ac-4847-8bc0-9e46f68e4e2c","description":"To authenticate with our services, will provide you an clientId and Realm name.
\n","_postman_id":"39f233a8-04ac-4847-8bc0-9e46f68e4e2c"},{"name":"Bank Slip (Boleto)","item":[{"name":"Wallet","item":[{"name":"List","id":"5be5257e-7af4-4b1d-9cc6-abd9d2690a0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/wallets","description":"Get a list of all the wallets for the authenticated user.
\n","urlObject":{"path":["api","v1","wallets"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"19ee7b34-a622-45ac-8e7c-1ed021ea5078","name":"OK List","originalRequest":{"method":"GET","header":[{"key":"client-id","value":"tech-hub-client","type":"text"}],"url":"https://banking-sandbox.kanastra.com.br/api/v1/wallets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jun 2024 21:23:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"541"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Accept, origin, Cookie, Accept-Encoding"},{"key":"allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"x-frame-options","value":"DENY"},{"key":"content-encoding","value":"gzip"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"x-request-id","value":"cd29b362a4373c4f8a3e4474dcc15695"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=nE0ghPQYPGfQVa%2FIY6PS46Jgtd9ZDltCX2aUnrwdJFb%2BZSQQgtR6m0bcFpHwaVosEavG7GLrpmehWoPjvrU3dJxdEcLBDAwk4ooLSmaP5gkYQDWX2hOZQTjXfnNJ5lDOVJ7Bdkv3paCASB6Btxpv8Uc5\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"89a87fc47fee011a-GRU"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"uuid\": \"452915ca-94fc-4d97-a262-cf944bb62145\",\n \"name\": \"Wallet Demonstração\",\n \"code\": 100,\n \"financialAccount\": {\n \"uuid\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"isDeleted\": false,\n \"branch\": \"1\",\n \"account\": \"93\",\n \"accountDigit\": \"0\",\n \"type\": \"LINKED_ACCOUNT\",\n \"status\": \"ACTIVE\",\n \"createdAt\": \"2024-06-20T09:58:21.994394-03:00\",\n \"updatedAt\": \"2024-06-26T16:38:32.147974-03:00\",\n \"institution\": \"559 - Kanastra SCD\",\n \"beneficiaryBankAccounts\": [\n {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"agency\": \"0001\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true,\n \"bankCode\": 559\n }\n ]\n },\n \"acceptPartialPayment\": false\n }\n ]\n}"}],"_postman_id":"5be5257e-7af4-4b1d-9cc6-abd9d2690a0d"},{"name":"Retrieve","id":"6a3809dd-8e4e-4600-8992-dae9a6efda57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/wallets/:wallet_id","description":"Retrieves detailed information about a specific wallet identified by its unique ID.
\n","urlObject":{"path":["api","v1","wallets",":wallet_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"452915ca-94fc-4d97-a262-cf944bb62145","key":"wallet_id"}]}},"response":[{"id":"2494c39b-cd35-4055-87ae-a5acfbe536f3","name":"OK Retrieve","originalRequest":{"method":"GET","header":[{"key":"client-id","value":"tech-hub-client","type":"text"}],"url":{"raw":"https://banking-sandbox.kanastra.com.br/api/v1/wallets/:wallet_id","protocol":"https","host":["banking-sandbox","kanastra","com","br"],"path":["api","v1","wallets",":wallet_id"],"variable":[{"key":"wallet_id","value":"452915ca-94fc-4d97-a262-cf944bb62145"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jun 2024 21:24:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"494"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Accept, origin, Cookie, Accept-Encoding"},{"key":"allow","value":"GET, PUT, HEAD, OPTIONS"},{"key":"x-frame-options","value":"DENY"},{"key":"content-encoding","value":"gzip"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"x-request-id","value":"e201686d7e81c4536dbdbae65e00140c"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=7574YIL2YrFyrTdYqPGO2rpwJ49IcDeBg760IsYeXANUEaj%2Bq06ZOKYKDwArK%2FePlQ%2FxwhjOZg8hpNedM3nXiGSQxp%2Bv6Ki9LYcJpRtXIMubLpVcREhJL2t%2Bj8Dgsvt2hVBPzxilX3eWAdXS%2Bk5IgxDw\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"89a880d47bbd011a-GRU"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"452915ca-94fc-4d97-a262-cf944bb62145\",\n \"name\": \"Wallet Demonstração\",\n \"code\": 100,\n \"financialAccount\": {\n \"uuid\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"isDeleted\": false,\n \"branch\": \"1\",\n \"account\": \"93\",\n \"accountDigit\": \"0\",\n \"type\": \"LINKED_ACCOUNT\",\n \"status\": \"ACTIVE\",\n \"createdAt\": \"2024-06-20T09:58:21.994394-03:00\",\n \"updatedAt\": \"2024-06-26T16:38:32.147974-03:00\",\n \"institution\": \"559 - Kanastra SCD\",\n \"beneficiaryBankAccounts\": [\n {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"agency\": \"0001\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true,\n \"bankCode\": 559\n }\n ]\n },\n \"acceptPartialPayment\": false\n}"}],"_postman_id":"6a3809dd-8e4e-4600-8992-dae9a6efda57"},{"name":"Create","id":"d8095c62-04a0-4ee1-b247-f672028cd440","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Wallet 5\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"code\": 106,\n \"acceptPartialPayment\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/wallets","description":"You can create a new wallet with this endpoint.
\nParameters:
\n","urlObject":{"path":["api","v1","wallets"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"87be8790-912c-4345-a82c-df9593c827e5","name":"OK Create","originalRequest":{"method":"POST","header":[{"key":"client-id","value":"tech-hub-client","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Wallet 5\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"code\": 106,\n \"acceptPartialPayment\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://banking-sandbox.kanastra.com.br/api/v1/wallets"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jun 2024 23:57:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"480"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Accept, origin, Cookie, Accept-Encoding"},{"key":"allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"x-frame-options","value":"DENY"},{"key":"content-encoding","value":"gzip"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"x-request-id","value":"6fbdc0973c2b368ca81ad5f02c0fa338"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=aL93B78hb%2BzjHld85sDlmFEaMCV9Dun2nzJ%2FiUeTz9V4c12h9tBPQ5rkb6CDk7E3hfQtowU6FUkuOCRRs6sTnddSg8y%2BDIpB%2FXHDiKrbGtbtVzCMpKCidy3Lqzbywv8IvC7etbntmKknpWrbx8UuXPL4\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"89a9610488d21aa4-GRU"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"34851df9-4022-47a6-a6d6-b28829c0db75\",\n \"name\": \"Test Wallet 5\",\n \"code\": 106,\n \"financialAccount\": {\n \"uuid\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"isDeleted\": false,\n \"branch\": \"1\",\n \"account\": \"93\",\n \"accountDigit\": \"0\",\n \"type\": \"LINKED_ACCOUNT\",\n \"status\": \"ACTIVE\",\n \"createdAt\": \"2024-06-20T09:58:21.994394-03:00\",\n \"updatedAt\": \"2024-06-26T16:38:32.147974-03:00\",\n \"institution\": \"559 - Kanastra SCD\",\n \"beneficiaryBankAccounts\": [\n {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"agency\": \"0001\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true,\n \"bankCode\": 559\n }\n ]\n },\n \"acceptPartialPayment\": true\n}"}],"_postman_id":"d8095c62-04a0-4ee1-b247-f672028cd440"},{"name":"Update","id":"1ca4a2a6-cd47-4111-9391-2757d82320bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Wallet Atualizada\",\n \"financial_account\": \"ea01e909-1c43-44bc-94d7-5cdeac0ef181\",\n \"code\": 562,\n \"accept_partial_payment\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/wallets/:wallet_id","description":"Updates an existing wallet by its unique ID based on the data provided in the request
\nParameters
\n","urlObject":{"path":["api","v1","wallets",":wallet_id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"f75fd44c-aad4-45c2-8f60-307147cbdef4","type":"any","value":"7ce74d14-62c4-434f-889f-8ba7abcc2f90","key":"wallet_id"}]}},"response":[{"id":"f6fc8d3d-bfe2-4b02-986a-ae2bf35cb5ab","name":"OK Update","originalRequest":{"method":"PUT","header":[{"key":"client-id","value":"tech-hub-client","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Wallet Atualizada\",\n \"financial_account\": \"ea01e909-1c43-44bc-94d7-5cdeac0ef181\",\n \"code\": 562,\n \"accept_partial_payment\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://banking-sandbox.kanastra.com.br/api/v1/wallets/6914fc04-98f5-4b03-8dbd-13d1d697f1ee"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"6914fc04-98f5-4b03-8dbd-13d1d697f1ee\",\n \"name\": \"Test Wallet Atualizada\",\n \"code\": 106,\n \"financialAccount\": {\n \"uuid\": \"ea01e909-1c43-44bc-94d7-5cdeac0ef181\",\n \"isDeleted\": false,\n \"branch\": \"0730\",\n \"account\": \"99570\",\n \"accountDigit\": \"5\",\n \"type\": \"LINKED_ACCOUNT\",\n \"status\": \"ACTIVE\",\n \"createdAt\": \"2024-06-25T15:08:29.512817-03:00\",\n \"updatedAt\": \"2024-06-25T15:08:29.512856-03:00\",\n \"institution\": \"559 - Kanastra SCD\",\n \"beneficiaryBankAccounts\": []\n },\n \"acceptPartialPayment\": false\n}"}],"_postman_id":"1ca4a2a6-cd47-4111-9391-2757d82320bc"}],"id":"63df9ac9-cec3-438f-9e93-66fb3f16fd9a","description":"Our wallet API offers a streamlined solution for managing customized bank slip options. Below are the key services available:
\nCreate Wallet:
Set up a new wallet with custom bank slip configurations. Each wallet must be linked to a financial account. This service simplifies the creation of personalized bank slip options.
Retrieve Wallet:
Access detailed information about existing wallets. This functionality provides a comprehensive view of the wallet configurations and associated parameters.
Update Wallet:
Modify the settings of an existing wallet to accommodate new requirements. This service ensures that wallet configurations remain up-to-date with the latest bank slip parameters.
These services enable efficient management and customization of bank slips, enhancing flexibility and control over financial transactions.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"22f1afbd-8ed9-4e25-a589-432a9db4495c"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"a8946731-505e-4e22-b7d5-edff8c3d629c"}}],"_postman_id":"63df9ac9-cec3-438f-9e93-66fb3f16fd9a"},{"name":"CNAB","item":[{"name":"File Return","item":[{"name":"List","event":[{"listen":"prerequest","script":{"id":"377cc244-f8e4-4076-9b52-013ca2364a45","exec":["const moment = require('moment');","pm.globals.set(\"today\", moment().format(\"YYYY-MM-DD\"));","console.log(moment().format(\"YYYY-MM-DD\"));"],"type":"text/javascript","packages":{}}}],"id":"67170ee5-875a-46f2-8e04-4a61b1ee2cf4","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"client-id","value":"{{client_api_id}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/Users/davinogueira/Downloads/CNAB400.rem"}]},"url":"{{base_url}}/api/v1/wallets/:wallet_uuid/cnab-file-return","urlObject":{"path":["api","v1","wallets",":wallet_uuid","cnab-file-return"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"wallet_uuid"}]}},"response":[{"id":"1c19420a-860b-4e3e-bed2-a03136756a0d","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0,\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\"\n },\n {\n \"payerState\": \"RJ\",\n \"documentDate\": \"2024-02-15\",\n \"documentNumber\": \"00045061-2\",\n \"dueDate\": \"2024-11-30\",\n \"payerCity\": \"RIO DE JANEIRO\",\n \"speciesId\": 1,\n \"payerAddress\": \"Avenida das Palmeiras\",\n \"payerZipCode\": \"22001234\",\n \"payerType\": 1,\n \"payerDocument\": 2034567890,\n \"payerName\": \"Maria Oliveira\",\n \"nominalValue\": 850.25,\n \"interestValue\": 1.5,\n \"payerNeighborhood\": \"COPACABANA\",\n \"interestType\": \"PERCENTAGE\"\n },\n {\n \"payerState\": \"MG\",\n \"documentDate\": \"2024-03-10\",\n \"documentNumber\": \"00045061-3\",\n \"dueDate\": \"2024-10-15\",\n \"payerCity\": \"BELO HORIZONTE\",\n \"speciesId\": 3,\n \"payerAddress\": \"Travessa dos Ipês\",\n \"payerZipCode\": \"30111222\",\n \"payerType\": 0,\n \"payerDocument\": 3056789012,\n \"payerName\": \"Carlos Alberto Lima\",\n \"nominalValue\": 450.75,\n \"interestValue\": 2.5,\n \"payerNeighborhood\": \"SANTA EFIGÊNIA\",\n \"interestType\": \"FIXED_AMOUNT\"\n },\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0, //[ 0 = natural person, 1 = legal person]\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\" // [FIXED_AMOUNT, PERCENTAGE, EXEMPT]\n },\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0, //[ 0 = natural person, 1 = legal person]\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\" // [FIXED_AMOUNT, PERCENTAGE, EXEMPT]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/slip/batch"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": {\n \"keys\": [\n {\n \"uuid\":\"e47cfadf-f3ff-4c06-ad2a-60039c11eeb6\",\n \"documentNumber\": \"00045061-1\"\n },\n {\n \"uuid\":\"cbb4e35c-8004-43bf-b989-ad8e7d4cbe79\",\n \"documentNumber\": \"00045061-2\"\n },\n {\n \"uuid\":\"ad2de51e-db68-4094-a4d5-d34c818673d7\",\n \"documentNumber\": \"00045061-3\"\n } \n ]\n }\n}"}],"_postman_id":"67170ee5-875a-46f2-8e04-4a61b1ee2cf4"},{"name":"Download by UUID","event":[{"listen":"prerequest","script":{"id":"377cc244-f8e4-4076-9b52-013ca2364a45","exec":["const moment = require('moment');","pm.globals.set(\"today\", moment().format(\"YYYY-MM-DD\"));","console.log(moment().format(\"YYYY-MM-DD\"));"],"type":"text/javascript","packages":{}}}],"id":"d8cbf99a-bdf8-45f6-b671-7a8c58551558","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"client-id","value":"{{client_api_id}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/Users/davinogueira/Downloads/CNAB400.rem"}]},"url":"{{base_url}}/api/v1/wallets/:wallet_uuid/cnab-file-return/:cnab_uuid/download","urlObject":{"path":["api","v1","wallets",":wallet_uuid","cnab-file-return",":cnab_uuid","download"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"452915ca-94fc-4d97-a262-cf944bb62145","key":"wallet_uuid"},{"type":"any","value":"7b9861d2-1de6-4194-82dd-bc8a99931301","key":"cnab_uuid"}]}},"response":[{"id":"e65ec4df-aaa6-4878-9313-54f9ec76fa1a","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0,\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\"\n },\n {\n \"payerState\": \"RJ\",\n \"documentDate\": \"2024-02-15\",\n \"documentNumber\": \"00045061-2\",\n \"dueDate\": \"2024-11-30\",\n \"payerCity\": \"RIO DE JANEIRO\",\n \"speciesId\": 1,\n \"payerAddress\": \"Avenida das Palmeiras\",\n \"payerZipCode\": \"22001234\",\n \"payerType\": 1,\n \"payerDocument\": 2034567890,\n \"payerName\": \"Maria Oliveira\",\n \"nominalValue\": 850.25,\n \"interestValue\": 1.5,\n \"payerNeighborhood\": \"COPACABANA\",\n \"interestType\": \"PERCENTAGE\"\n },\n {\n \"payerState\": \"MG\",\n \"documentDate\": \"2024-03-10\",\n \"documentNumber\": \"00045061-3\",\n \"dueDate\": \"2024-10-15\",\n \"payerCity\": \"BELO HORIZONTE\",\n \"speciesId\": 3,\n \"payerAddress\": \"Travessa dos Ipês\",\n \"payerZipCode\": \"30111222\",\n \"payerType\": 0,\n \"payerDocument\": 3056789012,\n \"payerName\": \"Carlos Alberto Lima\",\n \"nominalValue\": 450.75,\n \"interestValue\": 2.5,\n \"payerNeighborhood\": \"SANTA EFIGÊNIA\",\n \"interestType\": \"FIXED_AMOUNT\"\n },\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0, //[ 0 = natural person, 1 = legal person]\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\" // [FIXED_AMOUNT, PERCENTAGE, EXEMPT]\n },\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0, //[ 0 = natural person, 1 = legal person]\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\" // [FIXED_AMOUNT, PERCENTAGE, EXEMPT]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/slip/batch"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": {\n \"keys\": [\n {\n \"uuid\":\"1667e091-8d68-46b7-adf9-fdb373f8a80b\",\n \"documentNumber\": \"00045061-1\"\n },\n {\n \"uuid\":\"aa81edde-9f47-444d-9d88-4898f6be53a1\",\n \"documentNumber\": \"00045061-2\"\n },\n {\n \"uuid\":\"ed8dd125-26ed-4646-b8e9-1db684447cc4\",\n \"documentNumber\": \"00045061-3\"\n } \n ]\n }\n}"}],"_postman_id":"d8cbf99a-bdf8-45f6-b671-7a8c58551558"},{"name":"Download Frenchie by UUID","event":[{"listen":"prerequest","script":{"id":"377cc244-f8e4-4076-9b52-013ca2364a45","exec":["const moment = require('moment');","pm.globals.set(\"today\", moment().format(\"YYYY-MM-DD\"));","console.log(moment().format(\"YYYY-MM-DD\"));"],"type":"text/javascript","packages":{}}}],"id":"3e665604-3a76-4d57-bd70-a1fb30715212","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"client-id","value":"{{client_api_id}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/Users/davinogueira/Downloads/CNAB400.rem"}]},"url":"{{base_url}}/api/v1/wallets/:wallet_uuid/cnab-file-frenchie/:frenchie_uuid/download","urlObject":{"path":["api","v1","wallets",":wallet_uuid","cnab-file-frenchie",":frenchie_uuid","download"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"wallet_uuid"},{"type":"any","value":"","key":"frenchie_uuid"}]}},"response":[{"id":"749545f0-0751-44c9-9a8a-db44aaa98ea5","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0,\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\"\n },\n {\n \"payerState\": \"RJ\",\n \"documentDate\": \"2024-02-15\",\n \"documentNumber\": \"00045061-2\",\n \"dueDate\": \"2024-11-30\",\n \"payerCity\": \"RIO DE JANEIRO\",\n \"speciesId\": 1,\n \"payerAddress\": \"Avenida das Palmeiras\",\n \"payerZipCode\": \"22001234\",\n \"payerType\": 1,\n \"payerDocument\": 2034567890,\n \"payerName\": \"Maria Oliveira\",\n \"nominalValue\": 850.25,\n \"interestValue\": 1.5,\n \"payerNeighborhood\": \"COPACABANA\",\n \"interestType\": \"PERCENTAGE\"\n },\n {\n \"payerState\": \"MG\",\n \"documentDate\": \"2024-03-10\",\n \"documentNumber\": \"00045061-3\",\n \"dueDate\": \"2024-10-15\",\n \"payerCity\": \"BELO HORIZONTE\",\n \"speciesId\": 3,\n \"payerAddress\": \"Travessa dos Ipês\",\n \"payerZipCode\": \"30111222\",\n \"payerType\": 0,\n \"payerDocument\": 3056789012,\n \"payerName\": \"Carlos Alberto Lima\",\n \"nominalValue\": 450.75,\n \"interestValue\": 2.5,\n \"payerNeighborhood\": \"SANTA EFIGÊNIA\",\n \"interestType\": \"FIXED_AMOUNT\"\n },\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0, //[ 0 = natural person, 1 = legal person]\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\" // [FIXED_AMOUNT, PERCENTAGE, EXEMPT]\n },\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0, //[ 0 = natural person, 1 = legal person]\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\" // [FIXED_AMOUNT, PERCENTAGE, EXEMPT]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/slip/batch"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": {\n \"keys\": [\n {\n \"uuid\":\"035417b4-a067-4025-9ada-c3172b10c7bd\",\n \"documentNumber\": \"00045061-1\"\n },\n {\n \"uuid\":\"e1ed5568-4461-4115-bb93-a3194deab437\",\n \"documentNumber\": \"00045061-2\"\n },\n {\n \"uuid\":\"857396f7-33ed-408a-a0b9-89df8cf9239f\",\n \"documentNumber\": \"00045061-3\"\n } \n ]\n }\n}"}],"_postman_id":"3e665604-3a76-4d57-bd70-a1fb30715212"},{"name":"Download Today File","event":[{"listen":"prerequest","script":{"id":"377cc244-f8e4-4076-9b52-013ca2364a45","exec":["const moment = require('moment');","pm.globals.set(\"today\", moment().format(\"YYYY-MM-DD\"));","console.log(moment().format(\"YYYY-MM-DD\"));"],"type":"text/javascript","packages":{}}}],"id":"0376728c-a063-47d5-9c97-1f00248e6264","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"client-id","value":"{{client_api_id}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/Users/davinogueira/Downloads/CNAB400.rem"}]},"url":"{{base_url}}/api/v1/wallets/:wallet_uuid/cnab-file-return-today","urlObject":{"path":["api","v1","wallets",":wallet_uuid","cnab-file-return-today"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"452915ca-94fc-4d97-a262-cf944bb62145","key":"wallet_uuid"}]}},"response":[{"id":"466bf74b-3f13-4ed4-b807-1267e853273b","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0,\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\"\n },\n {\n \"payerState\": \"RJ\",\n \"documentDate\": \"2024-02-15\",\n \"documentNumber\": \"00045061-2\",\n \"dueDate\": \"2024-11-30\",\n \"payerCity\": \"RIO DE JANEIRO\",\n \"speciesId\": 1,\n \"payerAddress\": \"Avenida das Palmeiras\",\n \"payerZipCode\": \"22001234\",\n \"payerType\": 1,\n \"payerDocument\": 2034567890,\n \"payerName\": \"Maria Oliveira\",\n \"nominalValue\": 850.25,\n \"interestValue\": 1.5,\n \"payerNeighborhood\": \"COPACABANA\",\n \"interestType\": \"PERCENTAGE\"\n },\n {\n \"payerState\": \"MG\",\n \"documentDate\": \"2024-03-10\",\n \"documentNumber\": \"00045061-3\",\n \"dueDate\": \"2024-10-15\",\n \"payerCity\": \"BELO HORIZONTE\",\n \"speciesId\": 3,\n \"payerAddress\": \"Travessa dos Ipês\",\n \"payerZipCode\": \"30111222\",\n \"payerType\": 0,\n \"payerDocument\": 3056789012,\n \"payerName\": \"Carlos Alberto Lima\",\n \"nominalValue\": 450.75,\n \"interestValue\": 2.5,\n \"payerNeighborhood\": \"SANTA EFIGÊNIA\",\n \"interestType\": \"FIXED_AMOUNT\"\n },\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0, //[ 0 = natural person, 1 = legal person]\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\" // [FIXED_AMOUNT, PERCENTAGE, EXEMPT]\n },\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0, //[ 0 = natural person, 1 = legal person]\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\" // [FIXED_AMOUNT, PERCENTAGE, EXEMPT]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/slip/batch"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": {\n \"keys\": [\n {\n \"uuid\":\"f96d342e-79b9-443e-83f7-1beca0821799\",\n \"documentNumber\": \"00045061-1\"\n },\n {\n \"uuid\":\"93e82302-8582-4611-8108-6b6384b10ef9\",\n \"documentNumber\": \"00045061-2\"\n },\n {\n \"uuid\":\"166a4b26-8c7c-40e0-aa57-8aadb22dc235\",\n \"documentNumber\": \"00045061-3\"\n } \n ]\n }\n}"}],"_postman_id":"0376728c-a063-47d5-9c97-1f00248e6264"},{"name":"Download Today Frechie","event":[{"listen":"prerequest","script":{"id":"377cc244-f8e4-4076-9b52-013ca2364a45","exec":["const moment = require('moment');","pm.globals.set(\"today\", moment().format(\"YYYY-MM-DD\"));","console.log(moment().format(\"YYYY-MM-DD\"));"],"type":"text/javascript","packages":{}}}],"id":"2170338d-c09a-4f8a-a528-08d64a7b1962","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"client-id","value":"{{client_api_id}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/Users/davinogueira/Downloads/CNAB400.rem"}]},"url":"{{base_url}}/api/v1/wallets/:wallet_uuid/cnab-file-frenchie-today","urlObject":{"path":["api","v1","wallets",":wallet_uuid","cnab-file-frenchie-today"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"452915ca-94fc-4d97-a262-cf944bb62145","key":"wallet_uuid"}]}},"response":[{"id":"88d40922-6aab-4b71-8a2d-07312599a252","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0,\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\"\n },\n {\n \"payerState\": \"RJ\",\n \"documentDate\": \"2024-02-15\",\n \"documentNumber\": \"00045061-2\",\n \"dueDate\": \"2024-11-30\",\n \"payerCity\": \"RIO DE JANEIRO\",\n \"speciesId\": 1,\n \"payerAddress\": \"Avenida das Palmeiras\",\n \"payerZipCode\": \"22001234\",\n \"payerType\": 1,\n \"payerDocument\": 2034567890,\n \"payerName\": \"Maria Oliveira\",\n \"nominalValue\": 850.25,\n \"interestValue\": 1.5,\n \"payerNeighborhood\": \"COPACABANA\",\n \"interestType\": \"PERCENTAGE\"\n },\n {\n \"payerState\": \"MG\",\n \"documentDate\": \"2024-03-10\",\n \"documentNumber\": \"00045061-3\",\n \"dueDate\": \"2024-10-15\",\n \"payerCity\": \"BELO HORIZONTE\",\n \"speciesId\": 3,\n \"payerAddress\": \"Travessa dos Ipês\",\n \"payerZipCode\": \"30111222\",\n \"payerType\": 0,\n \"payerDocument\": 3056789012,\n \"payerName\": \"Carlos Alberto Lima\",\n \"nominalValue\": 450.75,\n \"interestValue\": 2.5,\n \"payerNeighborhood\": \"SANTA EFIGÊNIA\",\n \"interestType\": \"FIXED_AMOUNT\"\n },\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0, //[ 0 = natural person, 1 = legal person]\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\" // [FIXED_AMOUNT, PERCENTAGE, EXEMPT]\n },\n {\n \"payerState\": \"SP\",\n \"documentDate\": \"2024-01-26\",\n \"documentNumber\": \"00045061-1\",\n \"dueDate\": \"2024-12-20\",\n \"payerCity\": \"SAO PAULO\",\n \"speciesId\": 2,\n \"payerAddress\": \"Rua Francisco Antônio Santos\",\n \"payerZipCode\": \"49001231\",\n \"payerType\": 0, //[ 0 = natural person, 1 = legal person]\n \"payerDocument\": 1023419580,\n \"payerName\": \"Roberto Carlos da Silva\",\n \"nominalValue\": 635.64,\n \"interestValue\": 2.0,\n \"payerNeighborhood\": \"JARDIM HEBROM\",\n \"interestType\": \"FIXED_AMOUNT\" // [FIXED_AMOUNT, PERCENTAGE, EXEMPT]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/slip/batch"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": {\n \"keys\": [\n {\n \"uuid\":\"633482d3-9e76-4575-9955-918be11ece1c\",\n \"documentNumber\": \"00045061-1\"\n },\n {\n \"uuid\":\"0e025a25-55ea-4e1b-851b-04cc0f4fce6e\",\n \"documentNumber\": \"00045061-2\"\n },\n {\n \"uuid\":\"398f57e6-ff62-4f9f-b4f6-15e2bf092d11\",\n \"documentNumber\": \"00045061-3\"\n } \n ]\n }\n}"}],"_postman_id":"2170338d-c09a-4f8a-a528-08d64a7b1962"}],"id":"5d0e80bc-fb12-400c-8ede-0153309ecfc5","_postman_id":"5d0e80bc-fb12-400c-8ede-0153309ecfc5","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"d908543a-8344-40d7-8ecf-4e73ab61d70e","id":"d908543a-8344-40d7-8ecf-4e73ab61d70e","name":"Bank Slip (Boleto)","type":"folder"}}},{"name":"List","id":"4a2f2e4c-36ea-42a6-a592-3e996b9db3b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/wallets/:wallet_uuid/cnab","description":"status FieldThe status field can have one of the following values:
WAITING: The file has been created but processing has not yet started.
VALIDATING_ERROR: The file failed validation checks.
PROCESSING: The file is currently being processed.
PROCESSING_ERROR: The file passed validation but encountered an error during processing.
PROCESSED: The file was successfully processed.
Kanastra uses the CNAB400 layout to process billing files. These files contain detailed instructions for registering, settling, or canceling payment slips, ensuring that the entire billing workflow is handled in a standardized and automated way.
To ensure correct processing, it is mandatory to follow Kanastra’s official layout, which precisely defines the required fields and formats.
\nYou can access the official layout by the following link:
Kanastra's CNAB400 official reference manual
This endpoint retrieves a paginated list of bank slips. Each bank slip includes details such as unique identifiers, document dates, barcodes, line codes, due dates, nominal values, payer information, and calculated taxes. This endpoint is useful for fetching bank slips associated with a specific wallet for management and processing purposes.
\n","urlObject":{"path":["api","v1","wallets",":wallet_uuid","bank-slip"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"barCode","value":"{{codigo_de_barras}}"}],"variable":[{"type":"any","value":"966ea194-7a3a-4186-9f95-c51abfb920e2","key":"wallet_uuid"}]}},"response":[{"id":"ee4f59b2-8cc7-406a-a3fa-104a2ae3c68a","name":"OK List","originalRequest":{"method":"GET","header":[{"key":"client-id","value":"tech-hub-client","type":"text"}],"url":{"raw":"https://banking-sandbox.kanastra.com.br/api/v1/wallets/:wallet_uuid/bank-slip","protocol":"https","host":["banking-sandbox","kanastra","com","br"],"path":["api","v1","wallets",":wallet_uuid","bank-slip"],"variable":[{"key":"wallet_uuid","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 4,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"uuid\": \"57030b7e-7ebc-456f-b622-d043e4e12354\",\n \"participantControlNumber\": \"e613eb28-93c3-4698-8847-f0e202101659\",\n \"documentDate\": \"2024-06-25\",\n \"barCode\": \"55991993600000635648741925197495073000995705\",\n \"lineCode\": \"55998.74194 25197.495077 30009.957058 1 99360000063564\",\n \"ourNumber\": \"874192519749\",\n \"documentNumber\": \"00045065-1\",\n \"dueDate\": \"2024-12-20\",\n \"speciesId\": 2,\n \"nominalValue\": \"635.64\",\n \"interestValue\": \"2.00\",\n \"status\": \"PROCESSING\",\n \"interestType\": \"PERCENTAGE\",\n \"payer\": {\n \"uuid\": \"a9a7119c-5ca2-49d4-8332-ce8d2dc2bd39\",\n \"type\": \"NATURAL\",\n \"governmentId\": \"94384263708\",\n \"name\": \"Roberto Carlos da Silva\",\n \"phone\": \"1931039210\",\n \"email\": null,\n \"addressStreet\": \"Rua Francisco Antônio Santos\",\n \"addressNumber\": 123,\n \"addressComplement\": null,\n \"addressNeighborhood\": \"JARDIM HEBROM\",\n \"addressZipcode\": \"49001231\",\n \"addressCity\": \"São Paulo\",\n \"addressState\": \"SP\",\n \"contactName\": null,\n \"contactEmail\": null,\n \"contactPhone\": null,\n \"address\": {\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"street\": \"Rua Francisco Antônio Santos\",\n \"number\": \"123\",\n \"complement\": null,\n \"neighborhood\": \"JARDIM HEBROM\",\n \"zipcode\": \"49001231\"\n },\n \"contact\": {\n \"email\": null,\n \"phone\": null,\n \"name\": null\n },\n \"isDeleted\": false,\n \"createdAt\": \"2024-06-25T16:02:04.889957-03:00\",\n \"updatedAt\": \"2024-06-25T16:18:13.432830-03:00\",\n \"parent\": null\n },\n \"payDate\": null,\n \"payValue\": null,\n \"discountValue\": \"10.00\",\n \"discountLimit\": \"2024-12-19\",\n \"messages\": \"Mensagem de cobrança\",\n \"fineValue\": \"1.00\",\n \"fineType\": \"PERCENTAGE\",\n \"expireAt\": null,\n \"emails\": [],\n \"overdue\": false,\n \"calculatedTaxes\": {\n \"interest\": 0,\n \"fine\": 0,\n \"discount\": 0,\n \"total\": 0\n }\n },\n {\n \"uuid\": \"9d1aaa84-37a4-4009-b20a-17fbd4fdbfcc\",\n \"participantControlNumber\": \"a397e518-c903-425b-b744-b55d93ba4ec9\",\n \"documentDate\": \"2024-06-25\",\n \"barCode\": \"55997993600000635649685927254318073000995705\",\n \"lineCode\": \"55999.68590 27254.318077 30009.957058 7 99360000063564\",\n \"ourNumber\": \"968592725431\",\n \"documentNumber\": \"00045065-1\",\n \"dueDate\": \"2024-12-20\",\n \"speciesId\": 2,\n \"nominalValue\": \"635.64\",\n \"interestValue\": \"2.00\",\n \"status\": \"PROCESSING\",\n \"interestType\": \"PERCENTAGE\",\n \"payer\": {\n \"uuid\": \"a9a7119c-5ca2-49d4-8332-ce8d2dc2bd39\",\n \"type\": \"NATURAL\",\n \"governmentId\": \"94384263708\",\n \"name\": \"Roberto Carlos da Silva\",\n \"phone\": \"1931039210\",\n \"email\": null,\n \"addressStreet\": \"Rua Francisco Antônio Santos\",\n \"addressNumber\": 123,\n \"addressComplement\": null,\n \"addressNeighborhood\": \"JARDIM HEBROM\",\n \"addressZipcode\": \"49001231\",\n \"addressCity\": \"São Paulo\",\n \"addressState\": \"SP\",\n \"contactName\": null,\n \"contactEmail\": null,\n \"contactPhone\": null,\n \"address\": {\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"street\": \"Rua Francisco Antônio Santos\",\n \"number\": \"123\",\n \"complement\": null,\n \"neighborhood\": \"JARDIM HEBROM\",\n \"zipcode\": \"49001231\"\n },\n \"contact\": {\n \"email\": null,\n \"phone\": null,\n \"name\": null\n },\n \"isDeleted\": false,\n \"createdAt\": \"2024-06-25T16:02:04.889957-03:00\",\n \"updatedAt\": \"2024-06-25T16:18:13.432830-03:00\",\n \"parent\": null\n },\n \"payDate\": null,\n \"payValue\": null,\n \"discountValue\": \"10.00\",\n \"discountLimit\": \"2024-12-19\",\n \"messages\": \"Mensagem de cobrança\",\n \"fineValue\": \"1.00\",\n \"fineType\": \"PERCENTAGE\",\n \"expireAt\": null,\n \"emails\": [],\n \"overdue\": false,\n \"calculatedTaxes\": {\n \"interest\": 0,\n \"fine\": 0,\n \"discount\": 0,\n \"total\": 0\n }\n },\n {\n \"uuid\": \"660b76e5-cfc4-47df-b9fa-bda48642f81f\",\n \"participantControlNumber\": \"a04dd6eb-2e83-4d79-b97c-4ba1652ade3c\",\n \"documentDate\": \"2024-06-25\",\n \"barCode\": \"55991993600000635643402858511724073000995705\",\n \"lineCode\": \"55993.40287 58511.724070 30009.957058 1 99360000063564\",\n \"ourNumber\": \"340285851172\",\n \"documentNumber\": \"00045065-1\",\n \"dueDate\": \"2024-12-20\",\n \"speciesId\": 2,\n \"nominalValue\": \"635.64\",\n \"interestValue\": \"2.00\",\n \"status\": \"PROCESSING\",\n \"interestType\": \"PERCENTAGE\",\n \"payer\": {\n \"uuid\": \"a9a7119c-5ca2-49d4-8332-ce8d2dc2bd39\",\n \"type\": \"NATURAL\",\n \"governmentId\": \"94384263708\",\n \"name\": \"Roberto Carlos da Silva\",\n \"phone\": \"1931039210\",\n \"email\": null,\n \"addressStreet\": \"Rua Francisco Antônio Santos\",\n \"addressNumber\": 123,\n \"addressComplement\": null,\n \"addressNeighborhood\": \"JARDIM HEBROM\",\n \"addressZipcode\": \"49001231\",\n \"addressCity\": \"São Paulo\",\n \"addressState\": \"SP\",\n \"contactName\": null,\n \"contactEmail\": null,\n \"contactPhone\": null,\n \"address\": {\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"street\": \"Rua Francisco Antônio Santos\",\n \"number\": \"123\",\n \"complement\": null,\n \"neighborhood\": \"JARDIM HEBROM\",\n \"zipcode\": \"49001231\"\n },\n \"contact\": {\n \"email\": null,\n \"phone\": null,\n \"name\": null\n },\n \"isDeleted\": false,\n \"createdAt\": \"2024-06-25T16:02:04.889957-03:00\",\n \"updatedAt\": \"2024-06-25T16:18:13.432830-03:00\",\n \"parent\": null\n },\n \"payDate\": null,\n \"payValue\": null,\n \"discountValue\": \"10.00\",\n \"discountLimit\": \"2024-12-19\",\n \"messages\": \"Mensagem de cobrança\",\n \"fineValue\": \"1.00\",\n \"fineType\": \"PERCENTAGE\",\n \"expireAt\": null,\n \"emails\": [],\n \"overdue\": false,\n \"calculatedTaxes\": {\n \"interest\": 0,\n \"fine\": 0,\n \"discount\": 0,\n \"total\": 0\n }\n },\n {\n \"uuid\": \"2c5156f9-1df6-4b9b-bb5e-45b1e4037a8c\",\n \"participantControlNumber\": \"9de6edd8-4df7-43a5-934c-1b31df0e47e1\",\n \"documentDate\": \"2024-06-25\",\n \"barCode\": \"55999993600000635644772088301081073000995705\",\n \"lineCode\": \"55994.77204 88301.081076 30009.957058 9 99360000063564\",\n \"ourNumber\": \"477208830108\",\n \"documentNumber\": \"00045065-1\",\n \"dueDate\": \"2024-12-20\",\n \"speciesId\": 2,\n \"nominalValue\": \"635.64\",\n \"interestValue\": \"2.00\",\n \"status\": \"PROCESSING\",\n \"interestType\": \"PERCENTAGE\",\n \"payer\": {\n \"uuid\": \"a9a7119c-5ca2-49d4-8332-ce8d2dc2bd39\",\n \"type\": \"NATURAL\",\n \"governmentId\": \"94384263708\",\n \"name\": \"Roberto Carlos da Silva\",\n \"phone\": \"1931039210\",\n \"email\": null,\n \"addressStreet\": \"Rua Francisco Antônio Santos\",\n \"addressNumber\": 123,\n \"addressComplement\": null,\n \"addressNeighborhood\": \"JARDIM HEBROM\",\n \"addressZipcode\": \"49001231\",\n \"addressCity\": \"São Paulo\",\n \"addressState\": \"SP\",\n \"contactName\": null,\n \"contactEmail\": null,\n \"contactPhone\": null,\n \"address\": {\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"street\": \"Rua Francisco Antônio Santos\",\n \"number\": \"123\",\n \"complement\": null,\n \"neighborhood\": \"JARDIM HEBROM\",\n \"zipcode\": \"49001231\"\n },\n \"contact\": {\n \"email\": null,\n \"phone\": null,\n \"name\": null\n },\n \"isDeleted\": false,\n \"createdAt\": \"2024-06-25T16:02:04.889957-03:00\",\n \"updatedAt\": \"2024-06-25T16:18:13.432830-03:00\",\n \"parent\": null\n },\n \"payDate\": null,\n \"payValue\": null,\n \"discountValue\": \"10.00\",\n \"discountLimit\": \"2024-12-19\",\n \"messages\": \"Mensagem de cobrança\",\n \"fineValue\": \"1.00\",\n \"fineType\": \"PERCENTAGE\",\n \"expireAt\": null,\n \"emails\": [],\n \"overdue\": false,\n \"calculatedTaxes\": {\n \"interest\": 0,\n \"fine\": 0,\n \"discount\": 0,\n \"total\": 0\n }\n }\n ]\n}"}],"_postman_id":"ca6b5459-4b45-4dc3-8362-3071deeb7951"},{"name":"Retrieve","id":"8df72288-87e9-49fc-8a50-6d78638c2136","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/wallets/:wallet_uuid/bank-slip/:bank_slip_uuid","description":"Retrieves detailed information about a specific bank slip identified by its unique ID and wallet ID.
\n","urlObject":{"path":["api","v1","wallets",":wallet_uuid","bank-slip",":bank_slip_uuid"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"wallet_uuid"},{"type":"any","value":"","key":"bank_slip_uuid"}]}},"response":[{"id":"441903aa-b327-4455-a489-830b0102213e","name":"OK Retrieve","originalRequest":{"method":"GET","header":[{"key":"client-id","value":"tech-hub-client","type":"text"}],"url":{"raw":"https://banking-sandbox.kanastra.com.br/api/v1/wallets/:wallet_uuid/bank-slip/:bank_slip_uuid","protocol":"https","host":["banking-sandbox","kanastra","com","br"],"path":["api","v1","wallets",":wallet_uuid","bank-slip",":bank_slip_uuid"],"variable":[{"key":"wallet_uuid","value":""},{"key":"bank_slip_uuid","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"5cc5b868-0e1b-4d3b-b068-abedd4d5568b\",\n \"participantControlNumber\": \"1befb7df-5f1a-48a7-a8dc-ca146ce46a3b\",\n \"documentDate\": \"2024-06-25\",\n \"barCode\": \"55999993600000635641677509869181073000995705\",\n \"lineCode\": \"55991.67755 09869.181074 30009.957058 9 99360000063564\",\n \"ourNumber\": \"167750986918\",\n \"documentNumber\": \"00045065-1\",\n \"dueDate\": \"2024-12-20\",\n \"speciesId\": 2,\n \"nominalValue\": \"635.64\",\n \"interestValue\": \"2.00\",\n \"status\": \"PROCESSING\",\n \"interestType\": \"PERCENTAGE\",\n \"payer\": {\n \"uuid\": \"a9a7119c-5ca2-49d4-8332-ce8d2dc2bd39\",\n \"type\": \"NATURAL\",\n \"governmentId\": \"94384263708\",\n \"name\": \"Roberto Carlos da Silva\",\n \"phone\": \"1931039210\",\n \"email\": null,\n \"addressStreet\": \"Rua Francisco Antônio Santos\",\n \"addressNumber\": 123,\n \"addressComplement\": null,\n \"addressNeighborhood\": \"JARDIM HEBROM\",\n \"addressZipcode\": \"49001231\",\n \"addressCity\": \"São Paulo\",\n \"addressState\": \"SP\",\n \"contactName\": null,\n \"contactEmail\": null,\n \"contactPhone\": null,\n \"address\": {\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"street\": \"Rua Francisco Antônio Santos\",\n \"number\": \"123\",\n \"complement\": null,\n \"neighborhood\": \"JARDIM HEBROM\",\n \"zipcode\": \"49001231\"\n },\n \"contact\": {\n \"email\": null,\n \"phone\": null,\n \"name\": null\n },\n \"isDeleted\": false,\n \"createdAt\": \"2024-06-25T16:02:04.889957-03:00\",\n \"updatedAt\": \"2024-06-25T16:43:15.205549-03:00\",\n \"parent\": null\n },\n \"payDate\": null,\n \"payValue\": null,\n \"discountValue\": \"10.00\",\n \"discountLimit\": \"2024-12-19\",\n \"messages\": \"Mensagem de cobrança\",\n \"fineValue\": \"1.00\",\n \"fineType\": \"PERCENTAGE\",\n \"expireAt\": null,\n \"emails\": [],\n \"overdue\": false,\n \"calculatedTaxes\": {\n \"interest\": 0,\n \"fine\": 0,\n \"discount\": 0,\n \"total\": 0\n }\n}"}],"_postman_id":"8df72288-87e9-49fc-8a50-6d78638c2136"},{"name":"Get PDF File","id":"d0db3fb2-2f72-44e1-9e3f-eac710b06a6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/wallets/:wallet_uuid/bank-slip/:bank_slip_uuid/pdf","description":"Return the PDF file of the given bank slip ID
\n","urlObject":{"path":["api","v1","wallets",":wallet_uuid","bank-slip",":bank_slip_uuid","pdf"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"wallet_uuid"},{"type":"any","value":"","key":"bank_slip_uuid"}]}},"response":[{"id":"4ee741cd-df35-4016-91a2-06061c52e700","name":"Get PDF File","originalRequest":{"method":"GET","header":[{"key":"client-id","value":"tech-hub-client","type":"text"}],"url":{"raw":"https://banking-sandbox.kanastra.com.br/api/v1/wallets/:wallet_id/bank-slip/:bank_slip_id/pdf","protocol":"https","host":["banking-sandbox","kanastra","com","br"],"path":["api","v1","wallets",":wallet_id","bank-slip",":bank_slip_id","pdf"],"variable":[{"key":"wallet_id","value":"7ce74d14-62c4-434f-889f-8ba7abcc2f90"},{"key":"bank_slip_id","value":"5cc5b868-0e1b-4d3b-b068-abedd4d5568b"}]}},"_postman_previewlanguage":"Text","header":[{"key":"content-type","value":"application/pdf","description":"","type":"text"},{"key":"content-disposition","value":"attachment; filename=\"bcac8a0e-b52d-4925-b6b5-6f6.pdf\"","description":"","type":"text"},{"key":"content-length","value":"11219","description":"","type":"text"},{"key":"date","value":"Tue, 25 Jun 2024 20:16:23 GMT","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"Return the file itself"}],"_postman_id":"d0db3fb2-2f72-44e1-9e3f-eac710b06a6f"},{"name":"Create Bank Slips","id":"bd4d42a4-a2f0-414b-a9a1-db5185214e70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"documentDate\": \"2026-02-11\",\n \"documentNumber\": \"00045065-1\",\n \"participantControlNumber\": \"1284-2569343-432473-43209\",\n \"dueDate\": \"2024-12-20\",\n \"nominalValue\": \"635.64\",\n \"interestValue\": \"2.0\",\n \"interestType\": \"PERCENTAGE\",\n \"fineValue\": \"1.0\",\n \"fineType\": \"PERCENTAGE\",\n \"demonstrative\": \"Demonstrativo do boleto\\nDemonstrativo linha 2\\nDemonstrativo do boleto linha 3\",\n \"discountValue\": \"10.0\",\n \"discountLimit\": \"2024-12-19\",\n \"messages\": \"Mensagem no boleto\\nLinha 2 da mensagem\\nLinha 3 da mensagem\",\n \"expirationDays\": 100,\n \"emails\": [\n \"robertocarlosdasilva@kanastra.com.br\",\n \"robertocarlosdasilva2@kanastra.com.br\"\n ],\n \"ourNumber\": \"\",\n \"payer\": {\n \"type\": \"NATURAL\",\n \"governmentId\": \"94384263708\",\n \"name\": \"Roberto Carlos da Silva\",\n \"phone\": \"1931039210\",\n \"addressStreet\": \"Rua Francisco Antônio Santos\",\n \"addressNumber\": \"123\",\n \"addressComplement\": null,\n \"addressNeighborhood\": \"JARDIM HEBROM\",\n \"addressZipcode\": \"49001231\",\n \"addressCity\": \"São Paulo\",\n \"addressState\": \"SP\"\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/wallets/:wallet_uuid/bank-slip/batch","description":"This endpoint allows the cancellation of a bank slip, provided that its current status is OPEN. A bank slip with any other status (e.g., PAID, SETTLED) cannot be cancelled.
This endpoint updates specific fields of a bank slip. Like the cancellation operation, this endpoint can only be used on bank slips that are in the OPEN status. Partial updates are allowed, where only specified fields need to be included in the request.
Our bank slip service provides a simplified and efficient solution for handling financial transactions. With a straightforward approach, we present the main services available:
\nBank Slip Registration API:
Generate bank slip quickly and efficiently using a simple JSON API integration. This service offers a hassle-free method for bank slip generation, streamlining the financial transaction process.
Bank Slip Consultation:
Access detailed information about issued bank slips. This functionality provides complete visibility of the status and due dates.
PDF Bank Slip:
Your bank slip ready for payment. Obtain bank slips in PDF format for easy sharing and electronic storage. PDF issuance offers convenience in the distribution of financial documents.
This document provides the technical specifications and business logic for integrating bank slip (boleto) generation via the Kanastra API. It defines how to handle identifiers, idempotency, and the specific lifecycle between Kanastra’s database and the Nuclea clearing house.
\nparticipantControlNumber (Client or Funds Reference)Definition: The primary external identifier provided by the Originator (e.g., ERP internal ID, specific fund reference, or transaction ID).
\nPriority: This is the first and preferred option for providing an external reference.
\nValidation: Maximum length of 25 characters. This limit is strictly enforced to ensure compatibility with the CNAB 400 (remittance and return files) layout.
\nPurpose: Primary field for the client’s internal reconciliation and cross-referencing with their own systems.
\ndocumentNumber (Secondary Reference)Definition: A secondary external identifier (e.g., Invoice number or Contract ID).
\nPriority: This is the second option for external references.
\nValidation: Maximum length of 10 characters. This limit is strictly enforced due to the structural constraints of the CNAB 400 layout for remittance and return.
\nNote: Kanastra performs no validation (uniqueness or format) on this field; it acts as pass-through metadata within the allowed character limit.
\nPurpose: Used for additional internal mapping and reconciliation when the primary reference field is already in use.
\nourNumber (Unique Identifier & Idempotency Key)Definition: The primary key for the bank slip within the banking network.
\nUniqueness: This value must be unique within your assigned wallet range.
\nIdempotency: This field must be used as the primary mechanism to prevent duplicate charges per Wallet.
\nLast updated: February 2026
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"2d710970-60ce-47ff-981c-b7b38710dbb3"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"f2b1f7bc-510a-4eb0-8be7-a9ae717ade0b"}}],"_postman_id":"d908543a-8344-40d7-8ecf-4e73ab61d70e"},{"name":"Commercial Note","item":[{"name":"Issuers","item":[{"name":"List","id":"9b734307-5a25-4274-bcb2-b0de28595b38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/issuers","description":"Retrieves a list of all registered issuers, along with their associated details.
\n","urlObject":{"path":["api","v1","issuers"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"fd0b900c-ac7a-4e70-a0df-dc333e120c6e","name":"OK List","originalRequest":{"method":"GET","header":[{"key":"client-id","value":"tech-hub-client","type":"text"}],"url":"https://banking-sandbox.kanastra.com.br/api/v1/issuers"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"uuid\": \"1a58bbed-0449-40e8-9fce-e3d64399dc1a\",\n \"name\": \"Metallica\",\n \"governmentId\": \"31084694000116\",\n \"bankAccount\": null,\n \"address\": {\n \"city\": \"Curitiba\",\n \"state\": \"PR\",\n \"street\": \"Rua Holanda\",\n \"number\": \"166\",\n \"complement\": \"Casa 1\",\n \"neighborhood\": \"Bom Retiro\",\n \"zipcode\": \"80550120\"\n },\n \"contact\": {\n \"email\": \"contato@kanastra.com.br\",\n \"phone\": \"41999999999\",\n \"name\": \"James Hetfield\"\n },\n \"guarantees\": {\n \"guarantors\": [],\n \"vehicles\": []\n },\n \"representatives\": [],\n \"businessSector\": \"METALLIC\",\n \"annualBilling\": \"100000.00\",\n \"municipalRegistration\": \"152513\",\n \"stateRegistration\": \"4403084650\",\n \"cnae\": \"3314718\",\n \"companySize\": \"BIG\",\n \"partnerShipType\": \"LTDA\",\n \"inJudicialRecovery\": false,\n \"hasDebitUnion\": false,\n \"dueDiligenceStatus\": \"APPROVED\"\n }\n ]\n}"}],"_postman_id":"9b734307-5a25-4274-bcb2-b0de28595b38"},{"name":"Retrieve","id":"45e8704b-f814-42da-80d1-fcab5e0ad574","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/issuers/:issuer_uuid","description":"Retrieves detailed information about a specific issuer identified by its unique ID.
\n","urlObject":{"path":["api","v1","issuers",":issuer_uuid"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"issuer_uuid"}]}},"response":[{"id":"688cd147-a017-4ad1-b32a-0116d5604267","name":"OK Retrieve","originalRequest":{"method":"GET","header":[{"key":"client-id","value":"tech-hub-client","type":"text"}],"url":{"raw":"https://banking-sandbox.kanastra.com.br/api/v1/issuers/:issuer_id","protocol":"https","host":["banking-sandbox","kanastra","com","br"],"path":["api","v1","issuers",":issuer_id"],"variable":[{"key":"issuer_id","value":"1a58bbed-0449-40e8-9fce-e3d64399dc1a"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"1a58bbed-0449-40e8-9fce-e3d64399dc1a\",\n \"name\": \"Metallica\",\n \"governmentId\": \"31084694000116\",\n \"bankAccount\": null,\n \"address\": {\n \"city\": \"Curitiba\",\n \"state\": \"PR\",\n \"street\": \"Rua Holanda\",\n \"number\": \"166\",\n \"complement\": \"Casa 1\",\n \"neighborhood\": \"Bom Retiro\",\n \"zipcode\": \"80550120\"\n },\n \"contact\": {\n \"email\": \"contato@kanastra.com.br\",\n \"phone\": \"41999999999\",\n \"name\": \"James Hetfield\"\n },\n \"guarantees\": {\n \"guarantors\": [],\n \"vehicles\": []\n },\n \"representatives\": [],\n \"businessSector\": \"METALLIC\",\n \"annualBilling\": \"100000.00\",\n \"municipalRegistration\": \"152513\",\n \"stateRegistration\": \"4403084650\",\n \"cnae\": \"3314718\",\n \"companySize\": \"BIG\",\n \"partnerShipType\": \"LTDA\",\n \"inJudicialRecovery\": false,\n \"hasDebitUnion\": false,\n \"dueDiligenceStatus\": \"APPROVED\"\n}"}],"_postman_id":"45e8704b-f814-42da-80d1-fcab5e0ad574"},{"name":"Create","id":"1ce3606c-5e20-4d81-9ffd-f5c6d03647e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Issuer Name\",\n \"governmentId\": \"33647468000121\",\n \"businessSector\": \"BUSINESS\",\n \"annualBilling\": 10000.00,\n \"municipalRegistration\": \"898778\",\n \"cnae\": \"298938\",\n \"companySize\": \"MEDIUM\",\n \"partnerShipType\": \"LTDA\",\n \"inJudicialRecovery\": false,\n \"hasDebitUnion\": false,\n \"contact\": {\n \"name\": \"Ana Maria Braga\",\n \"email\": \"email_teste@kanastra.com.br\",\n \"phone\": \"1138735556\"\n },\n \"address\": {\n \"street\": \"Rua Ângelo Zanini\",\n \"number\": \"354\",\n \"complement\": \"\",\n \"neighborhood\": \"Jardim Cidade Pirituba\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zipcode\": \"02940020\"\n },\n \"guarantees\": {\n \"guarantors\": [\n {\n \"name\": \"Kanastra Gestao de Recursos LTDA\",\n \"governmentId\": \"44870622000198\",\n \"email\": \"contato@kanastra.com.br\",\n \"address\": {\n \"street\": \"Rua Fake\",\n \"number\": 123,\n \"complement\": \"Complement Fake\",\n \"neighborhood\": \"Bairro Fake\",\n \"city\": \"Cidade Fake\",\n \"state\": \"SP\",\n \"zipcode\": \"12345678\"\n }\n }\n ],\n \"vehicles\": [ //optional\n {\n \"description\": \"Ford Escort em perfeito estado\",\n \"conditionType\": \"NEW\",\n \"licencePlate\": \"BRA0990\",\n \"model\": \"Ford Escort\",\n \"color\": \"CINZA GRENOBLE METÁLICO\",\n \"chassi\": \"9K3RKS9VB52512KIG\",\n \"renavam\": \"MMX2O221555\",\n \"state\": \"SP\",\n \"evaluationBase\": \"FIPE\",\n \"assetAmount\": 38223.55,\n \"year\": \"1996\",\n \"manufactureYear\": \"1996\",\n \"brand\": \"FORD\",\n \"ownershipDocument\": \"data:application/pdf;base64,JVBERi0xLjYNJeLjz9MNCjI0IDAgb2JqDTw8L0ZpbHRlci9GbGF0ZURlY29kZS9GaXJzdCA0L0xlbmd0aCAyMTYvTiAxL1R5cGUvT2JqU3RtPj5zdHJlYW0NCmjePI9RS8MwFIX/yn1bi9jepCQ6GYNpFBTEMsW97CVLbjWYNpImmz/fVsXXcw/f/c4SEFarepPTe4iFok8dU09DgtDBQx6TMwT74vaLTE7uSPDUdXM0Xe/73r1FnVwYYEtHR6d9WdY3kX4ipRMV6oojSmxQMoGyac5RLBAXf63p38aGA7XPorLewyvFcYaJile8rB+D/YcwiRdMMGScszO8/IW0MdhsaKKYGA46gXKTr/cUQVY4We/cYMNpnLVeXPJUXHs9fECr7kAFk+eZ5Xr9LcAAfKpQrA0KZW5kc3RyZWFtDWVuZG9iag0yNSAwIG9iag08PC9GaWx0ZXIvRmxhdGVEZWNvZGUvRmlyc3QgNC9MZW5ndGggNDkvTiAxL1R5cGUvT2JqU3RtPj5zdHJlYW0NCmjeslAwULCx0XfOL80rUTDU985MKY42NAIKBsXqh1QWpOoHJKanFtvZAQQYAN/6C60NCmVuZHN0cmVhbQ1lbmRvYmoNMjYgMCBvYmoNPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0ZpcnN0IDkvTGVuZ3RoIDQyL04gMi9UeXBlL09ialN0bT4+c3RyZWFtDQpo3jJTMFAwVzC0ULCx0fcrzS2OBnENFIJi7eyAIsH6LnZ2AAEGAI2FCDcNCmVuZHN0cmVhbQ1lbmRvYmoNMjcgMCBvYmoNPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0ZpcnN0IDUvTGVuZ3RoIDEyMC9OIDEvVHlwZS9PYmpTdG0+PnN0cmVhbQ0KaN4yNFIwULCx0XfOzytJzSspVjAyBgoE6TsX5Rc45VdEGwB5ZoZGCuaWRrH6vqkpmYkYogGJRUCdChZgfUGpxfmlRcmpxUAzA4ryk4NTS6L1A1zc9ENSK0pi7ez0g/JLEktSFQz0QyoLUoF601Pt7AACDADYoCeWDQplbmRzdHJlYW0NZW5kb2JqDTIgMCBvYmoNPDwvTGVuZ3RoIDM1MjUvU3VidHlwZS9YTUwvVHlwZS9NZXRhZGF0YT4+c3RyZWFtDQo8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/Pgo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA1LjQtYzAwNSA3OC4xNDczMjYsIDIwMTIvMDgvMjMtMTM6MDM6MDMgICAgICAgICI+CiAgIDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+CiAgICAgIDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiCiAgICAgICAgICAgIHhtbG5zOnBkZj0iaHR0cDovL25zLmFkb2JlLmNvbS9wZGYvMS4zLyIKICAgICAgICAgICAgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIgogICAgICAgICAgICB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIKICAgICAgICAgICAgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIj4KICAgICAgICAgPHBkZjpQcm9kdWNlcj5BY3JvYmF0IERpc3RpbGxlciA2LjAgKFdpbmRvd3MpPC9wZGY6UHJvZHVjZXI+CiAgICAgICAgIDx4bXA6Q3JlYXRlRGF0ZT4yMDA2LTAzLTA2VDE1OjA2OjMzLTA1OjAwPC94bXA6Q3JlYXRlRGF0ZT4KICAgICAgICAgPHhtcDpDcmVhdG9yVG9vbD5BZG9iZVBTNS5kbGwgVmVyc2lvbiA1LjIuMjwveG1wOkNyZWF0b3JUb29sPgogICAgICAgICA8eG1wOk1vZGlmeURhdGU+MjAxNi0wNy0xNVQxMDoxMjoyMSswODowMDwveG1wOk1vZGlmeURhdGU+CiAgICAgICAgIDx4bXA6TWV0YWRhdGFEYXRlPjIwMTYtMDctMTVUMTA6MTI6MjErMDg6MDA8L3htcDpNZXRhZGF0YURhdGU+CiAgICAgICAgIDx4bXBNTTpEb2N1bWVudElEPnV1aWQ6ZmYzZGNmZDEtMjNmYS00NzZmLTgzOWEtM2U1Y2FlMmRhMmViPC94bXBNTTpEb2N1bWVudElEPgogICAgICAgICA8eG1wTU06SW5zdGFuY2VJRD51dWlkOjM1OTM1MGIzLWFmNDAtNGQ4YS05ZDZjLTAzMTg2YjRmZmIzNjwveG1wTU06SW5zdGFuY2VJRD4KICAgICAgICAgPGRjOmZvcm1hdD5hcHBsaWNhdGlvbi9wZGY8L2RjOmZvcm1hdD4KICAgICAgICAgPGRjOnRpdGxlPgogICAgICAgICAgICA8cmRmOkFsdD4KICAgICAgICAgICAgICAgPHJkZjpsaSB4bWw6bGFuZz0ieC1kZWZhdWx0Ij5CbGFuayBQREYgRG9jdW1lbnQ8L3JkZjpsaT4KICAgICAgICAgICAgPC9yZGY6QWx0PgogICAgICAgICA8L2RjOnRpdGxlPgogICAgICAgICA8ZGM6Y3JlYXRvcj4KICAgICAgICAgICAgPHJkZjpTZXE+CiAgICAgICAgICAgICAgIDxyZGY6bGk+RGVwYXJ0bWVudCBvZiBKdXN0aWNlIChFeGVjdXRpdmUgT2ZmaWNlIG9mIEltbWlncmF0aW9uIFJldmlldyk8L3JkZjpsaT4KICAgICAgICAgICAgPC9yZGY6U2VxPgogICAgICAgICA8L2RjOmNyZWF0b3I+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgCjw/eHBhY2tldCBlbmQ9InciPz4NCmVuZHN0cmVhbQ1lbmRvYmoNMTEgMCBvYmoNPDwvTWV0YWRhdGEgMiAwIFIvUGFnZUxhYmVscyA2IDAgUi9QYWdlcyA4IDAgUi9UeXBlL0NhdGFsb2c+Pg1lbmRvYmoNMjMgMCBvYmoNPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aCAxMD4+c3RyZWFtDQpIiQIIMAAAAAABDQplbmRzdHJlYW0NZW5kb2JqDTI4IDAgb2JqDTw8L0RlY29kZVBhcm1zPDwvQ29sdW1ucyA0L1ByZWRpY3RvciAxMj4+L0ZpbHRlci9GbGF0ZURlY29kZS9JRFs8REI3Nzc1Q0NFMjI3RjZCMzBDNDQwREY0MjIxREMzOTA+PEJGQ0NDRjNGNTdGNjEzNEFCRDNDMDRBOUU0Q0ExMDZFPl0vSW5mbyA5IDAgUi9MZW5ndGggODAvUm9vdCAxMSAwIFIvU2l6ZSAyOS9UeXBlL1hSZWYvV1sxIDIgMV0+PnN0cmVhbQ0KaN5iYgACJjDByGzIwPT/73koF0wwMUiBWYxA4v9/EMHA9I/hBVCxoDOQeH8DxH2KrIMIglFwIpD1vh5IMJqBxPpArHYgwd/KABBgAP8bEC0NCmVuZHN0cmVhbQ1lbmRvYmoNc3RhcnR4cmVmDQo0NTc2DQolJUVPRg0K\",\n \"evaluationReport\": \"data:application/pdf;base64,JVBERi0xLjYNJeLjz9MNCjI0IDAgb2JqDTw8L0ZpbHRlci9GbGF0ZURlY29kZS9GaXJzdCA0L0xlbmd0aCAyMTYvTiAxL1R5cGUvT2JqU3RtPj5zdHJlYW0NCmjePI9RS8MwFIX/yn1bi9jepCQ6GYNpFBTEMsW97CVLbjWYNpImmz/fVsXXcw/f/c4SEFarepPTe4iFok8dU09DgtDBQx6TMwT74vaLTE7uSPDUdXM0Xe/73r1FnVwYYEtHR6d9WdY3kX4ipRMV6oojSmxQMoGyac5RLBAXf63p38aGA7XPorLewyvFcYaJile8rB+D/YcwiRdMMGScszO8/IW0MdhsaKKYGA46gXKTr/cUQVY4We/cYMNpnLVeXPJUXHs9fECr7kAFk+eZ5Xr9LcAAfKpQrA0KZW5kc3RyZWFtDWVuZG9iag0yNSAwIG9iag08PC9GaWx0ZXIvRmxhdGVEZWNvZGUvRmlyc3QgNC9MZW5ndGggNDkvTiAxL1R5cGUvT2JqU3RtPj5zdHJlYW0NCmjeslAwULCx0XfOL80rUTDU985MKY42NAIKBsXqh1QWpOoHJKanFtvZAQQYAN/6C60NCmVuZHN0cmVhbQ1lbmRvYmoNMjYgMCBvYmoNPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0ZpcnN0IDkvTGVuZ3RoIDQyL04gMi9UeXBlL09ialN0bT4+c3RyZWFtDQpo3jJTMFAwVzC0ULCx0fcrzS2OBnENFIJi7eyAIsH6LnZ2AAEGAI2FCDcNCmVuZHN0cmVhbQ1lbmRvYmoNMjcgMCBvYmoNPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0ZpcnN0IDUvTGVuZ3RoIDEyMC9OIDEvVHlwZS9PYmpTdG0+PnN0cmVhbQ0KaN4yNFIwULCx0XfOzytJzSspVjAyBgoE6TsX5Rc45VdEGwB5ZoZGCuaWRrH6vqkpmYkYogGJRUCdChZgfUGpxfmlRcmpxUAzA4ryk4NTS6L1A1zc9ENSK0pi7ez0g/JLEktSFQz0QyoLUoF601Pt7AACDADYoCeWDQplbmRzdHJlYW0NZW5kb2JqDTIgMCBvYmoNPDwvTGVuZ3RoIDM1MjUvU3VidHlwZS9YTUwvVHlwZS9NZXRhZGF0YT4+c3RyZWFtDQo8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/Pgo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA1LjQtYzAwNSA3OC4xNDczMjYsIDIwMTIvMDgvMjMtMTM6MDM6MDMgICAgICAgICI+CiAgIDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+CiAgICAgIDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiCiAgICAgICAgICAgIHhtbG5zOnBkZj0iaHR0cDovL25zLmFkb2JlLmNvbS9wZGYvMS4zLyIKICAgICAgICAgICAgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIgogICAgICAgICAgICB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIKICAgICAgICAgICAgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIj4KICAgICAgICAgPHBkZjpQcm9kdWNlcj5BY3JvYmF0IERpc3RpbGxlciA2LjAgKFdpbmRvd3MpPC9wZGY6UHJvZHVjZXI+CiAgICAgICAgIDx4bXA6Q3JlYXRlRGF0ZT4yMDA2LTAzLTA2VDE1OjA2OjMzLTA1OjAwPC94bXA6Q3JlYXRlRGF0ZT4KICAgICAgICAgPHhtcDpDcmVhdG9yVG9vbD5BZG9iZVBTNS5kbGwgVmVyc2lvbiA1LjIuMjwveG1wOkNyZWF0b3JUb29sPgogICAgICAgICA8eG1wOk1vZGlmeURhdGU+MjAxNi0wNy0xNVQxMDoxMjoyMSswODowMDwveG1wOk1vZGlmeURhdGU+CiAgICAgICAgIDx4bXA6TWV0YWRhdGFEYXRlPjIwMTYtMDctMTVUMTA6MTI6MjErMDg6MDA8L3htcDpNZXRhZGF0YURhdGU+CiAgICAgICAgIDx4bXBNTTpEb2N1bWVudElEPnV1aWQ6ZmYzZGNmZDEtMjNmYS00NzZmLTgzOWEtM2U1Y2FlMmRhMmViPC94bXBNTTpEb2N1bWVudElEPgogICAgICAgICA8eG1wTU06SW5zdGFuY2VJRD51dWlkOjM1OTM1MGIzLWFmNDAtNGQ4YS05ZDZjLTAzMTg2YjRmZmIzNjwveG1wTU06SW5zdGFuY2VJRD4KICAgICAgICAgPGRjOmZvcm1hdD5hcHBsaWNhdGlvbi9wZGY8L2RjOmZvcm1hdD4KICAgICAgICAgPGRjOnRpdGxlPgogICAgICAgICAgICA8cmRmOkFsdD4KICAgICAgICAgICAgICAgPHJkZjpsaSB4bWw6bGFuZz0ieC1kZWZhdWx0Ij5CbGFuayBQREYgRG9jdW1lbnQ8L3JkZjpsaT4KICAgICAgICAgICAgPC9yZGY6QWx0PgogICAgICAgICA8L2RjOnRpdGxlPgogICAgICAgICA8ZGM6Y3JlYXRvcj4KICAgICAgICAgICAgPHJkZjpTZXE+CiAgICAgICAgICAgICAgIDxyZGY6bGk+RGVwYXJ0bWVudCBvZiBKdXN0aWNlIChFeGVjdXRpdmUgT2ZmaWNlIG9mIEltbWlncmF0aW9uIFJldmlldyk8L3JkZjpsaT4KICAgICAgICAgICAgPC9yZGY6U2VxPgogICAgICAgICA8L2RjOmNyZWF0b3I+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgCjw/eHBhY2tldCBlbmQ9InciPz4NCmVuZHN0cmVhbQ1lbmRvYmoNMTEgMCBvYmoNPDwvTWV0YWRhdGEgMiAwIFIvUGFnZUxhYmVscyA2IDAgUi9QYWdlcyA4IDAgUi9UeXBlL0NhdGFsb2c+Pg1lbmRvYmoNMjMgMCBvYmoNPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aCAxMD4+c3RyZWFtDQpIiQIIMAAAAAABDQplbmRzdHJlYW0NZW5kb2JqDTI4IDAgb2JqDTw8L0RlY29kZVBhcm1zPDwvQ29sdW1ucyA0L1ByZWRpY3RvciAxMj4+L0ZpbHRlci9GbGF0ZURlY29kZS9JRFs8REI3Nzc1Q0NFMjI3RjZCMzBDNDQwREY0MjIxREMzOTA+PEJGQ0NDRjNGNTdGNjEzNEFCRDNDMDRBOUU0Q0ExMDZFPl0vSW5mbyA5IDAgUi9MZW5ndGggODAvUm9vdCAxMSAwIFIvU2l6ZSAyOS9UeXBlL1hSZWYvV1sxIDIgMV0+PnN0cmVhbQ0KaN5iYgACJjDByGzIwPT/73koF0wwMUiBWYxA4v9/EMHA9I/hBVCxoDOQeH8DxH2KrIMIglFwIpD1vh5IMJqBxPpArHYgwd/KABBgAP8bEC0NCmVuZHN0cmVhbQ1lbmRvYmoNc3RhcnR4cmVmDQo0NTc2DQolJUVPRg0K\"\n }\n ]\n },\n \"representatives\": [\n {\n \"name\": \"Representative Name\",\n \"governmentId\": \"50707649692\",\n \"phone\": \"41991071908\",\n \"email\": \"henrique.kalke@kanastra.com.br\",\n \"addressStreet\": \"Rua da Flores\",\n \"addressNumber\": \"111\",\n \"addressNeighborhood\": \"Centro\",\n \"addressZipcode\": \"89237001\",\n \"addressCity\": \"Joinville\",\n \"addressState\": \"SC\",\n \"maritalStatus\": \"SINGLE\",\n \"isolatedSignature\": \"ISOLATED\",\n \"defaultSigner\": true,\n \"documents\": {\n \"powersOfAttorney\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==\",\n \"officialDocument\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==\"\n }\n }\n ],\n \"bankAccount\": {\n \"code\": \"443\",\n \"agency\": \"0002\",\n \"account\": \"02390\",\n \"digit\": \"6\"\n },\n \"documents\": {\n \"socialContract\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==\",\n \"directorsElectionMinute\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==\",\n \"balanceSheet\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==\",\n \"proofOfAddress\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/issuers","description":"The businessSector field can have one of the following values:
AGRICULTURAL
FOODS
BUSINESS
PHARMACY
FINANCIAL
SMOKE
HOSPITAL
REAL_ESTATE
INDUSTRY
INSTALLATION
METALLIC
STATIONERY_SHOP
OIL
PRIMARY
SERVICES
THIRD
TRANSPORT
The issuer registration endpoint is a vital tool for recording critical information about issuers before issuance. By providing data such as tax identification and business address, users ensure legal and tax compliance and guarantee the accuracy of commercial transactions. The validation of the provided data helps prevent future issues, and the registration process precedes any issuance, ensuring that all transactions comply with current legal norms and regulations.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"148a038e-b237-4860-a5c2-da85e058d5a4"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"85a8d9df-ba59-4864-b600-c11284ac7d84"}}],"_postman_id":"abbcf2d4-b51c-4650-9b5b-f0bb473494bd"},{"name":"Guarantees","item":[{"name":"Batch Guarantee","id":"87067af1-4598-4849-b540-96286d13f562","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"guarantees\": [\n {\n \"guarantee_type\": \"FIDUCIARY\",\n \"guarantee_data\": {\n \"fiduciary_assignment\": {\n \"data\": {\n \"type_title\": \"COMMERCIAL_NOTE\",\n \"bl\": \"MSDU7448553\",\n \"invoice\": \"\",\n \"value\": 11600000.00\n }\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/commercial-papers/:commercial_note_uuid/guarantees/batch","urlObject":{"path":["api","v1","commercial-papers",":commercial_note_uuid","guarantees","batch"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"02b28d1e-cfad-41e9-aabf-fdb8592499a9","key":"commercial_note_uuid"}]}},"response":[],"_postman_id":"87067af1-4598-4849-b540-96286d13f562"},{"name":"Batch Documents","id":"afe3f9fc-1a02-40fb-bffc-168dbac546af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"documents\": [\n {\n \"document_type\": \"property_deed\",\n \"file\": \"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCAABAAEDASIAAhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAv/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFQEBAQAAAAAAAAAAAAAAAAAAAAX/xAAUEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwCdABmX/9k=\"\n },\n {\n \"document_type\": \"income_proof\",\n \"file\": \"data:application/pdf;base64,JVBERi0xLjQKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPJ4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQo+PgplbmRvYmoKeHJlZgowIDQKMDAwMDAwMDAwMCA2NTUzNSBmCjAwMDAwMDAwMDkgMDAwMDAgbgowMDAwMDAwMDU4IDAwMDAwIG4KMDAwMDAwMDExNSAwMDAwMCBuCnRyYWlsZXIKPDwKL1NpemUgNAovUm9vdCAxIDAgUgo+PgpzdGFydHhyZWYKMTc0CiUlRU9G\"\n },\n {\n \"document_type\": \"identity_document\",\n \"file\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/commercial-papers/guarantee/:guarantee_uuid/documents/batch","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","name":"Commercial Note","type":"folder"}},"urlObject":{"path":["api","v1","commercial-papers","guarantee",":guarantee_uuid","documents","batch"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"d0197c0d-ec9f-452c-8244-af6356360a89","key":"guarantee_uuid"}]}},"response":[],"_postman_id":"afe3f9fc-1a02-40fb-bffc-168dbac546af"},{"name":"Guarantee","id":"dc695a9c-bb55-4925-9c00-1b8020f5cf5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/commercial-papers/guarantee/:guarantee_uuid","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","name":"Commercial Note","type":"folder"}},"urlObject":{"path":["api","v1","commercial-papers","guarantee",":guarantee_uuid"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"guarantee_uuid"}]}},"response":[],"_postman_id":"dc695a9c-bb55-4925-9c00-1b8020f5cf5c"},{"name":"List Guarantees","id":"721ec951-8330-40b8-8d3d-3faf5c4bc977","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/commercial-papers/:commercial_note_uuid/guarantees","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","name":"Commercial Note","type":"folder"}},"urlObject":{"path":["api","v1","commercial-papers",":commercial_note_uuid","guarantees"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"commercial_note_uuid"}]}},"response":[],"_postman_id":"721ec951-8330-40b8-8d3d-3faf5c4bc977"},{"name":"List Documents","id":"958f0994-54dc-4aec-95ea-e13d2a5065b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/commercial-papers/:commercial_note_uuid/documents","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","name":"Commercial Note","type":"folder"}},"urlObject":{"path":["api","v1","commercial-papers",":commercial_note_uuid","documents"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"commercial_note_uuid"}]}},"response":[],"_postman_id":"958f0994-54dc-4aec-95ea-e13d2a5065b5"},{"name":"Document","id":"0824bb59-db38-4243-a027-e765d3535fc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/commercial-papers/:commercial_note_uuid/documents/:doocument_uuid","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","name":"Commercial Note","type":"folder"}},"urlObject":{"path":["api","v1","commercial-papers",":commercial_note_uuid","documents",":doocument_uuid"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"commercial_note_uuid"},{"type":"any","value":"","key":"doocument_uuid"}]}},"response":[],"_postman_id":"0824bb59-db38-4243-a027-e765d3535fc9"},{"name":"Delete Guarantee","id":"8f05ce61-5030-4820-a235-fe5c05cc0e18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{base_url}}/api/v1/commercial-papers/guarantee/:guarantee_uuid","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","name":"Commercial Note","type":"folder"}},"urlObject":{"path":["api","v1","commercial-papers","guarantee",":guarantee_uuid"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"guarantee_uuid"}]}},"response":[],"_postman_id":"8f05ce61-5030-4820-a235-fe5c05cc0e18"}],"id":"3c885439-d0da-4c9f-93db-77272d2af000","_postman_id":"3c885439-d0da-4c9f-93db-77272d2af000","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","name":"Commercial Note","type":"folder"}}},{"name":"Amendment","item":[{"name":"Create","id":"6c86565a-f3bd-47c1-a1be-26f9a7565ac5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"commercial_paper_uuid\": \"49c646fc-4346-468a-9804-5830322de607\",\n \"guarantees\": [\n {\n \"type\": \"FIDUCIARY\",\n \"title\": \"Cessão fiduciária de créditos – lote 1\",\n \"invoice\": \"123456\",\n \"bl\": \"789012\",\n \"value\": \"150000.00\"\n },\n {\n \"type\": \"FIDUCIARY\",\n \"title\": \"Cessão fiduciária de créditos – lote 2\",\n \"invoice\": \"654321\",\n \"bl\": \"210987\",\n \"value\": \"85000.50\"\n }\n ]\n },\n {\n \"commercial_paper_uuid\": \"ab969315-3b82-4fa1-ba48-d83fe1317dff\",\n \"guarantees\": [\n {\n \"type\": \"FIDUCIARY\",\n \"title\": \"Cessão fiduciária – aditamento\",\n \"invoice\": \"111222\",\n \"bl\": \"333444\",\n \"value\": \"200000.00\"\n }\n ]\n },\n {\n \"commercial_paper_uuid\": \"b42e5901-39d1-4c42-a330-96bd3b390f4e\",\n \"guarantees\": [\n {\n \"type\": \"FIDUCIARY\",\n \"title\": \"Cessão fiduciária de créditos\",\n \"invoice\": \"555666\",\n \"bl\": \"777888\",\n \"value\": \"100000.00\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/commercial-papers/guarantees/amendment","urlObject":{"path":["api","v1","commercial-papers","guarantees","amendment"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"bc664ee6-33aa-4d67-baf5-b007a8027e77","name":"OK Create","originalRequest":{"method":"POST","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"commercial_paper_uuid\": \"49c646fc-4346-468a-9804-5830322de607\",\n \"guarantees\": [\n {\n \"type\": \"FIDUCIARY\",\n \"title\": \"Cessão fiduciária de créditos – lote 1\",\n \"invoice\": \"123456\",\n \"bl\": \"789012\",\n \"value\": \"150000.00\"\n },\n {\n \"type\": \"FIDUCIARY\",\n \"title\": \"Cessão fiduciária de créditos – lote 2\",\n \"invoice\": \"654321\",\n \"bl\": \"210987\",\n \"value\": \"85000.50\"\n }\n ]\n },\n {\n \"commercial_paper_uuid\": \"ab969315-3b82-4fa1-ba48-d83fe1317dff\",\n \"guarantees\": [\n {\n \"type\": \"FIDUCIARY\",\n \"title\": \"Cessão fiduciária – aditamento\",\n \"invoice\": \"111222\",\n \"bl\": \"333444\",\n \"value\": \"200000.00\"\n }\n ]\n },\n {\n \"commercial_paper_uuid\": \"b42e5901-39d1-4c42-a330-96bd3b390f4e\",\n \"guarantees\": [\n {\n \"type\": \"FIDUCIARY\",\n \"title\": \"Cessão fiduciária de créditos\",\n \"invoice\": \"555666\",\n \"bl\": \"777888\",\n \"value\": \"100000.00\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/commercial-papers/guarantees/amendment"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Tue, 27 Jan 2026 22:29:19 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, origin, Accept-Encoding"},{"key":"Allow","value":"POST, DELETE, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"504"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Amendment: processed 3 commercial papers, 0 failed\",\n \"processedCount\": 3,\n \"failedCount\": 0,\n \"results\": {\n \"processed\": [\n {\n \"index\": 0,\n \"commercialPaperUuid\": \"49c646fc-4346-468a-9804-5830322de607\",\n \"guaranteesCreated\": [\n {\n \"guaranteeUuid\": \"3b07f05f-7282-4fdc-8ed7-945ec0221171\",\n \"uniqueIdentifier\": \"Cessão fiduciária de créditos – lote 1_20260127_192916\"\n },\n {\n \"guaranteeUuid\": \"d9f36601-44e1-423c-8d1f-e983c22fc58d\",\n \"uniqueIdentifier\": \"Cessão fiduciária de créditos – lote 2_20260127_192917\"\n }\n ]\n },\n {\n \"index\": 1,\n \"commercialPaperUuid\": \"ab969315-3b82-4fa1-ba48-d83fe1317dff\",\n \"guaranteesCreated\": [\n {\n \"guaranteeUuid\": \"3f0d5d98-ae53-4b53-a1bb-dd634ffd5b7f\",\n \"uniqueIdentifier\": \"Cessão fiduciária – aditamento_20260127_192918\"\n }\n ]\n },\n {\n \"index\": 2,\n \"commercialPaperUuid\": \"b42e5901-39d1-4c42-a330-96bd3b390f4e\",\n \"guaranteesCreated\": [\n {\n \"guaranteeUuid\": \"1395d92b-c2ea-42e6-b608-8f9a7e301567\",\n \"uniqueIdentifier\": \"Cessão fiduciária de créditos_20260127_192919\"\n }\n ]\n }\n ],\n \"failed\": [],\n \"totalCommercialPapers\": 3\n }\n}"}],"_postman_id":"6c86565a-f3bd-47c1-a1be-26f9a7565ac5"}],"id":"3892930a-218f-4f18-8080-b10fc5d56ba8","_postman_id":"3892930a-218f-4f18-8080-b10fc5d56ba8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","id":"3210a0b6-a3cc-4146-a399-63c3c5f45046","name":"Commercial Note","type":"folder"}}},{"name":"List","id":"313e3e3e-7441-43cc-a291-853b19cb4965","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/commercial-notes","description":"Retrieves a list of all registered commercial notes, along with their associated details.
\nThe status field can have one of the following values:
WAITING_FOR_GUARANTEES
PREVIEW
SENT
SIGNED
SETTLED
CANCELED
REGISTERED
INVALID
WAITING_CESSION
VALIDATED
BULLETIN_SIGNED
Prerequisites
\nIssuer Creation: Before creating a Commercial Note, an Issuer must be created. Refer to the \"Issuer Creation\" section in this documentation for detailed instructions on how to create an Issuer.
\nSubscriber Document Number: A valid Subscriber document number is required to create a Commercial Note. Please contact us to create a Subscriber before proceeding.
\nObject array with the following information:
\nPrerequisites
\nIssuer Creation: Before creating a Commercial Note, an Issuer must be created. Refer to the \"Issuer Creation\" section in this documentation for detailed instructions on how to create an Issuer.
\nSubscriber Document Number: A valid Subscriber document number is required to create a Commercial Note. Please contact us to create a Subscriber before proceeding.
\nObject array with the following information:
\nCONTRACT: Commercial Note Contract (Termo Constitutivo)
\nBULLETIN: Commercial Note Bulletin (Boletim de Subscrição)
\nDISBURSEMENT_RECEIPT: Comercial Note disbursement receipt (when the subscriber pays the issuer)
\nPAYMENT_RECEIPT: Commercial Note payment receipt (when the issuer pays the subscriber)
\nBefore exploring the API, it is crucial to understand the concept of a Commercial Note, which plays a fundamental role in the modern business ecosystem.
\nA Commercial Note is a form of formal communication between companies, typically used in the context of commercial transactions. Essentially, it is a document that outlines a financial commitment between the involved parties, detailing the terms and conditions of a transaction. This document is vital for establishing and clarifying the expectations, rights, and responsibilities of both the supplier and the customer.
\nCommercial Notes can vary in complexity and content, depending on the nature of the transaction and the specific business practices of each sector. However, some common information generally included in a Commercial Note are:
\nDetails of the involved parties: This includes the full commercial names and addresses of the companies participating in the transaction.
\nQuantities and prices: The number of units of products or hours of services, along with the unit and total prices.
\nPayment terms: The agreed payment conditions, including deadlines and accepted payment methods.
\nLegal and compliance information: Any relevant legal provisions, such as consumer protection laws or tax regulations, applicable to the transaction.
\nMoving forward, you will find the endpoints for registering information and issuing the commercial note.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"0dd71f99-2e00-4ed7-b788-81f6c825402e"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"a1f5f812-a961-482e-9108-c4b478fd9825"}}],"_postman_id":"3210a0b6-a3cc-4146-a399-63c3c5f45046"},{"name":"Accounts","item":[{"name":"Bank Account Beneficiary","item":[{"name":"List","id":"62f7215e-e6ad-4eb3-8fbc-1b6ec9587342","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/accounts/:account_uuid/beneficiary-accounts?government_id","description":"This endpoint allows the registration of a new beneficiary bank account. By providing the necessary details, users can ensure the accuracy and security of their financial transactions, making future transfers more efficient.
\n","urlObject":{"path":["api","v1","accounts",":account_uuid","beneficiary-accounts"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"bd56f332-07d4-453b-8338-eaae0b3ede64","key":"account_uuid"}]}},"response":[{"id":"6a7807c2-c89f-41b9-8453-fdc188bdfd9a","name":"OK Create","originalRequest":{"method":"POST","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"holderName\": \"Beneficiary Name\",\n \"governmentId\": \"99999999999\",\n \"bankCode\": 559,\n \"agency\": 1,\n \"account\": 14,\n \"accountDigit\": 4,\n \"isFavorite\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://banking-sandbox.kanastra.com.br/api/v1/accounts/:account_uuid/beneficiary-accounts","protocol":"https","host":["banking-sandbox","kanastra","com","br"],"path":["api","v1","accounts",":account_uuid","beneficiary-accounts"],"variable":[{"key":"account_uuid","value":"bd56f332-07d4-453b-8338-eaae0b3ede64"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 06 Aug 2024 21:40:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"237"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Accept, origin, Cookie, Accept-Encoding"},{"key":"allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"x-frame-options","value":"DENY"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"x-request-id","value":"a5fbc540bfd13cbce9f7c32cf8ef5551"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=dz57H%2Bo0n243DkWIhrVof577u4DW%2BXirUijTtws3ROE1qfnFbRhROS3YRzhbAm8CgDkM53S64D1bbuV%2FJv8pjG13C0526wtwzInVKl8ktBH1BD42QFEH3JhHBpnBHPlSPKO9vfbZWmGnOivfdGyhBkSf\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8af22f4d7f8c01a1-GRU"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"71118033-f5ac-4bce-92b2-e1e9ad3e0362\",\n \"holderName\": \"Beneficiary Name\",\n \"governmentId\": \"99999999999\",\n \"code\": \"559\",\n \"agency\": \"1\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"14\",\n \"digit\": \"4\",\n \"isFavorite\": true\n}"}],"_postman_id":"854d11cd-79d0-43d6-ad0c-878d82ff028c"},{"name":"Delete","id":"a14381f8-0709-4907-b0b0-75f058ec665f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/accounts/:account_uuid/beneficiary-accounts/:beneficiary_uuid","description":"This endpoint allows the deletion of a specific beneficiary bank account using its unique identifier (UUID). By providing the UUID, users can remove the account from their list of registered beneficiaries, ensuring that it is no longer available for future transactions.
\n","urlObject":{"path":["api","v1","accounts",":account_uuid","beneficiary-accounts",":beneficiary_uuid"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"bd56f332-07d4-453b-8338-eaae0b3ede64","key":"account_uuid"},{"type":"any","value":"71118033-f5ac-4bce-92b2-e1e9ad3e0362","key":"beneficiary_uuid"}]}},"response":[{"id":"ad0887aa-4a58-41cf-bcdd-aae213403600","name":"Delete","originalRequest":{"method":"DELETE","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":{"raw":"https://banking-sandbox.kanastra.com.br/api/v1/accounts/:account_uuid/beneficiary-accounts/:beneficiary_uuid","protocol":"https","host":["banking-sandbox","kanastra","com","br"],"path":["api","v1","accounts",":account_uuid","beneficiary-accounts",":beneficiary_uuid"],"variable":[{"key":"account_uuid","value":"bd56f332-07d4-453b-8338-eaae0b3ede64"},{"key":"beneficiary_uuid","value":"71118033-f5ac-4bce-92b2-e1e9ad3e0362"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 06 Aug 2024 21:41:49 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Accept, origin, Cookie"},{"key":"allow","value":"DELETE, OPTIONS"},{"key":"x-frame-options","value":"DENY"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"x-request-id","value":"82556e079531e5dcaa8c65464c15588d"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=ClvEv45zGooWLgBjNnPa8gGdZjv93jBPyl%2BiDQaQ%2FcyEutV%2F3U%2BA5%2FZ1z7LgaD3Fn8DhCrZJRpEh3uuosP2W64hYToLcfkTjYoOcgKqSYC7O05ShIFJphEznQEVOVSfdwIJ1hrwzOUuFVdzYKOSg%2BYF3\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8af23174b80f01a1-GRU"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"a14381f8-0709-4907-b0b0-75f058ec665f"}],"id":"8222ede9-889d-42c2-876f-32af70d023a2","description":"The Bank Account Beneficiary endpoint is an essential tool for recording crucial information about beneficiary accounts before making any transfers. By providing data such as the beneficiary's bank account details and personal information, users ensure the accuracy and security of financial transactions. The validation of the provided data helps prevent future issues, and the registration process precedes any transfers, ensuring that all transactions comply with current banking norms and regulations.
\n","_postman_id":"8222ede9-889d-42c2-876f-32af70d023a2"},{"name":"Transactions","item":[{"name":"List","id":"3ec45497-b66f-4697-b460-b92af718fb63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/accounts/:account_uuid/transactions","description":"Retrieves a list of all registered transactions associated with a specific financial account, including details such as status, type of operation, and amount.
\nThe status field can have one of the following values:
CREATED: The transaction has been created.The typeOperation field can have one of the following values:
BANK_SLIP: Transaction made via bank slip (Brazilian Boleto) payment.The originType field can have one of the following values:
TRANSFER: Originated from a transfer operation.The Transactions Api provides secure and efficient access to critical financial information and transaction capabilities for specified bank accounts. Users can manage and review account details comprehensively
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d33696db-394d-4368-bdd8-578a2ba973ca","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"14392b08-72cb-47c7-b319-e423a686bfcb","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"d3de6379-d49b-4092-b8e8-29a7dae84592"},{"name":"Balance","item":[{"name":"Retrieve","id":"2cc43c32-d943-40ac-8f14-221256c8d546","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/accounts/:account_uuid/balance","description":"The Balance API endpoint offers real-time access to the current account balance of a specified bank account, critical for maintaining accurate financial oversight. Users can quickly ascertain the available funds in an account, facilitating effective financial planning and resource allocation. This endpoint is designed to provide immediate financial insights, helping users manage their accounts with precision and aiding in the prevention of overdrafts and the strategic planning of upcoming expenditures. It ensures that all financial decisions are made based on the most current and accurate account information available.
\n","_postman_id":"8c118d5c-2484-431e-895b-d4adff8eb8f7"},{"name":"TED Transfer","item":[{"name":"Retrieve","id":"e83c93fd-978f-4ee9-8fee-908aa78f6dcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/accounts/:account_uuid/transfer/:transfer_uuid","description":"General
\nTransfers
\n","urlObject":{"path":["api","v1","accounts",":account_uuid","transfers"],"host":["{{base_url}}"],"query":[{"key":"status","value":"PROCESSED"}],"variable":[{"type":"any","value":"{{account_uuid}}","key":"account_uuid"}]}},"response":[{"id":"477c6987-e2df-4eef-9324-41ac2bd0027d","name":"OK List w/ Filter","originalRequest":{"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/accounts/:account_uuid/transfers?status=PROCESSING","host":["{{base_url}}"],"path":["api","v1","accounts",":account_uuid","transfers"],"query":[{"key":"status","value":"PROCESSING"}],"variable":[{"key":"account_uuid","value":"bd56f332-07d4-453b-8338-eaae0b3ede64"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Sep 2024 03:38:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"939"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Accept, origin, Cookie, Accept-Encoding"},{"key":"allow","value":"GET, HEAD, OPTIONS"},{"key":"x-frame-options","value":"DENY"},{"key":"content-encoding","value":"gzip"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"x-request-id","value":"9239436dc0f663bc810e5e43202c728e"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=Go9J%2BP%2BOip7JCGgIF7n7AyS8FuSe4VyhHEESTGVAw9fDuWUGcqtmXQrsvA1vj%2FyiXXloqZX1NN5cDzYhp8Un9Duax0QTrC8Nv4CAEhBQvmSpop1GP7GG4Kk8zlg8IxZE87ZUM5dlQIoJ0up10z5h15MI\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8bdaf2c65df9028e-GRU"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 9,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"uuid\": \"ff0ca0c9-c8bf-4922-9c7d-0a741a97b728\",\n \"amount\": \"0.01\",\n \"createdAt\": \"2024-08-30T15:27:11.646367-03:00\",\n \"additionalInfo\": \"transfer request\",\n \"requester\": {\n \"name\": \"Marcelo Barros\",\n \"email\": \"marcelo.mazzola@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"66d0e22a-677f-4dab-b31f-fdb09cf50cc9\",\n \"amount\": \"1000.00\",\n \"createdAt\": \"2024-08-27T13:07:55.914291-03:00\",\n \"additionalInfo\": \"transfer request\",\n \"requester\": {\n \"name\": \"Guilherme\",\n \"email\": \"guilherme.nunes@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"fda14970-41ef-4d6b-adb4-e8187d613ea2\",\n \"amount\": \"1000.00\",\n \"createdAt\": \"2024-08-27T12:33:24.575100-03:00\",\n \"additionalInfo\": \"transfer request\",\n \"requester\": {\n \"name\": \"Guilherme\",\n \"email\": \"guilherme.nunes@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"ca717559-ee45-4af8-8380-b9e703360e83\",\n \"amount\": \"0.90\",\n \"createdAt\": \"2024-08-27T12:30:45.176925-03:00\",\n \"additionalInfo\": \"transfer request\",\n \"requester\": {\n \"name\": \"Leonardo Dias\",\n \"email\": \"leonardo.galdioli@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"ed0fd7d4-5ea2-4415-bcc2-5570ed356165\",\n \"amount\": \"1000.00\",\n \"createdAt\": \"2024-08-27T12:28:02.383244-03:00\",\n \"additionalInfo\": \"transfer request\",\n \"requester\": {\n \"name\": \"Guilherme\",\n \"email\": \"guilherme.nunes@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"b3cd5934-e2a8-40a3-9825-ce257c4cb192\",\n \"amount\": \"1222.23\",\n \"createdAt\": \"2024-08-13T16:30:06.247717-03:00\",\n \"additionalInfo\": \"transfer\",\n \"requester\": {\n \"name\": \"Marcelo Barros\",\n \"email\": \"marcelo.mazzola@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"31d5ca29-9a72-4b73-a820-f01e701653d2\",\n \"amount\": \"1000.00\",\n \"createdAt\": \"2024-07-16T14:41:42.299735-03:00\",\n \"additionalInfo\": \"transfer\",\n \"requester\": {\n \"name\": \"Marcelo Barros\",\n \"email\": \"marcelo.mazzola@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"ab6de144-b869-4e32-ace4-1969e33df9d7\",\n \"amount\": \"100.00\",\n \"createdAt\": \"2024-07-05T15:05:26.601028-03:00\",\n \"additionalInfo\": \"transfer\",\n \"requester\": {\n \"name\": \"Marcelo Barros\",\n \"email\": \"marcelo.mazzola@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"0461ddb3-7f89-4d8e-8012-2aec57a37813\",\n \"amount\": \"100.00\",\n \"createdAt\": \"2024-06-26T16:42:13.706680-03:00\",\n \"additionalInfo\": \"transfer\",\n \"requester\": {\n \"name\": \"Marcelo Barros\",\n \"email\": \"marcelo.mazzola@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n }\n ]\n}"},{"id":"6d1fa49c-4239-426e-8288-e169cded8848","name":"OK List","originalRequest":{"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/accounts/:account_uuid/transfers","host":["{{base_url}}"],"path":["api","v1","accounts",":account_uuid","transfers"],"variable":[{"key":"account_uuid","value":"bd56f332-07d4-453b-8338-eaae0b3ede64"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Sep 2024 03:39:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1069"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Accept, origin, Cookie, Accept-Encoding"},{"key":"allow","value":"GET, HEAD, OPTIONS"},{"key":"x-frame-options","value":"DENY"},{"key":"content-encoding","value":"gzip"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"x-request-id","value":"f82346858c6629208102fe5b92124cbc"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=DlE%2BeSA48xb7FyyTvNoWyimKUIw57RE92xH%2FD1KcKNluZjwdPVgYQLdSnqtRE9ELa7IstP7p%2FfcIIMkTUFciT3SEVg%2Bh%2FD3CQ8N3SxAaABgRWufz8BY2BZJ3Y7z8QFzZBYpYw%2F0yifSoG0kf6vJOzLjr\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8bdaf3f57fc9028e-GRU"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 21,\n \"next\": \"http://banking-sandbox.kanastra.com.br/api/v1/accounts/bd56f332-07d4-453b-8338-eaae0b3ede64/transfers?page=2\",\n \"previous\": null,\n \"results\": [\n {\n \"uuid\": \"ff0ca0c9-c8bf-4922-9c7d-0a741a97b728\",\n \"amount\": \"0.01\",\n \"createdAt\": \"2024-08-30T15:27:11.646367-03:00\",\n \"additionalInfo\": \"transfer request\",\n \"requester\": {\n \"name\": \"Marcelo Barros\",\n \"email\": \"marcelo.mazzola@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"a155e1be-bb44-4689-9527-e27020cff716\",\n \"amount\": \"1000.00\",\n \"createdAt\": \"2024-08-27T15:23:28.362480-03:00\",\n \"additionalInfo\": \"transfer request\",\n \"requester\": {\n \"name\": \"Guilherme\",\n \"email\": \"guilherme.nunes@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PENDING_APPROVAL\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"66d0e22a-677f-4dab-b31f-fdb09cf50cc9\",\n \"amount\": \"1000.00\",\n \"createdAt\": \"2024-08-27T13:07:55.914291-03:00\",\n \"additionalInfo\": \"transfer request\",\n \"requester\": {\n \"name\": \"Guilherme\",\n \"email\": \"guilherme.nunes@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"fda14970-41ef-4d6b-adb4-e8187d613ea2\",\n \"amount\": \"1000.00\",\n \"createdAt\": \"2024-08-27T12:33:24.575100-03:00\",\n \"additionalInfo\": \"transfer request\",\n \"requester\": {\n \"name\": \"Guilherme\",\n \"email\": \"guilherme.nunes@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"ca717559-ee45-4af8-8380-b9e703360e83\",\n \"amount\": \"0.90\",\n \"createdAt\": \"2024-08-27T12:30:45.176925-03:00\",\n \"additionalInfo\": \"transfer request\",\n \"requester\": {\n \"name\": \"Leonardo Dias\",\n \"email\": \"leonardo.galdioli@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"ed0fd7d4-5ea2-4415-bcc2-5570ed356165\",\n \"amount\": \"1000.00\",\n \"createdAt\": \"2024-08-27T12:28:02.383244-03:00\",\n \"additionalInfo\": \"transfer request\",\n \"requester\": {\n \"name\": \"Guilherme\",\n \"email\": \"guilherme.nunes@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"b3cd5934-e2a8-40a3-9825-ce257c4cb192\",\n \"amount\": \"1222.23\",\n \"createdAt\": \"2024-08-13T16:30:06.247717-03:00\",\n \"additionalInfo\": \"transfer\",\n \"requester\": {\n \"name\": \"Marcelo Barros\",\n \"email\": \"marcelo.mazzola@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PROCESSING\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"9f281ed0-88a3-44ec-972c-1818cad9f2f9\",\n \"amount\": \"1233.33\",\n \"createdAt\": \"2024-08-13T15:16:24.026636-03:00\",\n \"additionalInfo\": \"transfer\",\n \"requester\": {\n \"name\": \"Marcelo Barros\",\n \"email\": \"marcelo.mazzola@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PENDING_APPROVAL\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"d3c7b7ac-5ff5-452e-bc56-eefc47754747\",\n \"amount\": \"100.00\",\n \"createdAt\": \"2024-08-13T10:48:39.612940-03:00\",\n \"additionalInfo\": \"transfer\",\n \"requester\": {\n \"name\": \"Marcelo Barros\",\n \"email\": \"marcelo.mazzola@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PENDING_APPROVAL\",\n \"scheduledAt\": null\n },\n {\n \"uuid\": \"f156b57d-a152-4478-bd2d-c5a67f49ba72\",\n \"amount\": \"1000.00\",\n \"createdAt\": \"2024-08-12T16:16:09.904922-03:00\",\n \"additionalInfo\": \"transfer\",\n \"requester\": {\n \"name\": \"Marcelo Barros\",\n \"email\": \"marcelo.mazzola@kanastra.com.br\"\n },\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"beneficiaryAccount\": {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\",\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\",\n \"code\": \"559\",\n \"agency\": \"0001\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\": true\n },\n \"status\": \"PENDING_APPROVAL\",\n \"scheduledAt\": null\n }\n ]\n}"}],"_postman_id":"74a030b0-f560-4a58-9e8f-67f0ecb41e29"},{"name":"Create","event":[{"listen":"prerequest","script":{"id":"3d1abf54-4ef8-4c99-aef5-39868a074aa0","exec":[""],"type":"text/javascript","packages":{}}}],"id":"11a4650c-e54a-4346-bfe2-f75a341abbd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"client-id","value":"{{client_id}}","type":"text"},{"key":"Transaction-Hash-Key","value":"186400fbda4434d2aa0d075b5f87facf644a6d93f3eab5492daf84af2a766925","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 5.50,\n \"additionalInfo\": \"Transferencia para Breno (Teste)\",\n \"beneficiaryUuid\": \"a553b41e-1d81-41f7-8416-f0b742dd6c4f\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/accounts/:account_uuid/transfer","description":"To interact with this endpoint, you are required to generate a Transaction Hash Key and include it in the request headers. The Transaction Hash Key is generated using the following process:
\nGenerate HMAC Hash:
Use the SHA-256 algorithm to compute the HMAC hash of the request payload.
The key for this operation will be provided by our team during the initial configuration phase and must be securely stored on your end.
Hex Encoding:
Once the HMAC hash is generated, encode it in hexadecimal format.
Include in Headers:
Pass the resulting Transaction Hash Key in the request headers as part of the API call.
This security measure ensures data integrity and validation for all transactions conducted with our API. If you require further guidance on generating the hash or managing keys, please contact our support team.
\nThe Transfer API provides seamless access to detailed information about money transfers between accounts, ensuring users can manage their transactions with accuracy and confidence.
\nThe Transfer API ensures that all transaction data is readily available, supporting efficient financial oversight, audit compliance, and strategic cash management.
\n","_postman_id":"7b1b4071-b345-49c2-a4a6-94212085e22c"},{"name":"Create","item":[{"name":"Create Personal Financial Account","id":"71f5f897-d333-451f-9f85-3248324abde5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"client-id","value":"{{client_id}}","type":"text"},{"key":"Transaction-Hash-Key","value":"3904f415b4abc1faf46882e379653bdd7d1a392de039df6c21af0b98a36708a1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"CHECKING_ACCOUNT\",\n \"termsAccepted\": true,\n \"holder\": {\n \"name\": \"Personal Account Name\",\n \"phone\": \"1935412279\",\n \"email\": \"demo@kanastra.com.br\",\n \"governmentId\": \"99781738030\",\n \"addressStreet\": \"Rua Franca\",\n \"addressNumber\": \"856\",\n \"addressNeighborhood\": \"Centro\",\n \"addressZipcode\": \"29182632\",\n \"addressCity\": \"Serra\",\n \"addressState\": \"ES\",\n \"addressFile\": \"data:application/pdf;base64,JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL1Jlc291cmNlcyAyIDAgUgovQ29udGVudHMgNCAwIFI+PgplbmRvYmoKNCAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggNzM+PgpzdHJlYW0KeJwzUvDiMtAzNVco53IKUdB3M1QwNNIzMFAISVNwDQEJGZmb61kYKphbmuqZmyuEpChoBCfmFuSkKgS4uGkqhGSBlAEAAdMPsAplbmRzdHJlYW0KZW5kb2JqCjEgMCBvYmoKPDwvVHlwZSAvUGFnZXMKL0tpZHMgWzMgMCBSIF0KL0NvdW50IDEKL01lZGlhQm94IFswIDAgNTk1LjI4IDg0MS44OV0KPj4KZW5kb2JqCjUgMCBvYmoKPDwvVHlwZSAvRm9udAovQmFzZUZvbnQgL0hlbHZldGljYQovU3VidHlwZSAvVHlwZTEKL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQiAvSW1hZ2VDIC9JbWFnZUldCi9Gb250IDw8Ci9GMSA1IDAgUgo+PgovWE9iamVjdCA8PAo+Pgo+PgplbmRvYmoKNiAwIG9iago8PAovUHJvZHVjZXIgKFB5RlBERiAxLjcuMiBodHRwOi8vcHlmcGRmLmdvb2dsZWNvZGUuY29tLykKL0NyZWF0aW9uRGF0ZSAoRDoyMDI0MDkxMjE5MjMwNykKPj4KZW5kb2JqCjcgMCBvYmoKPDwKL1R5cGUgL0NhdGFsb2cKL1BhZ2VzIDEgMCBSCi9PcGVuQWN0aW9uIFszIDAgUiAvRml0SCBudWxsXQovUGFnZUxheW91dCAvT25lQ29sdW1uCj4+CmVuZG9iagp4cmVmCjAgOAowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAyMjkgMDAwMDAgbiAKMDAwMDAwMDQxMiAwMDAwMCBuIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwODcgMDAwMDAgbiAKMDAwMDAwMDMxNiAwMDAwMCBuIAowMDAwMDAwNTE2IDAwMDAwIG4gCjAwMDAwMDA2MjUgMDAwMDAgbiAKdHJhaWxlcgo8PAovU2l6ZSA4Ci9Sb290IDcgMCBSCi9JbmZvIDYgMCBSCj4+CnN0YXJ0eHJlZgo3MjgKJSVFT0YK\",\n \"documentType\": \"IDENTITY_DOCUMENT\",\n \"documentFile\": \"data:application/pdf;base64,JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL1Jlc291cmNlcyAyIDAgUgovQ29udGVudHMgNCAwIFI+PgplbmRvYmoKNCAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggNzM+PgpzdHJlYW0KeJwzUvDiMtAzNVco53IKUdB3M1QwNNIzMFAISVNwDQEJGZmb61kYKphbmuqZmyuEpChoBCfmFuSkKgS4uGkqhGSBlAEAAdMPsAplbmRzdHJlYW0KZW5kb2JqCjEgMCBvYmoKPDwvVHlwZSAvUGFnZXMKL0tpZHMgWzMgMCBSIF0KL0NvdW50IDEKL01lZGlhQm94IFswIDAgNTk1LjI4IDg0MS44OV0KPj4KZW5kb2JqCjUgMCBvYmoKPDwvVHlwZSAvRm9udAovQmFzZUZvbnQgL0hlbHZldGljYQovU3VidHlwZSAvVHlwZTEKL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQiAvSW1hZ2VDIC9JbWFnZUldCi9Gb250IDw8Ci9GMSA1IDAgUgo+PgovWE9iamVjdCA8PAo+Pgo+PgplbmRvYmoKNiAwIG9iago8PAovUHJvZHVjZXIgKFB5RlBERiAxLjcuMiBodHRwOi8vcHlmcGRmLmdvb2dsZWNvZGUuY29tLykKL0NyZWF0aW9uRGF0ZSAoRDoyMDI0MDkxMjE5MjMwNykKPj4KZW5kb2JqCjcgMCBvYmoKPDwKL1R5cGUgL0NhdGFsb2cKL1BhZ2VzIDEgMCBSCi9PcGVuQWN0aW9uIFszIDAgUiAvRml0SCBudWxsXQovUGFnZUxheW91dCAvT25lQ29sdW1uCj4+CmVuZG9iagp4cmVmCjAgOAowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAyMjkgMDAwMDAgbiAKMDAwMDAwMDQxMiAwMDAwMCBuIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwODcgMDAwMDAgbiAKMDAwMDAwMDMxNiAwMDAwMCBuIAowMDAwMDAwNTE2IDAwMDAwIG4gCjAwMDAwMDA2MjUgMDAwMDAgbiAKdHJhaWxlcgo8PAovU2l6ZSA4Ci9Sb290IDcgMCBSCi9JbmZvIDYgMCBSCj4+CnN0YXJ0eHJlZgo3MjgKJSVFT0YK\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/accounts/personal","description":"The documentType field can have one of the following values:
IDENTITY_DOCUMENT
DRIVERS_LICENSE
The document_type field can have one of the following values:
IDENTITY_DOCUMENT
DRIVERS_LICENSE
This Folder contains two major endpoints, one to create an Checking Account and other to create a Linked one, you can find more information in each endpoint below;
\nTo interact with both endpoints, you are required to generate a Transaction Hash Key and include it in the request headers. The Transaction Hash Key is generated using the following process:
\nGenerate HMAC Hash:
\nUse the SHA-256 algorithm to compute the HMAC hash of the request payload.
\nThe key for this operation will be provided by our team during the initial configuration phase and must be securely stored on your end.
\nHex Encoding:
\nInclude in Headers:
\nThis security measure ensures data integrity and validation for all transactions conducted with our API. If you require further guidance on generating the hash or managing keys, please contact our support team.
\n","_postman_id":"58369a35-4456-4c74-ae91-02b5c8f03519"},{"name":"PIX","item":[{"name":"PIX Keys","item":[{"name":"List keys","event":[{"listen":"test","script":{"id":"28119b43-5e05-43b4-ae91-81bb5c3742c4","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"78b2517e-97cd-49db-89c8-071b26b7a7d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"client-id","value":"{{client_api_id}}","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{base_url}}/api/v1/pix/:account_uuid/keys?status=ACTIVE","description":"This endpoint retrieves a list of keys associated with a specific account identified by account_uuid. The request allows filtering the keys based on their status and additional query parameters.
status (optional): Filter keys based on their status. For example, setting this to ACTIVE will return only active keys.
type (optional): Filter keys by their type.
uuid (optional): Filter keys by their unique identifier.
key (optional): Filter keys by their key value.
account_uuid (path parameter): A unique identifier for the account from which the PIX key details are being requested.Upon a successful request, the API will return a JSON object containing the following fields:
\ncount (integer): The total number of keys that match the query.
next (string or null): A URL to the next page of results, if applicable.
previous (string or null): A URL to the previous page of results, if applicable.
results (array): An array of key objects, each containing:
uuid (string): The unique identifier of the key.
createdAt (string): The timestamp when the key was created.
updatedAt (string): The timestamp when the key was last updated.
key (string): The actual key value.
type (string): The type of the key.
status (string): The current status of the key.
lastUsage (string or null): The timestamp of the last time the key was used, or null if it has not been used.
This endpoint retrieves the details associated with a specific PIX key for a given account. It allows users to access information about the beneficiary linked to the PIX key.
\naccount_uuid (path parameter): A unique identifier for the account from which the PIX key details are being requested.
pix_key (path parameter): The specific PIX key for which the details are being fetched.
Upon a successful request, the API will return a JSON object containing the following fields:
\nbeneficiary: An object containing details about the beneficiary.
holderName: The name of the beneficiary.
governmentId: The government identification number of the beneficiary.
code: A code associated with the beneficiary.
agency: The agency linked to the beneficiary.
account: The account number of the beneficiary.
digit: The digit associated with the account.
pixKey: The PIX key itself.
accountType: The type of account (e.g., checking, savings).
endToEndId: An identifier for tracking the transaction from start to finish.
This endpoint is used to delete a specific PIX key associated with a given account. The operation will remove the specified key from the account's settings.
\naccount_uuid (path parameter): The unique identifier for the account from which the PIX key will be deleted. This is a required parameter.
pix_key (path parameter): The unique identifier for the PIX key that needs to be deleted. This is also a required parameter.
Upon a successful deletion, the API will return a JSON response with a message indicating the outcome of the operation.
\nDeleting a PIX key is irreversible; once deleted, the key cannot be recovered.
\n","urlObject":{"path":["api","v1","pix",":account_uuid","key",":pix_key"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"brcode","value":null}],"variable":[{"type":"any","value":"{{account_uuid}}","key":"account_uuid"},{"type":"any","value":"{{pix_key}}","key":"pix_key"}]}},"response":[{"id":"9f426871-b6d7-42f5-bfc2-f3f0fee3b064","name":"OK Exclude Key","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json, text/plain, */*"},{"key":"Accept-Language","value":"en-US,en;q=0.9,pt-BR;q=0.8,pt;q=0.7"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:8000"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzIzNzU2MDQ3LCJpYXQiOjE3MjM2Njk2NDcsImp0aSI6ImQxNTUyZDQ5NDA5MzRiMzM4Zjg3MjRiY2M5NGNlODZhIiwidXNlcl9pZCI6Mn0.iNknGf2vWCT92R8HBf-a95hfPkShe9U0UCNuWJygNwo"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Origin","value":"http://localhost:8080"},{"key":"Referer","value":"http://localhost:8080/"},{"key":"Sec-Fetch-Dest","value":"empty"},{"key":"Sec-Fetch-Mode","value":"cors"},{"key":"Sec-Fetch-Site","value":"same-site"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0"},{"key":"sec-ch-ua","value":"\"Not/A)Brand\";v=\"8\", \"Chromium\";v=\"126\", \"Microsoft Edge\";v=\"126\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"client-id","value":"{{client_api_id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/pix/:account_uuid/key/:pix_key","host":["{{base_url}}"],"path":["api","v1","pix",":account_uuid","key",":pix_key"],"query":[{"key":"governament_id","value":"08733905630","disabled":true}],"variable":[{"key":"account_uuid","value":"{{account_uuid}}"},{"key":"pix_key","value":"{{pix_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 19 Aug 2025 14:34:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"Vary","value":"Accept, origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:8080"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-Id","value":"9e9c0b03-a916-4220-b5e3-280325800824"},{"key":"X-Kong-Upstream-Latency","value":"979"},{"key":"X-Kong-Proxy-Latency","value":"3"},{"key":"Via","value":"1.1 kong/3.9.1"},{"key":"X-Kong-Request-Id","value":"3ac2b25012f3394eea8cb358a5bada1c"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=OqSXcrM1tF6AG%2BZI5hy8XArNo%2B9sS4u7qE%2F4axV7PF%2Bx3n4xCam3Ur2rkJdnh%2FyYO1x%2Fak7%2F1LNSSufkxjgFy1DQoDudxEFtH2urhr6diBaEyFC6MTT5WTss6PcQWeg%3D\"}]}"},{"key":"Content-Encoding","value":"br"},{"key":"CF-RAY","value":"971a5e9e8be5941c-UDI"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Pix Key deleted successfully\"\n}"},{"id":"857231e3-5565-4ba7-974a-4cd174c90263","name":"BAD Exclude Key","originalRequest":{"method":"DELETE","header":[{"key":"client-id","value":"{{client_api_id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/pix/:account_uuid/key/:pix_key","host":["{{base_url}}"],"path":["api","v1","pix",":account_uuid","key",":pix_key"],"query":[{"key":"brcode","value":null,"type":"text","disabled":true}],"variable":[{"key":"account_uuid","value":"{{account_uuid}}"},{"key":"pix_key","value":"{{pix_key}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 22 Aug 2025 11:49:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"Vary","value":"Accept, origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-Id","value":"dc88b61e-1ffd-4fcb-8bd1-a1c1cf8521dc"},{"key":"X-Kong-Upstream-Latency","value":"291"},{"key":"X-Kong-Proxy-Latency","value":"2"},{"key":"Via","value":"1.1 kong/3.9.1"},{"key":"X-Kong-Request-Id","value":"2f508a32c0aa636f64743b1be179c91f"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=A%2BTHu6fJwT98nP7WcsaWUEgB4zWcUmlTlviAibXZS4rJM4zjaEUPXEOf9JCdmR%2FqYy2R0gD7Jsj5d%2BJsqDgDCX73WBZbRSfPwdsSUCM44xVuTtY%3D\"}]}"},{"key":"CF-RAY","value":"973225b0ffa79416-UDI"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid account UUID\"\n}"},{"id":"fba7ef68-5e5a-42df-afe9-d26df6e842ad","name":"U.E Exclude Key","originalRequest":{"method":"DELETE","header":[{"key":"client-id","value":"{{client_api_id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/pix/:account_uuid/key/:pix_key","host":["{{base_url}}"],"path":["api","v1","pix",":account_uuid","key",":pix_key"],"query":[{"key":"brcode","value":null,"type":"text","disabled":true}],"variable":[{"key":"account_uuid","value":"{{account_uuid}}"},{"key":"pix_key","value":"{{pix_key}}"}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 22 Aug 2025 11:49:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"66"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"Vary","value":"Accept, origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-Id","value":"d14d9618-f98d-441c-a822-9895bff1717f"},{"key":"X-Kong-Upstream-Latency","value":"298"},{"key":"X-Kong-Proxy-Latency","value":"1"},{"key":"Via","value":"1.1 kong/3.9.1"},{"key":"X-Kong-Request-Id","value":"d593fd37d95e4316abd4ec266dea1754"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=Q5LMOQ%2BgMoSUSAFNtTr5rfqRqbsQW7myYx9upPvh36xwPNGBZPjwhem2b5DmXN2MhU5Iu1a%2BQa2%2Bb%2BA1mrMUTPZJu%2BB8Kdi%2F75fVgbX%2BuvfeVN4%3D\"}]}"},{"key":"CF-RAY","value":"9732261b38029416-UDI"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"PIX_KEY_PIX_KEY_NOT_FOUND\",\n \"message\": \"Pix key not found\"\n}"}],"_postman_id":"8a143a7e-b145-46fe-8ecf-3c6220180201"},{"name":"Create Document Key","event":[{"listen":"test","script":{"id":"b51e410d-348f-4e89-ba2c-ac6646e5d1e0","exec":["pm.test(\"Should return new Pix Key\", function () {"," var jsonData = pm.response.json();"," var pix_key = jsonData.key;"," if (pix_key.not.eq(undefined)) {",""," pm.environment.set(\"pix_key\", jsonData.key);"," pm.globals.environment.set(\"pix_key\", jsonData.pix_key);"," };","});"],"type":"text/javascript","packages":{}}}],"id":"327d8707-8f4b-49a0-aafd-d169d8a72394","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"client-id","value":"{{client_api_id}}","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"DOCUMENT\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/pix/:account_uuid/key","description":"This endpoint allows the user to create a new document key for a specific financial account identified by account_uuid. To create the new document key, only the type is needed.
The request body must be sent in JSON format and should include the following parameter:
\ntype (string): Specifies the type of the key being created. In the provided example, the value is set to \"DOCUMENT\".account_uuid: A unique identifier for the account from which the PIX key details are being requested.Upon a successful request, the API will return a JSON object containing the following fields:
\nfinancialAccountUuid (string): The UUID of the financial account associated with the key.
uuid (string): The unique identifier for the key created.
key (string): The key that was added.
type (string): The type of the key.
status (string): The current status of the key.
createdAt (string): Timestamp indicating when the key was created.
updatedAt (string): Timestamp indicating when the key was last updated.
This endpoint allows users to generate a new key for a specified financial account identified by account_uuid. To create a random key, only the type is needed. The key is generated by BACEN, and to obtain it, the account’s key listing endpoint must be queried after the request.
The request requires a JSON body with the following parameter:
\ntype (string): This parameter specifies the type of key to be generated. In the provided example, the value is set to \"RANDOM\", indicating that a random key should be created.account_uuid: A unique identifier for the account from which the PIX key details are being requested.Upon a successful request, the API will return a JSON object containing the following fields:
\nfinancialAccountUuid (string): The UUID of the financial account associated with the key.
uuid (string): The unique identifier for the key created.
key (string): The key that was added.
type (string): The type of the key.
status (string): The current status of the key.
createdAt (string): Timestamp indicating when the key was created.
updatedAt (string): Timestamp indicating when the key was last updated.
This endpoint allows users to create a new key associated with a specified financial account. In this case, both type and key must be provided. The type must be \"EMAIL\", and the key, an actual e-mail.
The request body must be in JSON format and should include the following parameters:
\ntype (string): Specifies the type of the key being created. In the provided example, the value is set to \"EMAIL\".
key (string): The actual key value (an email address).
account_uuid: A unique identifier for the account from which the PIX key details are being requested.Upon a successful request, the API will return a JSON object containing the following fields:
\nfinancialAccountUuid (string): The UUID of the financial account associated with the key.
uuid (string): The UUID of the created key.
key (string): The key that was created.
type (string): The type of the key.
status (string): The status of the key creation.
createdAt (string): Timestamp indicating when the key was created.
updatedAt (string): Timestamp indicating when the key was last updated.
This endpoint allows users to create a new key associated with a specified financial account. The type must be \"PHONE\", and the key, an international phone number.
The request body must be in JSON format and include the following parameters:
\ntype (string): Specifies the type of the key being added. In the provided example, the value is set to \"PHONE\".
key (string): The actual key value (an international phone number, e.g., +5516...).
account_uuid: A unique identifier for the account from which the PIX key details are being requested.Upon a successful request, the API will return a JSON object containing the following fields:
\nfinancialAccountUuid (string): The UUID of the financial account associated with the key.
uuid (string): The unique identifier for the key created.
key (string): The key that was added.
type (string): The type of the key.
status (string): The current status of the key.
createdAt (string): Timestamp indicating when the key was created.
updatedAt (string): Timestamp indicating when the key was last updated.
This endpoint allows you to approve the creation of a specific PIX key associated with a financial account using an OTP (One-Time Password) for authentication.
\notp_code (body parameter): A string representing the One-Time Password required for the update operation.account_uuid (path parameter): The unique identifier for the financial account.
pix_key_uuid (path parameter): The unique identifier for the PIX key that you want to update.
Upon a successful request, the server will respond with a JSON object containing the following fields:
\nfinancialAccountUuid (string): The UUID of the financial account associated with the key.
uuid (string): The unique identifier for the key created.
key (string): The key that was added.
type (string): The type of the key.
status (string): The current status of the key.
createdAt (string): Timestamp indicating when the key was created.
updatedAt (string): Timestamp indicating when the key was last updated.
This endpoint allows you to deny a specific PIX key associated with a financial account using the provided OTP (One-Time Password) for authentication.
\notp_code (body parameter): A string representing the One-Time Password required for the update operation.account_uuid (path parameter): The unique identifier for the financial account.
pix_key_uuid (path parameter): The unique identifier for the PIX key that you want to update.
Upon a successful request, the server will respond with a JSON object containing the following fields:
\nfinancialAccountUuid (string): The UUID of the financial account associated with the key.
uuid (string): The unique identifier for the key created.
key (string): The key that was added.
type (string): The type of the key.
status (string): The current status of the key.
createdAt (string): Timestamp indicating when the key was created.
updatedAt (string): Timestamp indicating when the key was last updated.
This endpoint allows you to resend a One-Time Password (OTP) associated with a specific PIX key for a financial account. It is useful when the user has not received the OTP or needs to regenerate it for security purposes.
\notp_code (body parameter): A string representing the One-Time Password required for the update operation.account_uuid (path parameter): The unique identifier for the financial account.
pix_key_uuid (path parameter): The unique identifier for the PIX key that you want to update.
Upon a successful request, the server will respond with a JSON object containing the following fields:
\nfinancialAccountUuid (string): The UUID of the financial account associated with the key.
uuid (string): The unique identifier for the key created.
key (string): The key that was added.
type (string): The type of the key.
status (string): The current status of the key.
createdAt (string): Timestamp indicating when the key was created.
updatedAt (string): Timestamp indicating when the key was last updated.
The API supports four main types of keys: Random, Email, Phone, and Document (CPF/CNPJ).
\nBelow are the types of identifiers supported by DICT.
\nRandom Key (EVP): Creation occurs asynchronously. The key is generated by BACEN, and to obtain it, the account’s key listing endpoint must be queried after the request.
\nDocument Key (CPF/CNPJ): The API will automatically use the account holder’s document to register the key.
\nEmail or Phone Key: The user must prove ownership of the email or phone number. This process is carried out through the validation of an OTP (One-Time Password) sent to the respective contact.
\nNote: There is a limit on the number of active keys per account.
\nIndividual Account (PF): Up to 10 active keys.
\nBusiness Account (PJ): Up to 25 active keys.
\nEach PIX key can have one of the following statuses:
\nCREATED – The key has been successfully created in the system but is not yet active.
\nACTIVE – The key is fully active and can be used for transactions.
\nCANCELED – The key has been deactivated or removed and cannot be used.
\nFAILED – The creation or activation of the key failed due to an error.
\nWAITING_OTP_TOKEN – The key requires the user to validate ownership via an OTP (One-Time Password) before it becomes active.
\nThese statuses help track the lifecycle of each key and determine its current usability.
\n","_postman_id":"0376aec5-2d46-42db-aae6-7cb260707606"},{"name":"PIX Transfer","item":[{"name":"List PIX Transfer","id":"df988846-e2f0-4bf7-b134-53f3db8788f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_api_id}}","type":"text"},{"key":"Transaction-Hash-Key","value":"{{THK}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/pix/:account_uuid/transfer","description":"Retrieve Transfer Information
\nThis endpoint allows users to retrieve transfer information associated with a specific financial account, identified by account_uuid.
account_uuid (string): Unique identifier for the account whose transfers are being queried. (Required)Upon a successful request, the server will respond with a JSON object containing the following fields:
\ncount (integer): Total number of transfers for the account.
next (string | null): URL for the next page of results, if any.
previous (string | null): URL for the previous page of results, if any.
results (array): List of transfer objects containing:
uuid (string): Unique identifier of the transfer.
endToEndId (string): Identifier for tracking the transfer end-to-end.
amount (string): Amount transferred.
reconciliationId (string | null): Identifier for reconciliation purposes.
beneficiaryAccount (object): Detailed information about the beneficiary's account:
uuid (string): Unique identifier for the beneficiary's account.
holderName (string): Name of the account holder.
governmentId (string): Government ID associated with the beneficiary's account.
code (string): Bank code of the beneficiary's financial institution.
agency (string): Agency number of the beneficiary's account.
financialAccount (string): Type of financial account associated with the beneficiary.
account (string): The account number of the beneficiary.
digit (string): Account digit of the beneficiary's account.
isFavorite (boolean): Indicates whether the beneficiary is marked as a favorite.
bankingAccountType (string): Type of banking account.
transactionId (string): Unique identifier for the transaction.
product (string): The product associated with the transfer.
resourceUuid (string): Unique identifier for the resource related to the transfer.
reason (string | null): Reason for the transfer, if applicable.
status (string): Current status of the transfer.
initType (string): Type of initiation for the transfer.
sentAt (string | null): Timestamp when the transfer was sent.
feeAmount (string): Amount of any fees associated with the transfer.
isInternalTransfer (boolean): Indicates if the transfer is internal.
scheduledAt (string | null): Timestamp when the transfer is scheduled, if applicable.
transactionStatus (string | null): Current status of the transaction.
errorReason (string | null): Reason for any errors that occurred during the transfer.
This endpoint allows you to initiate a fund transfer to a specified beneficiary using the Pix payment system.
\nThe request body must be in JSON format and include the following parameters:
\namount (number): The amount of money to be transferred, specified in the appropriate currency unit.
additionalInfo (string): Optional additional information regarding the transfer.
initType (string): The type of initiation for the transfer. In this case, it must be set to \"DICT\".
beneficiary (object): An object containing the beneficiary's details:
holderName (string): The name of the account holder.
governmentId (string): The government identification number of the beneficiary.
code (string): The code identifying the beneficiary.
agency (string): The agency number of the beneficiary's bank.
account (string): The account number of the beneficiary.
digit (string): The account digit associated with the beneficiary's account.
pixKey (string): The Pix key associated with the beneficiary's account.
accountType (string): The type of account (e.g., checking or savings).
endToEndId (string): A unique identifier for the transaction, used for tracking purposes.
Upon a successful request, the server will respond with a JSON object containing the following fields:
\nstatus (string): Indicates whether the transfer was successful or if there was an error.
transactionId (string): A unique identifier for the transaction if successful.
message (string): Provides additional information about the transaction status.
This endpoint allows users to initiate a funds transfer using the PIX payment system. The transfer is executed to a specified beneficiary account and includes details about the transaction amount and additional information.
\nThe request body must be in JSON format and include the following parameters:
\nbeneficiary (object): Contains information about the recipient of the funds:
holderName (string): The name of the beneficiary.
governmentId (string): The government identification number of the beneficiary.
code (string): The bank code of the beneficiary's financial institution.
agency (string): The agency number of the beneficiary's account.
account (string): The account number of the beneficiary.
digit (string): The account digit of the beneficiary.
accountType (string): The type of account (e.g., checking, savings).
amount (number): The amount of money to be transferred.
additionalInfo (string): Any additional information related to the transaction.
initType (string): The type of initiation for the transfer (e.g., MANUAL).
Upon a successful request, the server will respond with a JSON object containing the following fields:
\nuuid (string): Unique identifier for the transaction.
endToEndId (string): Identifier for tracking the transaction end-to-end.
amount (string): The amount that was transferred.
reconciliationId (string | null): Identifier for reconciliation purposes, if applicable.
beneficiaryAccount (object): Detailed information about the beneficiary's account:
uuid (string): Unique identifier for the beneficiary's account.
holderName (string): Name of the beneficiary.
governmentId (string): Government ID of the beneficiary.
code (string): Bank code of the beneficiary's financial institution.
agency (string): Agency number of the beneficiary's account.
financialAccount (string): Type of financial account associated with the beneficiary.
account (string): The account number of the beneficiary.
digit (string): The account digit of the beneficiary.
isFavorite (boolean): Indicates whether the beneficiary is marked as a favorite.
bankingAccountType (string): Type of banking account (e.g., checking, savings).
transactionId (string | null): Identifier for the transaction, if available.
product (string): The product associated with the transaction.
resourceUuid (string): UUID of the resource related to the transaction.
reason (string | null): Reason for the transaction, if applicable.
status (string): Current status of the transaction.
initType (string): Type of initiation for the transfer.
sentAt (string | null): Timestamp when the transaction was sent.
feeAmount (string): Amount of any fees associated with the transaction.
isInternalTransfer (boolean): Indicates if the transfer is internal.
scheduledAt (string | null): Timestamp when the transaction is scheduled, if applicable.
transactionStatus (string | null): Current status of the transaction.
errorReason (string | null): Reason for any errors that occurred during the transaction.
This operation allows sending funds in real-time between accounts using the Brazilian PIX instant payment system. Transfers can be made using a registered PIX key or account details, and funds are settled instantly through the Central Bank’s SPI infrastructure.
\nIt enables immediate confirmation of the transaction to both sender and recipient, supporting 24/7 processing, including weekends and holidays.
\n","_postman_id":"e8f7d4fb-c279-4f08-819a-f60943f60491"},{"name":"PIX Deposit","item":[{"name":"List Deposits","id":"8fbd05ee-7061-4c35-b274-33fa92e022b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"client-id","value":"{{client_api_id}}","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/pix/:account_uuid/deposit","description":"This endpoint retrieves deposit information for a specific financial account identified by account_uuid. It allows users to check the status and details of deposit transactions associated with the given account.
account_uuid: A unique identifier for the account whose deposit information is being requested.
Upon a successful request, the API will return a JSON object containing the following fields:
\ncount (integer): Total number of deposits returned.
next (string): URL to retrieve the next page of results, if applicable.
previous (string): URL to retrieve the previous page of results, if applicable.
results (array): A list of deposit transaction objects, where each object contains:
uuid (string): Unique identifier of the deposit.
senderBank (object): Information about the sender's bank, including:
code (string): Bank code.
name (string): Bank name.
comp (string): Bank compensation code.
ispb (string): ISPB code of the bank.
isParticipantComp (boolean): Indicates if the bank is part of the compensation system.
isParticipantPix (boolean): Indicates if the bank participates in PIX.
isParticipantStr (boolean): Indicates if the bank participates in the STR system.
createdAt (string): Timestamp when the deposit was created.
updatedAt (string): Timestamp when the deposit was last updated.
externalId (string): External identifier associated with the deposit.
endToEndId (string): Unique end-to-end transaction identifier.
amount (string): Deposit amount.
reconciliationId (string|null): Identifier for reconciliation, if available.
status (string): Current status of the deposit.
initType (string): Indicates how the transaction was initiated.
senderAccount (string): Sender’s account number.
senderAccountType (string): Type of the sender’s account.
senderBranch (string): Sender’s bank branch.
senderName (string): Name of the sender.
senderGovernmentId (string): Government-issued ID of the sender.
description (string|null): Description of the deposit, if available.
transactionId (string): Unique transaction ID.
product (string): Product type associated with the deposit.
resourceUuid (string): Resource UUID linked to the transaction.
feeAmount (string): Amount charged as transaction fees, if any.
isInternalTransfer (boolean): Indicates whether the deposit is an internal transfer.
receiverPixKey (string): The PIX key of the receiver.
This endpoint is used to reverse a deposit transaction for a specific financial account identified by account_uuid and a deposit identified by deposit_uuid.
The request body must be sent in JSON format and should include the following parameter:
\namount (string): The amount to be reversed.account_uuid: A unique identifier for the financial account associated with the deposit.
deposit_uuid: A unique identifier for the deposit transaction to be reversed.
Performs a real-time funds transfer using the Brazilian Central Bank’s PIX instant payment system. Once the deposit is authorized, the amount is immediately credited to the recipient’s account, 24/7, including weekends and holidays.
\nInitiation → The payer selects the recipient’s PIX key or scans a QR code.
\nAuthorization → The payer’s bank authenticates the transaction.
\nSettlement → Funds are transferred instantly via the SPI infrastructure.
\nConfirmation → The recipient receives immediate confirmation of the deposit.
\nInstant settlement → Funds are available within seconds.
\n24/7 processing → Works on weekends and holidays.
\nPIX key support → CPF/CNPJ, phone, email, or random key.
\nQR code integration → Accepts both static and dynamic QR codes.
\nSecure → Fully regulated and encrypted by the Central Bank of Brazil.
\nThis endpoint retrieves a preview of a BR Code (Barcode) associated with a specific account identified by account_uuid.
The request body should be in JSON format and could contain the following parameters:
\nbrcode (string): The BR Code for which the preview is being requested. This should be formatted correctly to ensure a valid response.account_uuid (path parameter): The unique identifier for the account for which the QR code information is being requested.Upon a successful request, the API will return a JSON object containing the following fields:
\nendToEndId: Identifier for tracking the transaction.
financialAccount: Details of the financial account involved.
receiverAccount: Information about the receiver's account.
amount: The total amount associated with the transaction.
status: Current status of the BR Code request.
subscription: Contains details about any subscriptions related to the transaction.
This endpoint allows you to list QRCodes from the API.
\npix_key (query parameter): The PIX key associated with the QR code. This is required to filter the results.
status (query parameter): The status of the QR code. In this case, the status is set to CREATED to retrieve only those QR codes that are currently in the created state.
qrcodeType (query parameter): The type of QR code to filter by (e.g., static or dynamic).
reconciliation_id (query parameter): An optional identifier used for reconciliation purposes, typically provided by the system generating the QR code.
end_to_end_id (query parameter): An optional identifier to track the transaction from initiation to completion.
payer_government_id (query parameter): An optional field for the payer’s government-issued identification (CPF or CNPJ).
created_at (query parameter): An optional timestamp or date range to filter QR codes based on their creation date.
updated_at (query parameter): An optional timestamp or date range to filter QR codes based on the last update.
account_uuid (path parameter): The unique identifier for the account for which the QR code information is being requested.The response will contain the following fields:
\ncount (integer): The total number of QR codes returned in the response.
next (string or null): A URL to the next page of results if pagination is applicable; otherwise, it will be null.
previous (string or null): A URL to the previous page of results if pagination is applicable; otherwise, it will be null.
results (array): A list of QR code objects that match the request parameters. Each object contains the following fields:
uuid (string): The unique identifier for the QR code.
externalId (string): An external identifier associated with the QR code.
amount (string): The amount associated with the QR code.
amountType (string): The type of amount.
nominalAmount (number or null): The nominal amount associated with the QR code, if applicable.
reconciliationId (string): The identifier used for reconciliation purposes.
endToEndId (string or null): An identifier for tracking the transaction from start to finish, if applicable.
qrcodeStatus (string): The current status of the QR code.
dueDate (string or null): The due date for the QR code, if applicable.
qrcodeType (string): The type of QR code (e.g., static, dynamic).
version (integer): The version of the QR code.
createdAt (string): The timestamp when the QR code was created.
updatedAt (string): The timestamp when the QR code was last updated.
expirationSeconds (number or null): The expiration time in seconds, if applicable.
description (string or null): A description of the QR code, if provided.
url (string): The URL associated with the QR code.
paymentDate (string or null): The date when the payment was made, if applicable.
feeAmount (string): The fee amount associated with the QR code.
pixKey (string): The PIX key associated with the QR code.
financialAccount (string): The financial account associated with the QR code.
This endpoint allows you to update the details of a QR code associated with a specific account. The request modifies the attributes of the QR code identified by qrcode_uuid within the context of the specified account_uuid.
The request body should be in JSON format and could contain the following parameters:
\nqrcode_uuid (string): The unique identifier of the QR code. This is the only mandatory parameter.
amount_type (string): Defines how the payment amount is handled (e.g., FIXED, CUSTOM).
reconciliation_id (string): A reconciliation identifier for tracking the payment.
due_date (string): The due date for the payment in YYYY-MM-DD format.
expiration_seconds (number): The time in seconds until the QR code expires.
description (string): A description or note about the payment.
percentage (number): The discount percentage to be applied.
due (string): The due date for the discount in YYYY-MM-DD format.
nominal_amount (number): The nominal amount for the transaction.
fee (number): The applicable fee for the payment.
fine (number): The fine amount to be applied after the due date.
interest (number): The interest rate applied after the due date.
payer_name (string): The name of the payer.
payer_government_id (string): The payer’s government identification number (e.g., CPF).
account_uuid (path parameter): The unique identifier for the account for which the QR code information is being requested.
qrcode_uuid (path parameter): The unique identifier of the QR code.
Upon a successful request, the API will return a JSON response containing the updated details of the QR code, including:
\nuuid (string): The unique identifier for the QR code.
externalId (string): An external identifier associated with the QR code.
amount (string): The total amount including discounts.
amountType (string): The type of amount (e.g., nominal, discounted).
discounts (array of objects): An array reflecting the discounts applied.
nominalAmount (string): The nominal amount after any discounts.
fee (null or number): Any applicable fees.
fine (null or number): Any fines associated with the QR code.
interest (null or number): Any interest applicable to the transaction.
reconciliationId (string): The ID used for reconciliation purposes.
endToEndId (null or string): An optional end-to-end identifier.
qrcodeStatus (string): The current status of the QR code.
dueDate (string): The due date for the payment.
qrcodeType (string): The type of QR code.
version (number): The version of the QR code.
createdAt (string): Timestamp of when the QR code was created.
updatedAt (string): Timestamp of the last update to the QR code.
expirationSeconds (number): The remaining time until expiration.
description (null or string): An optional description of the QR code.
url (string): The URL associated with the QR code.
payerName (string): The name of the payer.
payerGovernmentId (null or string): The government ID of the payer, if applicable.
paymentDate (null or string): The date the payment was made, if applicable.
feeAmount (string): The amount of any fees applied.
pixKey (string): The PIX key associated with the transaction.
financialAccount (string): The financial account related to the transaction.
This endpoint is used to delete a specific QR code associated with a given account. The deletion is identified by the unique qrcode_uuid parameter, which represents the QR code to be removed from the system.
account_uuid (path parameter): The unique identifier for the account associated with the QR code.
qrcode_uuid (path parameter): The unique identifier for the QR code that you wish to delete.
Upon a successful deletion, the API will return a JSON object containing the following fields:
\nuuid: The unique identifier of the deleted QR code.
externalId: An identifier for external systems.
amount: The amount associated with the QR code.
amountType: The type of amount (e.g., FIXED, CUSTOM).
discounts: An array of discount objects, each containing:
percentage: The discount percentage applied.
due: The due amount after discounts.
nominalAmount: The nominal amount related to the QR code.
fee: Any applicable fees (if any).
fine: Any fines associated (if applicable).
interest: Interest details (if applicable).
reconciliationId: Identifier for reconciliation purposes.
endToEndId: Optional identifier for tracking.
qrcodeStatus: The current status of the QR code.
dueDate: The due date for payment.
qrcodeType: The type of QR code.
version: Version number of the QR code.
createdAt: Timestamp of when the QR code was created.
updatedAt: Timestamp of the last update to the QR code.
expirationSeconds: Time until expiration in seconds.
description: Optional description of the QR code.
url: The URL associated with the QR code.
payerName: Name of the payer.
payerGovernmentId: Government ID of the payer (if applicable).
paymentDate: Date of payment (if applicable).
feeAmount: Amount of any fees incurred.
pixKey: The PIX key associated with the QR code.
financialAccount: The financial account linked to the QR code.
This endpoint allows you to create a static QR code for PIX payments and transactions.
\nThe request body must be in JSON format and include the following parameters:
\npixKey (string): The unique key associated with the PIX payment.
reconciliationId (string): An identifier for reconciliation, which can be any string value (e.g., \"teste756\").
type (string): The type of QR code to generate. For this endpoint, it should be set to \"STATIC_QR_CODE\".
amount (number): The fixed amount for the transaction (e.g., 12).
description (string): A brief description of the transaction (e.g., \"Tests Static\").
amountType (string): Specifies the type of amount (e.g., FIXED).
account_uuid (path parameter): The unique identifier for the account associated with the QR code.Upon a successful request, the API will return a JSON object containing the following fields:
\nuuid (string): A unique identifier for the QR code.
externalId (string): An external identifier associated with the transaction.
amount (string): The amount specified in the request.
amountType (string): The type of amount (e.g., \"FIXED\").
nominalAmount (null): The nominal amount for the transaction.
reconciliationId (string): The reconciliation identifier provided in the request.
endToEndId (null): An optional identifier for tracking purposes.
qrcodeStatus (string): The current status of the QR code.
dueDate (null): The due date for the payment, if applicable.
qrcodeType (string): The type of QR code generated.
version (number): The version of the API response.
createdAt (string): The timestamp when the QR code was created.
updatedAt (string): The timestamp when the QR code was last updated.
expirationSeconds (null): The expiration time for the QR code in seconds.
description (string): The description provided in the request.
url (string): The URL where the QR code can be accessed.
paymentDate (null): The date when the payment was made, if applicable.
feeAmount (string): The fee amount associated with the transaction.
pixKey (string): The PIX key used for the transaction.
financialAccount (string): The financial account associated with the transaction.
This endpoint allows you to create a dynamic QR code for PIX payments and transactions.
\npixKey (string): The unique key associated with the PIX payment.
reconciliationId (string): A unique identifier for reconciliation purposes.
type (string): The type of QR code being generated; in this case, it should be set to \"DYNAMIC_QR_CODE\".
amountType (string): Specifies the type of amount.
description (string): A brief description of the transaction.
amount (number): The fixed amount for the transaction.
expirationSeconds (number): The duration in seconds before the QR code expires.
account_uuid (path parameter): The unique identifier for the account associated with the QR code.Upon a successful request, the API will return a JSON object containing the following fields:
\nuuid (string): Unique identifier for the generated QR code.
externalId (string): External identifier associated with the transaction.
amount (string): The amount specified in the request.
amountType (string): The type of amount (e.g., FIXED).
nominalAmount (number): The nominal amount of the transaction.
reconciliationId (string): The reconciliation identifier.
endToEndId (string): Identifier for tracking the transaction from start to finish.
qrcodeStatus (string): Status of the generated QR code.
dueDate (string): The due date for the transaction, if applicable.
qrcodeType (string): The type of QR code generated.
version (number): Version of the QR code.
createdAt (string): Timestamp of when the QR code was created.
updatedAt (string): Timestamp of the last update to the QR code.
expirationSeconds (number): The expiration time of the QR code in seconds.
description (string): Description of the transaction.
url (string): URL to access the QR code.
paymentDate (string): Date when the payment was made, if applicable.
feeAmount (string): Any fees associated with the transaction.
pixKey (string): The PIX key used for the transaction.
financialAccount (string): The financial account associated with the transaction.
This endpoint allows you to create a due dynamic QR code for PIX payments and transactions, where the payment request includes a due date and can support discounts, fines, and interest.
\nThe request body must be in JSON format and include the following parameters:
\npixKey (string): The unique key associated with the PIX transaction.
reconciliationId (string): An identifier for reconciling the transaction.
type (string): The type of QR code being generated; in this case, it should be set to \"DYNAMIC_QR_CODE\".
discounts (array): An array of discount objects applicable to the transaction. Each discount object should contain:
percentage (number): The discount percentage to apply.
due (string): The due date for the discount.
fee (number): The fee associated with the transaction.
fine (number): Any fine applicable to the transaction.
interest (number): The interest amount applicable to the transaction.
dueDate (string): The due date for the payment.
expirationSeconds (number): The time duration in seconds before the QR code expires.
amountType (string): The type of amount being processed (e.g., FIXED).
nominalAmount (number): The nominal amount for the transaction.
payerGovernmentId (string): The government ID of the payer.
payerName (string): The name of the payer.
account_uuid (path parameter): The unique identifier for the account associated with the QR code.Upon a successful request, the server responds with a JSON object containing the following fields:
\nuuid (string): A unique identifier for the generated QR code.
externalId (string): An external identifier for the transaction.
amount (string): The amount involved in the transaction.
amountType (string): The type of amount (e.g., FIXED).
discounts (array): An array containing the applied discounts.
nominalAmount (string): The nominal amount for the transaction.
fee (string): The fee charged for the transaction.
fine (string): The fine applied to the transaction.
interest (string): The interest applicable to the transaction.
reconciliationId (string): The reconciliation identifier used in the request.
endToEndId (null|string): An optional end-to-end identifier.
qrcodeStatus (string): The status of the generated QR code.
dueDate (string): The due date for the payment.
qrcodeType (string): The type of QR code generated.
version (number): The version of the response structure.
createdAt (string): The timestamp of when the QR code was created.
updatedAt (string): The timestamp of the last update to the QR code.
expirationSeconds (number): The expiration time in seconds for the QR code.
description (null|string): An optional description of the transaction.
url (string): A URL associated with the QR code.
payerName (string): The name of the payer.
payerGovernmentId (string): The government ID of the payer.
paymentDate (null|string): The date when the payment was made.
feeAmount (string): The calculated fee amount.
pixKey (string): The PIX key associated with the transaction.
financialAccount (string): The financial account related to the transaction.
Here we provide technical information regarding the initiation of Pix payments via QR Codes in Brazil. It follows the specifications defined by the Central Bank of Brazil (BACEN) and complies with the BR Code standard, which adopts the EMV QR Code Payment System (EMV-QRCPS) format.
\nThe BR Code is the standard used for generating QR Codes in Brazil. It follows the EMV standard for QR Code payment systems (EMV-QRCPS).
\nNote: The BR Code standard applies only to the Merchant Presented Mode (MPM).
\nThe Pix QR Code acts as a mechanism for providing or pre-filling payment information for initiating Pix transactions. It strictly adheres to the BR Code specifications, as defined in the official BR Code Manual.
\nThe following entities are authorized to generate a Pix QR Code:
\nPayment Service Providers (PSPs) of the payee.
\nThe National Treasury Secretariat (STN).
\nA Pix QR Code can contain up to two types of information:
\nPayment Data — Standard Pix payment details such as amount, description, and recipient.
\nRecurring Payment Parameters — Configuration data for recurring transactions.
\nOnce the QR Code is generated, the payer can scan it and follow the respective flows based on the data retrieved.
\nWhen installed on the payer’s mobile device, the PSP application is used to scan the QR Code. Upon scanning:
\nThe app accesses the backend service provided by the payee’s PSP.
\nThis backend is responsible for:
\nGenerating the payment order.
\nHandling recurrence requests.
\nOr managing both, depending on the configuration.
\nBelow is a summarized overview of the different types of Pix QR Codes. The following sections describe each type in detail, including examples.
\nThe Static QR Code provides a limited set of functionalities. In this type of QR Code, all data required for payment initiation (configurations) are fully contained within the QR Code itself.
\nThere are five configuration options, where:
\nOne is mandatory:
The user generating the static QR Code must provide a valid Pix key registered in the DICT (Directory of Transactional Account Identifiers), as defined by the DICT Operational Manual.
Four are optional:
\nTransaction ID — Used for payment reconciliation.
\nFree-text field — Custom text that can be displayed to the payer.
\nPayment amount — Predefined value for the transaction.
\nCash-out facilitator identifier — Identifies a third-party cash withdrawal facilitator.
\nThe Dynamic QR Code offers a broader set of functionalities, such as:
\nPayment reconciliation using a transaction ID.
\nPredefined payment amounts.
\nStructured free-text fields for presenting additional information.
\nLike the static QR Code, the dynamic QR Code must also include a valid Pix key from the DICT.
\nThe key characteristic of a dynamic QR Code is its flexibility. Its internal structure is configured with a URL.
\nThe dynamic QR Code itself contains only basic information about the payee. All other payment details are retrieved via the endpoint of the payee’s PSP, as indicated by the URL.
\nThe Composite QR Code combines the functionalities of both static and dynamic QR Codes while adding support for recurring payments.
\nKey characteristics:
\nIncludes all functionalities from the Static QR Code and the Dynamic QR Code (except for Pix Saque and Pix Troco).
\nContains a structured definition of parameters for recurring payments.
\nIntroduces a second URL field dedicated to recurrence configuration.
\nThe main distinction of the composite QR Code is this additional URL, located in a dedicated field within the BR Code. Its payload contains recurring payment configuration details offered by the payee to the payer.
\nThe amountType (string) parameter has two possible values:
\nFIXED – The amount is fixed and cannot be changed by the payer.
\nCUSTOM – The amount can be entered or modified by the payer at the time of payment, allowing flexibility.
\nThe type (string) parameter most important values are:
\nThe Pix Payments API facilitates the initiation and confirmation of payments using all methods available within Pix, the Brazilian instant payment system regulated by the Central Bank of Brazil (BACEN).
\nPix can be used by individuals (PF) and businesses (PJ) to make transfers, pay bills, and collect taxes and service fees.
\nPix transactions are backed by strict security and compliance measures established by BACEN. All participants must follow the rules related to the use of the Pix brand and the user experience standards.
\nThese requirements ensure the security and integrity of all operations within the Instant Payment System (SPI).
\n","_postman_id":"fb689a40-3fdc-415c-be9d-192bf9cd7285"},{"name":"List","id":"211f3ef5-7b05-4102-93ae-665df0f87260","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{client_id}}","type":"text"}],"url":"{{base_url}}/api/v1/accounts","description":"This provides a detailed overview of the financial accounts retrieved, including pagination information and specific account details.
\nThe status field can have one of the following values:
PRE_CREATED
IN_ANALISYS
REGULAR
LOCKED
CLOSED
RESERVED
CREATING
ERROR
ACTIVE
REPROVED
Retrieves the informed account uuid, along with their associated details.
\nThis endpoint retrieves information about banks based on the provided ISPB (Instituição de Pagamento e Sistema de Pagamento Brasileiro) code.
\nispb (string): The ISPB code of the bank you want to query.
code (string): Filter banks by their bank code.
isParticipantPix (boolean): Filter banks by participation in the PIX system.
isParticipantStr (boolean): Filter banks by participation in the STR system.
Upon a successful request, the API will return a JSON object containing the following fields:
\ncount (integer): The total number of banks matching the query.
next (string): A URL to the next page of results, if any.
previous (string): A URL to the previous page of results, if any.
results (array): An array of bank objects, each containing:
code (string): The bank's code.
name (string): The name of the bank.
comp (string): The bank's company information.
ispb (string): The ISPB code of the bank.
isParticipantComp (boolean): Indicates if the bank is a participant in the company.
isParticipantPix (boolean): Indicates if the bank is a participant in the PIX system.
isParticipantStr (boolean): Indicates if the bank is a participant in the STR system.
We offer two types of accounts:
\nThe Linked Account, also known as the Guarantee Account, is a financial service that offers a secure and efficient solution for managing financial resources. Designed to meet the needs of guarantees and secure transactions, the Linked Account provides a range of fundamental services to facilitate the control and movement of resources.
\nThe main objective of the Linked Account is to provide a reliable environment for securing financial resources dedicated to specific guarantees and transactions. This type of account aims to offer security and transparency in financial operations, providing peace of mind to all parties involved.
\nThe Free Movement Account is a payments account with unlimited capabilities, allowing access to all banking services offered by Kanastra.
\nThe main objective of the Free Movement Account is to provide a reliable, easy-to-use environment that facilitates the movement of received funds.
\n","event":[{"listen":"prerequest","script":{"id":"0701d0e7-01b5-4ee1-a074-654caeebe5fc","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"b97ee3be-de97-466c-b9c9-b5acde5252eb","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"9284a70e-4e5b-4f1e-b752-f5d05acc5113"},{"name":"Webhooks","item":[{"name":"Bank Slip","item":[{"name":"CNAB","item":[],"id":"437e135c-c62a-4f98-9376-58a240cd68f9","description":"This documentation outlines the webhook events related to CNAB file processing for bank slips. The events are designed to provide notifications about different processing stages and issues:
\nBANK_SLIP_CNAB_INVALID: Triggered when the CNAB file is invalid.
BANK_SLIP_CNAB_VALIDATION_ERROR: Triggered when there are validation errors.
BANK_SLIP_PROCESSING_ERROR: Triggered when there are processing errors.
BANK_SLIP_CNAB_PROCESSED: Triggered when the CNAB file has been successfully processed.
Each event dispatches a JSON payload with details about the processing of the CNAB file. Below is the structure of the payload for these events:
\n{\n \"data\": {\n \"errors\": [],\n \"totalLineProcessed\": 0,\n \"totalLineErrors\": 0,\n \"fileName\": \"\",\n \"cnabFileStatus\": \"\"\n },\n \"event\": \"\",\n \"product\": \"BANK_SLIP\"\n}\n\ndata:
errors: An array containing detailed error messages or codes that occurred during the processing of the CNAB file.
totalLineProcessed: Total number of lines that were successfully processed.
totalLineErrors: Number of lines that encountered errors during processing.
fileName: Name of the CNAB file that was processed.
cnabFileStatus: Current status of the CNAB file (e.g., PROCESSED).
event: Specifies the type of event triggered (BANK_SLIP_CNAB_INVALID, BANK_SLIP_CNAB_VALIDATION_ERROR, BANK_SLIP_PROCESSING_ERROR, BANK_SLIP_CNAB_PROCESSED).
product: BANK_SLIP
This documentation provides a comprehensive guide to the webhook events related to bank slip processing. The events notify subscribing systems of changes or updates to bank slips, facilitating real-time updates and responses:
\nBANK_SLIP_SETTLED: Triggered when a bank slip has been fully settled.
BANK_SLIP_CANCELED: Triggered when a bank slip has been canceled.
BANK_SLIP_OPEN: Triggered when a bank slip is created and open for payment.
BANK_SLIP_REJECTED: Triggered when a bank slip has been rejected.
BANK_SLIP_EXPIRED: Triggered when a bank slip has expired without payment.
Each event dispatches a JSON payload with detailed information about the bank slip. Below is the structure of the payload for these events:
\n{\n \"data\": {\n \"errors\": [],\n \"bankSlip\": {\n \"uuid\": \"\",\n \"payer\": {\n \"name\": \"\",\n \"type\": \"\",\n \"uuid\": \"\",\n \"email\": null,\n \"phone\": \"\",\n \"address\": {\n \"city\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"zipcode\": \"\",\n \"complement\": \"\",\n \"neighborhood\": \"\"\n },\n \"governmentId\": \"\",\n \"createdAt\": \"\",\n \"isDeleted\": false,\n \"updatedAt\": \"\"\n },\n \"status\": \"\",\n \"barCode\": \"\",\n \"dueDate\": \"\",\n \"overdue\": false,\n \"payDate\": null,\n \"expireAt\": \"\",\n \"fineType\": \"\",\n \"lineCode\": \"\",\n \"messages\": \"\",\n \"payValue\": null,\n \"createdAt\": \"\",\n \"fineValue\": \"\",\n \"ourNumber\": \"\",\n \"updatedAt\": \"\",\n \"rebateValue\": \"\",\n \"documentDate\": \"\",\n \"interestType\": \"\",\n \"nominalValue\": \"\",\n \"demonstrative\": \"\",\n \"discountLimit\": null,\n \"discountValue\": \"\",\n \"interestValue\": \"\",\n \"documentNumber\": \"\",\n \"expirationDays\": 0,\n \"calculatedTaxes\": {\n \"fine\": 0,\n \"total\": 0,\n \"rebate\": 0,\n \"discount\": 0,\n \"interest\": 0\n },\n \"installmentCount\": 0,\n \"participantControlNumber\": \"\"\n }\n },\n \"event\": \"\",\n \"product\": \"BANK_SLIP\"\n}\n\nerrors: Array of error messages encountered during bank slip processing.
bankSlip:
Comprehensive details about the bank slip including status, payer information, payment details, and tax calculations.
\nstatus: Current status of the bank slip (e.g., OPEN, SETTLED, CANCELED).
dueDate, payDate, expireAt: Relevant dates regarding the bank slip's validity and payment timeline.
fineType, interestType: Information on any fines or interest applied to the bank slip.
nominalValue, payValue, fineValue, discountValue, interestValue: Monetary values associated with the bank slip.