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

# List on-ramp references

> All filters are optional and combined. Unlike the other collections,
this one pages with `pageNumber`/`pageSize` and returns
`{data, pageNumber, pageSize, count}`, where `count` is the total
number of matches.




## OpenAPI

````yaml /api-reference/openapi.yaml get /onramp/references
openapi: 3.1.0
info:
  title: Zeam API Gateway
  version: 1.0.0
  description: >
    The Zeam API Gateway is the single, REST-based external surface for
    registered

    integrators. Every request, including token issuance, carries the
    application

    secret header `x-zeam-auth` — there is no unauthenticated route. Protected

    requests additionally carry a bearer access token obtained from

    POST /v1/auth/token; the gateway verifies it and resolves the caller's

    association server-side — you do not need to supply an association id

    header. Errors use RFC 7807 `application/problem+json`.


    Besides the codes listed per operation, any protected route can answer

    `504` when token verification times out, and any route that calls a

    downstream service can answer `503` when that service is unavailable or

    `504` when it times out.
  license:
    name: Proprietary
    url: https://zeam.app
  contact:
    name: Zeam Platform Team
    url: https://zeam.app
servers:
  - url: https://api.zeam.money/gw/v1
    description: >-
      Zeam API Gateway. The sandbox and production environments share this base
      URL; your application's registration determines which one a request runs
      in.
security:
  - BearerAuth: []
    ZeamAuth: []
tags:
  - name: Auth
    description: Public token issuance.
  - name: Wallets
    description: Association wallets with embedded balances.
  - name: Assets
    description: Platform asset registry.
  - name: Beneficiaries
    description: Association beneficiaries and their payment destinations.
  - name: Connectors
    description: Connector discovery.
  - name: Quotes
    description: Off-ramp and on-ramp quotes.
  - name: Payments
    description: >-
      P2P transfers, swaps, off-ramp cash-outs, and on-ramp collections, plus
      the compliance reference lookups used when building an off-ramp or
      on-ramp.
  - name: Transactions
    description: Transaction records, the polling and history complement to webhooks.
  - name: Statements
    description: Settled on-chain statement lines per wallet and asset.
  - name: Webhooks
    description: Association webhook registrations.
  - name: Onramp References
    description: |
      Setup for bespoke connectors (`flow: BESPOKE`, for example EasyPay and
      Noah), which are provider-initiated instead of quoted: register the
      customer with the provider, then register on-ramp references bound to
      one of your own wallets. Payments arriving on a reference pay out to its
      settlement account.
paths:
  /onramp/references:
    get:
      tags:
        - Onramp References
      summary: List on-ramp references
      description: |
        All filters are optional and combined. Unlike the other collections,
        this one pages with `pageNumber`/`pageSize` and returns
        `{data, pageNumber, pageSize, count}`, where `count` is the total
        number of matches.
      operationId: listOnrampReferences
      parameters:
        - name: customerId
          in: query
          required: false
          schema:
            type: string
        - name: settlementAccount
          in: query
          required: false
          schema:
            type: string
        - name: connectorId
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            default: 20
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: A page of references.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnrampReferencePage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationError'
        '502':
          $ref: '#/components/responses/UpstreamError'
components:
  schemas:
    OnrampReferencePage:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OnrampReference'
        pageNumber:
          type: integer
        pageSize:
          type: integer
        count:
          type: integer
    OnrampReference:
      type: object
      properties:
        reference:
          type: string
        routeId:
          type: string
          format: uuid
          description: The connector id.
        customerId:
          type:
            - string
            - 'null'
        settlementAccount:
          type: string
        isActive:
          type: boolean
        created:
          type: string
          format: date-time
    Problem:
      type: object
      required:
        - type
        - title
        - status
      description: RFC 7807 problem details.
      properties:
        type:
          type: string
          format: uri
          example: https://errors.zeam.app/validation-error
        title:
          type: string
          example: Validation Error
        status:
          type: integer
          example: 422
        detail:
          type: string
          example: The 'amount' field must be a positive decimal.
        instance:
          type: string
          example: /v1/quotes
        requestId:
          type: string
          example: 01J8Z6K3QW9F2
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
  responses:
    Unauthorized:
      description: Missing or invalid authentication.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: Authenticated but not permitted.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ValidationError:
      description: Request failed validation.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    UpstreamError:
      description: An unexpected error occurred while completing the request.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token issued by POST /v1/auth/token.
    ZeamAuth:
      type: apiKey
      in: header
      name: x-zeam-auth
      description: >-
        Application secret (the apiKey issued at registration), required on
        every request.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.