---
title: "Retrieve a recurring payment request by its ID"
method: GET
path: "/schedules/payment_requests/{id}"
tags: ["Recurring payment requests"]
---

# Retrieve a recurring payment request by its ID

`GET /schedules/payment_requests/{id}`

## Path parameters

- `id` string, required

## Response `200`

OK

- RecurringPaymentRequestResponse — A schedule that defines when and how payment request are automatically generated for a customer, including cadence, payment terms, etc..
  - `id` string — The Adfin ID of the recurring payment request.
  - `recurringPaymentRequestNo` string — A system-generated, unique identifier for the recurring payment request. Automatically created using the prefix SCH followed by a numeric sequence (e.g., SCH-1, SCH-2, ...).
  - `nextDate` string, date-time — The next date a new payment request will be generated.
  - `status` string — Indicates the current status of the recurring payment request. Possible values might include: - `ACTIVE` – currently generating new payment request - `FINISHED` – has finished all planned occurrences - `CANCELLED` – has been cancelled before finishing all planned occurrences
  - `cadence` IntervalCadence — A cadence that recurs at a fixed interval. Use this to define schedules that repeat every N units of time, such as "every 2 weeks" or "every 3 months".
    - `timeUnit` string, required — Determines whether the cadence repeats in weeks, months or years. Common values: - WEEK - MONTH - YEAR
    - `frequency` integer, required — Combined with `timeUnit` to determine how often the cadence occurs. For example: - `frequency = 2` and `timeUnit = WEEK` → every 2 weeks - `frequency = 1` and `timeUnit = MONTH` → every month
    - `startDate` string, date-time, required — The first occurrence happens at this time. Format: ISO 8601 with milliseconds, e.g. `2025-01-01T00:00:00.000Z`. Timestamps without milliseconds are rejected.
    - `endDate` string, date-time — Optional end date for the cadence. If provided, the generation stops at or before this date. If omitted, the cadence continues indefinitely.
  - `paymentRequestDetails` RecurringPaymentRequestDetails — Defines the configuration for a **Payment Request (PR)** automatically generated. This object specifies the customer, collection workflow, currency, payment terms for the payment requests.
    - `customer` CustomerDetails, required — Contains the unique identifier for the customer.
      - `id` string, required — The Adfin ID of the customer.
    - `paymentTerm` PaymentTerm — Defines the duration before an invoice is due, using a combination of a time unit and value. For example, a value of `30` with a `timeUnit` of `DAYS` represents "net 30 days".
      - `timeUnit` 'SECOND' | 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR' — The unit of time for the payment term. Common values include: - `DAYS` - `WEEKS` - `MONTHS` Optional. Defaults to `DAYS` if not provided.
      - `value` integer — The numeric value of the payment term. Combined with `timeUnit` to calculate due dates.
    - `distribution` CollectionDetails, required — Information about how an invoice or payment request is distributed and collected. This defines: - The method by which payment is expected to be collected. - The workflow template used to send the invoice or payment request. - Optional custom message for the customer. - Approval status for automatically distributing to the customer.
      - `collectionMethod` 'AUTO_COLLECT' | 'ON_DEMAND' | 'NONE' — How the payment is expected to be collected. For example: - `AUTO_COLLECT`: Collected automatically via direct debit. Takes effect once the customer has an active direct debit mandate; until they sign, collection waits with status reason `PENDING_DD_MANDATE`. - `ON_DEMAND`: Collected via other payment methods (eg. `CARD`, `APPLE_PAY`, `GOOGLE_PAY`, `BANK`). - `NONE`: No payment collection is initiated automatically.
      - `templateId` string, uuid — The workflow template ID used for sending the invoice or payment request to the customer. Optional — if null, the system default template will be used.
      - `customMessage` string — An optional message that will be sent to the customer when the invoice or payment request is distributed. Can be used for personalized greetings or additional instructions.
      - `approvedForSending` boolean, required — Boolean flag specifying whether the invoice or payment request is approved for sending. Defaults to `true` if not explicitly set.
    - `amount` number, required — The total amount to be collected for each of the payment requests generated.
    - `taxRate` number — The INCLUSIVE tax rate (%) applied to the payment request.
    - `currencyCode` string, required — The three-letter ISO 4217 currency code (e.g., `GBP`, `EUR`, `USD`). Indicates the currency in which the payment request is issued.
    - `description` string — A short, description of the payment request.
    - `reference` string — An optional reference or identifier that links this payment request to another system or document.
  - `creationTime` string, date-time — The date and time when the recurring payment request was created.
  - `lastUpdatedTime` string, date-time — The date and time when the recurring payment request was last updated.
  - `totalPaymentRequests` integer — The total number of payment requests this recurring payment request is expected to generate based on cadence, start date, and end date.
  - `nextPaymentRequests` NextPaymentRequestResponse[] — A list of upcoming payment requests to be generated. Ordered by index and date, and limited to a maximum of 12 items.
    - `index` integer — The sequence number of this payment request within the schedule. Starts from `1` for the first generated payment request and increments for each occurrence.
    - `issueDate` string, date-time — The date and time when the next payment request will be issued to the customer. Determined by the cadence configuration.
    - `payByDate` string, date-time — The date and time when the payment request is due for payment. Calculated based on the payment terms.

## Other responses

- `201` — The request was successful and the recurring payment request was retrieved
- `400` — A problem reading or understanding the request. Ensure that the request complies with the required format and includes all necessary parameters.
- `401` — Authentication required.
- `404` — Recurring payment request does not exist.
- `422` — A request validation error.
- `500` — The server could not process the request.

---

[API](https://skmtc.net/adfin/apis/adfin-api.md) · [All operations](https://skmtc.net/adfin/apis/adfin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/adfin/adfin-api/versions/c188ba232e1d/schema)