Recurring Payin

List all Recurring Payins

Changed on

Retrieve a list of all the Recurring Payins. You can filter the list with query parameters.

This API comes with Pagination support, you can customize limit and page query parameters as per the requirements.

get/recurring-payin

Request

  • Base URL
    https://api.finmo.net/v1
  • Auth
    HTTP basic

Query parameters

limitinteger
Example:10

Max number of records per page. Default is 10 per page

pageinteger
Example:1

The page number to return. If unspecified, the first page is returned

start_timeinteger
Example:1725926400

EPOCH timestamp (in seconds) for start time filter

end_timeinteger
Example:1726444800

EPOCH timestamp (in seconds) for end time filter

recurring_payin_idstring
Example:recur_payin_0123eda6e44a4e24a0d9fbb6f71a8403

Filter by Recurring Payin ID (supports multiple)

payment_plan_idstring
Example:payment_plan_964d1f1dedf94ec696463cee642e698d

Filter by Payment Plan ID (supports multiple)

customer_idstring
Example:cus_123

Filter by Customer ID (supports multiple)

amountnumber
Example:598

Filter by recurring amount

frequencystring
Example:MONTHLY

Filter by frequency ( WEEKLY, MONTHLY, QUARTERLY, YEARLY)

statusstring
Example:CREATED

Filter by status (CREATED, ACTIVE, CANCELLED, COMPLETED)

Response

OK

Changes