Paxos Claims API

openapi: 3.0.0
info:
  title: Paxos Account Members Claims API
  version: '2.0'
  description: '<p>Welcome to Paxos APIs. At Paxos, our mission is to enable the movement of any asset, any time, in a trustworthy way. These APIs serve that mission by making it easier than ever for you to directly integrate our product capabilities into your application, leveraging the speed, stability, and security of the Paxos platform.</p> <p>The documentation that follows gives you access to our Crypto Brokerage, Trading, and Exchange products. It includes APIs for market data, orders, and the held rate quote flow.</p> <p>To test in our sandbox environment, <a href="https://account.sandbox.paxos.com" target="_blank">sign up</a> for an account. For more information about Paxos and our APIs, visit <a href="https://www.paxos.com/" target="_blank">Paxos.com</a>.</p>

    '
  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:
    ClaimOnchainStatus:
      type: string
      enum:
      - PENDING
      - SUBMITTED
      - CONFIRMED
      - FAILED
    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
    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.
    UpdateClaimScheduleResponse:
      type: object
      properties:
        claim_schedule:
          $ref: '#/components/schemas/ClaimSchedule'
    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.
    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
    ClaimType:
      type: string
      enum:
      - CLAIM_ALL
      - CLAIM_FOR_ADDRESSES
      - CLAIM_UNREGISTER
      title: Claim-related enums
    DeleteClaimScheduleResponse:
      type: object
      title: Empty
    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
    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
    ScheduleType:
      type: string
      enum:
      - DAILY
      - MONTHLY
      - WEEKLY
  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