---
title: "GetRecurringPayment"
method: GET
path: "/v2/GetRecurringPayment"
tags: ["Payments (V2)"]
---

# GetRecurringPayment

`GET /v2/GetRecurringPayment`

Retrieves all recurring payments created in your account. This endpoint returns a list of all recurring payments with their status, execution details, and related invoices.

## Response `200`

Recurring payments retrieved successfully

- object
  - `IsSuccess` boolean — Indicates if the request was successful.
  - `Message` string — Response message associated with the request.
  - `ValidationErrors` object[] — List of validation errors, if any.
    - `Name` string
    - `Error` string
  - `Data` object
    - `RecurringPayment` object[] — Array of recurring payment objects.
      - `RecurringId` string — A unique number for each recurring payment. It's recommended to save this ID in your system with your customer profile so that, you can keep track of all payments done against that customer. Moreover, you will be able to cancel it when needed later on.
      - `RecurringStatus` 'ACTIVE' | 'UNCOMPLETED' | 'COMPLETED' | 'CANCELED' | 'DRAFT' — ACTIVE: The recurring payment is being processed normally but its iterations have not been completed yet. UNCOMPLETED: MyFatoorah tried to withdraw the recurring value but the payment has failed and also Retry Counts have been executed and produced failed payments. COMPLETED: The recurring payment has been executed successfully with all its iterations and will not be executed again. CANCELED: The recurring status is changed to canceled when you use CancelRecurringPayment endpoint to stop a recurring payment from being executed. DRAFT: The recurring status is initially set as draft. When the first payment (first invoice before recurring) is done the status changes to active.
      - `CreationDate` string, date-time — The date when the recurring payment was created.
      - `RecurringValue` number — The value to be paid by your customer.
      - `RecurringType` 'Custom' | 'Daily' | 'Weekly' | 'Monthly' — Recurring type you set in the request while creating the recurring payment. Possible values: (Custom-Daily-Weekly-Monthly)
      - `IntervalDays` integer — Valid when recurring type is set to 'custom'.
      - `ExecutedTimes` integer — How many times the recurring payment has been already executed.
      - `LastPayDate` string, date-time — Last date the recurring payment was executed.
      - `NextPayDate` string, date-time — Next date the recurring payment will be executed.
      - `IsActive` boolean — Whether the recurring status is active or not.
      - `RecurringInvoices` object[] — The list of invoices related to this recurring payment.
        - `InvoiceId` integer — The invoice ID associated with the recurring payment.
        - `CustomerReference` string — The customer reference associated with the invoice.
        - `CustomerName` string — The customer name associated with the invoice.
        - `CustomerMobile` string — The customer mobile number associated with the invoice.
        - `CreatedDate` string, date-time — The date when the invoice was created.
        - `InvoiceStatus` string — The status of the invoice.

---

[API](https://skmtc.net/myfatoorah/apis/myfatoorah-api-v3.md) · [All operations](https://skmtc.net/myfatoorah/apis/myfatoorah-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/myfatoorah/myfatoorah-api-v3/revisions/994a74287a16/schema)