> ## 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 escrow feeds

> Merchant-wide feed of all customers' escrows. Must **not** send a `customer-id` header.



## OpenAPI

````yaml openapi.json GET /v1/escrow/feeds
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/feeds:
    get:
      tags:
        - Disputes
      summary: Get escrow feeds
      description: >-
        Merchant-wide feed of all customers' escrows. Must **not** send a
        `customer-id` header.
      operationId: getEscrowFeeds
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - name: status
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/EscrowStatus'
        - name: customerId
          in: query
          required: false
          schema:
            type: string
        - name: categoryId
          in: query
          required: false
          schema:
            type: string
        - name: fromDate
          in: query
          required: false
          schema:
            type: string
            format: date
        - name: toDate
          in: query
          required: false
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Paginated escrows across all customers.
          content:
            application/json:
              example:
                status: 200
                message: Escrow transactions fetched successfully
                data:
                  data:
                    - id: 6948fb43cb570eeef76285e3
                      amount: 1000
                      purpose: iPhone 13 Pro Max
                      description: >-
                        Black Titanium, White Titanium, Natural Titanium, Desert
                        Titanium
                      whoPays: buyer
                      imageUrl: null
                      fee: 15
                      paymentToken: PY_KrWLqPd90314
                      paidAt: '1766391073'
                      status: COMPLETED
                      state: CLOSED
                      logs: []
                      channel: API
                      isSeller: false
                      dispute: null
                      paymentDetails:
                        id: 6948fd20cb570eeef76286a4
                        amount: 1015
                        status: success
                        reference: '9500364766547485'
                        fee: 15
                        transactionType: escrow
                        currency: NGN
                        createdAt: '2025-12-22T08:11:12.605Z'
                      category: null
                      completedAt: '1766391289'
                      approvedClaimBy: null
                      refundedBy: null
                      maxDelivery: 20
                      deliveryTimeline: minutes
                      totalQuantity: 1
                      settlementType: STANDARD
                      milestones: []
                      createdAt: '2025-12-22T08:03:15.124Z'
                      updatedAt: '2025-12-22T08:14:49.601Z'
                    - id: 6a3cd9b1734e96016b22732e
                      amount: 1000
                      purpose: multi-purpose escrow item
                      description: details
                      whoPays: buyer
                      imageUrl: null
                      fee: 30
                      paymentToken: PY_V2bRgyPJ3305
                      paidAt: null
                      status: PENDING
                      state: AWAITING_PAYMENT
                      logs: []
                      channel: API
                      isSeller: true
                      dispute: null
                      paymentDetails: null
                      category: null
                      completedAt: null
                      approvedClaimBy: null
                      refundedBy: null
                      maxDelivery: 1
                      deliveryTimeline: hours
                      totalQuantity: 2
                      settlementType: STANDARD
                      milestones: []
                      createdAt: '2026-06-25T07:33:05.400Z'
                      updatedAt: '2026-06-25T07:38:39.619Z'
                  pagination:
                    count: 2
                    pages: 1
                    isLastPage: true
                    nextPage: null
                    previousPage: null
components:
  parameters:
    Page:
      name: page
      in: query
      required: false
      description: Page number (1-based).
      schema:
        type: integer
        default: 1
      example: 1
    Limit:
      name: limit
      in: query
      required: false
      description: Items per page.
      schema:
        type: integer
        default: 10
      example: 10
  schemas:
    EscrowStatus:
      type: string
      description: High-level escrow status.
      enum:
        - PENDING
        - ONGOING
        - COMPLETED
        - REFUNDED
        - CLAIMED
        - DISPUTED
        - INVESTIGATING
  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).

````