{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/smart_collections_brazil/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition"]},"type":"markdown"},"seo":{"title":"Prerequisites","description":"Belvo provides open finance products for Latin America that allow you to securely access and aggregate financial data as well as accept and issue bank-to-bank payments","siteUrl":"https://developers.belvo.com/","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"prerequisites","__idx":0},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Beta"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Smart Collections is currently in Beta. Some contracts on this page are still being confirmed with our engineering team, so treat them as provisional and expect refinements before general availability, including:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Webhook payloads and event codes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["API reference updates for the Collection Instructions, Payment Authorization, and Charge endpoints"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Field names and documentation improvements (terminology, diagrams)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Contact your Belvo account manager to join the Beta program."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To use Belvo's Smart Collections, you must have already integrated both of the Brazil products it builds on: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Banking Aggregation"]}," (to monitor balances) and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Smart Transfers"]},", from Payments Brazil (to collect funds). Smart Collections runs in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["production only"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Smart Collections uses two Belvo products, one to monitor bank account balances and one to move the funds:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Task"},"children":["Task"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What you need"},"children":["What you need"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Belvo product"},"children":["Belvo product"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Monitor the balance"]},": know when the user has enough money to collect"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Link"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["link_id"]},") that lets Belvo read the user's account balance in the background"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Banking Aggregation (Open Finance Data Aggregation, OFDA)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Collect the funds"]},": move funds via Pix once the balance is sufficient"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A Smart Transfers ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payment Authorization"]}," you can charge against"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payments Brazil: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments_brazil/payments-brazil-smart-transfers-overview","target":"_blank"},"children":["Smart Transfers"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Set up each product separately"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Banking Aggregation and Payments are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["separate Belvo products"]},". Each has its ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["own API keys"]}," and its ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["own webhook configuration"]},", so you must set both up ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["independently"]},". Smart Collections will not work if you reuse one product's API keys or webhook endpoint for the other."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"banking-aggregation-ofda","__idx":1},"children":["Banking Aggregation (OFDA)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To monitor balances, you need to:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Complete the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/aggregation_brazil/prerequisites-get-started-in-10-minutes","target":"_blank"},"children":["Banking Aggregation getting started guide"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set up the OFDA Widget to create Links."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enable a webhook to receive ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COLLECTIONS"]}]}," webhook events (see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/developer_resources/resources-webhooks-aggregation","target":"_blank"},"children":["Aggregation Webhooks"]},")."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Belvo needs a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Link"]}," to read the user's account balance:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If you already aggregate this user's data, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["reuse their existing Link"]},". You don't need to create a new one for Smart Collections."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Otherwise, create one by following the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/aggregation_brazil/aggregation-brazil-integration-widget","target":"_blank"},"children":["OFDA Widget integration guide"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"smart-transfers-payments-brazil","__idx":2},"children":["Smart Transfers (Payments Brazil)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To collect funds, you need to:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Complete the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments_brazil/payments-brazil-prequisites","target":"_blank"},"children":["Payments Brazil prerequisites"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ask your Belvo account manager to enable Smart Transfers for your organization."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set up webhooks to receive ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payments-BR.V2"]}]}," webhook events (see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/developer_resources/resources-webhooks-payments-brazil","target":"_blank"},"children":["Payments Webhooks (Brazil)"]},")."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"The receiving account must be held by the user"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Smart Transfers only moves funds between accounts held by the same person (same CPF) or company (same CNPJ root). The beneficiary account on the Payment Authorization must therefore be held by the user you collect from. See the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments_brazil/payments-brazil-smart-transfers-overview","target":"_blank"},"children":["Smart Transfers overview"]},"."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Get the payments institution ID separately"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you create a Payment Authorization, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payer.institution"]}," is a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["payments"]}," institution ID from the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/belvoopenapispec/payment-institutions-(brazil)/listpaymentinstitutionsbrazil","target":"_blank"},"children":["List all payment institutions"]}," endpoint. It is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," the same as the OFDA institution from the user's Link, so you must look it up separately."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-step","__idx":3},"children":["Next step"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once these are in place, head to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/smart_collections_brazil/smart-collections-balance-checking","target":"_blank"},"children":["Phase 1: Balance Checking"]}," to create your first Collection Instruction."]}]},"headings":[{"value":"Prerequisites","id":"prerequisites","depth":1},{"value":"Banking Aggregation (OFDA)","id":"banking-aggregation-ofda","depth":2},{"value":"Smart Transfers (Payments Brazil)","id":"smart-transfers-payments-brazil","depth":2},{"value":"Next step","id":"next-step","depth":2}],"frontmatter":{"seo":{"title":"Prerequisites"}},"lastModified":"2026-10-20T12:19:23.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/smart_collections_brazil/smart-collections-prerequisites","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}