RecurringPaymentInput

INPUT

Input for recurring payment.

Fields

account_code

String

Customer-defined account code.

amountRequired

Int

Amount in minor units (for example cents).

fee_mode

FeeMode

Fee mode that determines if the payor or the merchant will pay the fees.

Values

CUSTOM_FEEINTERCHANGEMERCHANT_FEESERVICE_FEE

first_payment_date

AWSDate

Date for first payment.

merchant_uidRequired

String

Pay Theory unique identifier for the merchant.

metadata

AWSJSON

Metadata associated with this object.

mute_all_emails

Boolean

Manage whether the payor will receive emails for the recurring payment from Pay Theory.

payment_count

Int

The number of payments that will be made for the recurring payment. If not provided, the recurring payment will be made indefinitely.

payment_intervalRequired

RecurringInterval

The payment interval.

Values

ANNUALBI_ANNUALBI_WEEKLYMONTHLYQUARTERLYWEEKLY

payment_method_idRequired

String

Pay Theory unique identifier for the payment method.

payor

PayorInput

The payor that the recurring payment belongs to.

payor_id

String

Pay Theory unique identifier for the payor.

recurring_description

String

The description of the recurring payment.

recurring_nameRequired

String

The name of the recurring payment.

reference

String

Customer-defined reference.