# Retrieve a recurring payment request by its ID

Endpoint: GET /schedules/payment_requests/{id}
Version: 1.0.0
Security: Biller Access Token (Staging), Biller Access Token (Production)

## Path parameters:

  - `id` (string, required)

## Response 200 fields (application/json):

  - `id` (string)
    The Adfin ID of the recurring payment request.
    Example: 1

  - `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, ...).
    Example: "SCH-42"

  - `nextDate` (string)
    The next date a new payment request will be generated.
    Example: "2025-10-15T00:00:00Z"

  - `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
    Example: "ACTIVE"

  - `cadence` (object)
    Defines the recurrence pattern.
Uses a fixed interval cadence specifying:
- timeUnit: Unit of time (WEEK, MONTH, YEAR)
- frequency: Number of units between each occurrence
- startDate: First occurrence
- endDate: Optional final occurrence

  - `cadence.timeUnit` (string, required)
    Determines whether the cadence repeats in weeks, months or years.
Common values:
- WEEK
- MONTH
- YEAR
    Example: "WEEK"

  - `cadence.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
    Example: 2

  - `cadence.startDate` (string, 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.
    Example: "2025-01-01T00:00:00.000Z"

  - `cadence.endDate` (string)
    Optional end date for the cadence.
If provided, the generation stops at or before this date.
If omitted, the cadence continues indefinitely.
    Example: "2025-12-31T23:59:59.000Z"

  - `paymentRequestDetails` (object)
    Details of the payment request to be automatically generated.
Includes:
- customer – recipient of the payment request
- paymentTerm – when the payment request is due
- distribution – how the payment request is delivered and collected
- description – optional summary
- currencyCode – ISO 4217 currency code
- amount - amount of the payment request

  - `paymentRequestDetails.customer` (object, required)
    Adfin customer ID associated with this payment request.
    Example: {"id":"80349480-490b-4234-92e7-fad697e3d446"}

  - `paymentRequestDetails.customer.id` (string, required)
    The ID of the customer
    Example: "80349480-490b-4234-92e7-fad697e3d446"

  - `paymentRequestDetails.customer.name` (string)
    The name of the customer

  - `paymentRequestDetails.paymentTerm` (object)
    Defines when payment is due after the payment request is issued.

This field represents the payment term, consisting of:
- timeUnit: The unit of time (DAY, WEEK, etc.)
- value: The duration

Behavior:
- When the distribution method is ON_DEMAND: you may freely configure this field.
- When the distribution method is AUTO_COLLECT: this value is always fixed to 3 DAY and cannot be changed.

Examples:
- { "timeUnit": "DAY", "value": 30 } → Payment due 30 days after issue
- { "timeUnit": "WEEK", "value": 2 } → Payment due 2 weeks after issue
    Example: {"timeUnit":"DAY","value":30}

  - `paymentRequestDetails.paymentTerm.timeUnit` (string)
    The unit of time for the payment term. Only DAY is supported.

Optional. Defaults to DAY if not provided.
    Enum: "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "YEAR"

  - `paymentRequestDetails.paymentTerm.value` (integer)
    The numeric value of the payment term.
Combined with timeUnit to calculate due dates.

Optional. When omitted together with timeUnit, the payment term the schedule
already resolves by default applies.
    Example: 30

  - `paymentRequestDetails.distribution` (object, required)
    Specifies how the payment request will be sent and collected.

  - `paymentRequestDetails.distribution.collectionMethod` (string)
    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.
    Enum: "AUTO_COLLECT", "ON_DEMAND", "NONE"

  - `paymentRequestDetails.distribution.templateId` (string)
    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.
    Example: "d290f1ee-6c54-4b01-90e6-d701748f0851"

  - `paymentRequestDetails.distribution.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.
    Example: "Please find your invoice attached. Thank you!"

  - `paymentRequestDetails.distribution.approvedForSending` (boolean, required)
    Boolean flag specifying whether the invoice or payment request is approved for sending.
Defaults to true if not explicitly set.

  - `paymentRequestDetails.amount` (number, required)
    The total amount to be collected for each of the payment requests generated.
    Example: 1200

  - `paymentRequestDetails.taxRate` (number)
    The INCLUSIVE tax rate (%) applied to the payment request.
    Example: 20

  - `paymentRequestDetails.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.
    Example: "GBP"

  - `paymentRequestDetails.description` (string)
    A short, description of the payment request.
    Example: "Quarterly service fee"

  - `paymentRequestDetails.reference` (string)
    An optional reference or identifier that links this payment request
to another system or document.
    Example: "Q1-2025"

  - `creationTime` (string)
    The date and time when the recurring payment request was created.
    Example: "2025-09-27T12:00:00Z"

  - `lastUpdatedTime` (string)
    The date and time when the recurring payment request was last updated.
    Example: "2025-10-01T08:30:00Z"

  - `totalPaymentRequests` (integer)
    The total number of payment requests this recurring payment request is expected to generate
based on cadence, start date, and end date.
    Example: 10

  - `nextPaymentRequests` (array)
    A list of upcoming payment requests to be generated.
Ordered by index and date, and limited to a maximum of 12 items.

  - `nextPaymentRequests.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.
    Example: 3

  - `nextPaymentRequests.issueDate` (string)
    The date and time when the next payment request will be issued to the customer.
Determined by the cadence configuration.
    Example: "2025-11-01T00:00:00Z"

  - `nextPaymentRequests.payByDate` (string)
    The date and time when the payment request is due for payment.
Calculated based on the payment terms.
    Example: "2025-11-08T00:00:00Z"

## Response 201 fields (application/json):

  - `id` (string)
    The Adfin ID of the recurring payment request.
    Example: 1

  - `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, ...).
    Example: "SCH-42"

  - `nextDate` (string)
    The next date a new payment request will be generated.
    Example: "2025-10-15T00:00:00Z"

  - `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
    Example: "ACTIVE"

  - `cadence` (object)
    Defines the recurrence pattern.
Uses a fixed interval cadence specifying:
- timeUnit: Unit of time (WEEK, MONTH, YEAR)
- frequency: Number of units between each occurrence
- startDate: First occurrence
- endDate: Optional final occurrence

  - `cadence.timeUnit` (string, required)
    Determines whether the cadence repeats in weeks, months or years.
Common values:
- WEEK
- MONTH
- YEAR
    Example: "WEEK"

  - `cadence.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
    Example: 2

  - `cadence.startDate` (string, 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.
    Example: "2025-01-01T00:00:00.000Z"

  - `cadence.endDate` (string)
    Optional end date for the cadence.
If provided, the generation stops at or before this date.
If omitted, the cadence continues indefinitely.
    Example: "2025-12-31T23:59:59.000Z"

  - `paymentRequestDetails` (object)
    Details of the payment request to be automatically generated.
Includes:
- customer – recipient of the payment request
- paymentTerm – when the payment request is due
- distribution – how the payment request is delivered and collected
- description – optional summary
- currencyCode – ISO 4217 currency code
- amount - amount of the payment request

  - `paymentRequestDetails.customer` (object, required)
    Adfin customer ID associated with this payment request.
    Example: {"id":"80349480-490b-4234-92e7-fad697e3d446"}

  - `paymentRequestDetails.customer.id` (string, required)
    The ID of the customer
    Example: "80349480-490b-4234-92e7-fad697e3d446"

  - `paymentRequestDetails.customer.name` (string)
    The name of the customer

  - `paymentRequestDetails.paymentTerm` (object)
    Defines when payment is due after the payment request is issued.

This field represents the payment term, consisting of:
- timeUnit: The unit of time (DAY, WEEK, etc.)
- value: The duration

Behavior:
- When the distribution method is ON_DEMAND: you may freely configure this field.
- When the distribution method is AUTO_COLLECT: this value is always fixed to 3 DAY and cannot be changed.

Examples:
- { "timeUnit": "DAY", "value": 30 } → Payment due 30 days after issue
- { "timeUnit": "WEEK", "value": 2 } → Payment due 2 weeks after issue
    Example: {"timeUnit":"DAY","value":30}

  - `paymentRequestDetails.paymentTerm.timeUnit` (string)
    The unit of time for the payment term. Only DAY is supported.

Optional. Defaults to DAY if not provided.
    Enum: "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "YEAR"

  - `paymentRequestDetails.paymentTerm.value` (integer)
    The numeric value of the payment term.
Combined with timeUnit to calculate due dates.

Optional. When omitted together with timeUnit, the payment term the schedule
already resolves by default applies.
    Example: 30

  - `paymentRequestDetails.distribution` (object, required)
    Specifies how the payment request will be sent and collected.

  - `paymentRequestDetails.distribution.collectionMethod` (string)
    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.
    Enum: "AUTO_COLLECT", "ON_DEMAND", "NONE"

  - `paymentRequestDetails.distribution.templateId` (string)
    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.
    Example: "d290f1ee-6c54-4b01-90e6-d701748f0851"

  - `paymentRequestDetails.distribution.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.
    Example: "Please find your invoice attached. Thank you!"

  - `paymentRequestDetails.distribution.approvedForSending` (boolean, required)
    Boolean flag specifying whether the invoice or payment request is approved for sending.
Defaults to true if not explicitly set.

  - `paymentRequestDetails.amount` (number, required)
    The total amount to be collected for each of the payment requests generated.
    Example: 1200

  - `paymentRequestDetails.taxRate` (number)
    The INCLUSIVE tax rate (%) applied to the payment request.
    Example: 20

  - `paymentRequestDetails.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.
    Example: "GBP"

  - `paymentRequestDetails.description` (string)
    A short, description of the payment request.
    Example: "Quarterly service fee"

  - `paymentRequestDetails.reference` (string)
    An optional reference or identifier that links this payment request
to another system or document.
    Example: "Q1-2025"

  - `creationTime` (string)
    The date and time when the recurring payment request was created.
    Example: "2025-09-27T12:00:00Z"

  - `lastUpdatedTime` (string)
    The date and time when the recurring payment request was last updated.
    Example: "2025-10-01T08:30:00Z"

  - `totalPaymentRequests` (integer)
    The total number of payment requests this recurring payment request is expected to generate
based on cadence, start date, and end date.
    Example: 10

  - `nextPaymentRequests` (array)
    A list of upcoming payment requests to be generated.
Ordered by index and date, and limited to a maximum of 12 items.

  - `nextPaymentRequests.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.
    Example: 3

  - `nextPaymentRequests.issueDate` (string)
    The date and time when the next payment request will be issued to the customer.
Determined by the cadence configuration.
    Example: "2025-11-01T00:00:00Z"

  - `nextPaymentRequests.payByDate` (string)
    The date and time when the payment request is due for payment.
Calculated based on the payment terms.
    Example: "2025-11-08T00:00:00Z"


## Response 400 fields

## Response 401 fields

## Response 404 fields

## Response 422 fields

## Response 500 fields