createRecurringPayment

MUTATION

Creates recurring payment.

Arguments

inputRequired

RecurringPaymentInput

The input object that contains the details to create a new recurring payment.

Response

RecurringPayment

account_code

String| null

Custom account code for the recurring payment that will be tied to each payment.

amount_per_payment

Int| null

The amount of the recurring payment.

created_date

AWSDateTime| null

The date the recurring payment was created.

currency

String| null

The type of currency for the recurring payment.

fee_mode

FeeMode| null

The fee mode for the recurring payment.

Values

CUSTOM_FEEINTERCHANGEMERCHANT_FEESERVICE_FEE

fee_per_payment

Int| null

The fee for the recurring payment.

is_active

Boolean| null

Whether the recurring payment is active or been disabled.

is_processing

Boolean| null

Whether the recurring payment is currently processing.

recurring_id

String| null

The Pay Theory unique identifier assigned to the recurring payment.

merchant_uid

String| null

The Pay Theory unique identifier assigned to the merchant that the recurring payment belongs to.

metadata

AWSJSON| null

Custom metadata for the recurring payment that will be tied to each payment.

mute_all_emails

Boolean| null

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

next_payment_date

AWSDate| null

The date of the next payment to be made for the recurring payment.

payment_interval

RecurringInterval| null

The interval of the recurring payment.

Values

ANNUALBI_ANNUALBI_WEEKLYMONTHLYQUARTERLYWEEKLY

payment_method

PaymentMethodToken| null

The payment method used to make the recurring payment.

payor

Payor| null

The payor that the recurring payment belongs to.

prev_payment_date

AWSDate| null

The date of the last payment made for the recurring payment.

recurring_description

String| null

Custom description for the recurring payment.

recurring_name

String| null

Custom name for the recurring payment.

reference

String| null

Custom reference for the recurring payment that will be tied to each payment.

remaining_payments

Int| null

The number of payments remaining for the recurring payment.

status

RecurringStatus| null

The status of the recurring payment.

Values

INSTRUMENT_FAILURESUCCESSSYSTEM_FAILURE

total_amount_per_payment

Int| null

The amount the payor will be charged for the recurring payment.

Examples

Create a monthly schedule with a future start

Sets first_payment_date, so the first charge runs on that date. Leave it out to charge right away.

SUCCESS 200

GRAPHQL

mutation CreateRecurringPayment($input: RecurringPaymentInput!) {
  createRecurringPayment(input: $input) {
    recurring_id
    merchant_uid
    recurring_name
    recurring_description
    amount_per_payment
    fee_per_payment
    total_amount_per_payment
    fee_mode
    payment_interval
    prev_payment_date
    next_payment_date
    remaining_payments
    status
    is_active
    mute_all_emails
    account_code
    reference
    created_date
    payment_method {
      payment_method_id
      last_four
      payment_type
    }
    payor {
      payor_id
      full_name
      email
    }
  }
}