ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.
Recurrence Amount, use fixed for fixed amount recurences. For variable amount recurrences, a minimum can be defined. If defined, the counterparty cannot define a limit lower than the minimum. Variable amount recurrences need to be updated with the amount before each collecting date. If left blank, a variable amount recurrence will be created with no minimum
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Documentation","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/trio-372e8dab/93Kz5zeq9leNAs-j/images/LOGO_TRIO-02.png?fit=max\u0026auto=format\u0026n=93Kz5zeq9leNAs-j\u0026q=85\u0026s=1cf0ec2d074438cb2e0a6ac1d66db4f9","dark":"https://mintcdn.com/trio-372e8dab/93Kz5zeq9leNAs-j/images/LOGO_TRIO_Prancheta1.png?fit=max\u0026auto=format\u0026n=93Kz5zeq9leNAs-j\u0026q=85\u0026s=9b412ec26f2e68ec5734e75b5363223a","href":"https://www.trio.com.br/"},"favicon":{"light":"https://mintcdn.com/trio-372e8dab/fUAB1jI_-7Nq6WNd/images/favicon-32x32.png?fit=max\u0026auto=format\u0026n=fUAB1jI_-7Nq6WNd\u0026q=85\u0026s=02e84f8cdce49974f6bd250833fbf98d","dark":"https://mintcdn.com/trio-372e8dab/fUAB1jI_-7Nq6WNd/images/favicon-32x32.png?fit=max\u0026auto=format\u0026n=fUAB1jI_-7Nq6WNd\u0026q=85\u0026s=02e84f8cdce49974f6bd250833fbf98d"},"api":{"mdx":{"auth":{"method":"basic"}}},"navbar":{"links":[{"href":"https://suporte.trio.com.br/","label":"Support"}],"primary":{"type":"button","label":"App Trio Sandbox","href":"https://app.sandbox.trio.com.br/"}},"footer":{"socials":{"linkedin":"https://br.linkedin.com/company/trio-fin"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"trio-372e8dab","hasAudioNarration":false,"actualSubdomain":"trio-372e8dab","customDomains":["docs.trio.com.br"],"gitSource":{"type":"github","owner":"triohq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf69a197503f50adc66f00","collectionId":"e0177391-3341-4c23-a54c-c655765b35ef","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf69a197503f50adc66f00"},"feedback":{"thumbs":false,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adf69a197503f50adc66f00","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API reference","count":239},{"language":"default","tag":"Banking API","count":239},{"language":"default","tag":"Receivables","count":96},{"language":"default","tag":"Guides","count":51},{"language":"default","tag":"Payments","count":46},{"language":"default","tag":"Get Started","count":43},{"language":"default","tag":"Cards","count":35},{"language":"default","tag":"Webhooks","count":29},{"language":"default","tag":"Documents","count":29},{"language":"default","tag":"Pix","count":27}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v2/api-reference/banking-api/receivables/recurrences/generate-recurrence","slug":"/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence","pageMetadata":{"title":"Generate a Recurrence","description":"Generate a recurrence","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/recurrences","href":"/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Generate a recurrence\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Generate a Recurrence","description":"Generate a recurrence","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/recurrences","href":"/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"callbacks":{},"description":"Generate a recurrence","operationId":"TrioFoundationWeb.V2.In.Pix.RecurrenceController.generate","parameters":[],"requestBody":"7e9742c3-a48a-4875-a437-f6dcaccaea56","responses":{"201":"daedb550-6da7-4c15-8ef6-e14c4155e969","400":"2ab6bd3a-86f2-4a08-80b0-7b4094db3a38","401":"2abcd018-798b-43fe-9cd1-61b8fbff7e5b","403":"aee33fae-716b-4e4c-8cbe-5712964df453","422":"291a04c4-0043-474d-bf1b-d8942bd0d544","503":"baf66766-17fd-465b-96bd-5729f6e24e77"},"security":["dc341c7a-353f-4d54-8831-ef28c7482019"],"summary":"Generate a recurrence","tags":["Receivables (in)","Recurrences"],"method":"post","type":"path","servers":["6b606548-108f-4b34-8876-eafdf28edb31","2aa90cdd-ea34-4abe-ab07-114eac0f94f9","a19927d0-920a-4e65-aad9-8799051214df"],"path":"/v2/in/pix/recurrences","baseUrlOptions":["https://api.sandbox.trio.com.br","https://api.qa.trio.com.br","https://api.trio.com.br"],"title":"Generate a recurrence","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fe046b41-e8a0-4771-b1b3-3e1a7bf3345f":{"description":"Version of the v2 contract the client is written against. Each breaking change publishes a new version.","example":"2026-10-19.v2","in":"header","name":"Trio-Version","required":true,"schema":{"enum":["2026-10-19.v2"],"type":"string","x-struct":null,"x-validate":null,"isRequired":true,"description":"Version of the v2 contract the client is written against. Each breaking change publishes a new version.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"0315ebd6-204a-46e8-8b56-ca0449b95981":{"description":"ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.","in":"header","name":"Trio-Target-Org-Id","required":false,"schema":{"format":"uuid","type":"string","x-struct":null,"x-validate":null,"isRequired":false,"description":"ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"content":{"application/json":{"schema":{"description":"GenerateRecurrenceParameters","example":{"amounts":{"minimum":100},"bank_account_id":"019f4198-8913-1ec9-52c6-706c618a1c5d","contract_number":"123456789","counterparty":{"bank_account":{"branch":"1234","digit":"1","ispb":"12345678","number":"123456"},"name":"Payer Name","tax_number":"12345678000100"},"description":"Monthly payment for services","external_id":"external_id_123","first_payment":{"amount":100,"dict_key":"pixkey@mail.com","due_detail":{"discount":{"per_day_antecipated":{"amount":2,"calculation_days":"working","calculation_type":"amount"}},"due_date":"2026-10-30","fine":{"calculation_type":"percentage","value":10},"interest":{"amount":20,"calculation_days":"calendar","calculation_period":"month","calculation_type":"amount"},"rebate":{"calculation_type":"percentage","value":50}}},"options":{"authorization_type":"app","automated_attempt_retry":false,"automatic_schedule":false,"next_working_day":true,"qrcode_expiration_seconds":86400,"retry_policy":"3r_7d"},"periodicity":"mnth","start_date":"2026-10-25"},"properties":{"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"bank_account_id","typeLabel":"string\u003cuuid>"},"contract_number":{"description":"Contract Number","maxLength":35,"type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"contract_number","typeLabel":"string"},"counterparty":{"description":"Counterparty","properties":{"name":{"description":"Counterparty Name","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"counterparty.name","typeLabel":"string"},"tax_number":{"description":"Counterparty Tax Number","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"counterparty.tax_number","typeLabel":"string"},"bank_account":{"oneOf":[{"description":"Counterparty Bank Account, required for authorization type 'app', this is the bank account that will receive the request to approve the recurrence","properties":{"branch":{"description":"Counterparty Bank Account Branch","pattern":"^[0-9]+$","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"counterparty.bank_account.oneOf.0.branch","typeLabel":"string"},"digit":{"description":"Counterparty Bank Account Digit","pattern":"^[0-9]$","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"counterparty.bank_account.oneOf.0.digit","typeLabel":"string"},"ispb":{"description":"Counterparty Bank Account ISPB","pattern":"^[0-9]{8}$","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"counterparty.bank_account.oneOf.0.ispb","typeLabel":"string"},"number":{"description":"Counterparty Bank Account Number","pattern":"^[0-9]+$","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"counterparty.bank_account.oneOf.0.number","typeLabel":"string"}},"required":["ispb","number","branch","digit"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.bank_account.oneOf.0","typeLabel":"object"},{"description":"Counterparty Bank Account, required for authorization type 'app', this is the bank account that will receive the request to approve the recurrence","properties":{"branch":{"description":"Counterparty Bank Account Branch","pattern":"^[0-9]+$","type":"string","x-struct":null,"x-validate":null},"digit":{"description":"Counterparty Bank Account Digit","pattern":"^[0-9]$","type":"string","x-struct":null,"x-validate":null},"ispb":{"description":"Counterparty Bank Account ISPB","pattern":"^[0-9]{8}$","type":"string","x-struct":null,"x-validate":null},"number":{"description":"Counterparty Bank Account Number","pattern":"^[0-9]+$","type":"string","x-struct":null,"x-validate":null}},"required":["ispb","number","branch","digit"],"type":"null","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.bank_account.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.bank_account","typeLabel":"object | null"},"info":{"oneOf":[{"description":"Counterparty Info","properties":{"address":{"oneOf":[{"description":"Counterparty Address","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.info.oneOf.0.address.oneOf.0","typeLabel":"string"},{"description":"Counterparty Address","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.info.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.info.oneOf.0.address","typeLabel":"string | null"},"city":{"oneOf":[{"description":"Counterparty City","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.info.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"Counterparty City","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.info.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.info.oneOf.0.city","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Counterparty Email","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.info.oneOf.0.email.oneOf.0","typeLabel":"string"},{"description":"Counterparty Email","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.info.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.info.oneOf.0.email","typeLabel":"string | null"},"postal_code":{"oneOf":[{"description":"Counterparty Postal Code","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.info.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"description":"Counterparty Postal Code","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.info.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.info.oneOf.0.postal_code","typeLabel":"string | null"},"state":{"oneOf":[{"description":"Counterparty State","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.info.oneOf.0.state.oneOf.0","typeLabel":"string"},{"description":"Counterparty State","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.info.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.info.oneOf.0.state","typeLabel":"string | null"}},"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.info.oneOf.0","typeLabel":"object"},{"description":"Counterparty Info","properties":{"address":{"oneOf":[{"description":"Counterparty Address","type":"string","x-struct":null,"x-validate":null},{"description":"Counterparty Address","type":"null","x-struct":null,"x-validate":null}]},"city":{"oneOf":[{"description":"Counterparty City","type":"string","x-struct":null,"x-validate":null},{"description":"Counterparty City","type":"null","x-struct":null,"x-validate":null}]},"email":{"oneOf":[{"description":"Counterparty Email","type":"string","x-struct":null,"x-validate":null},{"description":"Counterparty Email","type":"null","x-struct":null,"x-validate":null}]},"postal_code":{"oneOf":[{"description":"Counterparty Postal Code","type":"string","x-struct":null,"x-validate":null},{"description":"Counterparty Postal Code","type":"null","x-struct":null,"x-validate":null}]},"state":{"oneOf":[{"description":"Counterparty State","type":"string","x-struct":null,"x-validate":null},{"description":"Counterparty State","type":"null","x-struct":null,"x-validate":null}]}},"type":"null","x-struct":null,"x-validate":null,"uniqueKey":"counterparty.info.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.info","typeLabel":"object | null"}},"required":["tax_number","name"],"type":"object","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"counterparty","typeLabel":"object"},"description":{"description":"Description","maxLength":35,"type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"description","typeLabel":"string"},"periodicity":{"description":"'week': every week, 'mnth': every month, 'qurt': every 3 months, 'mian': every 6 months, 'year': every year","enum":["week","mnth","qurt","mian","year"],"type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"periodicity","typeLabel":"enum\u003cstring>"},"start_date":{"description":"First day of the recurrence","format":"date","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"start_date","typeLabel":"string\u003cdate>"},"amounts":{"oneOf":[{"description":"Recurrence Amount, use fixed for fixed amount recurences. For variable amount recurrences, a minimum can be defined. If defined, the counterparty cannot define a limit lower than the minimum. Variable amount recurrences need to be updated with the amount before each collecting date. If left blank, a variable amount recurrence will be created with no minimum","properties":{"fixed":{"oneOf":[{"description":"Fixed Amount in cents, used for fixed amount recurrences","type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"amounts.oneOf.0.fixed.oneOf.0","typeLabel":"integer"},{"description":"Fixed Amount in cents, used for fixed amount recurrences","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"amounts.oneOf.0.fixed.oneOf.1","typeLabel":"null"}],"uniqueKey":"amounts.oneOf.0.fixed","typeLabel":"integer | null"},"minimum":{"oneOf":[{"description":"Minimum Amount in cents, used for variable amount recurrences","type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"amounts.oneOf.0.minimum.oneOf.0","typeLabel":"integer"},{"description":"Minimum Amount in cents, used for variable amount recurrences","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"amounts.oneOf.0.minimum.oneOf.1","typeLabel":"null"}],"uniqueKey":"amounts.oneOf.0.minimum","typeLabel":"integer | null"}},"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"amounts.oneOf.0","typeLabel":"object"},{"description":"Recurrence Amount, use fixed for fixed amount recurences. For variable amount recurrences, a minimum can be defined. If defined, the counterparty cannot define a limit lower than the minimum. Variable amount recurrences need to be updated with the amount before each collecting date. If left blank, a variable amount recurrence will be created with no minimum","properties":{"fixed":{"oneOf":[{"description":"Fixed Amount in cents, used for fixed amount recurrences","type":"integer","x-struct":null,"x-validate":null},{"description":"Fixed Amount in cents, used for fixed amount recurrences","type":"null","x-struct":null,"x-validate":null}]},"minimum":{"oneOf":[{"description":"Minimum Amount in cents, used for variable amount recurrences","type":"integer","x-struct":null,"x-validate":null},{"description":"Minimum Amount in cents, used for variable amount recurrences","type":"null","x-struct":null,"x-validate":null}]}},"type":"null","x-struct":null,"x-validate":null,"uniqueKey":"amounts.oneOf.1","typeLabel":"null"}],"uniqueKey":"amounts","typeLabel":"object | null"},"end_date":{"oneOf":[{"description":"Last day of the recurrence","format":"date","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Last day of the recurrence","format":"date","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_date","typeLabel":"string\u003cdate> | null"},"external_id":{"oneOf":[{"description":"Recurrence External ID","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"external_id.oneOf.0","typeLabel":"string"},{"description":"Recurrence External ID","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_id","typeLabel":"string | null"},"first_payment":{"oneOf":[{"description":"Schema for the first payment with due detail","properties":{"amount":{"oneOf":[{"description":"First Payment amount in cents","minimum":1,"type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.amount.oneOf.0","typeLabel":"integer"},{"description":"First Payment amount in cents","minimum":1,"type":"null","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_payment.oneOf.0.amount","typeLabel":"integer | null"},"dict_key":{"oneOf":[{"description":"Bank Account Pix Key","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.dict_key.oneOf.0","typeLabel":"string"},{"description":"Bank Account Pix Key","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.dict_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_payment.oneOf.0.dict_key","typeLabel":"string | null"},"due_detail":{"description":"Due detail of a Pix charge with due date. Each rule takes `amount` (cents) for the `amount` calculation type and `value` (basis points, 100 = 1%) for `percentage`.","example":{"discount":{"per_day_antecipated":{"amount":50,"calculation_days":"working","calculation_type":"amount"}},"due_date":"2026-09-30","fine":{"calculation_type":"percentage","value":200},"interest":{"calculation_days":"calendar","calculation_period":"month","calculation_type":"percentage","value":100}},"properties":{"due_date":{"description":"Due date","format":"date","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.due_date","typeLabel":"string\u003cdate>"},"discount":{"description":"Discount for payments before the due date; set only one option","properties":{"fixed_until_due":{"description":"Discount granted until each date","properties":{"amounts":{"items":{"properties":{"date":{"description":"Last date on which the discount applies","format":"date","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.fixed_until_due.amounts.items.[INDEX].date","typeLabel":"string\u003cdate>"},"amount":{"description":"Amount in cents, for the `amount` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.fixed_until_due.amounts.items.[INDEX].amount","typeLabel":"integer"},"value":{"description":"Percentage in basis points (100 = 1%), for the `percentage` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.fixed_until_due.amounts.items.[INDEX].value","typeLabel":"integer"}},"required":["date"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.fixed_until_due.amounts.items.[INDEX]","typeLabel":"object"},"type":"array","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.fixed_until_due.amounts","typeLabel":"object[]"},"calculation_type":{"oneOf":[{"description":"Discount calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailDiscountCalculationType","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.fixed_until_due.calculation_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Discount calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailDiscountCalculationType","type":"null","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.fixed_until_due.calculation_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.fixed_until_due.calculation_type","typeLabel":"enum\u003cstring> | null"}},"required":["calculation_type","amounts"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.fixed_until_due","typeLabel":"object"},"per_day_antecipated":{"description":"Discount per day paid in advance","properties":{"calculation_type":{"oneOf":[{"description":"Discount calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailDiscountCalculationType","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.per_day_antecipated.calculation_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Discount calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailDiscountCalculationType","type":"null","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.per_day_antecipated.calculation_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.per_day_antecipated.calculation_type","typeLabel":"enum\u003cstring> | null"},"amount":{"description":"Amount in cents, for the `amount` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.per_day_antecipated.amount","typeLabel":"integer"},"calculation_days":{"oneOf":[{"description":"Discount calculation days of dynamic brcode with due detail","enum":["calendar","working"],"title":"DynamicBrcodeDueDetailDiscountCalculationDays","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.per_day_antecipated.calculation_days.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Discount calculation days of dynamic brcode with due detail","enum":["calendar","working"],"title":"DynamicBrcodeDueDetailDiscountCalculationDays","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.per_day_antecipated.calculation_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_payment.oneOf.0.due_detail.discount.per_day_antecipated.calculation_days","typeLabel":"enum\u003cstring> | null"},"value":{"description":"Percentage in basis points (100 = 1%), for the `percentage` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.per_day_antecipated.value","typeLabel":"integer"}},"required":["calculation_type"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.discount.per_day_antecipated","typeLabel":"object"}},"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.discount","typeLabel":"object"},"fine":{"description":"Fine charged after the due date","properties":{"calculation_type":{"oneOf":[{"description":"Fine calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailFineCalculationType","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.fine.calculation_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Fine calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailFineCalculationType","type":"null","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.fine.calculation_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.fine.calculation_type","typeLabel":"enum\u003cstring> | null"},"amount":{"description":"Amount in cents, for the `amount` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.fine.amount","typeLabel":"integer"},"value":{"description":"Percentage in basis points (100 = 1%), for the `percentage` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.fine.value","typeLabel":"integer"}},"required":["calculation_type"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.fine","typeLabel":"object"},"interest":{"description":"Interest charged after the due date","properties":{"calculation_type":{"oneOf":[{"description":"Interest calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailInterestCalculationType","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.interest.calculation_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Interest calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailInterestCalculationType","type":"null","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.interest.calculation_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.interest.calculation_type","typeLabel":"enum\u003cstring> | null"},"amount":{"description":"Amount in cents, for the `amount` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.interest.amount","typeLabel":"integer"},"calculation_days":{"oneOf":[{"description":"Interest calculation days of dynamic brcode with due detail","enum":["calendar","working"],"title":"DynamicBrcodeDueDetailInterestCalculationDays","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.interest.calculation_days.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Interest calculation days of dynamic brcode with due detail","enum":["calendar","working"],"title":"DynamicBrcodeDueDetailInterestCalculationDays","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.interest.calculation_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_payment.oneOf.0.due_detail.interest.calculation_days","typeLabel":"enum\u003cstring> | null"},"calculation_period":{"oneOf":[{"description":"Interest calculation period of dynamic brcode with due detail","enum":["day","month","year"],"title":"DynamicBrcodeDueDetailInterestCalculationPeriod","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.interest.calculation_period.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Interest calculation period of dynamic brcode with due detail","enum":["day","month","year"],"title":"DynamicBrcodeDueDetailInterestCalculationPeriod","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.interest.calculation_period.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_payment.oneOf.0.due_detail.interest.calculation_period","typeLabel":"enum\u003cstring> | null"},"value":{"description":"Percentage in basis points (100 = 1%), for the `percentage` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.interest.value","typeLabel":"integer"}},"required":["calculation_type"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.interest","typeLabel":"object"},"rebate":{"description":"Rebate applied to the amount","properties":{"calculation_type":{"oneOf":[{"description":"Rebate calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailRebateCalculationType","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.rebate.calculation_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Rebate calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailRebateCalculationType","type":"null","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.rebate.calculation_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"first_payment.oneOf.0.due_detail.rebate.calculation_type","typeLabel":"enum\u003cstring> | null"},"amount":{"description":"Amount in cents, for the `amount` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.rebate.amount","typeLabel":"integer"},"value":{"description":"Percentage in basis points (100 = 1%), for the `percentage` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.rebate.value","typeLabel":"integer"}},"required":["calculation_type"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail.rebate","typeLabel":"object"}},"required":["due_date"],"title":"V2 PixDueDetailParams","type":"object","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.due_detail","typeLabel":"V2 PixDueDetailParams · object"},"recurrence_required":{"oneOf":[{"default":true,"description":"If set to false, the counterparty is able to make the first payment and refuse the recurrence. If set to true, the recurrence and first payment are approved in a single authorization.","type":"boolean","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.recurrence_required.oneOf.0","typeLabel":"boolean"},{"default":true,"description":"If set to false, the counterparty is able to make the first payment and refuse the recurrence. If set to true, the recurrence and first payment are approved in a single authorization.","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0.recurrence_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_payment.oneOf.0.recurrence_required","typeLabel":"boolean | null"}},"title":"V2 FirstPaymentWithDueDetail","type":"object","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.0","typeLabel":"V2 FirstPaymentWithDueDetail · object"},{"description":"Schema for the first payment with due detail","properties":{"amount":{"oneOf":[{"description":"First Payment amount in cents","minimum":1,"type":"integer","x-struct":null,"x-validate":null},{"description":"First Payment amount in cents","minimum":1,"type":"null","x-struct":null,"x-validate":null}]},"dict_key":{"oneOf":[{"description":"Bank Account Pix Key","type":"string","x-struct":null,"x-validate":null},{"description":"Bank Account Pix Key","type":"null","x-struct":null,"x-validate":null}]},"due_detail":{"description":"Due detail of a Pix charge with due date. Each rule takes `amount` (cents) for the `amount` calculation type and `value` (basis points, 100 = 1%) for `percentage`.","example":{"discount":{"per_day_antecipated":{"amount":50,"calculation_days":"working","calculation_type":"amount"}},"due_date":"2026-09-30","fine":{"calculation_type":"percentage","value":200},"interest":{"calculation_days":"calendar","calculation_period":"month","calculation_type":"percentage","value":100}},"properties":{"discount":{"description":"Discount for payments before the due date; set only one option","properties":{"fixed_until_due":{"description":"Discount granted until each date","properties":{"amounts":{"items":{"properties":{"amount":{"description":"Amount in cents, for the `amount` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null},"date":{"description":"Last date on which the discount applies","format":"date","type":"string","x-struct":null,"x-validate":null},"value":{"description":"Percentage in basis points (100 = 1%), for the `percentage` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null}},"required":["date"],"type":"object","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"calculation_type":{"oneOf":[{"description":"Discount calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailDiscountCalculationType","type":"string","x-struct":null,"x-validate":null},{"description":"Discount calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailDiscountCalculationType","type":"null","x-struct":null,"x-validate":null}]}},"required":["calculation_type","amounts"],"type":"object","x-struct":null,"x-validate":null},"per_day_antecipated":{"description":"Discount per day paid in advance","properties":{"amount":{"description":"Amount in cents, for the `amount` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null},"calculation_days":{"oneOf":[{"description":"Discount calculation days of dynamic brcode with due detail","enum":["calendar","working"],"title":"DynamicBrcodeDueDetailDiscountCalculationDays","type":"string","x-struct":null,"x-validate":null},{"description":"Discount calculation days of dynamic brcode with due detail","enum":["calendar","working"],"title":"DynamicBrcodeDueDetailDiscountCalculationDays","type":"null","x-struct":null,"x-validate":null}]},"calculation_type":{"oneOf":[{"description":"Discount calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailDiscountCalculationType","type":"string","x-struct":null,"x-validate":null},{"description":"Discount calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailDiscountCalculationType","type":"null","x-struct":null,"x-validate":null}]},"value":{"description":"Percentage in basis points (100 = 1%), for the `percentage` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null}},"required":["calculation_type"],"type":"object","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"due_date":{"description":"Due date","format":"date","type":"string","x-struct":null,"x-validate":null},"fine":{"description":"Fine charged after the due date","properties":{"amount":{"description":"Amount in cents, for the `amount` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null},"calculation_type":{"oneOf":[{"description":"Fine calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailFineCalculationType","type":"string","x-struct":null,"x-validate":null},{"description":"Fine calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailFineCalculationType","type":"null","x-struct":null,"x-validate":null}]},"value":{"description":"Percentage in basis points (100 = 1%), for the `percentage` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null}},"required":["calculation_type"],"type":"object","x-struct":null,"x-validate":null},"interest":{"description":"Interest charged after the due date","properties":{"amount":{"description":"Amount in cents, for the `amount` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null},"calculation_days":{"oneOf":[{"description":"Interest calculation days of dynamic brcode with due detail","enum":["calendar","working"],"title":"DynamicBrcodeDueDetailInterestCalculationDays","type":"string","x-struct":null,"x-validate":null},{"description":"Interest calculation days of dynamic brcode with due detail","enum":["calendar","working"],"title":"DynamicBrcodeDueDetailInterestCalculationDays","type":"null","x-struct":null,"x-validate":null}]},"calculation_period":{"oneOf":[{"description":"Interest calculation period of dynamic brcode with due detail","enum":["day","month","year"],"title":"DynamicBrcodeDueDetailInterestCalculationPeriod","type":"string","x-struct":null,"x-validate":null},{"description":"Interest calculation period of dynamic brcode with due detail","enum":["day","month","year"],"title":"DynamicBrcodeDueDetailInterestCalculationPeriod","type":"null","x-struct":null,"x-validate":null}]},"calculation_type":{"oneOf":[{"description":"Interest calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailInterestCalculationType","type":"string","x-struct":null,"x-validate":null},{"description":"Interest calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailInterestCalculationType","type":"null","x-struct":null,"x-validate":null}]},"value":{"description":"Percentage in basis points (100 = 1%), for the `percentage` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null}},"required":["calculation_type"],"type":"object","x-struct":null,"x-validate":null},"rebate":{"description":"Rebate applied to the amount","properties":{"amount":{"description":"Amount in cents, for the `amount` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null},"calculation_type":{"oneOf":[{"description":"Rebate calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailRebateCalculationType","type":"string","x-struct":null,"x-validate":null},{"description":"Rebate calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"title":"DynamicBrcodeDueDetailRebateCalculationType","type":"null","x-struct":null,"x-validate":null}]},"value":{"description":"Percentage in basis points (100 = 1%), for the `percentage` calculation type","minimum":1,"type":"integer","x-struct":null,"x-validate":null}},"required":["calculation_type"],"type":"object","x-struct":null,"x-validate":null}},"required":["due_date"],"title":"V2 PixDueDetailParams","type":"object","x-struct":null,"x-validate":null},"recurrence_required":{"oneOf":[{"default":true,"description":"If set to false, the counterparty is able to make the first payment and refuse the recurrence. If set to true, the recurrence and first payment are approved in a single authorization.","type":"boolean","x-struct":null,"x-validate":null},{"default":true,"description":"If set to false, the counterparty is able to make the first payment and refuse the recurrence. If set to true, the recurrence and first payment are approved in a single authorization.","type":"null","x-struct":null,"x-validate":null}]}},"title":"V2 FirstPaymentWithDueDetail","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"first_payment.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_payment","typeLabel":"V2 FirstPaymentWithDueDetail · object | null"},"options":{"oneOf":[{"description":"Recurrence options","properties":{"authorization_type":{"oneOf":[{"default":"qrcode","description":"Authorization type of the recurrence. Use 'qrcode' for requesting directly to the counterparty banking app or 'qrcode' for generating a QRCode","enum":["app","qrcode"],"type":"string","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.0.authorization_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"default":"qrcode","description":"Authorization type of the recurrence. Use 'qrcode' for requesting directly to the counterparty banking app or 'qrcode' for generating a QRCode","enum":["app","qrcode"],"type":"null","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.0.authorization_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"options.oneOf.0.authorization_type","typeLabel":"enum\u003cstring> | null"},"automated_attempt_retry":{"oneOf":[{"default":true,"description":"Automated Attempt Retry. If not set, all the attempts retries should be scheduled each time after the previous one is not settled. i.e. if the attempt is not settled, the next attempt needs to be rescheduled. If the parameter is true, it will be done automatically","type":"boolean","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.0.automated_attempt_retry.oneOf.0","typeLabel":"boolean"},{"default":true,"description":"Automated Attempt Retry. If not set, all the attempts retries should be scheduled each time after the previous one is not settled. i.e. if the attempt is not settled, the next attempt needs to be rescheduled. If the parameter is true, it will be done automatically","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.0.automated_attempt_retry.oneOf.1","typeLabel":"null"}],"uniqueKey":"options.oneOf.0.automated_attempt_retry","typeLabel":"boolean | null"},"automatic_schedule":{"oneOf":[{"default":true,"description":"Automated Collecting on the defined periodicity. If not set, the recurrence must be scheduled each time. i.e. if periodicity is 'mnth', the recurrence needs to be scheduled each month, between 2 and 10 days before the next payment date","type":"boolean","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.0.automatic_schedule.oneOf.0","typeLabel":"boolean"},{"default":true,"description":"Automated Collecting on the defined periodicity. If not set, the recurrence must be scheduled each time. i.e. if periodicity is 'mnth', the recurrence needs to be scheduled each month, between 2 and 10 days before the next payment date","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.0.automatic_schedule.oneOf.1","typeLabel":"null"}],"uniqueKey":"options.oneOf.0.automatic_schedule","typeLabel":"boolean | null"},"next_working_day":{"oneOf":[{"default":false,"description":"Do not bill on Holidays, bill on the counterparty's next working day","type":"boolean","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.0.next_working_day.oneOf.0","typeLabel":"boolean"},{"default":false,"description":"Do not bill on Holidays, bill on the counterparty's next working day","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.0.next_working_day.oneOf.1","typeLabel":"null"}],"uniqueKey":"options.oneOf.0.next_working_day","typeLabel":"boolean | null"},"qrcode_expiration_seconds":{"oneOf":[{"default":86400,"description":"Expiration time in seconds for the dynamic QR code. If the generated QR code is static, this field is disconsidered as the static QR code does not expire.","type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.0.qrcode_expiration_seconds.oneOf.0","typeLabel":"integer"},{"default":86400,"description":"Expiration time in seconds for the dynamic QR code. If the generated QR code is static, this field is disconsidered as the static QR code does not expire.","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.0.qrcode_expiration_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"options.oneOf.0.qrcode_expiration_seconds","typeLabel":"integer | null"},"retry_policy":{"oneOf":[{"default":"3r_7d","description":"Recurrence retry policy. '3r_7d': if the collecting fails, it will be retried 3 times in a 7 days period, on alternating days. 'none': no retry","enum":["none","3r_7d"],"type":"string","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.0.retry_policy.oneOf.0","typeLabel":"enum\u003cstring>"},{"default":"3r_7d","description":"Recurrence retry policy. '3r_7d': if the collecting fails, it will be retried 3 times in a 7 days period, on alternating days. 'none': no retry","enum":["none","3r_7d"],"type":"null","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.0.retry_policy.oneOf.1","typeLabel":"null"}],"uniqueKey":"options.oneOf.0.retry_policy","typeLabel":"enum\u003cstring> | null"}},"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.0","typeLabel":"object"},{"description":"Recurrence options","properties":{"authorization_type":{"oneOf":[{"default":"qrcode","description":"Authorization type of the recurrence. Use 'qrcode' for requesting directly to the counterparty banking app or 'qrcode' for generating a QRCode","enum":["app","qrcode"],"type":"string","x-struct":null,"x-validate":null},{"default":"qrcode","description":"Authorization type of the recurrence. Use 'qrcode' for requesting directly to the counterparty banking app or 'qrcode' for generating a QRCode","enum":["app","qrcode"],"type":"null","x-struct":null,"x-validate":null}]},"automated_attempt_retry":{"oneOf":[{"default":true,"description":"Automated Attempt Retry. If not set, all the attempts retries should be scheduled each time after the previous one is not settled. i.e. if the attempt is not settled, the next attempt needs to be rescheduled. If the parameter is true, it will be done automatically","type":"boolean","x-struct":null,"x-validate":null},{"default":true,"description":"Automated Attempt Retry. If not set, all the attempts retries should be scheduled each time after the previous one is not settled. i.e. if the attempt is not settled, the next attempt needs to be rescheduled. If the parameter is true, it will be done automatically","type":"null","x-struct":null,"x-validate":null}]},"automatic_schedule":{"oneOf":[{"default":true,"description":"Automated Collecting on the defined periodicity. If not set, the recurrence must be scheduled each time. i.e. if periodicity is 'mnth', the recurrence needs to be scheduled each month, between 2 and 10 days before the next payment date","type":"boolean","x-struct":null,"x-validate":null},{"default":true,"description":"Automated Collecting on the defined periodicity. If not set, the recurrence must be scheduled each time. i.e. if periodicity is 'mnth', the recurrence needs to be scheduled each month, between 2 and 10 days before the next payment date","type":"null","x-struct":null,"x-validate":null}]},"next_working_day":{"oneOf":[{"default":false,"description":"Do not bill on Holidays, bill on the counterparty's next working day","type":"boolean","x-struct":null,"x-validate":null},{"default":false,"description":"Do not bill on Holidays, bill on the counterparty's next working day","type":"null","x-struct":null,"x-validate":null}]},"qrcode_expiration_seconds":{"oneOf":[{"default":86400,"description":"Expiration time in seconds for the dynamic QR code. If the generated QR code is static, this field is disconsidered as the static QR code does not expire.","type":"integer","x-struct":null,"x-validate":null},{"default":86400,"description":"Expiration time in seconds for the dynamic QR code. If the generated QR code is static, this field is disconsidered as the static QR code does not expire.","type":"null","x-struct":null,"x-validate":null}]},"retry_policy":{"oneOf":[{"default":"3r_7d","description":"Recurrence retry policy. '3r_7d': if the collecting fails, it will be retried 3 times in a 7 days period, on alternating days. 'none': no retry","enum":["none","3r_7d"],"type":"string","x-struct":null,"x-validate":null},{"default":"3r_7d","description":"Recurrence retry policy. '3r_7d': if the collecting fails, it will be retried 3 times in a 7 days period, on alternating days. 'none': no retry","enum":["none","3r_7d"],"type":"null","x-struct":null,"x-validate":null}]}},"type":"null","x-struct":null,"x-validate":null,"uniqueKey":"options.oneOf.1","typeLabel":"null"}],"uniqueKey":"options","typeLabel":"object | null"}},"required":["bank_account_id","counterparty","description","periodicity","contract_number","start_date"],"title":"V2 GenerateRecurrenceParameters","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.GenerateRecurrenceParams","x-validate":null,"uniqueKey":"","typeLabel":"V2 GenerateRecurrenceParameters · object"},"examples":{"Example":{"title":"Example","value":{"amounts":{"minimum":100},"bank_account_id":"019f4198-8913-1ec9-52c6-706c618a1c5d","contract_number":"123456789","counterparty":{"bank_account":{"branch":"1234","digit":"1","ispb":"12345678","number":"123456"},"name":"Payer Name","tax_number":"12345678000100"},"description":"Monthly payment for services","external_id":"external_id_123","first_payment":{"amount":100,"dict_key":"pixkey@mail.com","due_detail":{"discount":{"per_day_antecipated":{"amount":2,"calculation_days":"working","calculation_type":"amount"}},"due_date":"2026-10-30","fine":{"calculation_type":"percentage","value":10},"interest":{"amount":20,"calculation_days":"calendar","calculation_period":"month","calculation_type":"amount"},"rebate":{"calculation_type":"percentage","value":50}}},"options":{"authorization_type":"app","automated_attempt_retry":false,"automatic_schedule":false,"next_working_day":true,"qrcode_expiration_seconds":86400,"retry_policy":"3r_7d"},"periodicity":"mnth","start_date":"2026-10-25"}}},"exampleType":"generated"}},"description":"The recurrence generate attributes","required":true,"exampleType":"generated"},"responses":{"daedb550-6da7-4c15-8ef6-e14c4155e969":{"content":{"application/json":{"schema":{"description":"The created recurrence, plus the QRCode the payer authorizes it through (null when the journey has none)","example":{"data":{"amounts":{"fixed":{"amount":10000,"currency":"BRL"},"maximum":null,"minimum":null},"authorized_at":null,"bank_account_id":"019f4198-8913-1ec9-52c6-706c618a1c5d","contract_number":"0001","counterparty":{"bank_account":{"id":"49521ece-9203-07f7-7767-e32734e5b636"},"id":"49521ece-9203-186b-cfc7-281c207f7f52"},"description":"Test Recurrence","end_date":null,"external_id":null,"first_payment":{"amount":null,"date":"2026-07-10"},"id":"019f4198-9f53-8f20-a167-5242b634311d","inserted_at":"2026-07-08T11:59:09.140530Z","number_of_collections":null,"options":{"automatic_schedule":true,"next_working_day":true,"retry_policy":"none"},"origin":{"id":"019f4198-9de7-4ba7-d718-5e9fce7cbccb","type":"api_client"},"periodicity":"week","qrcode":{"hash":"00020101021226630014br.gov.bcb.pix...6304B527","id":"019f4198-9f53-0000-0000-000000000001","type":"dynamic"},"reference":{"id":null,"type":"qrdn"},"start_date":"2026-07-08","status":"created","type":"in","updated_at":"2026-07-08T11:59:09.140530Z"}},"properties":{"data":{"properties":{"amounts":{"description":"Amounts of the recurrence: `fixed` for fixed amount recurrences, `minimum` (set by the receiver) and `maximum` (set by the payer) for variable ones","properties":{"fixed":{"oneOf":[{"description":"An amount in cents","example":{"amount":10000,"currency":"BRL"},"properties":{"amount":{"description":"Amount in cents","type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"data.amounts.fixed.oneOf.0.amount","typeLabel":"integer"},"currency":{"description":"Currency","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.amounts.fixed.oneOf.0.currency","typeLabel":"string"}},"title":"V2 RecurrenceAmount","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Amount","x-validate":null,"uniqueKey":"data.amounts.fixed.oneOf.0","typeLabel":"V2 RecurrenceAmount · object"},{"description":"An amount in cents","example":{"amount":10000,"currency":"BRL"},"properties":{"amount":{"description":"Amount in cents","type":"integer","x-struct":null,"x-validate":null},"currency":{"description":"Currency","type":"string","x-struct":null,"x-validate":null}},"title":"V2 RecurrenceAmount","type":"null","x-struct":"Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Amount","x-validate":null,"uniqueKey":"data.amounts.fixed.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.amounts.fixed","typeLabel":"V2 RecurrenceAmount · object | null"},"maximum":{"oneOf":[{"description":"An amount in cents","example":{"amount":10000,"currency":"BRL"},"properties":{"amount":{"description":"Amount in cents","type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"data.amounts.maximum.oneOf.0.amount","typeLabel":"integer"},"currency":{"description":"Currency","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.amounts.maximum.oneOf.0.currency","typeLabel":"string"}},"title":"V2 RecurrenceAmount","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Amount","x-validate":null,"uniqueKey":"data.amounts.maximum.oneOf.0","typeLabel":"V2 RecurrenceAmount · object"},{"description":"An amount in cents","example":{"amount":10000,"currency":"BRL"},"properties":{"amount":{"description":"Amount in cents","type":"integer","x-struct":null,"x-validate":null},"currency":{"description":"Currency","type":"string","x-struct":null,"x-validate":null}},"title":"V2 RecurrenceAmount","type":"null","x-struct":"Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Amount","x-validate":null,"uniqueKey":"data.amounts.maximum.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.amounts.maximum","typeLabel":"V2 RecurrenceAmount · object | null"},"minimum":{"oneOf":[{"description":"An amount in cents","example":{"amount":10000,"currency":"BRL"},"properties":{"amount":{"description":"Amount in cents","type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"data.amounts.minimum.oneOf.0.amount","typeLabel":"integer"},"currency":{"description":"Currency","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.amounts.minimum.oneOf.0.currency","typeLabel":"string"}},"title":"V2 RecurrenceAmount","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Amount","x-validate":null,"uniqueKey":"data.amounts.minimum.oneOf.0","typeLabel":"V2 RecurrenceAmount · object"},{"description":"An amount in cents","example":{"amount":10000,"currency":"BRL"},"properties":{"amount":{"description":"Amount in cents","type":"integer","x-struct":null,"x-validate":null},"currency":{"description":"Currency","type":"string","x-struct":null,"x-validate":null}},"title":"V2 RecurrenceAmount","type":"null","x-struct":"Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Amount","x-validate":null,"uniqueKey":"data.amounts.minimum.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.amounts.minimum","typeLabel":"V2 RecurrenceAmount · object | null"}},"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"data.amounts","typeLabel":"object"},"authorized_at":{"oneOf":[{"description":"When the payer authorized the recurrence","format":"date-time","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.authorized_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When the payer authorized the recurrence","format":"date-time","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.authorized_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.authorized_at","typeLabel":"string\u003cdate-time> | null"},"bank_account_id":{"description":"Bank account that receives the collections","format":"uuid","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.bank_account_id","typeLabel":"string\u003cuuid>"},"contract_number":{"oneOf":[{"description":"Contract number","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.contract_number.oneOf.0","typeLabel":"string"},{"description":"Contract number","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.contract_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contract_number","typeLabel":"string | null"},"counterparty":{"description":"Payer of the recurrence","properties":{"bank_account":{"description":"Payer bank account","properties":{"id":{"oneOf":[{"description":"Counterparty bank account ID","format":"uuid","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.counterparty.bank_account.id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Counterparty bank account ID","format":"uuid","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.counterparty.bank_account.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.counterparty.bank_account.id","typeLabel":"string\u003cuuid> | null"}},"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"data.counterparty.bank_account","typeLabel":"object"},"id":{"oneOf":[{"description":"Counterparty ID","format":"uuid","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.counterparty.id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Counterparty ID","format":"uuid","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.counterparty.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.counterparty.id","typeLabel":"string\u003cuuid> | null"}},"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"data.counterparty","typeLabel":"object"},"description":{"oneOf":[{"description":"Description","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.description.oneOf.0","typeLabel":"string"},{"description":"Description","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.description","typeLabel":"string | null"},"end_date":{"oneOf":[{"description":"Last day of the recurrence","format":"date","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Last day of the recurrence","format":"date","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.end_date","typeLabel":"string\u003cdate> | null"},"external_id":{"oneOf":[{"description":"External ID","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.external_id.oneOf.0","typeLabel":"string"},{"description":"External ID","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.external_id","typeLabel":"string | null"},"first_payment":{"description":"First payment of the recurrence","properties":{"amount":{"oneOf":[{"description":"An amount in cents","example":{"amount":10000,"currency":"BRL"},"properties":{"amount":{"description":"Amount in cents","type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"data.first_payment.amount.oneOf.0.amount","typeLabel":"integer"},"currency":{"description":"Currency","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.first_payment.amount.oneOf.0.currency","typeLabel":"string"}},"title":"V2 RecurrenceAmount","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Amount","x-validate":null,"uniqueKey":"data.first_payment.amount.oneOf.0","typeLabel":"V2 RecurrenceAmount · object"},{"description":"An amount in cents","example":{"amount":10000,"currency":"BRL"},"properties":{"amount":{"description":"Amount in cents","type":"integer","x-struct":null,"x-validate":null},"currency":{"description":"Currency","type":"string","x-struct":null,"x-validate":null}},"title":"V2 RecurrenceAmount","type":"null","x-struct":"Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Amount","x-validate":null,"uniqueKey":"data.first_payment.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.first_payment.amount","typeLabel":"V2 RecurrenceAmount · object | null"},"date":{"oneOf":[{"description":"Day of the first payment","format":"date","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.first_payment.date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Day of the first payment","format":"date","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.first_payment.date.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.first_payment.date","typeLabel":"string\u003cdate> | null"}},"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"data.first_payment","typeLabel":"object"},"id":{"description":"Recurrence ID","format":"uuid","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"inserted_at":{"description":"When the recurrence was created","format":"date-time","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.inserted_at","typeLabel":"string\u003cdate-time>"},"number_of_collections":{"oneOf":[{"description":"Number of collections","type":"integer","x-struct":null,"x-validate":null,"uniqueKey":"data.number_of_collections.oneOf.0","typeLabel":"integer"},{"description":"Number of collections","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.number_of_collections.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.number_of_collections","typeLabel":"integer | null"},"options":{"description":"Recurrence options","properties":{"automatic_schedule":{"description":"Whether collections are scheduled automatically","type":"boolean","x-struct":null,"x-validate":null,"uniqueKey":"data.options.automatic_schedule","typeLabel":"boolean"},"next_working_day":{"description":"Whether collections falling on a non-working day move to the next one","type":"boolean","x-struct":null,"x-validate":null,"uniqueKey":"data.options.next_working_day","typeLabel":"boolean"},"retry_policy":{"description":"Types of recurrence retry policy","enum":["none","3r_7d"],"title":"RecurrenceRetryPolicy","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.options.retry_policy","typeLabel":"enum\u003cstring>"}},"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"data.options","typeLabel":"object"},"origin":{"description":"Who or what created the recurrence","properties":{"id":{"oneOf":[{"description":"Origin ID","format":"uuid","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.origin.id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Origin ID","format":"uuid","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.origin.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.origin.id","typeLabel":"string\u003cuuid> | null"},"type":{"oneOf":[{"description":"Origin type","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.origin.type.oneOf.0","typeLabel":"string"},{"description":"Origin type","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.origin.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.origin.type","typeLabel":"string | null"}},"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"data.origin","typeLabel":"object"},"periodicity":{"description":"'week': every week, 'mnth': every month, 'qurt': every 3 months, 'mian': every 6 months, 'year': every year","enum":["week","mnth","qurt","mian","year"],"title":"RecurrencePeriodicity","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.periodicity","typeLabel":"enum\u003cstring>"},"qrcode":{"oneOf":[{"description":"QRCode the payer authorizes the recurrence through","properties":{"hash":{"description":"QRCode hash (Pix copy and paste)","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.qrcode.oneOf.0.hash","typeLabel":"string"},"id":{"description":"QRCode ID","format":"uuid","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.qrcode.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"description":"QRCode type","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.qrcode.oneOf.0.type","typeLabel":"string"}},"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"data.qrcode.oneOf.0","typeLabel":"object"},{"description":"QRCode the payer authorizes the recurrence through","properties":{"hash":{"description":"QRCode hash (Pix copy and paste)","type":"string","x-struct":null,"x-validate":null},"id":{"description":"QRCode ID","format":"uuid","type":"string","x-struct":null,"x-validate":null},"type":{"description":"QRCode type","type":"string","x-struct":null,"x-validate":null}},"type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.qrcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.qrcode","typeLabel":"object | null"},"reference":{"description":"What the recurrence was created from","properties":{"id":{"oneOf":[{"description":"Reference ID","format":"uuid","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.reference.id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Reference ID","format":"uuid","type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.reference.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.reference.id","typeLabel":"string\u003cuuid> | null"},"type":{"oneOf":[{"description":"Reference type","enum":["requ","qrdn","qres"],"type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.reference.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Reference type","enum":["requ","qrdn","qres"],"type":"null","x-struct":null,"x-validate":null,"uniqueKey":"data.reference.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.reference.type","typeLabel":"enum\u003cstring> | null"}},"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"data.reference","typeLabel":"object"},"start_date":{"description":"First day of the recurrence","format":"date","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.start_date","typeLabel":"string\u003cdate>"},"status":{"description":"Types of recurrence status","enum":["created","approved","rejected","expired","cancelled"],"title":"RecurrenceStatus","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"type":{"description":"Types of recurrence type","enum":["in","out"],"title":"RecurrenceType","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"When the recurrence was last updated","format":"date-time","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"}},"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"data","typeLabel":"object"}},"title":"V2 GenerateRecurrenceResponse","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.GenerateResponse","x-validate":null,"uniqueKey":"","typeLabel":"V2 GenerateRecurrenceResponse · object"},"examples":{"Example":{"title":"Example","value":{"data":{"amounts":{"fixed":{"amount":10000,"currency":"BRL"},"maximum":null,"minimum":null},"authorized_at":null,"bank_account_id":"019f4198-8913-1ec9-52c6-706c618a1c5d","contract_number":"0001","counterparty":{"bank_account":{"id":"49521ece-9203-07f7-7767-e32734e5b636"},"id":"49521ece-9203-186b-cfc7-281c207f7f52"},"description":"Test Recurrence","end_date":null,"external_id":null,"first_payment":{"amount":null,"date":"2026-07-10"},"id":"019f4198-9f53-8f20-a167-5242b634311d","inserted_at":"2026-07-08T11:59:09.140530Z","number_of_collections":null,"options":{"automatic_schedule":true,"next_working_day":true,"retry_policy":"none"},"origin":{"id":"019f4198-9de7-4ba7-d718-5e9fce7cbccb","type":"api_client"},"periodicity":"week","qrcode":{"hash":"00020101021226630014br.gov.bcb.pix...6304B527","id":"019f4198-9f53-0000-0000-000000000001","type":"dynamic"},"reference":{"id":null,"type":"qrdn"},"start_date":"2026-07-08","status":"created","type":"in","updated_at":"2026-07-08T11:59:09.140530Z"}}}},"exampleType":"generated"}},"description":"Generate Recurrence Response","exampleType":"generated"},"2ab6bd3a-86f2-4a08-80b0-7b4094db3a38":{"content":{"application/json":{"schema":{"example":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}},"properties":{"error":{"properties":{"error_code":{"description":"Stable UPPER_SNAKE identifier of the error, for programs and logs. Branch on this, not on the message.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_code","typeLabel":"string"},"error_message":{"description":"Human readable explanation of the error.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_message","typeLabel":"string"},"errors":{"description":"Only on INVALID_PARAMETER for a request outside the operation's schema: one entry per offending field.","items":{"properties":{"field":{"description":"JSON pointer to the field, e.g. /amount.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"What is wrong with it.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","x-struct":null,"x-validate":null,"uniqueKey":"error.errors","typeLabel":"object[]"}},"required":["error_code","error_message"],"type":"object","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"title":"V2 error","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error","x-validate":null,"uniqueKey":"","typeLabel":"V2 error · object"},"examples":{"Example":{"title":"Example","value":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}}}},"exampleType":"generated"}},"description":"Malformed request: a body that is not valid JSON (MALFORMED_REQUEST), or a Trio-Version header that is missing or not the current one (INVALID_TRIO_VERSION).","exampleType":"generated"},"2abcd018-798b-43fe-9cd1-61b8fbff7e5b":{"content":{"application/json":{"schema":{"example":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}},"properties":{"error":{"properties":{"error_code":{"description":"Stable UPPER_SNAKE identifier of the error, for programs and logs. Branch on this, not on the message.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_code","typeLabel":"string"},"error_message":{"description":"Human readable explanation of the error.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_message","typeLabel":"string"},"errors":{"description":"Only on INVALID_PARAMETER for a request outside the operation's schema: one entry per offending field.","items":{"properties":{"field":{"description":"JSON pointer to the field, e.g. /amount.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"What is wrong with it.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","x-struct":null,"x-validate":null,"uniqueKey":"error.errors","typeLabel":"object[]"}},"required":["error_code","error_message"],"type":"object","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"title":"V2 error","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error","x-validate":null,"uniqueKey":"","typeLabel":"V2 error · object"},"examples":{"Example":{"title":"Example","value":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}}}},"exampleType":"generated"}},"description":"Missing or invalid API key credentials (INVALID_CREDENTIALS).","exampleType":"generated"},"aee33fae-716b-4e4c-8cbe-5712964df453":{"content":{"application/json":{"schema":{"example":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}},"properties":{"error":{"properties":{"error_code":{"description":"Stable UPPER_SNAKE identifier of the error, for programs and logs. Branch on this, not on the message.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_code","typeLabel":"string"},"error_message":{"description":"Human readable explanation of the error.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_message","typeLabel":"string"},"errors":{"description":"Only on INVALID_PARAMETER for a request outside the operation's schema: one entry per offending field.","items":{"properties":{"field":{"description":"JSON pointer to the field, e.g. /amount.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"What is wrong with it.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","x-struct":null,"x-validate":null,"uniqueKey":"error.errors","typeLabel":"object[]"}},"required":["error_code","error_message"],"type":"object","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"title":"V2 error","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error","x-validate":null,"uniqueKey":"","typeLabel":"V2 error · object"},"examples":{"Example":{"title":"Example","value":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}}}},"exampleType":"generated"}},"description":"The API key may not do this (FORBIDDEN): for instance Trio-Target-Org-Id names an org it has no access to, or writes through a read-only access.","exampleType":"generated"},"291a04c4-0043-474d-bf1b-d8942bd0d544":{"content":{"application/json":{"schema":{"example":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}},"properties":{"error":{"properties":{"error_code":{"description":"Stable UPPER_SNAKE identifier of the error, for programs and logs. Branch on this, not on the message.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_code","typeLabel":"string"},"error_message":{"description":"Human readable explanation of the error.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_message","typeLabel":"string"},"errors":{"description":"Only on INVALID_PARAMETER for a request outside the operation's schema: one entry per offending field.","items":{"properties":{"field":{"description":"JSON pointer to the field, e.g. /amount.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"What is wrong with it.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","x-struct":null,"x-validate":null,"uniqueKey":"error.errors","typeLabel":"object[]"}},"required":["error_code","error_message"],"type":"object","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"title":"V2 error","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error","x-validate":null,"uniqueKey":"","typeLabel":"V2 error · object"},"examples":{"Example":{"title":"Example","value":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}}}},"exampleType":"generated"}},"description":"Invalid input (INVALID_PARAMETER, REQUIRED_PARAMETER, or the code of the rule the request breaks). A request outside the operation's schema lists the offending fields in `errors`.","exampleType":"generated"},"baf66766-17fd-465b-96bd-5729f6e24e77":{"content":{"application/json":{"schema":{"example":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}},"properties":{"error":{"properties":{"error_code":{"description":"Stable UPPER_SNAKE identifier of the error, for programs and logs. Branch on this, not on the message.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_code","typeLabel":"string"},"error_message":{"description":"Human readable explanation of the error.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_message","typeLabel":"string"},"errors":{"description":"Only on INVALID_PARAMETER for a request outside the operation's schema: one entry per offending field.","items":{"properties":{"field":{"description":"JSON pointer to the field, e.g. /amount.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"What is wrong with it.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","x-struct":null,"x-validate":null,"uniqueKey":"error.errors","typeLabel":"object[]"}},"required":["error_code","error_message"],"type":"object","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"title":"V2 error","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error","x-validate":null,"uniqueKey":"","typeLabel":"V2 error · object"},"examples":{"Example":{"title":"Example","value":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}}}},"exampleType":"generated"}},"description":"A service needed to answer is unavailable (TRIO_SERVICE_UNAVAILABLE).","exampleType":"generated"}},"security":{"dc341c7a-353f-4d54-8831-ef28c7482019":{"authorization":{"scheme":"basic","type":"http","scopes":[],"schemeName":"authorization"}}},"servers":{"6b606548-108f-4b34-8876-eafdf28edb31":{"url":"https://api.sandbox.trio.com.br","variables":{}},"2aa90cdd-ea34-4abe-ab07-114eac0f94f9":{"url":"https://api.qa.trio.com.br","variables":{}},"a19927d0-920a-4e65-aad9-8799051214df":{"url":"https://api.trio.com.br","variables":{}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"basic","type":"http","scopes":[],"schemeName":"authorization"},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"authorization","name":"Authorization"}],"title":"authorization"}]},"originalFileLocation":"v2/api-reference/openapi.json"},"subdomain":"trio-372e8dab","siteName":"Documentation","title":"Generate a Recurrence - Documentation","navMaps":{"firstHrefInVersion":{"V2":{"href":"/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence","matchLevel":0},"V1":{"href":"/api-reference/banking-api/receivables/recurrences/generate-recurrence","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T14:55:22.587Z","originalFileLocation":"v2/api-reference/banking-api/receivables/recurrences/generate-recurrence.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Generate a recurrence\">\u003cmeta data-mint-head name=\"application-name\" content=\"Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trio-372e8dab/rOBbojnXBM3FDhcZ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/trio-372e8dab/rOBbojnXBM3FDhcZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trio-372e8dab/rOBbojnXBM3FDhcZ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/trio-372e8dab/rOBbojnXBM3FDhcZ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/trio-372e8dab/rOBbojnXBM3FDhcZ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trio-372e8dab/rOBbojnXBM3FDhcZ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trio-372e8dab/rOBbojnXBM3FDhcZ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/trio-372e8dab/rOBbojnXBM3FDhcZ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/trio-372e8dab/rOBbojnXBM3FDhcZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Generate a Recurrence - Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Generate a recurrence\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.trio.com.br/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://trio-372e8dab.mintlify.app/_mintlify/api/og/v2?division=Recurrences\u0026amp;title=Generate+a+Recurrence\u0026amp;description=Generate+a+recurrence\u0026amp;theme=a7af139e37e3767434f3134c\u0026amp;signature=1ea9d72624a1837ede64d83d43430d992504c82e2e4e40b541a369b13492eb94\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Generate a Recurrence - Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Generate a recurrence\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://trio-372e8dab.mintlify.app/_mintlify/api/og/v2?division=Recurrences\u0026amp;title=Generate+a+Recurrence\u0026amp;description=Generate+a+recurrence\u0026amp;theme=a7af139e37e3767434f3134c\u0026amp;signature=1ea9d72624a1837ede64d83d43430d992504c82e2e4e40b541a369b13492eb94\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/trio-372e8dab/rOBbojnXBM3FDhcZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.trio.com.br/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.trio.com.br/#organization\",\"name\":\"Documentation\",\"url\":\"https://docs.trio.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/trio-372e8dab/93Kz5zeq9leNAs-j/images/LOGO_TRIO-02.png?fit=max\u0026auto=format\u0026n=93Kz5zeq9leNAs-j\u0026q=85\u0026s=1cf0ec2d074438cb2e0a6ac1d66db4f9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.trio.com.br#website\",\"name\":\"Documentation\",\"url\":\"https://docs.trio.com.br\",\"publisher\":{\"@id\":\"https://docs.trio.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.trio.com.br/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence#webpage\",\"url\":\"https://docs.trio.com.br/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence\",\"name\":\"Generate a Recurrence\",\"description\":\"Generate a recurrence\",\"dateModified\":\"2026-10-26T14:55:22.587Z\",\"isPartOf\":{\"@id\":\"https://docs.trio.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.trio.com.br/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.trio.com.br/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Banking API\",\"item\":\"https://docs.trio.com.br/v2/api-reference/banking-api/onboarding/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Receivables\",\"item\":\"https://docs.trio.com.br/v2/api-reference/banking-api/receivables/boletos/post\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Recurrences\",\"item\":\"https://docs.trio.com.br/v2/api-reference/banking-api/receivables/recurrences/list-recurrences\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Generate a Recurrence\",\"item\":\"https://docs.trio.com.br/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.trio.com.br/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence#apireference\",\"headline\":\"Generate a Recurrence\",\"name\":\"Generate a Recurrence\",\"description\":\"Generate a recurrence\",\"url\":\"https://docs.trio.com.br/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence\",\"mainEntityOfPage\":{\"@id\":\"https://docs.trio.com.br/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence#webpage\"},\"dateModified\":\"2026-10-26T14:55:22.587Z\",\"publisher\":{\"@id\":\"https://docs.trio.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.trio.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Documentation","nav":{"global":null,"versions":[{"version":"V2","default":true,"tag":"Current","tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/v2/guides/onboarding-guide"}]},{"tab":"API reference","groups":[{"group":"Banking API","pages":[{"group":"Onboarding","pages":[{"title":"Onboard entity","sidebarTitle":"Onboard entity","openapi":"v2/api-reference/openapi.json POST /v2/onboarding","href":"/v2/api-reference/banking-api/onboarding/create"},{"title":"Upload onboarding document","sidebarTitle":"Upload document","openapi":"v2/api-reference/openapi.json POST /v2/onboarding/documents","href":"/v2/api-reference/banking-api/onboarding/create-document"}]},{"group":"Entities","pages":[{"title":"List entities","openapi":"v2/api-reference/openapi.json GET /v2/entities","href":"/v2/api-reference/banking-api/entities/list"},{"title":"Get entity by ID","openapi":"v2/api-reference/openapi.json GET /v2/entities/{id}","href":"/v2/api-reference/banking-api/entities/get"}]},{"group":"Counterparties","pages":[{"title":"List Counterparties","openapi":"v2/api-reference/openapi.json GET /v2/counterparties","href":"/v2/api-reference/banking-api/counterparties/list-counterparties"},{"title":"Get Counterparty","openapi":"v2/api-reference/openapi.json GET /v2/counterparties/{id}","href":"/v2/api-reference/banking-api/counterparties/get-counterparty"},{"title":"Find or Create Counterparty","openapi":"v2/api-reference/openapi.json POST /v2/counterparties","href":"/v2/api-reference/banking-api/counterparties/create-counterparty"},{"group":"Bank Accounts","pages":[{"title":"List Counterparty Bank Accounts","openapi":"v2/api-reference/openapi.json GET /v2/counterparties/{counterparty_id}/bank_accounts","href":"/v2/api-reference/banking-api/counterparties/bank-accounts/list-counterparty-bank-accounts"},{"title":"Get Counterparty Bank Account","openapi":"v2/api-reference/openapi.json GET /v2/counterparties/{counterparty_id}/bank_accounts/{counterparty_bank_account_id}","href":"/v2/api-reference/banking-api/counterparties/bank-accounts/get-counterparty-bank-account"},{"title":"Create Counterparty Bank Account","openapi":"v2/api-reference/openapi.json POST /v2/counterparties/{counterparty_id}/bank_accounts","href":"/v2/api-reference/banking-api/counterparties/bank-accounts/create-counterparty-bank-account"}]},{"group":"Recipients","pages":[{"title":"Create Counterparty Recipient","openapi":"v2/api-reference/openapi.json POST /v2/counterparty_recipients","href":"/v2/api-reference/banking-api/counterparties/recipients/create-counterparty-recipient"},{"title":"Show Counterparty Recipient","openapi":"v2/api-reference/openapi.json GET /v2/counterparty_recipients/{id}","href":"/v2/api-reference/banking-api/counterparties/recipients/get-counterparty-recipient"},{"title":"List Counterparty Recipients","openapi":"v2/api-reference/openapi.json GET /v2/counterparties/{counterparty_id}/recipients","href":"/v2/api-reference/banking-api/counterparties/recipients/list-counterparty-recipients"}]}]},{"group":"Bank Accounts","pages":[{"title":"List Bank Accounts","openapi":"v2/api-reference/openapi.json GET /v2/bank_accounts","href":"/v2/api-reference/banking-api/bank-accounts/list-bank-accounts"},{"title":"Get Bank Account","openapi":"v2/api-reference/openapi.json GET /v2/bank_accounts/{id}","href":"/v2/api-reference/banking-api/bank-accounts/get-bank-account"},{"title":"Create Bank Account","openapi":"v2/api-reference/openapi.json POST /v2/bank_accounts","href":"/v2/api-reference/banking-api/bank-accounts/create-bank-account"},{"title":"Update Bank Account Parameters","openapi":"v2/api-reference/openapi.json PUT /v2/bank_accounts/{id}","href":"/v2/api-reference/banking-api/bank-accounts/update-bank-account"},{"group":"Transactions","pages":[{"title":"List Bank Account Transactions","openapi":"v2/api-reference/openapi.json GET /v2/bank_accounts/{id}/transactions","href":"/v2/api-reference/banking-api/bank-accounts/transactions/list-bank-account-transactions"}]},{"group":"Balances","pages":[{"title":"Get Bank Account Balances","openapi":"v2/api-reference/openapi.json GET /v2/bank_accounts/{id}/balances","href":"/v2/api-reference/banking-api/bank-accounts/balances/get-bank-account-balances"}]},{"group":"Metrics","pages":[{"title":"Get Bank Account Metrics","openapi":"v2/api-reference/openapi.json GET /v2/bank_accounts/{id}/metrics","href":"/v2/api-reference/banking-api/bank-accounts/metrics/get-bank-account-metrics"}]}]},{"group":"Pix Keys","pages":[{"title":"List Pix keys","openapi":"v2/api-reference/openapi.json GET /v2/pix/keys","href":"/v2/api-reference/banking-api/receivables/pix-keys/list-pix-keys"},{"title":"Create Pix key","openapi":"v2/api-reference/openapi.json POST /v2/pix/keys","href":"/v2/api-reference/banking-api/receivables/pix-keys/create-pix-key"},{"title":"Get Pix key","openapi":"v2/api-reference/openapi.json GET /v2/pix/keys/{id}","href":"/v2/api-reference/banking-api/receivables/pix-keys/get-pix-key"},{"title":"Confirm Pix key","openapi":"v2/api-reference/openapi.json PUT /v2/pix/keys/{id}/confirm","href":"/v2/api-reference/banking-api/receivables/pix-keys/confirm-pix-key"},{"title":"Resend Pix key confirmation token","openapi":"v2/api-reference/openapi.json POST /v2/pix/keys/{id}/resend_token","href":"/v2/api-reference/banking-api/receivables/pix-keys/resend-pix-key-token"},{"title":"Cancel Pix key","openapi":"v2/api-reference/openapi.json POST /v2/pix/keys/{id}/cancel","href":"/v2/api-reference/banking-api/receivables/pix-keys/cancel-pix-key"}]},{"group":"Receivables","pages":[{"group":"Boleto","pages":[{"title":"Create boleto","openapi":"v2/api-reference/openapi.json POST /v2/in/boletos","href":"/v2/api-reference/banking-api/receivables/boletos/post"},{"title":"List boletos","openapi":"v2/api-reference/openapi.json GET /v2/in/boletos","href":"/v2/api-reference/banking-api/receivables/boletos/list"},{"title":"Get boleto","openapi":"v2/api-reference/openapi.json GET /v2/in/boletos/{id}","href":"/v2/api-reference/banking-api/receivables/boletos/get"},{"title":"Update boleto due date","openapi":"v2/api-reference/openapi.json PUT /v2/in/boletos/{id}","href":"/v2/api-reference/banking-api/receivables/boletos/update"},{"title":"Cancel boleto","openapi":"v2/api-reference/openapi.json POST /v2/in/boletos/{id}/cancel","href":"/v2/api-reference/banking-api/receivables/boletos/cancel"},{"title":"Recreate boleto","openapi":"v2/api-reference/openapi.json POST /v2/in/boletos/{id}/recreate","href":"/v2/api-reference/banking-api/receivables/boletos/recreate"},{"title":"Add protest","openapi":"v2/api-reference/openapi.json PUT /v2/in/boletos/{id}/protest/add","href":"/v2/api-reference/banking-api/receivables/boletos/add-protest"},{"title":"Remove protest","openapi":"v2/api-reference/openapi.json PUT /v2/in/boletos/{id}/protest/remove","href":"/v2/api-reference/banking-api/receivables/boletos/remove-protest"}]},{"group":"Pix","pages":[{"group":"Static QR Code","pages":[{"title":"Create static QR code","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/qrcodes/static","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-static/post"},{"title":"Get static QR code","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/static/{id}","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-static/get"},{"title":"Get static QR code image","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/static/{id}/image","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-static/get-image"},{"title":"Get static QR code hash","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/static/{id}/hash","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-static/get-hash"}]},{"group":"Dynamic QR Code","pages":[{"title":"Create dynamic QR code","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/qrcodes","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-dynamic/post"},{"title":"Get dynamic QR code","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/{id}","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-dynamic/get"},{"title":"Update dynamic QR code","openapi":"v2/api-reference/openapi.json PUT /v2/in/pix/qrcodes/{id}","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-dynamic/update"},{"title":"Get dynamic QR code image","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/{id}/image","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-dynamic/get-image"},{"title":"Get dynamic QR code hash","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/{id}/hash","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-dynamic/get-hash"}]},{"group":"Dynamic QR Code with Due Date","pages":[{"title":"Create dynamic QR code with due date","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/qrcodes/with_due","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-with-due/post"},{"title":"Get dynamic QR code with due date","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/with_due/{id}","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-with-due/get"},{"title":"Get dynamic QR code with due date image","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/with_due/{id}/image","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-with-due/get-image"},{"title":"Get dynamic QR code with due date hash","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/with_due/{id}/hash","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-with-due/get-hash"}]},{"group":"Refund","pages":[{"title":"Refund Pix","openapi":"v2/api-reference/openapi.json POST /v2/documents/in/{id}/refund","href":"/v2/api-reference/banking-api/receivables/pix/refunds/post"}]}]},{"group":"Recurrences","pages":[{"title":"List Recurrences","description":"List recurrences with parameters","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences","href":"/v2/api-reference/banking-api/receivables/recurrences/list-recurrences"},{"title":"Generate a Recurrence","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/recurrences","href":"/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence"},{"title":"Get Recurrence","description":"Get recurrence with stages","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences/{id}","href":"/v2/api-reference/banking-api/receivables/recurrences/get-recurrence"},{"title":"Cancel Recurrence","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/recurrences/{id}/cancel","href":"/v2/api-reference/banking-api/receivables/recurrences/cancel-recurrence"},{"title":"List Recurrence Collections","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences/collections","href":"/v2/api-reference/banking-api/receivables/recurrences/list-recurrence-collections"},{"title":"Get Collection","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences/collections/{id}","href":"/v2/api-reference/banking-api/receivables/recurrences/get-collection"},{"title":"Update Collection","openapi":"v2/api-reference/openapi.json PUT /v2/in/pix/recurrences/collections/{id}","href":"/v2/api-reference/banking-api/receivables/recurrences/update-collection"},{"title":"Cancel Collection","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/recurrences/collections/{id}/cancel","href":"/v2/api-reference/banking-api/receivables/recurrences/cancel-collection"},{"title":"Schedule Collection","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/recurrences/collections/{id}/schedule","href":"/v2/api-reference/banking-api/receivables/recurrences/schedule-collection"},{"title":"Create Next Collection","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/recurrences/collections/next","href":"/v2/api-reference/banking-api/receivables/recurrences/create-next-collection"},{"title":"List Collection Attempts","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences/collections/attempts","href":"/v2/api-reference/banking-api/receivables/recurrences/list-collection-attempts"},{"title":"Get Collection Attempt","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences/collections/attempts/{id}","href":"/v2/api-reference/banking-api/receivables/recurrences/get-collection-attempt"},{"title":"Get Recurrence Request","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences/requests/{id}","href":"/v2/api-reference/banking-api/receivables/recurrences/get-recurrence-request"}]}]},{"group":"Payments","pages":[{"group":"Pix","pages":[{"group":"Transfer","pages":[{"title":"Check Pix Key","openapi":"v2/api-reference/openapi.json POST /v2/out/pix/keys/check","href":"/v2/api-reference/banking-api/payments/pix/transfer-pix/check-key"},{"title":"Get Pix Key Check","openapi":"v2/api-reference/openapi.json GET /v2/out/pix/keys/{id}","href":"/v2/api-reference/banking-api/payments/pix/transfer-pix/get-key-check"},{"title":"Generate a Pix Payment","openapi":"v2/api-reference/openapi.json POST /v2/out/pix","href":"/v2/api-reference/banking-api/payments/pix/transfer-pix/generate-pix-payment"},{"title":"Generate a Pix Payment (async)","openapi":"v2/api-reference/openapi.json POST /v2/out/pix/async","href":"/v2/api-reference/banking-api/payments/pix/transfer-pix/generate-pix-payment-async"}]},{"group":"QR Code","pages":[{"title":"Check Pix BR Code","openapi":"v2/api-reference/openapi.json POST /v2/out/pix/brcodes/check","href":"/v2/api-reference/banking-api/payments/pix/brcode/check-brcode"},{"title":"Get Pix BR Code Check","openapi":"v2/api-reference/openapi.json GET /v2/out/pix/brcodes/{id}","href":"/v2/api-reference/banking-api/payments/pix/brcode/get-brcode-check"},{"title":"Generate a Pix Payment (BR Code)","openapi":"v2/api-reference/openapi.json POST /v2/out/pix","href":"/v2/api-reference/banking-api/payments/pix/brcode/generate-pix-payment-brcode"}]}]},{"group":"Boleto","pages":[{"title":"Check boleto","openapi":"v2/api-reference/openapi.json POST /v2/out/boleto/check","href":"/v2/api-reference/banking-api/payments/boleto/check-boleto"},{"title":"Pay boleto","openapi":"v2/api-reference/openapi.json POST /v2/out/boleto","href":"/v2/api-reference/banking-api/payments/boleto/pay-boleto"},{"title":"Pay boleto (async)","openapi":"v2/api-reference/openapi.json POST /v2/out/boleto/async","href":"/v2/api-reference/banking-api/payments/boleto/pay-boleto-async"}]},{"group":"Utility","pages":[{"title":"Check Utility","openapi":"v2/api-reference/openapi.json POST /v2/out/utility/check","href":"/v2/api-reference/banking-api/payments/utility/check-utility"},{"title":"Pay Utility","openapi":"v2/api-reference/openapi.json POST /v2/out/utility","href":"/v2/api-reference/banking-api/payments/utility/pay-utility"},{"title":"Pay Utility (async)","openapi":"v2/api-reference/openapi.json POST /v2/out/utility/async","href":"/v2/api-reference/banking-api/payments/utility/pay-utility-async"}]},{"group":"Tax (ISS, DAS)","pages":[{"title":"Check Tax","openapi":"v2/api-reference/openapi.json POST /v2/out/tax/check","href":"/v2/api-reference/banking-api/payments/tax/check-tax"},{"title":"Pay Tax","openapi":"v2/api-reference/openapi.json POST /v2/out/tax","href":"/v2/api-reference/banking-api/payments/tax/pay-tax"},{"title":"Pay Tax (async)","openapi":"v2/api-reference/openapi.json POST /v2/out/tax/async","href":"/v2/api-reference/banking-api/payments/tax/pay-tax-async"}]},{"group":"Darf (manual)","pages":[{"title":"Check DARF","openapi":"v2/api-reference/openapi.json POST /v2/out/darf/check","href":"/v2/api-reference/banking-api/payments/darf/check-darf"},{"title":"Pay DARF","openapi":"v2/api-reference/openapi.json POST /v2/out/darf","href":"/v2/api-reference/banking-api/payments/darf/pay-darf"},{"title":"Pay DARF (async)","openapi":"v2/api-reference/openapi.json POST /v2/out/darf/async","href":"/v2/api-reference/banking-api/payments/darf/pay-darf-async"}]}]},{"group":"Transfers","pages":[{"title":"Transfer","openapi":"v2/api-reference/openapi.json POST /v2/transfer","href":"/v2/api-reference/banking-api/transfers/transfer"}]},{"group":"Documents","pages":[{"group":"Receivables","pages":[{"title":"List Receivables","openapi":"v2/api-reference/openapi.json GET /v2/documents/in","href":"/v2/api-reference/banking-api/documents/receivables/list-receivables"},{"title":"Get Receivable","openapi":"v2/api-reference/openapi.json GET /v2/documents/in/{id}","href":"/v2/api-reference/banking-api/documents/receivables/get-receivable"},{"title":"Search Receivables","openapi":"v2/api-reference/openapi.json GET /v2/documents/in/search","href":"/v2/api-reference/banking-api/documents/receivables/search-receivables"}]},{"group":"Receivables - Refunds","pages":[{"title":"List Receivable Refunds","openapi":"v2/api-reference/openapi.json GET /v2/documents/in/refunds","href":"/v2/api-reference/banking-api/documents/receivables-refunds/list-receivable-refunds"},{"title":"Get Receivable Refund","openapi":"v2/api-reference/openapi.json GET /v2/documents/in/refunds/{id}","href":"/v2/api-reference/banking-api/documents/receivables-refunds/get-receivable-refund"},{"title":"Search Receivable Refunds","openapi":"v2/api-reference/openapi.json GET /v2/documents/in/refunds/search","href":"/v2/api-reference/banking-api/documents/receivables-refunds/search-receivable-refunds"}]},{"group":"Payments","pages":[{"title":"List Payments","openapi":"v2/api-reference/openapi.json GET /v2/documents/out","href":"/v2/api-reference/banking-api/documents/payments/list-payments"},{"title":"Get Payment","openapi":"v2/api-reference/openapi.json GET /v2/documents/out/{id}","href":"/v2/api-reference/banking-api/documents/payments/get-payment"},{"title":"Search Payments","openapi":"v2/api-reference/openapi.json GET /v2/documents/out/search","href":"/v2/api-reference/banking-api/documents/payments/search-payments"}]},{"group":"Payments - Refunds","pages":[{"title":"List Payment Refunds","openapi":"v2/api-reference/openapi.json GET /v2/documents/out/refunds","href":"/v2/api-reference/banking-api/documents/payments-refunds/list-payment-refunds"},{"title":"Get Payment Refund","openapi":"v2/api-reference/openapi.json GET /v2/documents/out/refunds/{id}","href":"/v2/api-reference/banking-api/documents/payments-refunds/get-payment-refund"},{"title":"Search Payment Refunds","openapi":"v2/api-reference/openapi.json GET /v2/documents/out/refunds/search","href":"/v2/api-reference/banking-api/documents/payments-refunds/search-payment-refunds"}]},{"group":"Transfers","pages":[{"title":"List Transfers","openapi":"v2/api-reference/openapi.json GET /v2/documents/transfer","href":"/v2/api-reference/banking-api/documents/transfers/list-transfers"},{"title":"Get Transfer","openapi":"v2/api-reference/openapi.json GET /v2/documents/transfer/{id}","href":"/v2/api-reference/banking-api/documents/transfers/get-transfer"}]}]},{"group":"Cards","pages":[{"title":"Create Card","openapi":"v2/api-reference/openapi.json POST /v2/cards","href":"/v2/api-reference/banking-api/cards/create-card"},{"title":"List Cards","openapi":"v2/api-reference/openapi.json GET /v2/cards","href":"/v2/api-reference/banking-api/cards/list-cards"},{"title":"Get Card","openapi":"v2/api-reference/openapi.json GET /v2/cards/{id}","href":"/v2/api-reference/banking-api/cards/get-card"},{"title":"Update Card","openapi":"v2/api-reference/openapi.json PUT /v2/cards/{id}","href":"/v2/api-reference/banking-api/cards/update-card"},{"title":"Block Card","openapi":"v2/api-reference/openapi.json POST /v2/cards/{id}/block","href":"/v2/api-reference/banking-api/cards/block-card"},{"title":"Unblock Card","openapi":"v2/api-reference/openapi.json POST /v2/cards/{id}/unblock","href":"/v2/api-reference/banking-api/cards/unblock-card"},{"title":"Cancel Card","openapi":"v2/api-reference/openapi.json POST /v2/cards/{id}/cancel","href":"/v2/api-reference/banking-api/cards/cancel-card"},{"title":"Get Card Details","openapi":"v2/api-reference/openapi.json GET /v2/cards/{id}/info","href":"/v2/api-reference/banking-api/cards/get-card-details"},{"title":"Top Up Card Balance","openapi":"v2/api-reference/openapi.json POST /v2/cards/{id}/topup","href":"/v2/api-reference/banking-api/cards/top-up-card-balance"},{"title":"Generate Card Top Up QR Code","openapi":"v2/api-reference/openapi.json POST /v2/cards/{id}/topup/qrcode","href":"/v2/api-reference/banking-api/cards/generate-card-top-up-qrcode"},{"title":"Transfer Card Balance","openapi":"v2/api-reference/openapi.json POST /v2/cards/{id}/transfer_balance","href":"/v2/api-reference/banking-api/cards/transfer-card-balance"},{"title":"List Card Invoices","openapi":"v2/api-reference/openapi.json GET /v2/cards/invoices","href":"/v2/api-reference/banking-api/cards/list-card-invoices"},{"title":"Get Card Current Invoice","openapi":"v2/api-reference/openapi.json GET /v2/cards/invoices/current","href":"/v2/api-reference/banking-api/cards/get-card-current-invoice"},{"title":"List Card Invoice Lines","openapi":"v2/api-reference/openapi.json GET /v2/cards/invoices/{id}/lines","href":"/v2/api-reference/banking-api/cards/list-card-invoice-lines"},{"title":"Generate Card Invoice Statement CSV URL","openapi":"v2/api-reference/openapi.json GET /v2/cards/invoices/{id}/export","href":"/v2/api-reference/banking-api/cards/generate-card-invoice-statement-csv-url"},{"title":"List Card Purchase Documents","openapi":"v2/api-reference/openapi.json GET /v2/cards/purchases","href":"/v2/api-reference/banking-api/cards/list-card-purchase-documents"},{"title":"Show Card Purchase Document by ID","openapi":"v2/api-reference/openapi.json GET /v2/cards/purchases/{id}","href":"/v2/api-reference/banking-api/cards/show-card-purchase-document-by-id"},{"title":"Show Card Purchase Document by End to End ID","openapi":"v2/api-reference/openapi.json GET /v2/cards/purchases/e2e/{id}","href":"/v2/api-reference/banking-api/cards/show-card-purchase-document-by-end-to-end-id"}]},{"group":"Pledged","pages":[{"title":"List Advance Requests","openapi":"v2/api-reference/openapi.json GET /v2/pledged/advance_requests","href":"/v2/api-reference/banking-api/pledged/list-advance-requests"},{"title":"Create Advance Request","openapi":"v2/api-reference/openapi.json POST /v2/pledged/advance_requests","href":"/v2/api-reference/banking-api/pledged/create-advance-request"},{"title":"Get Advance Request","openapi":"v2/api-reference/openapi.json GET /v2/pledged/advance_requests/{id}","href":"/v2/api-reference/banking-api/pledged/get-advance-request"},{"title":"Cancel Advance Request","openapi":"v2/api-reference/openapi.json POST /v2/pledged/advance_requests/{id}/cancel","href":"/v2/api-reference/banking-api/pledged/cancel-advance-request"}]},{"group":"Institutions","pages":[{"title":"List institutions","openapi":"v2/api-reference/openapi.json GET /v2/institutions","href":"/v2/api-reference/banking-api/institutions/list"}]},{"group":"Developers","pages":[{"group":"Webhooks","pages":[{"title":"List Webhooks","openapi":"v2/api-reference/openapi.json GET /v2/webhooks","href":"/v2/api-reference/banking-api/developers/webhooks/list-webhooks"},{"title":"Get Webhook","openapi":"v2/api-reference/openapi.json GET /v2/webhooks/{webhook_id}","href":"/v2/api-reference/banking-api/developers/webhooks/get-webhook"},{"title":"Create Webhook","openapi":"v2/api-reference/openapi.json POST /v2/webhooks","href":"/v2/api-reference/banking-api/developers/webhooks/create-webhook"},{"title":"Delete Webhook","openapi":"v2/api-reference/openapi.json DELETE /v2/webhooks/{webhook_id}","href":"/v2/api-reference/banking-api/developers/webhooks/delete-webhook"},{"title":"Replace Webhook","openapi":"v2/api-reference/openapi.json PUT /v2/webhooks/{webhook_id}","href":"/v2/api-reference/banking-api/developers/webhooks/replace-webhook"}]}]}]}]},{"tab":"FAQ","pages":[{"title":"FAQ","href":"/v2/faq/frequently-asked-questions"}]}]},{"version":"V1","tag":"Legacy","pages":[{"title":"V1","href":"/api-reference/banking-api/receivables/recurrences/generate-recurrence"}]}]},"title":"Generate a Recurrence - Documentation","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}