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/payjoy-salesclerks-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

openapi: 3.2.0
info:
  title: PayJoy Partner API V2 Carts Sales Clerks API
  version: 1.0.0
  description: 'PayJoy Partner API (Sales Integration) lets retail and OEM partners integrate PayJoy point-of-sale financing: retrieve cart/sale information, list merchants and sales clerks, offer and process customer repayments, redeem and cancel vouchers, pay down payments, and pull transaction history for reconciliation. Assembled by API Evangelist from the per-operation OpenAPI fragments published verbatim on the PayJoy developer portal API Reference.'
  contact:
    name: PayJoy Developer Portal
    url: https://developers.payjoy.com/
servers:
- url: https://partner-integration.sandbox.payjoy.com/partner-api
  description: Sandbox
security:
- PayJoyApiKeyAuth: []
tags:
- name: SalesClerks
  description: Retrieve sales clerks information.
paths:
  /v2/clerks:
    get:
      tags:
      - SalesClerks
      summary: Get Sales Clerks information
      description: Retrieve all sales clerks
      operationId: getSalesClerks
      parameters:
      - name: X-PayJoy-ApiKey
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSalesClerksResponse'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /v2/clerks/{clerkTag}:
    get:
      tags:
      - SalesClerks
      summary: Get Sales Clerk information by clerkTag
      description: Retrieve a single sales clerk by clerkTag
      operationId: getSalesClerk
      parameters:
      - name: X-PayJoy-ApiKey
        in: header
        required: true
        schema:
          type: string
      - name: clerkTag
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSalesClerkResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    GetSalesClerkResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            clerkTag:
              type: string
            name:
              type: string
            phoneNumber:
              type: string
            email:
              type: string
            isActive:
              type: boolean
            assignedMerchant:
              type: object
              properties:
                merchantTag:
                  type: string
                merchantName:
                  type: string
            metadata:
              type: object
              additionalProperties:
                type: string
    ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Error'
    GetSalesClerksResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              clerkTag:
                type: string
              name:
                type: string
              phoneNumber:
                type: string
              email:
                type: string
              isActive:
                type: boolean
              assignedMerchant:
                type: object
                properties:
                  merchantTag:
                    type: string
                  name:
                    type: string
              metadata:
                type: object
                additionalProperties:
                  type: string
    Error:
      type: object
      properties:
        code:
          type: string
          description: The error code
        message:
          type: string
          description: Human-readable error message
        context:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              value:
                type: string
  securitySchemes:
    PayJoyApiKeyAuth:
      type: apiKey
      in: header
      name: X-PayJoy-ApiKey
      description: API key required to authenticate all requests. Include this key in the request header as `X-PayJoy-ApiKey`.