---
title: "Create Recurring Payin"
method: POST
path: "/recurring-payin"
tags: ["Recurring Payin"]
---

# Create Recurring Payin

`POST /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

## Request body

- object
  - `customer_id` string — Customer ID (cus_*). Optional but recommended for customer-specific recurring payments
  - `payin_method_name` string, required — Payin method Name to be used for recurring payments
  - `payment_plan_id` string — Payment plan ID (payment_plan_*). If provided, other payment plan fields will be ignored
  - `is_auto_debit` boolean — Whether payments should be automatically debited without customer intervention
  - `frequency` 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY' — Frequency of recurring payments. Required if payment_plan_id is not provided
  - `currency` string — Currency code for the recurring payment (ISO 4217). Required if payment_plan_id is not provided
  - `country` string — Country code for the recurring payment (ISO 3166-1 alpha-2). Required if payment_plan_id is not provided
  - `amount` number, required — Amount for each recurring payment. Required if is_recurring_amount_fixed is true or not provided
  - `start_at` string, date-time, required — Start date and time for the recurring payments (ISO 8601 format)
  - `end_at` string, date-time — End date and time for the recurring payments (ISO 8601 format). Optional
  - `initial_activation_delay` integer — Delay in minutes before the first payment is processed. Optional
  - `is_recurring_amount_fixed` boolean — Whether the recurring amount is fixed. If false, amount field is not required

## Response `201`

Created

## Other responses

- `400` — Bad Request
- `404` — Not Found

---

[API](https://skmtc.dev/finmo/apis/finmo-api.md) · [All operations](https://skmtc.dev/finmo/apis/finmo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/finmo/finmo-api/revisions/1a3073c93930/schema)