RecurringPaymentInput
INPUTInput for recurring payment.
Fields
account_code
Customer-defined account code.
amountRequired
Amount in minor units (for example cents).
fee_mode
Fee mode that determines if the payor or the merchant will pay the fees.
Values
CUSTOM_FEEINTERCHANGEMERCHANT_FEESERVICE_FEE
first_payment_date
Date for first payment.
merchant_uidRequired
Pay Theory unique identifier for the merchant.
metadata
Metadata associated with this object.
mute_all_emails
Manage whether the payor will receive emails for the recurring payment from Pay Theory.
payment_count
The number of payments that will be made for the recurring payment. If not provided, the recurring payment will be made indefinitely.
payment_intervalRequired
The payment interval.
Values
ANNUALBI_ANNUALBI_WEEKLYMONTHLYQUARTERLYWEEKLY
payment_method_idRequired
Pay Theory unique identifier for the payment method.
payor
The payor that the recurring payment belongs to.
payor_id
Pay Theory unique identifier for the payor.
recurring_description
The description of the recurring payment.
recurring_nameRequired
The name of the recurring payment.
reference
Customer-defined reference.