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.

Body

application/json

The recurrence generate attributes

GenerateRecurrenceParameters

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-time>
required

Recurrence Start Date

virtual_account_id
string<uuid>
required

Virtual Account ID

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-time> | null

Recurrence End Date

external_id
string | null

Recurrence External ID

first_payment
FirstPaymentWithDueDetail · object | null

Schema for the first payment with due detail

options
object | null

Recurrence options

Response

Generate Recurrence Response

Generate Recurrence response

data
object

Generate recurrence response data