# Recurrences

## List recurrences

> List recurrences with parameters

```json
{"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cashin/pix/recurrences":{"get":{"callbacks":{},"description":"List recurrences with parameters","operationId":"TrioFoundationWeb.Banking.Cashin.RecurrenceController.index","parameters":[{"description":"Recurrence Entity Id","in":"query","name":"entity_id","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Virtual Account Id","in":"query","name":"virtual_account_id","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Recurrence datetime, lower bound for the list of recurrences","in":"query","name":"from_datetime","required":true,"schema":{"format":"date-time","type":"string"}},{"description":"Recurrence datetime, upper bound for the list of recurrences","in":"query","name":"to_datetime","required":true,"schema":{"format":"date-time","type":"string"}},{"description":"Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.","in":"query","name":"before","required":false,"schema":{"type":"string"}},{"description":"Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.","in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"Number of registries to be returned","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurrenceListResponse"}}},"description":"Recurrences"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"List recurrences","tags":["Recurrences"]}}},"components":{"schemas":{"RecurrenceListResponse":{"description":"Recurrence lists response","properties":{"data":{"$ref":"#/components/schemas/RecurrenceListData"}},"title":"RecurrenceListResponse","type":"object"},"RecurrenceListData":{"description":"A list data of automatic recurrences","items":{"$ref":"#/components/schemas/RecurrenceData"},"title":"RecurrenceListData","type":"array"},"RecurrenceData":{"description":"A recurrence","properties":{"counterparty_bank_account_id":{"description":"Counterparty Bank Account ID","format":"uuid","type":"string"},"start_date":{"description":"Recurrence Start Date","format":"date-time","type":"string"},"counterparty_id":{"description":"Counterparty ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted At","format":"date-time","type":"string"},"type":{"$ref":"#/components/schemas/RecurrenceType"},"entity_id":{"description":"Entity ID","format":"uuid","type":"string"},"reference_id":{"description":"Reference ID","format":"uuid","type":"string"},"minimum_amount":{"description":"Minimum Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"ispb":{"description":"ISPB","type":"string"},"first_payment_date":{"description":"First Payment Date","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual Account ID","format":"uuid","type":"string"},"number_of_collections":{"description":"Number Of Collections","type":"string"},"company_id":{"description":"Company ID","format":"uuid","type":"string"},"automatic_schedule":{"description":"Automated Collecting","type":"string"},"end_date":{"description":"Recurrence End Date","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceStatus"},"updated_at":{"description":"Updated At","format":"date-time","type":"string"},"next_working_day":{"description":"Next Working Day","type":"string"},"description":{"description":"Description","type":"string"},"id":{"description":"Recurrence ID","format":"uuid","type":"string"},"id_rec":{"description":"ID Rec","type":"string"},"fixed_amount":{"description":"Fixed Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"contract_number":{"description":"Contract Number","type":"string"},"txid":{"description":"Txid","type":"string"},"journey":{"$ref":"#/components/schemas/Journey"},"external_id":{"description":"External ID","format":"uuid","type":"string"},"authorization_date":{"description":"Authorization Date","format":"date-time","type":"string"},"retry_policy":{"$ref":"#/components/schemas/RecurrenceRetryPolicy"},"timestamp":{"description":"Timestamp","type":"string"},"origin_id":{"description":"Origin ID","format":"uuid","type":"string"},"org_id":{"description":"Org ID","format":"uuid","type":"string"},"first_payment_amount":{"description":"First payment Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"maximum_amount":{"description":"Maximum Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"reference_type":{"$ref":"#/components/schemas/RecurrenceReferenceType"},"periodicity":{"$ref":"#/components/schemas/RecurrencePeriodicity"},"origin_type":{"$ref":"#/components/schemas/RecurrenceOrigintype"},"update_date":{"description":"Update Date","format":"date-time","type":"string"},"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string"},"counterparty_info_id":{"description":"Counterparty Info ID","format":"uuid","type":"string"},"counterparty_seq":{"description":"Counterparty Seq","type":"string"}},"title":"RecurrenceData","type":"object"},"RecurrenceType":{"description":"Types of recurrence type","enum":["in","out"],"title":"RecurrenceType","type":"string"},"RecurrenceStatus":{"description":"Types of recurrence status","enum":["created","approved","rejected","expired","cancelled"],"title":"RecurrenceStatus","type":"string"},"Journey":{"description":"Types of recurrence journey","enum":["aut1","aut2","aut3","aut4"],"title":"Journey","type":"string"},"RecurrenceRetryPolicy":{"description":"Types of recurrence retry policy","enum":["none","3r_7d"],"title":"RecurrenceRetryPolicy","type":"string"},"RecurrenceReferenceType":{"description":"Recurrence reference types, 'requ' = app, 'qrdn' = dynamicQRCode, 'qres' = staticQRCode","enum":["requ","qrdn","qres"],"title":"RecurrenceReferenceType","type":"string"},"RecurrencePeriodicity":{"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"},"RecurrenceOrigintype":{"description":"Origin Types of recurrence","enum":["none","api_client","console_user","billing","reconciliation","checkout","bridge"],"title":"RecurrenceOrigintype","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}}
```

## Generate a recurrence

> Generate a recurrence

```json
{"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cashin/pix/recurrences":{"post":{"callbacks":{},"description":"Generate a recurrence","operationId":"TrioFoundationWeb.Banking.Cashin.RecurrenceController.generate","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateRecurrenceParameters"}}},"description":"The recurrence generate attributes","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateRecurrenceResponse"}}},"description":"Generate Recurrence Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Generate a recurrence","tags":["Recurrences"]}}},"components":{"schemas":{"GenerateRecurrenceParameters":{"description":"GenerateRecurrenceParameters","properties":{"amounts":{"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","nullable":true,"properties":{"fixed":{"description":"Fixed Amount in cents, used for fixed amount recurrences","nullable":true,"type":"integer"},"minimum":{"description":"Minimum Amount in cents, used for variable amount recurrences","nullable":true,"type":"integer"}},"type":"object"},"contract_number":{"description":"Contract Number","maxLength":35,"type":"string"},"counterparty":{"description":"Counterparty","properties":{"bank_account":{"description":"Counterparty Bank Account, required for authorization type 'app', this is the bank account that will receive the request to approve the recurrence","nullable":true,"properties":{"branch":{"description":"Counterparty Bank Account Branch","pattern":"^[0-9]+$","type":"string"},"digit":{"description":"Counterparty Bank Account Digit","pattern":"^[0-9]$","type":"string"},"ispb":{"description":"Counterparty Bank Account ISPB","pattern":"^[0-9]{8}$","type":"string"},"number":{"description":"Counterparty Bank Account Number","pattern":"^[0-9]+$","type":"string"}},"required":["ispb","number","branch","digit"],"type":"object"},"info":{"description":"Counterparty Info","nullable":true,"properties":{"address":{"description":"Counterparty Address","nullable":true,"type":"string"},"city":{"description":"Counterparty City","nullable":true,"type":"string"},"email":{"description":"Counterparty Email","nullable":true,"type":"string"},"postal_code":{"description":"Counterparty Postal Code","nullable":true,"type":"string"},"state":{"description":"Counterparty State","nullable":true,"type":"string"}},"type":"object"},"name":{"description":"Counterparty Name","type":"string"},"tax_number":{"description":"Counterparty Tax Number","type":"string"}},"required":["tax_number","name"],"type":"object"},"description":{"description":"Description","maxLength":35,"type":"string"},"end_date":{"description":"Recurrence End Date","format":"date-time","nullable":true,"type":"string"},"external_id":{"description":"Recurrence External ID","nullable":true,"type":"string"},"first_payment":{"$ref":"#/components/schemas/FirstPaymentWithDueDetail"},"options":{"description":"Recurrence options","nullable":true,"properties":{"authorization_type":{"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"],"nullable":true,"type":"string"},"automatic_schedule":{"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","nullable":true,"type":"boolean"},"next_working_day":{"default":false,"description":"Do not bill on Holidays, bill on the counterparty's next working day","nullable":true,"type":"boolean"},"qrcode_expiration_seconds":{"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.","nullable":true,"type":"integer"},"retry_policy":{"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"],"nullable":true,"type":"string"}},"type":"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"],"type":"string"},"start_date":{"description":"Recurrence Start Date","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual Account ID","format":"uuid","type":"string"}},"required":["virtual_account_id","counterparty","description","periodicity","contract_number","start_date"],"title":"GenerateRecurrenceParameters","type":"object"},"FirstPaymentWithDueDetail":{"description":"Schema for the first payment with due detail","nullable":true,"properties":{"amount":{"description":"First Payment amount in cents","nullable":true,"type":"integer"},"dict_key":{"description":"Virtual Account Pix Key","nullable":true,"type":"string"},"due_detail":{"$ref":"#/components/schemas/DynamicBrcodeDueDetailParams"},"expiration_seconds":{"description":"[Deprecated] use the 'options.qrcode_expiration_seconds' field instead.","nullable":true,"type":"integer"},"recurrence_required":{"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.","nullable":true,"type":"boolean"}},"title":"FirstPaymentWithDueDetail","type":"object"},"DynamicBrcodeDueDetailParams":{"description":"Body params for dynamic brcode due detail","nullable":true,"properties":{"discount":{"description":"Discount of the due detail","nullable":true,"type":"integer"},"discount_amounts":{"description":"Discount amounts of the due detail","items":{"type":"integer"},"nullable":true,"type":"array"},"discount_antecipation_type":{"$ref":"#/components/schemas/DynamicBrcodeDueDetailDiscountAntecipationType"},"discount_calculation_days":{"$ref":"#/components/schemas/DynamicBrcodeDueDetailDiscountCalculationDays"},"discount_calculation_type":{"$ref":"#/components/schemas/DynamicBrcodeDueDetailDiscountCalculationType"},"discount_dates":{"description":"Discount dates of the due detail","items":{"format":"date","type":"string"},"nullable":true,"type":"array"},"due_date":{"description":"Due date of the dynamic brcode","format":"date","type":"string"},"fine":{"description":"Fine of the due detail","nullable":true,"type":"integer"},"fine_calculation_type":{"$ref":"#/components/schemas/DynamicBrcodeDueDetailFineCalculationType"},"interest":{"description":"Interest of the due detail","nullable":true,"type":"integer"},"interest_calculation_days":{"$ref":"#/components/schemas/DynamicBrcodeDueDetailInterestCalculationDays"},"interest_calculation_period":{"$ref":"#/components/schemas/DynamicBrcodeDueDetailInterestCalculationPeriod"},"interest_calculation_type":{"$ref":"#/components/schemas/DynamicBrcodeDueDetailInterestCalculationType"},"rebate":{"description":"Rebate of the due detail","nullable":true,"type":"integer"},"rebate_calculation_type":{"$ref":"#/components/schemas/DynamicBrcodeDueDetailRebateCalculationType"}},"required":["due_date"],"title":"DynamicBrcodeDueDetailParams","type":"object"},"DynamicBrcodeDueDetailDiscountAntecipationType":{"description":"Discount antecipation type of dynamic brcode with due detail","enum":["fixed_until_due","per_day_antecipated"],"nullable":true,"title":"DynamicBrcodeDueDetailDiscountAntecipationType","type":"string"},"DynamicBrcodeDueDetailDiscountCalculationDays":{"description":"Discount calculation days of dynamic brcode with due detail","enum":["calendar","working"],"nullable":true,"title":"DynamicBrcodeDueDetailDiscountCalculationDays","type":"string"},"DynamicBrcodeDueDetailDiscountCalculationType":{"description":"Discount calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"nullable":true,"title":"DynamicBrcodeDueDetailDiscountCalculationType","type":"string"},"DynamicBrcodeDueDetailFineCalculationType":{"description":"Fine calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"nullable":true,"title":"DynamicBrcodeDueDetailFineCalculationType","type":"string"},"DynamicBrcodeDueDetailInterestCalculationDays":{"description":"Interest calculation days of dynamic brcode with due detail","enum":["calendar","working"],"nullable":true,"title":"DynamicBrcodeDueDetailInterestCalculationDays","type":"string"},"DynamicBrcodeDueDetailInterestCalculationPeriod":{"description":"Interest calculation period of dynamic brcode with due detail","enum":["day","month","year"],"nullable":true,"title":"DynamicBrcodeDueDetailInterestCalculationPeriod","type":"string"},"DynamicBrcodeDueDetailInterestCalculationType":{"description":"Interest calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"nullable":true,"title":"DynamicBrcodeDueDetailInterestCalculationType","type":"string"},"DynamicBrcodeDueDetailRebateCalculationType":{"description":"Rebate calculation type of dynamic brcode with due detail","enum":["amount","percentage"],"nullable":true,"title":"DynamicBrcodeDueDetailRebateCalculationType","type":"string"},"GenerateRecurrenceResponse":{"description":"Generate Recurrence response","properties":{"data":{"description":"Generate recurrence response data","properties":{"counterparty_bank_account_id":{"description":"Counterparty Bank Account ID","format":"uuid","type":"string"},"start_date":{"description":"Recurrence Start Date","format":"date-time","type":"string"},"counterparty_id":{"description":"Counterparty ID","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/RecurrenceType"},"entity_id":{"description":"Entity ID","format":"uuid","type":"string"},"reference_id":{"description":"Reference ID","format":"uuid","type":"string"},"minimum_amount":{"description":"Minimum Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"ispb":{"description":"ISPB","type":"string"},"first_payment_date":{"description":"First Payment Date","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual Account ID","format":"uuid","type":"string"},"company_id":{"description":"Company ID","format":"uuid","type":"string"},"automatic_schedule":{"description":"Automated Collecting","type":"string"},"end_date":{"description":"Recurrence End Date","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceStatus"},"next_working_day":{"description":"Next Working Day","type":"string"},"description":{"description":"Description","type":"string"},"id":{"description":"Recurrence ID","format":"uuid","type":"string"},"id_rec":{"description":"ID Rec","type":"string"},"fixed_amount":{"description":"Fixed Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"contract_number":{"description":"Contract Number","type":"string"},"txid":{"description":"Txid","type":"string"},"journey":{"$ref":"#/components/schemas/Journey"},"external_id":{"description":"External ID","format":"uuid","type":"string"},"retry_policy":{"$ref":"#/components/schemas/RecurrenceRetryPolicy"},"timestamp":{"description":"Timestamp","type":"string"},"org_id":{"description":"Org ID","format":"uuid","type":"string"},"first_payment_amount":{"description":"First payment Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"maximum_amount":{"description":"Maximum Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"reference_type":{"$ref":"#/components/schemas/RecurrenceReferenceType"},"periodicity":{"$ref":"#/components/schemas/RecurrencePeriodicity"},"qrcode":{"description":"QR Code data, only present when approval_type 'qrcode' ","nullable":true,"properties":{"hash":{"description":"QR Code Hash","type":"string"},"id":{"description":"QR Code ID","format":"uuid","type":"string"},"type":{"description":"QR Code type","enum":["dynamic","static"],"type":"string"}},"type":"object"},"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string"},"counterparty_info_id":{"description":"Counterparty Info ID","format":"uuid","type":"string"},"counterparty_seq":{"description":"Counterparty Seq","type":"string"}},"type":"object"}},"title":"GenerateRecurrenceResponse","type":"object"},"RecurrenceType":{"description":"Types of recurrence type","enum":["in","out"],"title":"RecurrenceType","type":"string"},"RecurrenceStatus":{"description":"Types of recurrence status","enum":["created","approved","rejected","expired","cancelled"],"title":"RecurrenceStatus","type":"string"},"Journey":{"description":"Types of recurrence journey","enum":["aut1","aut2","aut3","aut4"],"title":"Journey","type":"string"},"RecurrenceRetryPolicy":{"description":"Types of recurrence retry policy","enum":["none","3r_7d"],"title":"RecurrenceRetryPolicy","type":"string"},"RecurrenceReferenceType":{"description":"Recurrence reference types, 'requ' = app, 'qrdn' = dynamicQRCode, 'qres' = staticQRCode","enum":["requ","qrdn","qres"],"title":"RecurrenceReferenceType","type":"string"},"RecurrencePeriodicity":{"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"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}}
```

## List recurrence collections

> List recurrence collections with parameters

```json
{"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cashin/pix/recurrences/collections":{"get":{"callbacks":{},"description":"List recurrence collections with parameters","operationId":"TrioFoundationWeb.Banking.Cashin.Recurrence.CollectionController.index","parameters":[{"description":"Entity Id","in":"query","name":"entity_id","required":false,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Recurrence Id","in":"query","name":"recurrence_id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"From datetime","in":"query","name":"from_datetime","required":true,"schema":{"$ref":"#/components/schemas/DATETIME"}},{"description":"To datetime","in":"query","name":"to_datetime","required":true,"schema":{"$ref":"#/components/schemas/DATETIME"}},{"description":"Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.","in":"query","name":"before","required":false,"schema":{"type":"string"}},{"description":"Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.","in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"Number of registries to be returned","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurrenceCollectionListResponse"}}},"description":"Collections"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"List recurrence collections","tags":["Recurrences"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"DATETIME":{"description":"Datetime schema","format":"date-time","title":"DATETIME","type":"string"},"RecurrenceCollectionListResponse":{"description":"Recurrence collection list response","properties":{"data":{"$ref":"#/components/schemas/RecurrenceCollectionListData"}},"title":"RecurrenceCollectionListResponse","type":"object"},"RecurrenceCollectionListData":{"description":"A list data of automatic recurrence collections","items":{"$ref":"#/components/schemas/RecurrenceCollectionData"},"title":"RecurrenceCollectionListData","type":"array"},"RecurrenceCollectionData":{"description":"A recurrence collection","properties":{"aditional_info":{"description":"Aditional info","type":"string"},"amount":{"properties":{"amount":{"description":"Amount int in cents","type":"integer"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string"},"company_id":{"description":"Company ID","format":"uuid","type":"string"},"counterparty_info_id":{"description":"Counterparty Info ID","format":"uuid","type":"string"},"entity_id":{"description":"Entity ID","format":"uuid","type":"string"},"final_date":{"description":"Final date","format":"date-time","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"next_working_day":{"description":"Next working day","format":"date-time","type":"string"},"org_id":{"description":"Org ID","format":"uuid","type":"string"},"recurrence_id":{"description":"Recurrence ID","format":"uuid","type":"string"},"recurrence_timestamp":{"description":"Recurrence Timestamp","format":"uuid","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"txid":{"description":"TXID","format":"uuid","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual account ID","format":"uuid","type":"string"}},"title":"RecurrenceCollectionData","type":"object"},"RecurrenceStatus":{"description":"Types of recurrence status","enum":["created","approved","rejected","expired","cancelled"],"title":"RecurrenceStatus","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}}
```

## List recurrence collection's attempt

> List recurrence collection's attempt

```json
{"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cashin/pix/recurrences/collections/attempts":{"get":{"callbacks":{},"description":"List recurrence collection's attempt","operationId":"TrioFoundationWeb.Banking.Cashin.Recurrence.Collection.AttemptController.index","parameters":[{"description":"Entity UUID","in":"query","name":"entity_id","required":false,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Recurrence UUID","in":"query","name":"recurrence_id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Collection UUID","in":"query","name":"collection_id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"From datetime","in":"query","name":"from_datetime","required":false,"schema":{"$ref":"#/components/schemas/DATETIME"}},{"description":"To datetime","in":"query","name":"to_datetime","required":false,"schema":{"$ref":"#/components/schemas/DATETIME"}},{"description":"Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.","in":"query","name":"before","required":false,"schema":{"type":"string"}},{"description":"Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.","in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"Number of registries to be returned","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptListResponse"}}},"description":"Collection"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"List recurrence collection's attempt","tags":["Recurrences"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"DATETIME":{"description":"Datetime schema","format":"date-time","title":"DATETIME","type":"string"},"RecurrenceCollectionAttemptListResponse":{"description":"Recurrence collection's attempt list response","properties":{"data":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptListData"}},"title":"RecurrenceCollectionAttemptListResponse","type":"object"},"RecurrenceCollectionAttemptListData":{"description":"A list data of automatic recurrence collection's attempts","items":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptData"},"title":"RecurrenceCollectionAttemptListData","type":"array"},"RecurrenceCollectionAttemptData":{"description":"A recurrence collection attempt","properties":{"collection_id":{"description":"Collection ID","format":"uuid","type":"string"},"collection_timestamp":{"description":"Collection Timestamp","format":"uuid","type":"string"},"due_date":{"description":"Due date","format":"date-time","type":"string"},"end_to_end_id":{"description":"End To End ID","type":"string"},"external_id":{"description":"External ID","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"txid":{"description":"TXID","type":"string"},"type":{"description":"Attempt type","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"}},"title":"RecurrenceCollectionAttemptData","type":"object"},"RecurrenceCollectionAttemptStatus":{"description":"Types of recurrence collection attempt statuses","enum":["requested","scheduled","settled","cancelled","rejected","expired","failed"],"title":"RecurrenceCollectionAttemptStatus","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}}
```

## Get recurrence collection attempt

> Get recurrence collection attempt

```json
{"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cashin/pix/recurrences/collections/attempts/{id}":{"get":{"callbacks":{},"description":"Get recurrence collection attempt","operationId":"TrioFoundationWeb.Banking.Cashin.Recurrence.Collection.AttemptController.show","parameters":[{"description":"Attempt ID","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Entity UUID","in":"query","name":"entity_id","required":false,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Load stages?","in":"query","name":"load_stages","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptResponse"}}},"description":"Collection"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Get recurrence collection attempt","tags":["Recurrences"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"RecurrenceCollectionAttemptResponse":{"description":"Recurrence collection attempt response with stages","properties":{"data":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptData"}},"title":"RecurrenceCollectionAttemptResponse","type":"object"},"RecurrenceCollectionAttemptData":{"description":"A recurrence collection attempt","properties":{"collection_id":{"description":"Collection ID","format":"uuid","type":"string"},"collection_timestamp":{"description":"Collection Timestamp","format":"uuid","type":"string"},"due_date":{"description":"Due date","format":"date-time","type":"string"},"end_to_end_id":{"description":"End To End ID","type":"string"},"external_id":{"description":"External ID","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"txid":{"description":"TXID","type":"string"},"type":{"description":"Attempt type","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"}},"title":"RecurrenceCollectionAttemptData","type":"object"},"RecurrenceCollectionAttemptStatus":{"description":"Types of recurrence collection attempt statuses","enum":["requested","scheduled","settled","cancelled","rejected","expired","failed"],"title":"RecurrenceCollectionAttemptStatus","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}}
```

## Create next collection

> Create next collection

```json
{"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cashin/pix/recurrences/collections/create_next_collection":{"post":{"callbacks":{},"description":"Create next collection","operationId":"TrioFoundationWeb.Banking.Cashin.Recurrence.CollectionController.create_next_collection","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNextCollectionParams"}}},"description":"Create next_collection attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurrenceCollectionResponse"}}},"description":"Collection"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Create next collection","tags":["Recurrences"]}}},"components":{"schemas":{"CreateNextCollectionParams":{"description":"Create NextCollection params","properties":{"recurrence_id":{"description":"Recurrence ID","format":"uuid","type":"string"}},"required":["recurrence_id"],"title":"CreateNextCollectionParams","type":"object"},"RecurrenceCollectionResponse":{"description":"Recurrence collection response with stages and attempts","properties":{"data":{"$ref":"#/components/schemas/RecurrenceCollectionDataWithStages"}},"title":"RecurrenceCollectionResponse","type":"object"},"RecurrenceCollectionDataWithStages":{"description":"A recurrence collection with stages","properties":{"aditional_info":{"description":"Aditional info","type":"string"},"amount":{"properties":{"amount":{"description":"Amount int in cents","type":"integer"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"attempts":{"items":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptData"},"type":"array"},"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string"},"company_id":{"description":"Company ID","format":"uuid","type":"string"},"counterparty_info_id":{"description":"Counterparty Info ID","format":"uuid","type":"string"},"entity_id":{"description":"Entity ID","format":"uuid","type":"string"},"final_date":{"description":"Final date","format":"date-time","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"next_working_day":{"description":"Next working day","format":"date-time","type":"string"},"org_id":{"description":"Org ID","format":"uuid","type":"string"},"recurrence_id":{"description":"Recurrence ID","format":"uuid","type":"string"},"recurrence_timestamp":{"description":"Recurrence Timestamp","format":"uuid","type":"string"},"stages":{"items":{"$ref":"#/components/schemas/RecurrenceCollectionStageData"},"type":"array"},"status":{"$ref":"#/components/schemas/RecurrenceStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"txid":{"description":"TXID","format":"uuid","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual account ID","format":"uuid","type":"string"}},"title":"RecurrenceCollectionDataWithStages","type":"object"},"RecurrenceCollectionAttemptData":{"description":"A recurrence collection attempt","properties":{"collection_id":{"description":"Collection ID","format":"uuid","type":"string"},"collection_timestamp":{"description":"Collection Timestamp","format":"uuid","type":"string"},"due_date":{"description":"Due date","format":"date-time","type":"string"},"end_to_end_id":{"description":"End To End ID","type":"string"},"external_id":{"description":"External ID","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"txid":{"description":"TXID","type":"string"},"type":{"description":"Attempt type","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"}},"title":"RecurrenceCollectionAttemptData","type":"object"},"RecurrenceCollectionAttemptStatus":{"description":"Types of recurrence collection attempt statuses","enum":["requested","scheduled","settled","cancelled","rejected","expired","failed"],"title":"RecurrenceCollectionAttemptStatus","type":"string"},"RecurrenceCollectionStageData":{"description":"A recurrence collection stage","properties":{"amount":{"properties":{"amount":{"description":"Amount int in cents","type":"integer"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string"},"cancelation_code":{"description":"Cancelation code","type":"string"},"cancelation_description":{"description":"Cancelation description","type":"string"},"cancelation_origin":{"description":"Cancelation origin","type":"string"},"collection_id":{"description":"Collection ID","format":"uuid","type":"string"},"collection_timestamp":{"description":"Collection Timestamp","format":"uuid","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"next_working_day":{"description":"Next working day","type":"boolean"},"rejection_code":{"description":"Rejection code","type":"string"},"rejection_description":{"description":"Rejection description","type":"string"},"requester_tax_number":{"description":"Requester tax number","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual account ID","format":"uuid","type":"string"}},"title":"RecurrenceCollectionStageData","type":"object"},"RecurrenceStatus":{"description":"Types of recurrence status","enum":["created","approved","rejected","expired","cancelled"],"title":"RecurrenceStatus","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}}
```

## Get recurrence collection

> Get recurrence collection

```json
{"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cashin/pix/recurrences/collections/{id}":{"get":{"callbacks":{},"description":"Get recurrence collection","operationId":"TrioFoundationWeb.Banking.Cashin.Recurrence.CollectionController.show","parameters":[{"description":"Collection ID","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Entity Id","in":"query","name":"entity_id","required":false,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Bank Account Id","in":"query","name":"bank_account_id","required":false,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Virtual account Id","in":"query","name":"virtual_account_id","required":false,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Load stages?","in":"query","name":"load_stages","required":false,"schema":{"type":"boolean"}},{"description":"Load attempts?","in":"query","name":"load_attempts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurrenceCollectionResponse"}}},"description":"Collection"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Get recurrence collection","tags":["Recurrences"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"RecurrenceCollectionResponse":{"description":"Recurrence collection response with stages and attempts","properties":{"data":{"$ref":"#/components/schemas/RecurrenceCollectionDataWithStages"}},"title":"RecurrenceCollectionResponse","type":"object"},"RecurrenceCollectionDataWithStages":{"description":"A recurrence collection with stages","properties":{"aditional_info":{"description":"Aditional info","type":"string"},"amount":{"properties":{"amount":{"description":"Amount int in cents","type":"integer"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"attempts":{"items":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptData"},"type":"array"},"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string"},"company_id":{"description":"Company ID","format":"uuid","type":"string"},"counterparty_info_id":{"description":"Counterparty Info ID","format":"uuid","type":"string"},"entity_id":{"description":"Entity ID","format":"uuid","type":"string"},"final_date":{"description":"Final date","format":"date-time","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"next_working_day":{"description":"Next working day","format":"date-time","type":"string"},"org_id":{"description":"Org ID","format":"uuid","type":"string"},"recurrence_id":{"description":"Recurrence ID","format":"uuid","type":"string"},"recurrence_timestamp":{"description":"Recurrence Timestamp","format":"uuid","type":"string"},"stages":{"items":{"$ref":"#/components/schemas/RecurrenceCollectionStageData"},"type":"array"},"status":{"$ref":"#/components/schemas/RecurrenceStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"txid":{"description":"TXID","format":"uuid","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual account ID","format":"uuid","type":"string"}},"title":"RecurrenceCollectionDataWithStages","type":"object"},"RecurrenceCollectionAttemptData":{"description":"A recurrence collection attempt","properties":{"collection_id":{"description":"Collection ID","format":"uuid","type":"string"},"collection_timestamp":{"description":"Collection Timestamp","format":"uuid","type":"string"},"due_date":{"description":"Due date","format":"date-time","type":"string"},"end_to_end_id":{"description":"End To End ID","type":"string"},"external_id":{"description":"External ID","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"txid":{"description":"TXID","type":"string"},"type":{"description":"Attempt type","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"}},"title":"RecurrenceCollectionAttemptData","type":"object"},"RecurrenceCollectionAttemptStatus":{"description":"Types of recurrence collection attempt statuses","enum":["requested","scheduled","settled","cancelled","rejected","expired","failed"],"title":"RecurrenceCollectionAttemptStatus","type":"string"},"RecurrenceCollectionStageData":{"description":"A recurrence collection stage","properties":{"amount":{"properties":{"amount":{"description":"Amount int in cents","type":"integer"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string"},"cancelation_code":{"description":"Cancelation code","type":"string"},"cancelation_description":{"description":"Cancelation description","type":"string"},"cancelation_origin":{"description":"Cancelation origin","type":"string"},"collection_id":{"description":"Collection ID","format":"uuid","type":"string"},"collection_timestamp":{"description":"Collection Timestamp","format":"uuid","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"next_working_day":{"description":"Next working day","type":"boolean"},"rejection_code":{"description":"Rejection code","type":"string"},"rejection_description":{"description":"Rejection description","type":"string"},"requester_tax_number":{"description":"Requester tax number","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual account ID","format":"uuid","type":"string"}},"title":"RecurrenceCollectionStageData","type":"object"},"RecurrenceStatus":{"description":"Types of recurrence status","enum":["created","approved","rejected","expired","cancelled"],"title":"RecurrenceStatus","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}}
```

## Update collection Amount

> Update collection Amount by ID

```json
{"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cashin/pix/recurrences/collections/{id}":{"put":{"callbacks":{},"description":"Update collection Amount by ID","operationId":"TrioFoundationWeb.Banking.Cashin.Recurrence.CollectionController.update_amount","parameters":[{"description":"Collection ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionUpdateParams"}}},"description":"The update attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurrenceCollectionResponse"}}},"description":"Collection"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Update collection Amount","tags":["Recurrences"]}}},"components":{"schemas":{"CollectionUpdateParams":{"description":"Collection update params","properties":{"amount":{"description":"Updated amount","type":"integer"}},"required":["amount"],"title":"CollectionUpdateParams","type":"object"},"RecurrenceCollectionResponse":{"description":"Recurrence collection response with stages and attempts","properties":{"data":{"$ref":"#/components/schemas/RecurrenceCollectionDataWithStages"}},"title":"RecurrenceCollectionResponse","type":"object"},"RecurrenceCollectionDataWithStages":{"description":"A recurrence collection with stages","properties":{"aditional_info":{"description":"Aditional info","type":"string"},"amount":{"properties":{"amount":{"description":"Amount int in cents","type":"integer"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"attempts":{"items":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptData"},"type":"array"},"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string"},"company_id":{"description":"Company ID","format":"uuid","type":"string"},"counterparty_info_id":{"description":"Counterparty Info ID","format":"uuid","type":"string"},"entity_id":{"description":"Entity ID","format":"uuid","type":"string"},"final_date":{"description":"Final date","format":"date-time","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"next_working_day":{"description":"Next working day","format":"date-time","type":"string"},"org_id":{"description":"Org ID","format":"uuid","type":"string"},"recurrence_id":{"description":"Recurrence ID","format":"uuid","type":"string"},"recurrence_timestamp":{"description":"Recurrence Timestamp","format":"uuid","type":"string"},"stages":{"items":{"$ref":"#/components/schemas/RecurrenceCollectionStageData"},"type":"array"},"status":{"$ref":"#/components/schemas/RecurrenceStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"txid":{"description":"TXID","format":"uuid","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual account ID","format":"uuid","type":"string"}},"title":"RecurrenceCollectionDataWithStages","type":"object"},"RecurrenceCollectionAttemptData":{"description":"A recurrence collection attempt","properties":{"collection_id":{"description":"Collection ID","format":"uuid","type":"string"},"collection_timestamp":{"description":"Collection Timestamp","format":"uuid","type":"string"},"due_date":{"description":"Due date","format":"date-time","type":"string"},"end_to_end_id":{"description":"End To End ID","type":"string"},"external_id":{"description":"External ID","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"txid":{"description":"TXID","type":"string"},"type":{"description":"Attempt type","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"}},"title":"RecurrenceCollectionAttemptData","type":"object"},"RecurrenceCollectionAttemptStatus":{"description":"Types of recurrence collection attempt statuses","enum":["requested","scheduled","settled","cancelled","rejected","expired","failed"],"title":"RecurrenceCollectionAttemptStatus","type":"string"},"RecurrenceCollectionStageData":{"description":"A recurrence collection stage","properties":{"amount":{"properties":{"amount":{"description":"Amount int in cents","type":"integer"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string"},"cancelation_code":{"description":"Cancelation code","type":"string"},"cancelation_description":{"description":"Cancelation description","type":"string"},"cancelation_origin":{"description":"Cancelation origin","type":"string"},"collection_id":{"description":"Collection ID","format":"uuid","type":"string"},"collection_timestamp":{"description":"Collection Timestamp","format":"uuid","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"next_working_day":{"description":"Next working day","type":"boolean"},"rejection_code":{"description":"Rejection code","type":"string"},"rejection_description":{"description":"Rejection description","type":"string"},"requester_tax_number":{"description":"Requester tax number","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual account ID","format":"uuid","type":"string"}},"title":"RecurrenceCollectionStageData","type":"object"},"RecurrenceStatus":{"description":"Types of recurrence status","enum":["created","approved","rejected","expired","cancelled"],"title":"RecurrenceStatus","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}}
```

## Cancel collection

> Cancel collection by ID

```json
{"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cashin/pix/recurrences/collections/{id}/cancel":{"post":{"callbacks":{},"description":"Cancel collection by ID","operationId":"TrioFoundationWeb.Banking.Cashin.Recurrence.CollectionController.cancel","parameters":[{"description":"Collection ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelCollectionParams"}}},"description":"The collection cancel attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurrenceCollectionResponse"}}},"description":"Collection"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Cancel collection","tags":["Recurrences"]}}},"components":{"schemas":{"CancelCollectionParams":{"description":"Cancel collection params with ID","properties":{"entity_id":{"description":"Entity ID","format":"uuid","type":"string"},"requester_tax_number":{"description":"Requester Tax Number","type":"string"}},"required":["requester_tax_number"],"title":"CancelCollectionParams","type":"object"},"RecurrenceCollectionResponse":{"description":"Recurrence collection response with stages and attempts","properties":{"data":{"$ref":"#/components/schemas/RecurrenceCollectionDataWithStages"}},"title":"RecurrenceCollectionResponse","type":"object"},"RecurrenceCollectionDataWithStages":{"description":"A recurrence collection with stages","properties":{"aditional_info":{"description":"Aditional info","type":"string"},"amount":{"properties":{"amount":{"description":"Amount int in cents","type":"integer"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"attempts":{"items":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptData"},"type":"array"},"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string"},"company_id":{"description":"Company ID","format":"uuid","type":"string"},"counterparty_info_id":{"description":"Counterparty Info ID","format":"uuid","type":"string"},"entity_id":{"description":"Entity ID","format":"uuid","type":"string"},"final_date":{"description":"Final date","format":"date-time","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"next_working_day":{"description":"Next working day","format":"date-time","type":"string"},"org_id":{"description":"Org ID","format":"uuid","type":"string"},"recurrence_id":{"description":"Recurrence ID","format":"uuid","type":"string"},"recurrence_timestamp":{"description":"Recurrence Timestamp","format":"uuid","type":"string"},"stages":{"items":{"$ref":"#/components/schemas/RecurrenceCollectionStageData"},"type":"array"},"status":{"$ref":"#/components/schemas/RecurrenceStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"txid":{"description":"TXID","format":"uuid","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual account ID","format":"uuid","type":"string"}},"title":"RecurrenceCollectionDataWithStages","type":"object"},"RecurrenceCollectionAttemptData":{"description":"A recurrence collection attempt","properties":{"collection_id":{"description":"Collection ID","format":"uuid","type":"string"},"collection_timestamp":{"description":"Collection Timestamp","format":"uuid","type":"string"},"due_date":{"description":"Due date","format":"date-time","type":"string"},"end_to_end_id":{"description":"End To End ID","type":"string"},"external_id":{"description":"External ID","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"txid":{"description":"TXID","type":"string"},"type":{"description":"Attempt type","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"}},"title":"RecurrenceCollectionAttemptData","type":"object"},"RecurrenceCollectionAttemptStatus":{"description":"Types of recurrence collection attempt statuses","enum":["requested","scheduled","settled","cancelled","rejected","expired","failed"],"title":"RecurrenceCollectionAttemptStatus","type":"string"},"RecurrenceCollectionStageData":{"description":"A recurrence collection stage","properties":{"amount":{"properties":{"amount":{"description":"Amount int in cents","type":"integer"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string"},"cancelation_code":{"description":"Cancelation code","type":"string"},"cancelation_description":{"description":"Cancelation description","type":"string"},"cancelation_origin":{"description":"Cancelation origin","type":"string"},"collection_id":{"description":"Collection ID","format":"uuid","type":"string"},"collection_timestamp":{"description":"Collection Timestamp","format":"uuid","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"next_working_day":{"description":"Next working day","type":"boolean"},"rejection_code":{"description":"Rejection code","type":"string"},"rejection_description":{"description":"Rejection description","type":"string"},"requester_tax_number":{"description":"Requester tax number","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceCollectionAttemptStatus"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"transaction_date":{"description":"Transaction date","format":"date-time","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual account ID","format":"uuid","type":"string"}},"title":"RecurrenceCollectionStageData","type":"object"},"RecurrenceStatus":{"description":"Types of recurrence status","enum":["created","approved","rejected","expired","cancelled"],"title":"RecurrenceStatus","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}}
```

## Schedule collection

> Schedule collection

```json
{"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cashin/pix/recurrences/collections/{id}/schedule":{"post":{"callbacks":{},"description":"Schedule collection","operationId":"TrioFoundationWeb.Banking.Cashin.Recurrence.CollectionController.schedule","parameters":[{"description":"Collection ID","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionScheduleParams"}}},"description":"The collection schedule attributes","required":true},"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP204NoContent"}}},"description":"No Content"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Schedule collection","tags":["Recurrences"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"CollectionScheduleParams":{"description":"Schedule update params","properties":{"amount":{"description":"Collection Amount in cents. Use it for updating the collection amount before scheduling. Does not work on recurrences with fixed amount.","type":"integer"},"due_date":{"description":"attempt's due date","format":"date-time","nullable":true,"type":"string"},"external_id":{"description":"attempt's external_id","nullable":true,"type":"string"}},"title":"CollectionScheduleParams","type":"object"},"HTTP204NoContent":{"format":"string","title":"HTTP204NoContent","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}}
```

## Get recurrence request

> Get recurrence request

```json
{"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cashin/pix/recurrences/requests/{id}":{"get":{"callbacks":{},"description":"Get recurrence request","operationId":"TrioFoundationWeb.Banking.Cashin.Recurrence.RequestController.show","parameters":[{"description":"Request ID","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Entity Id","in":"query","name":"entity_id","required":false,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Bank Account Id","in":"query","name":"bank_account_id","required":false,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Virtual Account Id","in":"query","name":"virtual_account_id","required":false,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Load stages?","in":"query","name":"load_stages","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurrenceRequestResponse"}}},"description":"Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Get recurrence request","tags":["Recurrences"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"RecurrenceRequestResponse":{"description":"Recurrence Request response","properties":{"data":{"$ref":"#/components/schemas/RecurrenceRequestData"}},"title":"RecurrenceRequestResponse","type":"object"},"RecurrenceRequestData":{"description":"A recurrence Request","properties":{"counterparty_bank_account_id":{"description":"Counterparty bank account ID","format":"uuid","type":"string"},"counterparty_id":{"description":"Counterparty ID","format":"uuid","type":"string"},"counterparty_seq":{"description":"Counterparty sequence","type":"integer"},"expiration_date":{"description":"Expiration date","format":"date-time","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"id_solic_rec":{"description":"Recurrence Request Identification","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"recurrence_id":{"description":"Recurrence ID","format":"uuid","type":"string"},"recurrence_timestamp":{"description":"Recurrence Timestamp","format":"uuid","type":"string"},"status":{"description":"Status of the recurrence request","enum":["created","sent","received","rejected","accepted","expired","cancelled"],"type":"string"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"}},"title":"RecurrenceRequestData","type":"object"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}}
```

## Get recurrence

> Get recurrence with stages

```json
{"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cashin/pix/recurrences/{id}":{"get":{"callbacks":{},"description":"Get recurrence with stages","operationId":"TrioFoundationWeb.Banking.Cashin.RecurrenceController.show","parameters":[{"description":"Recurrence Id","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Entity Id","in":"query","name":"entity_id","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Bank Account Id","in":"query","name":"bank_account_id","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Virtual account Id","in":"query","name":"virtual_account_id","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Load stages?","in":"query","name":"load_stages","required":false,"schema":{"type":"boolean"}},{"description":"Load requests?","in":"query","name":"load_requests","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurrenceResponse"}}},"description":"Recurrence"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Get recurrence","tags":["Recurrences"]}}},"components":{"schemas":{"RecurrenceResponse":{"description":"Recurrence response with stages","properties":{"data":{"$ref":"#/components/schemas/DataWithStageAndRequest"}},"title":"RecurrenceResponse","type":"object"},"DataWithStageAndRequest":{"description":"Data with Stage and Request","properties":{"counterparty_bank_account_id":{"description":"Counterparty Bank Account ID","format":"uuid","type":"string"},"start_date":{"description":"Recurrence Start Date","format":"date-time","type":"string"},"counterparty_id":{"description":"Counterparty ID","format":"uuid","type":"string"},"stages":{"items":{"$ref":"#/components/schemas/RecurrenceStageData"},"type":"array"},"inserted_at":{"description":"Inserted At","format":"date-time","type":"string"},"requests":{"items":{"$ref":"#/components/schemas/RecurrenceRequestData"},"type":"array"},"type":{"$ref":"#/components/schemas/RecurrenceType"},"entity_id":{"description":"Entity ID","format":"uuid","type":"string"},"reference_id":{"description":"Reference ID","format":"uuid","type":"string"},"minimum_amount":{"description":"Minimum Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"ispb":{"description":"ISPB","type":"string"},"first_payment_date":{"description":"First Payment Date","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual Account ID","format":"uuid","type":"string"},"number_of_collections":{"description":"Number Of Collections","type":"string"},"company_id":{"description":"Company ID","format":"uuid","type":"string"},"automatic_schedule":{"description":"Automated Collecting","type":"string"},"end_date":{"description":"Recurrence End Date","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceStatus"},"updated_at":{"description":"Updated At","format":"date-time","type":"string"},"next_working_day":{"description":"Next Working Day","type":"string"},"description":{"description":"Description","type":"string"},"id":{"description":"Recurrence ID","format":"uuid","type":"string"},"id_rec":{"description":"ID Rec","type":"string"},"fixed_amount":{"description":"Fixed Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"contract_number":{"description":"Contract Number","type":"string"},"txid":{"description":"Txid","type":"string"},"journey":{"$ref":"#/components/schemas/Journey"},"external_id":{"description":"External ID","format":"uuid","type":"string"},"authorization_date":{"description":"Authorization Date","format":"date-time","type":"string"},"retry_policy":{"$ref":"#/components/schemas/RecurrenceRetryPolicy"},"timestamp":{"description":"Timestamp","type":"string"},"origin_id":{"description":"Origin ID","format":"uuid","type":"string"},"org_id":{"description":"Org ID","format":"uuid","type":"string"},"first_payment_amount":{"description":"First payment Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"maximum_amount":{"description":"Maximum Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"reference_type":{"$ref":"#/components/schemas/RecurrenceReferenceType"},"periodicity":{"$ref":"#/components/schemas/RecurrencePeriodicity"},"origin_type":{"$ref":"#/components/schemas/RecurrenceOrigintype"},"update_date":{"description":"Update Date","format":"date-time","type":"string"},"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string"},"counterparty_info_id":{"description":"Counterparty Info ID","format":"uuid","type":"string"},"counterparty_seq":{"description":"Counterparty Seq","type":"string"}},"title":"DataWithStageAndRequest","type":"object"},"RecurrenceStageData":{"description":"Stage of a recurrence","properties":{"cancelation_code":{"description":"Cancelation Code","type":"string"},"cancelation_description":{"description":"Cancelation Description","type":"string"},"cancelation_origin":{"description":"Cancelation Origin","type":"string"},"collection_id":{"description":"Collection ID","format":"uuid","type":"string"},"collection_timestamp":{"description":"Collection Timestamp","format":"date-time","type":"string"},"error_code":{"description":"Error Code","type":"string"},"error_message":{"description":"Error Message","type":"string"},"id":{"description":"Recurrence ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted At","format":"date-time","type":"string"},"journey":{"$ref":"#/components/schemas/Journey"},"recurrence_id":{"description":"Recurrence ID","format":"uuid","type":"string"},"reference_id":{"description":"Reference ID","format":"uuid","type":"string"},"reference_type":{"$ref":"#/components/schemas/RecurrenceReferenceType"},"rejection_code":{"description":"Rejection Code","type":"string"},"rejection_description":{"description":"Rejection Description","type":"string"},"request_id":{"description":"Request ID","format":"uuid","type":"string"},"request_timestamp":{"description":"Request Timestamp","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceStatus"},"timestamp":{"description":"Timestamp","type":"string"},"updated_at":{"description":"Updated At","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual Account ID","format":"uuid","type":"string"}},"title":"RecurrenceStageData","type":"object"},"Journey":{"description":"Types of recurrence journey","enum":["aut1","aut2","aut3","aut4"],"title":"Journey","type":"string"},"RecurrenceReferenceType":{"description":"Recurrence reference types, 'requ' = app, 'qrdn' = dynamicQRCode, 'qres' = staticQRCode","enum":["requ","qrdn","qres"],"title":"RecurrenceReferenceType","type":"string"},"RecurrenceStatus":{"description":"Types of recurrence status","enum":["created","approved","rejected","expired","cancelled"],"title":"RecurrenceStatus","type":"string"},"RecurrenceRequestData":{"description":"A recurrence Request","properties":{"counterparty_bank_account_id":{"description":"Counterparty bank account ID","format":"uuid","type":"string"},"counterparty_id":{"description":"Counterparty ID","format":"uuid","type":"string"},"counterparty_seq":{"description":"Counterparty sequence","type":"integer"},"expiration_date":{"description":"Expiration date","format":"date-time","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"id_solic_rec":{"description":"Recurrence Request Identification","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"recurrence_id":{"description":"Recurrence ID","format":"uuid","type":"string"},"recurrence_timestamp":{"description":"Recurrence Timestamp","format":"uuid","type":"string"},"status":{"description":"Status of the recurrence request","enum":["created","sent","received","rejected","accepted","expired","cancelled"],"type":"string"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"}},"title":"RecurrenceRequestData","type":"object"},"RecurrenceType":{"description":"Types of recurrence type","enum":["in","out"],"title":"RecurrenceType","type":"string"},"RecurrenceRetryPolicy":{"description":"Types of recurrence retry policy","enum":["none","3r_7d"],"title":"RecurrenceRetryPolicy","type":"string"},"RecurrencePeriodicity":{"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"},"RecurrenceOrigintype":{"description":"Origin Types of recurrence","enum":["none","api_client","console_user","billing","reconciliation","checkout","bridge"],"title":"RecurrenceOrigintype","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}}
```

## Cancel recurrence

> Cancel recurrence by ID

```json
{"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cashin/pix/recurrences/{id}/cancel":{"post":{"callbacks":{},"description":"Cancel recurrence by ID","operationId":"TrioFoundationWeb.Banking.Cashin.RecurrenceController.cancel","parameters":[{"description":"Recurrence ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelRecurrenceParams"}}},"description":"The recurrence cancel attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurrenceResponse"}}},"description":"Recurrence"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Cancel recurrence","tags":["Recurrences"]}}},"components":{"schemas":{"CancelRecurrenceParams":{"description":"Cancel recurrence params with ID","properties":{"requester_tax_number":{"description":"Requester Tax Number","type":"string"}},"required":["requester_tax_number"],"title":"CancelRecurrenceParams","type":"object"},"RecurrenceResponse":{"description":"Recurrence response with stages","properties":{"data":{"$ref":"#/components/schemas/DataWithStageAndRequest"}},"title":"RecurrenceResponse","type":"object"},"DataWithStageAndRequest":{"description":"Data with Stage and Request","properties":{"counterparty_bank_account_id":{"description":"Counterparty Bank Account ID","format":"uuid","type":"string"},"start_date":{"description":"Recurrence Start Date","format":"date-time","type":"string"},"counterparty_id":{"description":"Counterparty ID","format":"uuid","type":"string"},"stages":{"items":{"$ref":"#/components/schemas/RecurrenceStageData"},"type":"array"},"inserted_at":{"description":"Inserted At","format":"date-time","type":"string"},"requests":{"items":{"$ref":"#/components/schemas/RecurrenceRequestData"},"type":"array"},"type":{"$ref":"#/components/schemas/RecurrenceType"},"entity_id":{"description":"Entity ID","format":"uuid","type":"string"},"reference_id":{"description":"Reference ID","format":"uuid","type":"string"},"minimum_amount":{"description":"Minimum Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"ispb":{"description":"ISPB","type":"string"},"first_payment_date":{"description":"First Payment Date","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual Account ID","format":"uuid","type":"string"},"number_of_collections":{"description":"Number Of Collections","type":"string"},"company_id":{"description":"Company ID","format":"uuid","type":"string"},"automatic_schedule":{"description":"Automated Collecting","type":"string"},"end_date":{"description":"Recurrence End Date","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceStatus"},"updated_at":{"description":"Updated At","format":"date-time","type":"string"},"next_working_day":{"description":"Next Working Day","type":"string"},"description":{"description":"Description","type":"string"},"id":{"description":"Recurrence ID","format":"uuid","type":"string"},"id_rec":{"description":"ID Rec","type":"string"},"fixed_amount":{"description":"Fixed Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"contract_number":{"description":"Contract Number","type":"string"},"txid":{"description":"Txid","type":"string"},"journey":{"$ref":"#/components/schemas/Journey"},"external_id":{"description":"External ID","format":"uuid","type":"string"},"authorization_date":{"description":"Authorization Date","format":"date-time","type":"string"},"retry_policy":{"$ref":"#/components/schemas/RecurrenceRetryPolicy"},"timestamp":{"description":"Timestamp","type":"string"},"origin_id":{"description":"Origin ID","format":"uuid","type":"string"},"org_id":{"description":"Org ID","format":"uuid","type":"string"},"first_payment_amount":{"description":"First payment Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"maximum_amount":{"description":"Maximum Amount","properties":{"amount":{"description":"Amount integer in cents","type":"string"},"currency":{"description":"Amount currency","type":"string"}},"type":"object"},"reference_type":{"$ref":"#/components/schemas/RecurrenceReferenceType"},"periodicity":{"$ref":"#/components/schemas/RecurrencePeriodicity"},"origin_type":{"$ref":"#/components/schemas/RecurrenceOrigintype"},"update_date":{"description":"Update Date","format":"date-time","type":"string"},"bank_account_id":{"description":"Bank Account ID","format":"uuid","type":"string"},"counterparty_info_id":{"description":"Counterparty Info ID","format":"uuid","type":"string"},"counterparty_seq":{"description":"Counterparty Seq","type":"string"}},"title":"DataWithStageAndRequest","type":"object"},"RecurrenceStageData":{"description":"Stage of a recurrence","properties":{"cancelation_code":{"description":"Cancelation Code","type":"string"},"cancelation_description":{"description":"Cancelation Description","type":"string"},"cancelation_origin":{"description":"Cancelation Origin","type":"string"},"collection_id":{"description":"Collection ID","format":"uuid","type":"string"},"collection_timestamp":{"description":"Collection Timestamp","format":"date-time","type":"string"},"error_code":{"description":"Error Code","type":"string"},"error_message":{"description":"Error Message","type":"string"},"id":{"description":"Recurrence ID","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted At","format":"date-time","type":"string"},"journey":{"$ref":"#/components/schemas/Journey"},"recurrence_id":{"description":"Recurrence ID","format":"uuid","type":"string"},"reference_id":{"description":"Reference ID","format":"uuid","type":"string"},"reference_type":{"$ref":"#/components/schemas/RecurrenceReferenceType"},"rejection_code":{"description":"Rejection Code","type":"string"},"rejection_description":{"description":"Rejection Description","type":"string"},"request_id":{"description":"Request ID","format":"uuid","type":"string"},"request_timestamp":{"description":"Request Timestamp","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RecurrenceStatus"},"timestamp":{"description":"Timestamp","type":"string"},"updated_at":{"description":"Updated At","format":"date-time","type":"string"},"virtual_account_id":{"description":"Virtual Account ID","format":"uuid","type":"string"}},"title":"RecurrenceStageData","type":"object"},"Journey":{"description":"Types of recurrence journey","enum":["aut1","aut2","aut3","aut4"],"title":"Journey","type":"string"},"RecurrenceReferenceType":{"description":"Recurrence reference types, 'requ' = app, 'qrdn' = dynamicQRCode, 'qres' = staticQRCode","enum":["requ","qrdn","qres"],"title":"RecurrenceReferenceType","type":"string"},"RecurrenceStatus":{"description":"Types of recurrence status","enum":["created","approved","rejected","expired","cancelled"],"title":"RecurrenceStatus","type":"string"},"RecurrenceRequestData":{"description":"A recurrence Request","properties":{"counterparty_bank_account_id":{"description":"Counterparty bank account ID","format":"uuid","type":"string"},"counterparty_id":{"description":"Counterparty ID","format":"uuid","type":"string"},"counterparty_seq":{"description":"Counterparty sequence","type":"integer"},"expiration_date":{"description":"Expiration date","format":"date-time","type":"string"},"id":{"description":"ID","format":"uuid","type":"string"},"id_solic_rec":{"description":"Recurrence Request Identification","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"recurrence_id":{"description":"Recurrence ID","format":"uuid","type":"string"},"recurrence_timestamp":{"description":"Recurrence Timestamp","format":"uuid","type":"string"},"status":{"description":"Status of the recurrence request","enum":["created","sent","received","rejected","accepted","expired","cancelled"],"type":"string"},"timestamp":{"description":"Timestamp","format":"uuid","type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"}},"title":"RecurrenceRequestData","type":"object"},"RecurrenceType":{"description":"Types of recurrence type","enum":["in","out"],"title":"RecurrenceType","type":"string"},"RecurrenceRetryPolicy":{"description":"Types of recurrence retry policy","enum":["none","3r_7d"],"title":"RecurrenceRetryPolicy","type":"string"},"RecurrencePeriodicity":{"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"},"RecurrenceOrigintype":{"description":"Origin Types of recurrence","enum":["none","api_client","console_user","billing","reconciliation","checkout","bridge"],"title":"RecurrenceOrigintype","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.trio.com.br/api_reference/banking-api/collecting/recurrences.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.