Welcome to the BMB API, a powerful and comprehensive solution designed to facilitate seamless integration with banking services. The BMB API enables businesses to leverage a broad range of banking functionalities, providing a robust foundation for Bank-as-a-Service (BaaS) applications. Whether you're looking to create new financial products, improve customer experiences, or streamline your banking operations, the BMB API offers the tools and capabilities you need.
\nAuthentication and Security: Ensure secure access and transactions with advanced authentication methods and security protocols.
\nPayments and Transfers: Initiate and process payments, transfers, and other financial transactions securely and efficiently.
\nReporting and Analytics: Gain insights with comprehensive reporting and analytics capabilities, enabling data-driven decision-making.
\nCompliance and Regulation: Stay compliant with regulatory requirements through built-in compliance features and regular updates.
\nThe BMB API is designed to be developer-friendly
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15468772","collectionId":"c6b20310-d276-4033-aa05-b7e1b58b2f92","publishedId":"2sAY4sjPrx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"f19d38"},"publishDate":"2025-04-06T20:09:20.000Z"},"item":[{"name":"Authentication","item":[{"name":"Connect","id":"a39b5d30-f628-459e-bc12-56bd333d88b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"secretKey","value":"8sNjhlp7UR4B3SWZNnTecwRZDfQSVQ66sJCbvDrRaygY0LkqlslbutTHjEH5ZF5Pu6zr9IOkE3dlI5VO61MQhruC8FkuQ54A4cp52vC6aSic3NEc8KalkxSO3JTL6frq","type":"text"},{"key":"Key","value":"Bankys","type":"text"}],"url":"https://api-sandbox.bmb.dev.br/connect/token","description":"","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}},"urlObject":{"path":["connect","token"],"host":["https://api-sandbox.bmb.dev.br"],"query":[],"variable":[]}},"response":[{"id":"dbb2b651-17fb-43f4-aae1-6c6e1199d271","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"secretKey","value":"fdweewfwefewfewvwe","type":"text"},{"key":"Key","value":"tetegewgew","type":"text"}],"url":"https://api-sandbox.bmb.dev.br/connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 18 Aug 2024 12:38:35 GMT"},{"key":"Server","value":"Apache/2.4.46 (Unix) OpenSSL/1.1.1i PHP/7.2.34 mod_perl/2.0.11 Perl/v5.32.0"},{"key":"X-Powered-By","value":"PHP/7.2.34"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"237"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": \"true\",\n \"token\": \"2b4701a83b5f4ed3a2881645029054535ed64c566415685da2945e6ad4e9278f712afaa61a132f1e8168d08ee962d8ab89c7c85c9fac2c2ea836ccf928b37dae\",\n \"tokenId\": \"ed4592baa3749bdd35b20c670a778547\",\n \"Expiration\": \"2024-08-18 10:38:35\"\n}"}],"_postman_id":"a39b5d30-f628-459e-bc12-56bd333d88b2"}],"id":"f4fb9487-235d-4060-b5f1-0c09a2c39b48","description":"All endpoints listed in the API reference (BMB BaaS) use the standard API Token for authentication. In this authentication method, a new header must be created/set on each HTTP request.
Therefore, the secretKey and Key header must be inserted and a value (API Token) assigned to it, for authentication with the BMB API.
Creating accounts using the BMB API is simple and efficient. The API allows you to automate the entire account creation process for new customers, from collecting basic information to confirming identity. To get started, make a call to the account creation endpoint providing the necessary data such as name, address and personal identification. The API will take care of the rest, ensuring that all steps are completed safely and in compliance with current regulations.
\n","_postman_id":"e220fc73-4b82-4684-943e-c8337d3b0068","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}}},{"name":"Liveness","item":[{"name":"Single Step","id":"2f62ec73-8189-4890-8b1e-d18617006f51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"}],"body":{"mode":"raw","raw":"{\n \"validationType\": \"LIVENESS\",\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/onboarding/liveness","description":"To finalize and send the account, make sure the SELFIE is sent along with images of the full document or front and back of the document.
\n","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}},"urlObject":{"path":["baas","api","v1","onboarding","liveness"],"host":["https://api-sandbox.bmb.dev.br"],"query":[],"variable":[]}},"response":[],"_postman_id":"2f62ec73-8189-4890-8b1e-d18617006f51"}],"id":"ab05255e-8c65-4940-af63-96321fbcee9c","_postman_id":"ab05255e-8c65-4940-af63-96321fbcee9c","description":"","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}}},{"name":"Verify account status","id":"c5e3b18a-f2b7-4364-9e9c-a4a9badcb0f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/onboarding/?document=document","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}},"urlObject":{"path":["baas","api","v1","onboarding",""],"host":["https://api-sandbox.bmb.dev.br"],"query":[{"key":"document","value":"document"}],"variable":[]}},"response":[{"id":"49438515-b16d-419d-aacd-b7d8c5137b78","name":"Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"968fad17f718db2d67eb694b5ab16f9859bb7be3c5778b4041f56af029a2a9aa6992e09e396dd9f4e5b9afaa121c2951d71cb0c3d503407bd9fbfa06fb4719f4","type":"text"},{"key":"TokenId","value":"41c294fa9c4574b3ab79a29893f16c19","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-sandbox.bmb.dev.br/baas/api/v1/onboarding/?document=40419348859","host":["https://api-sandbox.bmb.dev.br"],"path":["baas","api","v1","onboarding",""],"query":[{"key":"document","value":"40419348859"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Tue, 27 Aug 2024 02:09:14 GMT"},{"key":"Server","value":"Apache/2.4.46 (Unix) OpenSSL/1.1.1i PHP/7.2.34 mod_perl/2.0.11 Perl/v5.32.0"},{"key":"X-Powered-By","value":"PHP/7.2.34"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"38"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\"Success\":\"true\",\"Status\":\"APPROVED\"}"}],"_postman_id":"c5e3b18a-f2b7-4364-9e9c-a4a9badcb0f3"}],"id":"91ef47f1-a0b9-4cda-8176-84568d84f123","description":"Overview
The integration process allows you to open accounts for individuals and legal entities.
Data Submission
Submit complete user details at the beginning of the onboarding process.
Data Validation
After sending the data, wait for validation. Once validated, you can proceed with submitting documents.
Submission of Documents
Send the necessary documents, such as selfie, driver's license or ID.
Finishing
Complete the onboarding process with the final step using the FINISH endpoint.
Please follow the correct sequence of steps to ensure successful account opening.
\nPayload example for approved accounts
\n{\n \"event\": \"accountCreated\",\n \"data\": {\n \"accountId\": \"c5dfea48-50b2-496d-a548-cc9df0f03660\",\n \"passwordAccount\": \"b6c685e7be3af8d47a9fe04add39275ccbaf3681\",\n \"Name\": \"Weslley Tecnic\",\n \"Document\": \"33344455566\",\n \"Status\": \"APPROVED\",\n \"Ispb\": \"13372874\",\n \"Bank\": \"002\",\n \"Agency\": \"0001\",\n \"Account\": \"17064-5\",\n }\n}\n\nThis endpoint is dedicated exclusively to managing PIX keys.
\n","_postman_id":"e1cc1ba4-c6a5-4aaf-acc6-c8635d6962ff","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}}},{"name":"QR Code","item":[{"name":"Create QR Code Static","id":"dfdd2dcf-b71b-4be3-afce-636adf0db965","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"description\": \"Teste pix Estatico\",\n \"type\": \"PIX_STATIC\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/qrcode/create","description":"The Static QR Code contains fixed information that doesn't change with time, maintaining the same data since its creation.
\nPayments in physical establishments: enterprises can generate static QR codes using Pix and show them in their establishments. Allowing the clients to scan the QR Code directly in their chosen payment app. This speeds up the payment process and eliminates the need to use PoS'.
\nDonations: Charities and non-profit organizations can make use of the Pix Static QR Code to receive donations quickly and conveniently. People interested in contributing can scan the code and make payments directly from their mobile devices.
\nThe Static QR Code contains fixed information that doesn't change with time, maintaining the same data since its creation.
\nPayments in physical establishments: enterprises can generate static QR codes using Pix and show them in their establishments. Allowing the clients to scan the QR Code directly in their chosen payment app. This speeds up the payment process and eliminates the need to use PoS'.
\nDonations: Charities and non-profit organizations can make use of the Pix Static QR Code to receive donations quickly and conveniently. People interested in contributing can scan the code and make payments directly from their mobile devices.
\nThis endpoint is dedicated to PIX QR Code generations.
\n","_postman_id":"48d492fc-e168-4bdd-b9f9-e359cdd89b5d","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}}},{"name":"Transfers","item":[{"name":"Pix transfer with bank account","item":[{"name":"Transfer","id":"6295d777-67a0-4c33-9438-1e771c21e349","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"},{"key":"IdempotencyKey","value":"e42556cb-2273-4a4f-8435-4638717b324b","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"amount\": 1000,\n \"description\": \"Pix Manual Online\",\n \"beneficiary\": {\n \"number\": \"90112\",\n \"branch\": \"0001\",\n \"type\": \"CURRENT\",\n \"participantIspb\": \"13372874\",\n \"holder\": {\n \"document\": \"12345678000123\",\n \"name\": \"Name Payer\",\n \"type\": \"NATURAL\"\n\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/transfers/manual","description":"","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}},"urlObject":{"path":["baas","api","v1","transfers","manual"],"host":["https://api-sandbox.bmb.dev.br"],"query":[],"variable":[]}},"response":[{"id":"39d53947-5f39-481f-ba9d-89adb477df54","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"},{"key":"IdempotencyKey","value":"18bc3c0a-4937-4425-8115-b4b7883a4074","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"amount\": 1,\n \"description\": \"Pix Manual\",\n \"beneficiary\": {\n \"number\": \"123456\",\n \"branch\": \"1010\",\n \"type\": \"CURRENT\",\n \"participantIspb\": \"13372874\",\n \"holder\": {\n \"document\": \"12345678900\",\n \"name\": \"Name Payer \",\n \"type\": \"NATURAL\"\n\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/transfers/manual"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 26 Sep 2024 17:20:02 GMT"},{"key":"Server","value":"Apache/2.4.46 (Unix) OpenSSL/1.1.1i PHP/7.2.34 mod_perl/2.0.11 Perl/v5.32.0"},{"key":"X-Powered-By","value":"PHP/7.2.34"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"264"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": \"true\",\n \"endToEndId\": \"E1337287420240926172002JxDxUnpJ4\",\n \"beneficiary\": {\n \"number\": \"123456\",\n \"branch\": \"1010\",\n \"type\": \"CURRENT\",\n \"holder\": {\n \"name\": \"Name Payer\",\n \"document\": \"12345678900\",\n \"type\": \"NATURAL\"\n },\n \"participant\": {\n \"name\": \"BMB PAGAMENTOS\",\n \"ispb\": \"13372874\"\n }\n }\n}"},{"id":"2705356f-8b43-4a53-a6f2-4f190de1c3ff","name":"Erro","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"80fbb9b7c115ad4e181d8c6a94e09c86ee698596a8d43e554485b165cb76d4ad150348aabb16a7ff111fcfa16a05dc09eef2ec306da480b2a2b2d0fa38f10a45","type":"text"},{"key":"TokenId","value":"35434ff45ae1269091a91e297c489502","type":"text"},{"key":"IdempotencyKey","value":"d2cceae9-c166-4223-80bc-f7493c8f13d9","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"a9b82597-b56a-430e-ab12-b4ccd102c4fc\",\n \"password\": \"f02f0291d93658d412e786f7e63acebd8e76b52f\"\n },\n \"amount\": 1000,\n \"description\": \"Pix Manual Online\",\n \"beneficiary\": {\n \"number\": \"90112\",\n \"branch\": \"0001\",\n \"type\": \"CURRENT\",\n \"participantIspb\": \"13372874\",\n \"holder\": {\n \"document\": \"19451169000196\",\n \"name\": \"Name Payer\",\n \"type\": \"NATURAL\"\n\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/transfers/manual"},"status":"Unprocessable","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 28 Sep 2024 17:49:47 GMT"},{"key":"Server","value":"Apache/2.4.46 (Unix) OpenSSL/1.1.1i PHP/7.2.34 mod_perl/2.0.11 Perl/v5.32.0"},{"key":"X-Powered-By","value":"PHP/7.2.34"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"72"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": \"false\",\n \"Message\": \"Daily limit exceeded. Available: R$ 3,00\"\n}"}],"_postman_id":"6295d777-67a0-4c33-9438-1e771c21e349"}],"id":"0812ab59-e039-446a-afac-8910d2a83d11","description":"It is possible to make a Pix without the key, you only need to inform the bank account information of the client (similar to TED (\"Transferência Eletrônica Disponível\" or Electronic Transfer Available)). In this scenario, you do not need to use the payment initiation endpoint, just fill in the payload data and send the desired amount.
\n","_postman_id":"0812ab59-e039-446a-afac-8910d2a83d11","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}}},{"name":"Pix Transfer with key","item":[{"name":"Initialization","id":"6ff3b5fd-8f4f-44bd-abca-4e609acb3887","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"},{"key":"IdempotencyKey","value":"f5e3935d-05e0-4b3b-81aa-5f16eb23ebf2","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"key\": \"19451169000196\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/transfers/initialization","description":"","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}},"urlObject":{"path":["baas","api","v1","transfers","initialization"],"host":["https://api-sandbox.bmb.dev.br"],"query":[],"variable":[]}},"response":[{"id":"b836bfe1-1226-4e13-a087-d967a33d53ad","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"},{"key":"IdempotencyKey","value":"857a24dc-a668-4f48-acca-f05dae566794","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"key\": \"12345678000111\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/transfers/initialization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 26 Sep 2024 17:47:17 GMT"},{"key":"Server","value":"Apache/2.4.46 (Unix) OpenSSL/1.1.1i PHP/7.2.34 mod_perl/2.0.11 Perl/v5.32.0"},{"key":"X-Powered-By","value":"PHP/7.2.34"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ci_session=9fe8ff0bf25568510eb5bdc30ea017f281189547; expires=Thu, 26-Sep-2024 18:07:17 GMT; Max-Age=1200; path=/; HttpOnly"},{"key":"Content-Length","value":"295"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"19451169000196\",\n \"endToEndId\": \"E1337287420240926174717571182800\",\n \"beneficiary\": {\n \"number\": \"90112\",\n \"branch\": \"0001\",\n \"type\": \"PAYMENT\",\n \"participant\": {\n \"name\": \"AGILE CORPORATION\",\n \"ispb\": \"12573115\"\n },\n \"holder\": {\n \"name\": \"NATURAL PERSON LOREN IPSUN LOREN\",\n \"document\": \"12345678000111\",\n \"type\": \"LEGAL\"\n }\n }\n}"}],"_postman_id":"6ff3b5fd-8f4f-44bd-abca-4e609acb3887"},{"name":"Confirm","id":"51c49a4f-7db6-4635-abf3-bd295f780353","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"},{"key":"IdempotencyKey","value":"b46ac55f-f99f-4c3b-b211-1d9898099180","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"amount\": 10,\n \"key\": \"12345678000111\",\n \"description\": \"Transfer Pix Key\",\n \"endToEndId\": \"E1337287420240926175614604827305\",\n \"beneficiary\": {\n \"number\": \"90112\",\n \"branch\": \"0001\",\n \"type\": \"CURRENT\",\n \"participantIspb\": \"13372874\",\n \"holder\": {\n \"document\": \"12345678000111\",\n \"name\": \"Name Payer\",\n \"type\": \"NATURAL\"\n\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/transfers/confirm","description":"","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}},"urlObject":{"path":["baas","api","v1","transfers","confirm"],"host":["https://api-sandbox.bmb.dev.br"],"query":[],"variable":[]}},"response":[{"id":"df037705-aa55-452c-9cbe-a9417fe7b215","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"},{"key":"IdempotencyKey","value":"39d96f75-85b4-4835-8153-2aea25386395","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"amount\": 1.60,\n \"key\": \"12345678000111\",\n \"description\": \"Transfer Pix Key\",\n \"endToEndId\": \"E1337287420240926174717571182800\",\n \"beneficiary\": {\n \"number\": \"90112\",\n \"branch\": \"0001\",\n \"type\": \"PAYMENT\",\n \"participantIspb\": \"12573115\",\n \"holder\": {\n \"document\": \"19451169000196\",\n \"name\": \"NATURAL PERSON LOREN IPSUN LOREN\",\n \"type\": \"LEGAL\"\n\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/transfers/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 26 Sep 2024 17:47:29 GMT"},{"key":"Server","value":"Apache/2.4.46 (Unix) OpenSSL/1.1.1i PHP/7.2.34 mod_perl/2.0.11 Perl/v5.32.0"},{"key":"X-Powered-By","value":"PHP/7.2.34"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"289"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": \"true\",\n \"endToEndId\": \"E1337287420240926174717571182800\",\n \"beneficiary\": {\n \"number\": \"90112\",\n \"branch\": \"0001\",\n \"type\": \"PAYMENT\",\n \"holder\": {\n \"name\": \"NATURAL PERSON LOREN IPSUN LOREN\",\n \"document\": \"12345678000111\",\n \"type\": \"LEGAL\"\n },\n \"participant\": {\n \"name\": \"AGILE CORPORATION\",\n \"ispb\": \"12573115\"\n }\n }\n}"}],"_postman_id":"51c49a4f-7db6-4635-abf3-bd295f780353"}],"id":"d68b16ce-2222-41a1-a253-431818ac6a9a","description":"To perform a Pix transfer with a key, it is necessary to first query the key information through the payment initiation endpoint and finally carry out the transfer.
\nThis endpoint will provide you with basic data relating to the queried key. Additionally, it will provide the \"endToEndId\" attribute that will be required by the transfer endpoint if you choose Pix with key.
\n","_postman_id":"d68b16ce-2222-41a1-a253-431818ac6a9a","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}}},{"name":"Transfer Refund","id":"abf7a2bf-953b-447e-912f-11cbc8791484","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"},{"key":"IdempotencyKey","value":"8295fe15-a322-46a1-a1f2-657d4c79d759","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"amount\": 1,\n \"endToEndId\": \"E1337287420241002191514045633134\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/transfers/refund","description":"","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}},"urlObject":{"path":["baas","api","v1","transfers","refund"],"host":["https://api-sandbox.bmb.dev.br"],"query":[],"variable":[]}},"response":[],"_postman_id":"abf7a2bf-953b-447e-912f-11cbc8791484"},{"name":"Get Transaction","id":"f2410190-5681-426d-a6cd-d2cfffaa5477","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/transfers/transaction?endToEndId=E1337287420240928174147cFOODePLw","description":"","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}},"urlObject":{"path":["baas","api","v1","transfers","transaction"],"host":["https://api-sandbox.bmb.dev.br"],"query":[{"key":"endToEndId","value":"E1337287420240928174147cFOODePLw"}],"variable":[]}},"response":[],"_postman_id":"f2410190-5681-426d-a6cd-d2cfffaa5477"}],"id":"b6bcdbd7-c0ca-4e13-a917-01cd741af071","description":"This endpoint is dedicated to Pix transfers.
\n","_postman_id":"b6bcdbd7-c0ca-4e13-a917-01cd741af071","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}}},{"name":"Payment","item":[{"name":"Initialization","id":"af37ce60-ec5d-4a15-865b-a9bb0be98892","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"payload\": \"00020126420014br.gov.bcb.pix0120marketing@bmb.app.br5204000053039865802BR5920RODRIGO BERNARDES DE6009Sao Paulo622905259cb48426a1d29c2ba1ce9a1a463047105\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/payment/qrcode/initialization","description":"","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}},"urlObject":{"path":["baas","api","v1","payment","qrcode","initialization"],"host":["https://api-sandbox.bmb.dev.br"],"query":[],"variable":[]}},"response":[{"id":"a1dad9e6-0246-49a9-9a93-8cf0c48144e2","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"payload\": \"00020126420014br.gov.bcb.pix0120marketing@bmb.app.br5204000053039865802BR5920RODRIGO BERNARDES DE6009Sao Paulo622905259cb48426a1d29c2ba1ce9a1a463047105\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/payment/qrcode/initialization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.4"},{"key":"Date","value":"Fri, 27 Sep 2024 20:57:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"410"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' https://fonts.googleapis.com https://unpkg.com; img-src 'self' data: https://cdn.plyr.io https://www.bry.com.br https://fonts.googleapis.com https://unpkg.com; font-src 'self' data:"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Permissions-Policy","value":"geolocation=(), midi=(), notifications=(), push=(), sync-xhr=(), microphone=(), camera=(), magnetometer=(), gyroscope=(), accelerometer=(), usb=()"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"marketing@bmb.app.br\",\n \"endToEndId\": \"E1337287420240927205758018596354\",\n \"transactionId\": \"9cb48426a1d29c2ba1ce9a1a4\",\n \"allowChangeAmount\": false,\n \"categoryCode\": \"0000\",\n \"type\": \"QR_CODE_STATIC\",\n \"beneficiary\": {\n \"number\": \"123456\",\n \"branch\": \"0001\",\n \"type\": \"PAYMENT\",\n \"holder\": {\n \"name\": \"Rodrigo Teste\",\n \"document\": \"12345678900\",\n \"type\": \"NATURAL\"\n },\n \"participant\": {\n \"name\": \"BMB PAGAMENTOS\",\n \"ispb\": \"13372874\"\n }\n }\n}"}],"_postman_id":"af37ce60-ec5d-4a15-865b-a9bb0be98892"},{"name":"Confirm Static","id":"abbe73c8-d2d8-48e1-b260-964813c2503d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"},{"key":"IdempotencyKey","value":"d60e2596-a10e-44d2-bce1-00f9f4eeaff9","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"key\": \"testepix@bmb.app.br\",\n \"endToEndId\": \"E1337287420240927205758018596354\",\n \"transactionId\": \"9cb48426a1d29c2ba1ce9a1a4\",\n \"type\": \"QR_CODE_STATIC\",\n \"amount\": 10,\n \"beneficiary\": {\n \"participantIspb\": \"13372874\",\n \"number\": \"123456\",\n \"branch\": \"0001\",\n \"type\": \"PAYMENT\",\n \"holder\": {\n \"name\": \"Lucas Testes\",\n \"document\": \"12345678900\",\n \"type\": \"NATURAL\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/payment/static/confirm","description":"","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}},"urlObject":{"path":["baas","api","v1","payment","static","confirm"],"host":["https://api-sandbox.bmb.dev.br"],"query":[],"variable":[]}},"response":[{"id":"37f6d439-c8a7-492e-b817-10e86396bef4","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"},{"key":"IdempotencyKey","value":"250f725c-ef1e-4a40-8186-11b19faf2acd","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"key\": \"marketing@bmb.app.br\",\n \"endToEndId\": \"E1337287420240927205758018596354\",\n \"transactionId\": \"9cb48426a1d29c2ba1ce9a1a4\",\n \"type\": \"QR_CODE_STATIC\",\n \"amount\": 10,\n \"beneficiary\": {\n \"participantIspb\": \"13372874\",\n \"number\": \"123456\",\n \"branch\": \"0001\",\n \"type\": \"PAYMENT\",\n \"holder\": {\n \"name\": \"Rodrigo Testes\",\n \"document\": \"12345678900\",\n \"type\": \"NATURAL\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/payment/static/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.4"},{"key":"Date","value":"Fri, 27 Sep 2024 20:58:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"268"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' https://fonts.googleapis.com https://unpkg.com; img-src 'self' data: https://cdn.plyr.io https://www.bry.com.br https://fonts.googleapis.com https://unpkg.com; font-src 'self' data:"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Permissions-Policy","value":"geolocation=(), midi=(), notifications=(), push=(), sync-xhr=(), microphone=(), camera=(), magnetometer=(), gyroscope=(), accelerometer=(), usb=()"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": \"true\",\n \"endToEndId\": \"E1337287420240927205758018596354\",\n \"beneficiary\": {\n \"number\": \"123456\",\n \"branch\": \"0001\",\n \"type\": \"PAYMENT\",\n \"holder\": {\n \"name\": \"Rodrigo Testes\",\n \"document\": \"12345678900\",\n \"type\": \"NATURAL\"\n },\n \"participant\": {\n \"name\": \"BMB PAGAMENTOS\",\n \"ispb\": \"13372874\"\n }\n }\n}"}],"_postman_id":"abbe73c8-d2d8-48e1-b260-964813c2503d"},{"name":"Confirm Dinamyc","id":"f8c5ff04-6371-4642-bfe1-36ae7231954f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"},{"key":"IdempotencyKey","value":"7f7d46a2-32f9-4938-a497-1795cdec4167","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"key\": \"testespix@bmb.app.br\",\n \"endToEndId\": \"E1337287420240927201725202831502\",\n \"transactionId\": \"d4ce63c8067e6291751c6800ffda4627\",\n \"type\": \"QR_CODE_DYNAMIC_IMMEDIATE_PAYMENT\",\n \"amount\": 4.99,\n \"beneficiary\": {\n \"participantIspb\": \"13372874\",\n \"number\": \"123456\",\n \"branch\": \"0001\",\n \"type\": \"PAYMENT\",\n \"holder\": {\n \"name\": \"Lucas Testes\",\n \"document\": \"12345678900\",\n \"type\": \"NATURAL\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/payment/dynamic/confirm","description":"","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}},"urlObject":{"path":["baas","api","v1","payment","dynamic","confirm"],"host":["https://api-sandbox.bmb.dev.br"],"query":[],"variable":[]}},"response":[{"id":"6d9f6c4c-f39e-41c7-9fe9-a0be8663b181","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"fdweewfwefewfewvwe","type":"text"},{"key":"TokenId","value":"tetegewgew","type":"text"},{"key":"IdempotencyKey","value":"215b6c58-b34b-46d6-ae33-b28f3b1f5954","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAccount\": {\n \"accountId\": \"ba05467d-56c5-4186-890a-a4cf340921a7\",\n \"password\": \"827ccb0eea8a706c4c34a16891f84e7b\"\n },\n \"key\": \"testespix@bmb.app.br\",\n \"endToEndId\": \"E1337287420240927201725202831502\",\n \"transactionId\": \"d4ce63c8067e6291751c6800ffda4627\",\n \"type\": \"QR_CODE_DYNAMIC_IMMEDIATE_PAYMENT\",\n \"amount\": 4.99,\n \"beneficiary\": {\n \"participantIspb\": \"13372874\",\n \"number\": \"123456\",\n \"branch\": \"0001\",\n \"type\": \"PAYMENT\",\n \"holder\": {\n \"name\": \"Rodrigo Testes\",\n \"document\": \"12345678900\",\n \"type\": \"NATURAL\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.bmb.dev.br/baas/api/v1/payment/dynamic/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.4"},{"key":"Date","value":"Fri, 27 Sep 2024 20:19:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"268"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' https://fonts.googleapis.com https://unpkg.com; img-src 'self' data: https://cdn.plyr.io https://www.bry.com.br https://fonts.googleapis.com https://unpkg.com; font-src 'self' data:"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Permissions-Policy","value":"geolocation=(), midi=(), notifications=(), push=(), sync-xhr=(), microphone=(), camera=(), magnetometer=(), gyroscope=(), accelerometer=(), usb=()"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": \"true\",\n \"endToEndId\": \"E1337287420240927201725202831502\",\n \"beneficiary\": {\n \"number\": \"123456\",\n \"branch\": \"0001\",\n \"type\": \"PAYMENT\",\n \"holder\": {\n \"name\": \"Rodrigo Testes\",\n \"document\": \"12345678900\",\n \"type\": \"NATURAL\"\n },\n \"participant\": {\n \"name\": \"BMB PAGAMENTOS\",\n \"ispb\": \"13372874\"\n }\n }\n}"}],"_postman_id":"f8c5ff04-6371-4642-bfe1-36ae7231954f"}],"id":"ddfabd84-f06b-434b-85c9-21ac40dc885b","description":"This endpoint is dedicated for QR Code Pix payments.
\n","_postman_id":"ddfabd84-f06b-434b-85c9-21ac40dc885b","auth":{"type":"inherit","inherit":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","id":"c6b20310-d276-4033-aa05-b7e1b58b2f92","name":"BMB Finance | API","type":"collection"}}}],"id":"e6fba905-6022-41a5-8aea-8b6c36127ab5","description":"Pix events can be of three types:
PIX_RECEIVED - For Pix successfully received
PIX_PAYMENT_EFFECTIVE - Pix made successfully
PIX_REFUNDED - Pix refunded
{\n \"eventType\": \"PIX_RECEIVED\",\n \"correlationId\": \"S110211111111111111111111\",\n \"endToEndId\": \"E182361202024041911111111111111\",\n \"amount\": 100.0,\n \"createdAt\": \"2024-08-19 16:20:22\",\n \"payer\": {\n \"number\": \"49041111116\",\n \"branch\": \"0001\",\n \"type\": \"PAYMENT\",\n \"participant\": {\n \"name\": \"NU PAGAMENTOS - IP\",\n \"ispb\": \"18236120\"\n },\n \"holder\": {\n \"name\": \"GUSTAVO EXEMPLO\",\n \"document\": \"94881558099\",\n \"type\": \"NATURAL\"\n }\n },\n \"beneficiary\": {\n \"number\": \"11111\",\n \"branch\": \"0001\",\n \"type\": \"CURRENT\",\n \"participant\": {\n \"name\": \"BMB PAGAMENTOS\",\n \"ispb\": \"13372874\"\n },\n \"holder\": {\n \"document\": \"33344455566\",\n \"type\": \"LEGAL\"\n }\n }\n}\n\nThis functionality allows clients to pay bank slips and taxes (water, electricity, gas, telephone bill, etc. See the list of available agreements).
\nBill payment process
\nThe payment process consists of the following steps:
\nQuery for the bill information
\nWith the response, the client system must validate some information before the payment.
Validate bill payment status. The payment only will be made for bills with status equals to PENDING_PAYMENT.
Validate the isAllowPartialPayment flag, where this indicates whether partial payment is allowed. If this flag is true, check the range of values according to the information present in the payment calculation object paymentCalculation.
After the necessary checks, carry out the payment process.
\nBrings together Endpoints intended for Charges management
\nCharge types
\nThe list below, presents the Charge Types on BMB
\nBANKSLIP: Conventional bank slip
\nBANKSLIP_PIX: A bankslip that cointains a QR Code and can also be paid using a Pix payment method
\nIMPORTANT: Before creating Charges of the BANKSLIP and BANKSLIP_PIX type, it will be necessary to configure the bank account as an Authorized Bank slip Emitter or in pt-BR “Cedente”.
The following section describes the payload structure for initiating a mobile recharge request through the API. This payload is designed to authenticate the user and specify the product for the transaction.
\nField Descriptions
\ndataAccount: Contains authentication credentials for the account performing the recharge.
\nPRODUCTS: Specifies the type of product or service being requested.
\ndataAccount: Contains authentication credentials for the account making the recharge request.
\nproducts: The product being requested for the recharge, usually the mobile network provider.
\nsupplier: The supplier providing the recharge services (typically the same as products).
phoneNumber: The phone number for which the recharge is being made.
\namount: The recharge amount, represented in the currency unit (e.g., Brazilian Reals).
\ndataAccount:
\naccountId must be a valid UUID string.
password must not be empty and should meet minimum security requirements.
products & supplier:
\nproducts and supplier should be valid and represent the mobile network operator. For example, \"CLARO\", \"TIM\", etc.phoneNumber:
\nMust be a valid phone number format for the specified country, including area codes (e.g., for Brazil, phone numbers typically contain 11 digits starting with a 9).
\nEnsure the number is numeric and follows the required phone number length.
\namount:
\namount should be a positive numeric value and represent the value to be recharged. It should be an integer (e.g., 20 for 20 units).The following section describes the payload structure used for authorizing a mobile recharge transaction via the API. This payload is used to authenticate the user and confirm the details of the transaction before it is processed.
\nField Descriptions
\ndataAccount: Contains authentication credentials for the account requesting the authorization.
\ntransactionId: The unique identifier of the transaction to be authorized.
\nproductName: The name of the mobile network provider for the recharge.
\ndataAccount:
\naccountId must be a valid UUID string.
password must not be empty and should meet the security standards set by the system.
transactionId:
\ntransactionId must be a valid string that matches the previously generated transaction ID. This ID is generated when initiating the recharge request.productName:
\nproductName must be a valid mobile network provider, such as \"CLARO\", \"TIM\", \"VIVO\", etc.
Ensure that the productName matches the product associated with the transactionId for a valid authorization.
The Mobile Recharge API provides a seamless and secure way to integrate mobile recharge functionalities into your applications or systems. Designed for flexibility and ease of use, this API supports various mobile carriers and allows users to perform real-time phone top-ups. Below is an overview of its key features, endpoints, and implementation details.
\nFeatures
\nReal-Time Recharge
Recharge mobile phones instantly with minimal latency.
Carrier Integration
Supports multiple mobile carriers, ensuring wide coverage.
Secure Transactions
Transactions are protected with industry-standard security protocols, including authentication and encryption.
Idempotency Support
Avoid duplicate transactions with unique Idempotency Key handling.
Validation Checks
Built-in phone number validation to ensure accuracy before processing.