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

# Get milestones

> Returns the milestone list for an escrow, by payment token. Returns an empty array for standard (non-milestone) escrows.



## OpenAPI

````yaml openapi.json GET /v1/escrow/milestone/{paymentToken}
openapi: 3.0.3
info:
  title: Payluk ThirdParty API
  version: 1.0.0
  description: >-
    Merchant / Business API for the Payluk escrow and payments platform.


    All routes are mounted under `/v1` and authenticated with a secret key.
    Every response uses the standard envelope `{ status, message, data }`.
  contact:
    name: Payluk Developer Support
    email: support@payluk.ng
    url: https://payluk.ng
servers:
  - url: https://staging.api.payluk.ng
    description: 'Staging: use sk_test_ keys here for safe testing'
  - url: https://api.payluk.ng
    description: 'Production: use sk_live_ keys'
security:
  - bearerAuth: []
tags:
  - name: Escrow
    description: Create and manage standard escrow payment links.
  - name: Milestone Escrow
    description: Escrows that release funds in parts as milestones are confirmed.
  - name: Vault Escrow
    description: >-
      Merchant-only pooled-stake escrows: customers stake from their wallets and
      the merchant declares the winner.
  - name: Categories
    description: Organise escrows into merchant-defined categories.
  - name: Merchant Customers
    description: Manage the buyers and sellers that transact under your merchant account.
  - name: Disputes
    description: Confirm deliveries, raise disputes and resolve them.
  - name: Payments
    description: Fund wallets and escrows, verify references and manage payout details.
  - name: Debit Cards
    description: List and remove customers' saved debit cards.
  - name: Crypto Whitelist
    description: Manage whitelisted crypto withdrawal addresses.
  - name: Misc
    description: Supporting reference data.
paths:
  /v1/escrow/milestone/{paymentToken}:
    get:
      tags:
        - Milestone Escrow
      summary: Get milestones
      description: >-
        Returns the milestone list for an escrow, by payment token. Returns an
        empty array for standard (non-milestone) escrows.
      operationId: getMilestones
      parameters:
        - $ref: '#/components/parameters/PaymentToken'
      responses:
        '200':
          description: Milestones fetched.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    example: 200
                  message:
                    type: string
                    example: Milestones fetched successfully
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Milestone'
              example:
                status: 200
                message: Milestones fetched successfully
                data:
                  - id: 665f1b2c9a1e4d0012ab3c21
                    title: Design
                    amount: 300000
                    dueDate: '2026-07-15'
                    status: RELEASED
                    releasedAt: '1750584900'
                  - id: 665f1b2c9a1e4d0012ab3c22
                    title: Development
                    amount: 500000
                    dueDate: '2026-08-15'
                    status: PENDING
                    releasedAt: null
                  - id: 665f1b2c9a1e4d0012ab3c23
                    title: Deployment
                    amount: 200000
                    dueDate: null
                    status: PENDING
                    releasedAt: null
        '400':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    PaymentToken:
      name: paymentToken
      in: path
      required: true
      description: The escrow's payment token (e.g. `PY_8AB12C9D3045`).
      schema:
        type: string
      example: PY_8AB12C9D3045
  schemas:
    Milestone:
      type: object
      properties:
        id:
          type: string
          example: 665f1b2c9a1e4d0012ab3c21
        title:
          type: string
          example: Design
        description:
          type: string
          example: Figma mockups
        amount:
          type: integer
          example: 300000
        dueDate:
          type: string
          nullable: true
          example: '2026-07-15'
        customerId:
          type: string
          nullable: true
          description: >-
            Optional beneficiary. When set, releasing this milestone credits
            this customer's main balance instead of the seller's.
          example: null
        status:
          type: string
          enum:
            - PENDING
            - RELEASED
          example: PENDING
        releasedAt:
          type: string
          nullable: true
          example: null
    ApiError:
      type: object
      description: Standard error envelope.
      properties:
        status:
          type: integer
          example: 400
        message:
          type: string
          example: Action not allowed
        data:
          type: object
          example: {}
  responses:
    NotFound:
      description: Escrow not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            status: 400
            message: Escrow not found
            data: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your secret key as a Bearer token. The key prefix selects the
        environment: `sk_test_...` (test) or `sk_live_...` (live).

````