> ## Documentation Index > Fetch the complete documentation index at: https://docs.trio.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Generate a Recurrence > Generate a recurrence ## OpenAPI ````yaml v2/api-reference/openapi.json POST /v2/in/pix/recurrences openapi: 3.0.0 info: title: Trio API v2 version: 2026-10-19.v2 servers: - url: https://api.sandbox.trio.com.br variables: {} - url: https://api.qa.trio.com.br variables: {} - url: https://api.trio.com.br variables: {} security: [] tags: [] paths: /v2/in/pix/recurrences: parameters: - description: >- Version of the v2 contract the client is written against. Each breaking change publishes a new version. example: 2026-10-19.v2 in: header name: Trio-Version required: true schema: enum: - 2026-10-19.v2 type: string x-struct: null x-validate: null - description: >- ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org. in: header name: Trio-Target-Org-Id required: false schema: format: uuid type: string x-struct: null x-validate: null post: tags: - Receivables (in) - Recurrences summary: Generate a recurrence description: Generate a recurrence operationId: TrioFoundationWeb.V2.In.Pix.RecurrenceController.generate parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/V2_GenerateRecurrenceParameters' description: The recurrence generate attributes required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/V2_GenerateRecurrenceResponse' description: Generate Recurrence Response '400': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: >- Malformed request: a body that is not valid JSON (MALFORMED_REQUEST), or a Trio-Version header that is missing or not the current one (INVALID_TRIO_VERSION). '401': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: Missing or invalid API key credentials (INVALID_CREDENTIALS). '403': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: >- The API key may not do this (FORBIDDEN): for instance Trio-Target-Org-Id names an org it has no access to, or writes through a read-only access. '422': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: >- Invalid input (INVALID_PARAMETER, REQUIRED_PARAMETER, or the code of the rule the request breaks). A request outside the operation's schema lists the offending fields in `errors`. '503': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: >- A service needed to answer is unavailable (TRIO_SERVICE_UNAVAILABLE). callbacks: {} security: - authorization: [] components: schemas: V2_GenerateRecurrenceParameters: description: GenerateRecurrenceParameters example: amounts: minimum: 100 bank_account_id: 019f4198-8913-1ec9-52c6-706c618a1c5d contract_number: '123456789' counterparty: bank_account: branch: '1234' digit: '1' ispb: '12345678' number: '123456' name: Payer Name tax_number: '12345678000100' description: Monthly payment for services external_id: external_id_123 first_payment: amount: 100 dict_key: pixkey@mail.com due_detail: discount: per_day_antecipated: amount: 2 calculation_days: working calculation_type: amount due_date: '2026-10-30' fine: calculation_type: percentage value: 10 interest: amount: 20 calculation_days: calendar calculation_period: month calculation_type: amount rebate: calculation_type: percentage value: 50 options: authorization_type: app automated_attempt_retry: false automatic_schedule: false next_working_day: true qrcode_expiration_seconds: 86400 retry_policy: 3r_7d periodicity: mnth start_date: '2026-10-25' properties: 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 x-struct: null x-validate: null minimum: description: Minimum Amount in cents, used for variable amount recurrences nullable: true type: integer x-struct: null x-validate: null type: object x-struct: null x-validate: null bank_account_id: description: Bank Account ID format: uuid type: string x-struct: null x-validate: null contract_number: description: Contract Number maxLength: 35 type: string x-struct: null x-validate: null 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 x-struct: null x-validate: null digit: description: Counterparty Bank Account Digit pattern: ^[0-9]$ type: string x-struct: null x-validate: null ispb: description: Counterparty Bank Account ISPB pattern: ^[0-9]{8}$ type: string x-struct: null x-validate: null number: description: Counterparty Bank Account Number pattern: ^[0-9]+$ type: string x-struct: null x-validate: null required: - ispb - number - branch - digit type: object x-struct: null x-validate: null info: description: Counterparty Info nullable: true properties: address: description: Counterparty Address nullable: true type: string x-struct: null x-validate: null city: description: Counterparty City nullable: true type: string x-struct: null x-validate: null email: description: Counterparty Email nullable: true type: string x-struct: null x-validate: null postal_code: description: Counterparty Postal Code nullable: true type: string x-struct: null x-validate: null state: description: Counterparty State nullable: true type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null name: description: Counterparty Name type: string x-struct: null x-validate: null tax_number: description: Counterparty Tax Number type: string x-struct: null x-validate: null required: - tax_number - name type: object x-struct: null x-validate: null description: description: Description maxLength: 35 type: string x-struct: null x-validate: null end_date: description: Last day of the recurrence format: date nullable: true type: string x-struct: null x-validate: null external_id: description: Recurrence External ID nullable: true type: string x-struct: null x-validate: null first_payment: $ref: '#/components/schemas/V2_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 x-struct: null x-validate: null automated_attempt_retry: default: true description: >- Automated Attempt Retry. If not set, all the attempts retries should be scheduled each time after the previous one is not settled. i.e. if the attempt is not settled, the next attempt needs to be rescheduled. If the parameter is true, it will be done automatically nullable: true type: boolean x-struct: null x-validate: null 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 x-struct: null x-validate: null next_working_day: default: false description: >- Do not bill on Holidays, bill on the counterparty's next working day nullable: true type: boolean x-struct: null x-validate: null 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 x-struct: null x-validate: null 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 x-struct: null x-validate: null type: object x-struct: null x-validate: null periodicity: description: >- 'week': every week, 'mnth': every month, 'qurt': every 3 months, 'mian': every 6 months, 'year': every year enum: - week - mnth - qurt - mian - year type: string x-struct: null x-validate: null start_date: description: First day of the recurrence format: date type: string x-struct: null x-validate: null required: - bank_account_id - counterparty - description - periodicity - contract_number - start_date title: V2 GenerateRecurrenceParameters type: object x-struct: >- Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.GenerateRecurrenceParams x-validate: null V2_GenerateRecurrenceResponse: description: >- The created recurrence, plus the QRCode the payer authorizes it through (null when the journey has none) example: data: amounts: fixed: amount: 10000 currency: BRL maximum: null minimum: null authorized_at: null bank_account_id: 019f4198-8913-1ec9-52c6-706c618a1c5d contract_number: '0001' counterparty: bank_account: id: 49521ece-9203-07f7-7767-e32734e5b636 id: 49521ece-9203-186b-cfc7-281c207f7f52 description: Test Recurrence end_date: null external_id: null first_payment: amount: null date: '2026-07-10' id: 019f4198-9f53-8f20-a167-5242b634311d inserted_at: '2026-07-08T11:59:09.140530Z' number_of_collections: null options: automatic_schedule: true next_working_day: true retry_policy: none origin: id: 019f4198-9de7-4ba7-d718-5e9fce7cbccb type: api_client periodicity: week qrcode: hash: 00020101021226630014br.gov.bcb.pix...6304B527 id: 019f4198-9f53-0000-0000-000000000001 type: dynamic reference: id: null type: qrdn start_date: '2026-07-08' status: created type: in updated_at: '2026-07-08T11:59:09.140530Z' properties: data: properties: amounts: description: >- Amounts of the recurrence: `fixed` for fixed amount recurrences, `minimum` (set by the receiver) and `maximum` (set by the payer) for variable ones properties: fixed: $ref: '#/components/schemas/V2_RecurrenceAmount' maximum: $ref: '#/components/schemas/V2_RecurrenceAmount' minimum: $ref: '#/components/schemas/V2_RecurrenceAmount' type: object x-struct: null x-validate: null authorized_at: description: When the payer authorized the recurrence format: date-time nullable: true type: string x-struct: null x-validate: null bank_account_id: description: Bank account that receives the collections format: uuid type: string x-struct: null x-validate: null contract_number: description: Contract number nullable: true type: string x-struct: null x-validate: null counterparty: description: Payer of the recurrence properties: bank_account: description: Payer bank account properties: id: description: Counterparty bank account ID format: uuid nullable: true type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null id: description: Counterparty ID format: uuid nullable: true type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null description: description: Description nullable: true type: string x-struct: null x-validate: null end_date: description: Last day of the recurrence format: date nullable: true type: string x-struct: null x-validate: null external_id: description: External ID nullable: true type: string x-struct: null x-validate: null first_payment: description: First payment of the recurrence properties: amount: $ref: '#/components/schemas/V2_RecurrenceAmount' date: description: Day of the first payment format: date nullable: true type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null id: description: Recurrence ID format: uuid type: string x-struct: null x-validate: null inserted_at: description: When the recurrence was created format: date-time type: string x-struct: null x-validate: null number_of_collections: description: Number of collections nullable: true type: integer x-struct: null x-validate: null options: description: Recurrence options properties: automatic_schedule: description: Whether collections are scheduled automatically type: boolean x-struct: null x-validate: null next_working_day: description: >- Whether collections falling on a non-working day move to the next one type: boolean x-struct: null x-validate: null retry_policy: $ref: '#/components/schemas/RecurrenceRetryPolicy' type: object x-struct: null x-validate: null origin: description: Who or what created the recurrence properties: id: description: Origin ID format: uuid nullable: true type: string x-struct: null x-validate: null type: description: Origin type nullable: true type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null periodicity: $ref: '#/components/schemas/RecurrencePeriodicity' qrcode: description: QRCode the payer authorizes the recurrence through nullable: true properties: hash: description: QRCode hash (Pix copy and paste) type: string x-struct: null x-validate: null id: description: QRCode ID format: uuid type: string x-struct: null x-validate: null type: description: QRCode type type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null reference: description: What the recurrence was created from properties: id: description: Reference ID format: uuid nullable: true type: string x-struct: null x-validate: null type: description: Reference type enum: - requ - qrdn - qres nullable: true type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null start_date: description: First day of the recurrence format: date type: string x-struct: null x-validate: null status: $ref: '#/components/schemas/RecurrenceStatus' type: $ref: '#/components/schemas/RecurrenceType' updated_at: description: When the recurrence was last updated format: date-time type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null title: V2 GenerateRecurrenceResponse type: object x-struct: >- Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.GenerateResponse x-validate: null V2_error: example: error: error_code: INVALID_PARAMETER error_message: 'Invalid parameters: /amount: Invalid integer. Got: string' errors: - field: /amount message: 'Invalid integer. Got: string' properties: error: properties: error_code: description: >- Stable UPPER_SNAKE identifier of the error, for programs and logs. Branch on this, not on the message. type: string x-struct: null x-validate: null error_message: description: Human readable explanation of the error. type: string x-struct: null x-validate: null errors: description: >- Only on INVALID_PARAMETER for a request outside the operation's schema: one entry per offending field. items: properties: field: description: JSON pointer to the field, e.g. /amount. type: string x-struct: null x-validate: null message: description: What is wrong with it. type: string x-struct: null x-validate: null required: - field - message type: object x-struct: null x-validate: null type: array x-struct: null x-validate: null required: - error_code - error_message type: object x-struct: null x-validate: null required: - error title: V2 error type: object x-struct: Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error x-validate: null V2_FirstPaymentWithDueDetail: description: Schema for the first payment with due detail nullable: true properties: amount: description: First Payment amount in cents minimum: 1 nullable: true type: integer x-struct: null x-validate: null dict_key: description: Bank Account Pix Key nullable: true type: string x-struct: null x-validate: null due_detail: $ref: '#/components/schemas/V2_PixDueDetailParams' 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 x-struct: null x-validate: null title: V2 FirstPaymentWithDueDetail type: object x-struct: null x-validate: null V2_RecurrenceAmount: description: An amount in cents example: amount: 10000 currency: BRL nullable: true properties: amount: description: Amount in cents type: integer x-struct: null x-validate: null currency: description: Currency type: string x-struct: null x-validate: null title: V2 RecurrenceAmount type: object x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Amount x-validate: null RecurrenceRetryPolicy: description: Types of recurrence retry policy enum: - none - 3r_7d title: RecurrenceRetryPolicy type: string x-struct: null x-validate: null 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 x-struct: null x-validate: null RecurrenceStatus: description: Types of recurrence status enum: - created - approved - rejected - expired - cancelled title: RecurrenceStatus type: string x-struct: null x-validate: null RecurrenceType: description: Types of recurrence type enum: - in - out title: RecurrenceType type: string x-struct: null x-validate: null V2_PixDueDetailParams: description: >- Due detail of a Pix charge with due date. Each rule takes `amount` (cents) for the `amount` calculation type and `value` (basis points, 100 = 1%) for `percentage`. example: discount: per_day_antecipated: amount: 50 calculation_days: working calculation_type: amount due_date: '2026-09-30' fine: calculation_type: percentage value: 200 interest: calculation_days: calendar calculation_period: month calculation_type: percentage value: 100 properties: discount: description: Discount for payments before the due date; set only one option properties: fixed_until_due: description: Discount granted until each date properties: amounts: items: properties: amount: description: Amount in cents, for the `amount` calculation type minimum: 1 type: integer x-struct: null x-validate: null date: description: Last date on which the discount applies format: date type: string x-struct: null x-validate: null value: description: >- Percentage in basis points (100 = 1%), for the `percentage` calculation type minimum: 1 type: integer x-struct: null x-validate: null required: - date type: object x-struct: null x-validate: null type: array x-struct: null x-validate: null calculation_type: $ref: >- #/components/schemas/DynamicBrcodeDueDetailDiscountCalculationType required: - calculation_type - amounts type: object x-struct: null x-validate: null per_day_antecipated: description: Discount per day paid in advance properties: amount: description: Amount in cents, for the `amount` calculation type minimum: 1 type: integer x-struct: null x-validate: null calculation_days: $ref: >- #/components/schemas/DynamicBrcodeDueDetailDiscountCalculationDays calculation_type: $ref: >- #/components/schemas/DynamicBrcodeDueDetailDiscountCalculationType value: description: >- Percentage in basis points (100 = 1%), for the `percentage` calculation type minimum: 1 type: integer x-struct: null x-validate: null required: - calculation_type type: object x-struct: null x-validate: null type: object x-struct: null x-validate: null due_date: description: Due date format: date type: string x-struct: null x-validate: null fine: description: Fine charged after the due date properties: amount: description: Amount in cents, for the `amount` calculation type minimum: 1 type: integer x-struct: null x-validate: null calculation_type: $ref: '#/components/schemas/DynamicBrcodeDueDetailFineCalculationType' value: description: >- Percentage in basis points (100 = 1%), for the `percentage` calculation type minimum: 1 type: integer x-struct: null x-validate: null required: - calculation_type type: object x-struct: null x-validate: null interest: description: Interest charged after the due date properties: amount: description: Amount in cents, for the `amount` calculation type minimum: 1 type: integer x-struct: null x-validate: null calculation_days: $ref: >- #/components/schemas/DynamicBrcodeDueDetailInterestCalculationDays calculation_period: $ref: >- #/components/schemas/DynamicBrcodeDueDetailInterestCalculationPeriod calculation_type: $ref: >- #/components/schemas/DynamicBrcodeDueDetailInterestCalculationType value: description: >- Percentage in basis points (100 = 1%), for the `percentage` calculation type minimum: 1 type: integer x-struct: null x-validate: null required: - calculation_type type: object x-struct: null x-validate: null rebate: description: Rebate applied to the amount properties: amount: description: Amount in cents, for the `amount` calculation type minimum: 1 type: integer x-struct: null x-validate: null calculation_type: $ref: '#/components/schemas/DynamicBrcodeDueDetailRebateCalculationType' value: description: >- Percentage in basis points (100 = 1%), for the `percentage` calculation type minimum: 1 type: integer x-struct: null x-validate: null required: - calculation_type type: object x-struct: null x-validate: null required: - due_date title: V2 PixDueDetailParams type: object x-struct: null x-validate: null DynamicBrcodeDueDetailDiscountCalculationType: description: Discount calculation type of dynamic brcode with due detail enum: - amount - percentage nullable: true title: DynamicBrcodeDueDetailDiscountCalculationType type: string x-struct: null x-validate: null DynamicBrcodeDueDetailDiscountCalculationDays: description: Discount calculation days of dynamic brcode with due detail enum: - calendar - working nullable: true title: DynamicBrcodeDueDetailDiscountCalculationDays type: string x-struct: null x-validate: null DynamicBrcodeDueDetailFineCalculationType: description: Fine calculation type of dynamic brcode with due detail enum: - amount - percentage nullable: true title: DynamicBrcodeDueDetailFineCalculationType type: string x-struct: null x-validate: null DynamicBrcodeDueDetailInterestCalculationDays: description: Interest calculation days of dynamic brcode with due detail enum: - calendar - working nullable: true title: DynamicBrcodeDueDetailInterestCalculationDays type: string x-struct: null x-validate: null DynamicBrcodeDueDetailInterestCalculationPeriod: description: Interest calculation period of dynamic brcode with due detail enum: - day - month - year nullable: true title: DynamicBrcodeDueDetailInterestCalculationPeriod type: string x-struct: null x-validate: null DynamicBrcodeDueDetailInterestCalculationType: description: Interest calculation type of dynamic brcode with due detail enum: - amount - percentage nullable: true title: DynamicBrcodeDueDetailInterestCalculationType type: string x-struct: null x-validate: null DynamicBrcodeDueDetailRebateCalculationType: description: Rebate calculation type of dynamic brcode with due detail enum: - amount - percentage nullable: true title: DynamicBrcodeDueDetailRebateCalculationType type: string x-struct: null x-validate: null securitySchemes: authorization: scheme: basic type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.