Create Recurring Payin

Recurring Payin is a method for setting up automated, recurring payments from customers. This allows merchants to collect funds on a scheduled basis without requiring manual intervention for each payment.

Recurring Payins are useful for:

• Subscription Services: Monthly or yearly subscription payments
• Membership Fees: Recurring membership or service fees
• Utility Bills: Automated bill payments

Key Features

• Flexible Scheduling: Support for WEEKLY, MONTHLY, QUARTERLY, and YEARLY frequencies
• Auto Debit: Automatic payment processing without customer intervention
• Fixed or Variable Amounts: Support for both fixed recurring amounts and variable amounts
• Payment Plans: Integration with existing payment plans or standalone recurring payments
• Activation Delays: Configurable delays before the first payment is processed

Prerequisites

Before creating a Recurring Payin, ensure you have:

1. Customer Created: The customer must exist in the system (optional but recommended)
2. Payin Method: A valid payin method ID for the payment type
3. Payment Plan (Optional): If using an existing payment plan, ensure it's properly configured

Recurring Payin Types

• With Payment Plan: Uses an existing payment plan configuration
• Standalone: Creates a new recurring payment configuration without a payment plan

Status Flow

• CREATED: Initial status when recurring payin is created
• ACTIVE: When the recurring payin is active and processing payments
• CANCELLED: Permanently cancelled recurring payments
• COMPLETED: When all scheduled payments have been completed

Webhook Notifications

Finmo will send webhook notifications for recurring payin events:

• RecurringPayin_CREATED: When a recurring payin is created
• RecurringPayin_ACTIVATED: When the recurring payin becomes active
• RecurringPayin_PAYMENT_PROCESSED: When a scheduled payment is processed
• RecurringPayin_PAYMENT_FAILED: When a scheduled payment fails
• RecurringPayin_CANCELLED: When the recurring payin is cancelled