Skip to main content
POST
Generate a recurrence

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

Trio-Version
enum<string>
required

Version of the v2 contract the client is written against. Each breaking change publishes a new version.

Available options:
2026-10-19.v2
Trio-Target-Org-Id
string<uuid>

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.

Body

application/json

The recurrence generate attributes

GenerateRecurrenceParameters

bank_account_id
string<uuid>
required

Bank Account ID

contract_number
string
required

Contract Number

Maximum string length: 35
counterparty
object
required

Counterparty

description
string
required

Description

Maximum string length: 35
periodicity
enum<string>
required

'week': every week, 'mnth': every month, 'qurt': every 3 months, 'mian': every 6 months, 'year': every year

Available options:
week,
mnth,
qurt,
mian,
year
start_date
string<date>
required

First day of the recurrence

amounts
object | null

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

end_date
string<date> | null

Last day of the recurrence

external_id
string | null

Recurrence External ID

first_payment
V2 FirstPaymentWithDueDetail · object | null

Schema for the first payment with due detail

options
object | null

Recurrence options

Response

Generate Recurrence Response

The created recurrence, plus the QRCode the payer authorizes it through (null when the journey has none)

data
object