> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flinks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Schedule Information

> Retrieve the details of a payment schedule by its ID, including the associated PAD agreement identifier once it has been generated.

<Warning>
  **Work in progress**

  This section is currently under active development as part of improvements planned for 2026. Content may change as we expand product capabilities.

  If you're interested in early access or want to learn more about what's coming, feel free to [reach out to the team](/guides/support/contact-flinks).
</Warning>

Retrieve the details of a payment schedule, including the associated PAD agreement identifier.

## PAD Availability

The `padId` field is `null` immediately after creating a transaction. Once the system generates the PAD agreement, `padId` is populated and you can use it to [retrieve the PAD link](/api/pay/endpoints/eft/get-pad).

For the full flow from contact to PAD link, see the [EFT PAD Signing guide](/guides/pay/eft/generate-pad-link).


## OpenAPI

````yaml GET /api/v1/schedules/{scheduleId}
openapi: 3.0.3
info:
  title: Flinks EFT API
  description: >
    Flinks Electronic Funds Transfer (EFT) API provides endpoints to create,
    monitor, and manage PAD-based debit and credit transactions through Canada's
    EFT rail.


    ## Authentication

    Most endpoints require authentication using an API key passed via the
    `x-client-id` header, provided during onboarding.


    For more information, visit: https://docs.flinks.com
  version: 1.0.0
  contact:
    name: Flinks Support
    url: https://www.flinks.com/contact/sales
  termsOfService: https://www.flinks.com
servers:
  - url: https://www.{baseurl}.com
    description: Flinks Pay Production
    variables:
      baseurl:
        default: '{baseurl}'
        description: The base URI for the environment (e.g. flinks)
security: []
tags:
  - name: Transactions
    description: Create EFT debit and credit transactions
  - name: Payment Requests
    description: Monitor and manage payment requests
  - name: Schedules
    description: Manage recurring payment schedules
  - name: Contacts
    description: Retrieve stored contact information
  - name: PAD Agreements
    description: Retrieve Pre-Authorized Debit agreements
  - name: Institutions
    description: Retrieve supported financial institutions
paths:
  /api/v1/schedules/{scheduleId}:
    get:
      tags:
        - Schedules
      summary: Get Schedule
      description: >-
        Retrieve the details of a payment schedule by its ID, including the
        associated PAD agreement identifier once it has been generated.
      operationId: getEftSchedule
      parameters:
        - name: scheduleId
          in: path
          required: true
          description: The schedule identifier returned when creating a transaction.
          schema:
            type: string
            format: uuid
          example: a1b2c3d4-5678-90ab-cdef-1234567890ab
        - name: x-client-id
          in: header
          required: true
          description: Your API key provided during onboarding.
          schema:
            type: string
      responses:
        '200':
          description: Schedule retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleDto'
              example:
                id: a1b2c3d4-5678-90ab-cdef-1234567890ab
                amount: 250
                startDate: '2026-04-15'
                endDate: '2027-04-15'
                transactionsCount: 12
                paymentFrequency: Monthly
                paymentDirection: DEBIT
                paymentType: EFT
                status: Active
                padId: b2c3d4e5-6789-01bc-defg-2345678901bc
                crossReferenceNumber: INV-1001
                createdAt: '2026-04-10T14:30:00Z'
                lastModifiedAt: '2026-04-10T14:30:00Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - Invalid or missing x-client-id header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Schedule not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ScheduleDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique schedule identifier.
          example: a1b2c3d4-5678-90ab-cdef-1234567890ab
        amount:
          type: number
          format: double
          description: Payment amount.
          example: 250
        startDate:
          type: string
          format: date
          description: Schedule start date.
          example: '2026-04-15'
        endDate:
          type: string
          format: date
          description: Schedule end date.
          example: '2027-04-15'
        transactionsCount:
          type: integer
          description: Total number of scheduled payments.
          example: 12
        paymentFrequency:
          type: string
          enum:
            - OneTime
            - Weekly
            - Biweekly
            - Monthly
          description: Payment frequency.
          example: Monthly
        paymentDirection:
          type: string
          enum:
            - DEBIT
            - CREDIT
          description: Payment direction.
          example: DEBIT
        paymentType:
          type: string
          description: Payment type.
          example: EFT
        status:
          type: string
          description: Current schedule status.
          example: Active
        padId:
          type: string
          format: uuid
          nullable: true
          description: >-
            Associated PAD agreement identifier. `null` until the PAD has been
            generated.
          example: b2c3d4e5-6789-01bc-defg-2345678901bc
        crossReferenceNumber:
          type: string
          nullable: true
          description: Your reference identifier.
          example: INV-1001
        createdAt:
          type: string
          format: date-time
          nullable: true
          description: Creation timestamp.
        lastModifiedAt:
          type: string
          format: date-time
          description: Last update timestamp.
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: Error type URI.
          example: https://tools.ietf.org/html/rfc7231#section-6.5.1
        title:
          type: string
          description: Error title.
          example: Bad Request
        status:
          type: integer
          description: HTTP status code.
          example: 400
        detail:
          type: string
          description: Human-readable error description.
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Field-level validation errors.

````