> ## 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.

# PAD Agreement

> Retrieve a Pre-Authorized Debit (PAD) agreement by its ID. The response includes a `padLink` URL that can be presented to the end user for PAD signing.

<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 a Pre-Authorized Debit (PAD) agreement by its ID. Use this endpoint to obtain the `padLink` URL after [creating a DEBIT transaction](/api/pay/endpoints/eft/create-transaction).

## Retrieving the PAD Link

When you create a DEBIT transaction via `POST /api/v1/transactions`, the response includes a `padId` in each schedule object. Use that `padId` with this endpoint to retrieve the full PAD details, including the `padLink`.

The `padLink` is a URL you present to your end user so they can review and sign the PAD agreement before the payment is processed.

## Typical Flow

1. [Create a DEBIT transaction](/api/pay/endpoints/eft/create-transaction) — returns `padId` in the schedule response
2. **Get PAD agreement** (this endpoint) — returns `padLink`
3. Present `padLink` to the end user for PAD signing


## OpenAPI

````yaml GET /api/v1/pads/{padId}
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/pads/{padId}:
    get:
      tags:
        - PAD Agreements
      summary: Get PAD Agreement
      description: >-
        Retrieve a Pre-Authorized Debit (PAD) agreement by its ID. The response
        includes a `padLink` URL that can be presented to the end user for PAD
        signing.
      operationId: getEftPad
      parameters:
        - name: padId
          in: path
          required: true
          description: The unique identifier of the PAD agreement.
          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: PAD agreement retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PadDto'
              example:
                id: a1b2c3d4-5678-90ab-cdef-1234567890ab
                padLink: /pad/a1b2c3d4-5678-90ab-cdef-1234567890ab
                amount: 250
                frequency: Monthly
                status: Active
                startDate: '2026-04-15'
                endDate: '2027-04-15'
                transactionsCount: 12
                createdAt: '2026-04-10T14:30:00Z'
                lastModifiedAt: '2026-04-10T14:30:00Z'
                payor:
                  name: Jane Doe
                  email: jane@example.com
                  type: Individual
                  institutionCode: '001'
                  transitNumber: '12345'
                  accountNumber: '1234567'
                payee:
                  name: Acme Corp
                  email: billing@acme.com
                  address:
                    addressLine1: 123 Main St
                    addressLine2: Suite 100
                    addressLine3: H2E 2E2
        '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: PAD agreement not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PadDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique PAD agreement identifier.
          example: a1b2c3d4-5678-90ab-cdef-1234567890ab
        padLink:
          type: string
          format: uri
          description: URL for the end user to review and sign the PAD agreement.
          example: /pad/a1b2c3d4-5678-90ab-cdef-1234567890ab
        amount:
          type: number
          format: double
          description: Payment amount.
          example: 250
        frequency:
          type: string
          enum:
            - OneTime
            - Weekly
            - Biweekly
            - Monthly
          description: Payment frequency.
          example: Monthly
        status:
          type: string
          description: Current PAD status.
          example: Active
        startDate:
          type: string
          format: date
          description: When the PAD becomes effective.
          example: '2026-04-15'
        endDate:
          type: string
          format: date
          description: When the PAD expires.
          example: '2027-04-15'
        transactionsCount:
          type: integer
          description: Total number of scheduled payments.
          example: 12
        createdAt:
          type: string
          format: date-time
          nullable: true
          description: Creation timestamp.
        lastModifiedAt:
          type: string
          format: date-time
          description: Last update timestamp.
        payor:
          type: object
          properties:
            name:
              type: string
              description: Payor name.
              example: Jane Doe
            email:
              type: string
              description: Payor email.
              example: jane@example.com
            type:
              type: string
              description: Contact type (e.g., Individual, Business).
              example: Individual
            institutionCode:
              type: string
              description: Bank institution code.
              example: '001'
            transitNumber:
              type: string
              description: Bank transit number.
              example: '12345'
            accountNumber:
              type: string
              description: Bank account number.
              example: '1234567'
        payee:
          type: object
          properties:
            name:
              type: string
              description: Payee name.
              example: Acme Corp
            email:
              type: string
              description: Payee email.
              example: billing@acme.com
            address:
              type: object
              properties:
                addressLine1:
                  type: string
                  description: Primary address line.
                  example: 123 Main St
                addressLine2:
                  type: string
                  description: Secondary address line.
                  example: Suite 100
                addressLine3:
                  type: string
                  description: Tertiary address line (e.g., postal code).
                  example: H2E 2E2
    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.

````