Paxos API Credentials API

openapi: 3.0.0
info:
  title: Paxos Account Members API Credentials 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: API Credentials
  description: 'API credentials allow programmatic access to Paxos APIs. These endpoints enable you to manage and view your API credentials.

    '
paths:
  /api-creds/credentials:
    get:
      summary: List API Credentials
      description: List all API credentials that have been created.
      operationId: ListApiCredentials
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListApiCredentialsResponse'
      parameters:
      - name: order
        description: Determines whether the items are returned in ascending (ASC), or descending (DESC) order. Defaults to DESC.
        in: query
        required: false
        schema:
          type: string
          enum:
          - DESC
          - ASC
      - name: order_by
        description: The specific field by which the returned results will be ordered. Defaults to CREATED_AT.
        in: query
        required: false
        schema:
          type: string
          enum:
          - CREATED_AT
      - name: limit
        description: The maximum number of items to return. Defaults to 0 (return all records). Max value is 1000.
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: page_cursor
        description: The page cursor for pagination. Use the next_page_cursor from the response to get the next page.
        in: query
        required: false
        schema:
          type: string
      - name: statuses
        description: Filter for credentials with a set of statuses. Defaults to [APPROVED].
        in: query
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - APPROVED
            - DISABLED
      - name: ids
        description: Optionally filter by the UUIDs of the credentials. Limit 100.
        in: query
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: client_ids
        description: Optionally filter by the client IDs of the credentials. Limit 100.
        in: query
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
      tags:
      - API Credentials
      security:
      - OAuth2:
        - api_creds:read_credentials
  /api-creds/credentials/{client_id}:
    delete:
      summary: Delete API Credentials
      description: Delete the given API Credentials, preventing them from being used for authentication.
      operationId: DeleteApiCredentials
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiCredentialsResponse'
      parameters:
      - name: client_id
        description: The client_id of the credentials to delete.
        in: path
        required: true
        schema:
          type: string
      tags:
      - API Credentials
      security:
      - OAuth2:
        - api_creds:delete_credentials
components:
  schemas:
    FirstPartyClient:
      type: object
      properties:
        id:
          type: string
        customer_id:
          type: string
        client_id:
          type: string
        client_public_keys:
          type: array
          items:
            $ref: '#/components/schemas/ClientPublicKey'
        status:
          $ref: '#/components/schemas/FirstPartyClientStatus'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        nickname:
          type: string
        ip_allowlist:
          type: array
          items:
            type: string
        enforce_request_signing:
          type: boolean
        client_scopes:
          type: array
          items:
            type: string
        created_by:
          type: string
    DeleteApiCredentialsResponse:
      type: object
      properties:
        credentials:
          $ref: '#/components/schemas/FirstPartyClient'
    ClientPublicKey:
      type: object
      properties:
        id:
          type: string
        client_id:
          type: string
        algorithm:
          type: string
        public_key:
          type: string
        active:
          type: boolean
        nickname:
          type: string
      required:
      - nickname
      - algorithm
      - public_key
    FirstPartyClientStatus:
      type: string
      enum:
      - APPROVED
      - DISABLED
    ListApiCredentialsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/FirstPartyClient'
        next_page_cursor:
          type: string
          description: The page cursor for the next page of results. Empty if this is the last page.
  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