Paxos

Paxos Claims API

Claims represent rewards paid out on-chain. Use claim schedules to automate daily reward claims. *These endpoints are only relevant for whitelisted Rewards partners.*

GitHub OpenAPI

Operations 5

GET /rewards/claim-schedules List claim schedules #
POST /rewards/claim-schedules Create a claim schedule #
DELETE /rewards/claim-schedules/{id} Delete a claim schedule #
PUT /rewards/claim-schedules/{id} Update a claim schedule #
GET /rewards/claims List claims #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/paxos/refs/heads/main/openapi/paxos-claims-api-openapi.yml

Other Resources

🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/paxos/refs/heads/main/llms/paxos-llms.txt

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/paxos-claims-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

paxos-claims-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Paxos Claims API
  version: '2.0'
  description: Welcome to Paxos APIs.
  x-logo:
    url: /docs/paxos.svg
    backgroundColor: '#FFFFFF'
    altText: Paxos logo
servers:
- url: https://api.paxos.com/v2
  description: Production
- url: https://api.sandbox.paxos.com/v2
  description: Sandbox
tags:
- name: Claims
  description: 'Claims represent rewards paid out on-chain. Use claim schedules to automate daily reward claims.


    *These endpoints are only relevant for whitelisted Rewards partners.*'
paths:
  /rewards/claim-schedules:
    get:
      summary: List claim schedules
      description: Returns a paginated list of claim schedules
      operationId: ListClaimSchedules
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListClaimSchedulesResponse'
      parameters:
      - name: payout_group_id
        description: Optionally filter by payout_group
        in: query
        required: false
        schema:
          type: string
      - name: limit
        description: Number of results to return. Defaults to 100. Maximum 1000.
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: page_cursor
        description: 'Optional: Cursor for getting the next page of results.'
        in: query
        required: false
        schema:
          type: string
      tags:
      - Claims
      security:
      - OAuth2:
        - rewards:read_claims_schedule
    post:
      summary: Create a claim schedule
      description: Creates a new claim schedule for automatic reward claims
      operationId: CreateClaimSchedule
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateClaimScheduleResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClaimScheduleRequest'
        required: true
      tags:
      - Claims
      security:
      - OAuth2:
        - rewards:write_claims_schedule
  /rewards/claim-schedules/{id}:
    delete:
      summary: Delete a claim schedule
      description: Deletes a claim schedule
      operationId: DeleteClaimSchedule
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteClaimScheduleResponse'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - Claims
      security:
      - OAuth2:
        - rewards:write_claims_schedule
    put:
      summary: Update a claim schedule
      description: Updates an existing claim schedule
      operationId: UpdateClaimSchedule
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateClaimScheduleResponse'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimServicePublicUpdateClaimScheduleBody'
        required: true
      tags:
      - Claims
      security:
      - OAuth2:
        - rewards:write_claims_schedule
  /rewards/claims:
    get:
      summary: List claims
      description: Returns a paginated list of claims with optional filtering
      operationId: ListClaims
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListClaimsResponse'
      parameters:
      - name: payout_group_id
        description: Optional filters
        in: query
        required: false
        schema:
          type: string
      - name: statuses
        in: query
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - PENDING
            - SUBMITTED
            - CONFIRMED
            - FAILED
      - name: chain
        in: query
        required: false
        schema:
          type: string
      - name: jurisdiction
        in: query
        required: false
        schema:
          type: string
      - name: start_time
        description: Start and end times - Inclusive
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: end_time
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: asset_type
        description: When set, only claims for this asset type (e.g. "USDG", "PYUSD") are returned.
        in: query
        required: false
        schema:
          type: string
      - name: limit
        description: Pagination
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: page_cursor
        in: query
        required: false
        schema:
          type: string
      tags:
      - Claims
      security:
      - OAuth2:
        - rewards:read_claims
components:
  schemas:
    DeleteClaimScheduleResponse:
      type: object
      title: Empty
    ListClaimSchedulesResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ClaimSchedule'
          description: Claim schedules in this page of results.
        next_page_cursor:
          type: string
          description: Token to retrieve the next page of results, or empty if there are no more results.
    CreateClaimScheduleRequest:
      type: object
      properties:
        payout_group_id:
          type: string
        schedule_type:
          $ref: '#/components/schemas/ScheduleType'
        days_of_week:
          type: array
          items:
            type: integer
            format: int32
        days_of_month:
          type: array
          items:
            type: integer
            format: int32
        hour:
          type: integer
          format: int32
        minute:
          type: integer
          format: int32
      required:
      - payout_group_id
      - schedule_type
      - hour
      - minute
    ClaimType:
      type: string
      enum:
      - CLAIM_ALL
      - CLAIM_FOR_ADDRESSES
      - CLAIM_UNREGISTER
      title: Claim-related enums
    ClaimOnchainStatus:
      type: string
      enum:
      - PENDING
      - SUBMITTED
      - CONFIRMED
      - FAILED
    ClaimServicePublicUpdateClaimScheduleBody:
      type: object
      properties:
        schedule_type:
          $ref: '#/components/schemas/ScheduleType'
        days_of_week:
          type: array
          items:
            type: integer
            format: int32
        days_of_month:
          type: array
          items:
            type: integer
            format: int32
        hour:
          type: integer
          format: int32
        minute:
          type: integer
          format: int32
      required:
      - schedule_type
      - hour
      - minute
    CreateClaimScheduleResponse:
      type: object
      properties:
        claim_schedule:
          $ref: '#/components/schemas/ClaimSchedule'
    ClaimSchedule:
      type: object
      properties:
        id:
          type: string
        payout_group_id:
          type: string
        schedule_type:
          $ref: '#/components/schemas/ScheduleType'
        next_run_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        days_of_week:
          type: array
          items:
            type: integer
            format: int32
        days_of_month:
          type: array
          items:
            type: integer
            format: int32
        hour:
          type: integer
          format: int32
        minute:
          type: integer
          format: int32
    UpdateClaimScheduleResponse:
      type: object
      properties:
        claim_schedule:
          $ref: '#/components/schemas/ClaimSchedule'
    ScheduleType:
      type: string
      enum:
      - DAILY
      - MONTHLY
      - WEEKLY
    ListClaimsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Claim'
          description: Claims in this page of results.
        next_page_cursor:
          type: string
          description: Token to retrieve the next page of results, or empty if there are no more results.
    Claim:
      type: object
      properties:
        id:
          type: string
        payout_group_id:
          type: string
        claim_type:
          $ref: '#/components/schemas/ClaimType'
        claim_schedule_id:
          type: string
          title: Present if triggered by schedule
        onchain_status:
          $ref: '#/components/schemas/ClaimOnchainStatus'
        amount:
          type: string
          format: decimal
          title: Amount in business units (e.g., "123.456789" for USDG)
        tx_hash:
          type: string
        addresses:
          type: array
          items:
            type: string
          title: For CLAIM_FOR_ADDRESSES type
        error_message:
          type: string
        blockchain:
          type: string
        asset_type:
          type: string
        submitted_at:
          type: string
          format: date-time
        confirmed_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      title: Claim represents a reward claim transaction
  securitySchemes:
    OAuth2:
      type: oauth2
      description: 'Paxos APIs use [OAuth 2](https://tools.ietf.org/html/rfc6749) with the [client credentials](https://tools.ietf.org/html/rfc6749#section-4.4) grant flow.


        **Token URLs:**

        - Production: https://oauth.paxos.com/oauth2/token

        - Sandbox: https://oauth.sandbox.paxos.com/oauth2/token


        Learn more in the [API credentials guide →](https://docs.paxos.com/developer/credentials)

        '
      flows:
        clientCredentials:
          tokenUrl: https://oauth.paxos.com/oauth2/token
          scopes:
            conversion:read_conversion_stablecoin: Retrieve stablecoin conversion details
            conversion:write_conversion_stablecoin: Create or cancel a stablecoin conversion
            exchange:historical_prices: Retrieve marketnaverage prices at a certain time increment
            exchange:read_order: Retrieve order or order execution details
            exchange:read_quote: Retrieve quote details for buying or selling an asset
            exchange:read_quote_execution: Retrieve quote execution details
            exchange:write_quote_execution: Create a quote execution for buying or selling an asset
            exchange:write_order: Create or cancel an order for buying or selling an asset
            fee:write_crypto_withdrawal_fee: Create a guaranteed fee for crypto withdrawal
            funding:read_bank_balance: Retrieve Paxos dedicated bank account balance
            funding:read_profile: Retrieve Profile details and deposit funds in Sandbox
            funding:write_profile: Create a Profile
            identity:read_account: Retrieve Account details
            identity:read_identity: Retrieve Identity details or documents
            identity:write_account: Create or update Account and Account Members
            identity:write_identity: Create or update Identity details and set Sandbox Identify Status
            settlement:read_transaction: Retrieve settlement transaction details
            settlement:write_transaction: Create, affirm or cancel a settlement transaction
            tax:read_tax_form: Retrieve tax details
            tax:read_tax_lot: Retrieve tax lot details
            tax:write_tax_lot: Update the given tax-lot ID
            transfer:read_deposit_address: Retrieve deposit address details
            transfer:read_fiat_account: Retrieve Fiat Account details
            transfer:read_fiat_deposit_instructions: Retrieve fiat deposit instruction details
            transfer:read_transfer: Retrieve transfer details
            transfer:read_transfer_limit: Retrieve limits for the given transaction type
            transfer:reject_crypto_deposit: Reject a crypto deposit (travel rule)
            transfer:update_crypto_deposit: Provide required travel-rule details
            transfer:write_crypto_withdrawal: Withdraw asset to a specified destination address
            transfer:write_deposit_address: Create an deposit address on a blockchain network
            transfer:write_fiat_account: Create, update or delete a Fiat Account
            transfer:write_fiat_deposit_instructions: Create, update or delete fiat deposit instructions
            transfer:write_internal_transfer: Transfer assets between two Profiles
            transfer:write_sandbox_fiat_deposit: Initiate a test fiat deposit in the Sandbox environment
            transfer:write_fiat_withdrawal: Withdraw fiat to the given destination
            events:read_event: Retrieve events
x-tagGroups:
- name: Deposits and Withdrawals
  tags:
  - Transfers
  - Fiat Transfers
  - Deposit Addresses
  - Crypto Deposits
  - Crypto Withdrawals
  - Fees
  - Internal Transfers
  - Paxos Transfers
  - Limits
- name: Identity
  tags:
  - Identity
  - Institution Members
  - Accounts
  - Account Members
  - Identity Documents
- name: API Credentials
  tags:
  - API Credentials
- name: Profiles
  tags:
  - Profiles
- name: Sandbox
  tags:
  - Sandbox Deposits
  - Sandbox Identity
  - Sandbox Fiat Transfers
- name: Settlements
  tags:
  - Settlement
- name: Stablecoin Conversion
  tags:
  - Stablecoin Conversion
- name: Taxes
  tags:
  - Tax Forms
- name: Trading
  tags:
  - Market Data
  - Orders
  - Quotes
  - Quote Executions
  - Pricing
  - Issuer Quotes
- name: Rewards
  tags:
  - Monitoring Addresses
  - Statements
  - Payments
- name: Rewards (Alpha)
  tags:
  - Reward Addresses
  - Claims
  - Payout Groups
  - Rewards
- name: Events
  tags:
  - Events
  - Event Types
  - Event Objects