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/chartercaptain-com:chartercaptain-com-payments-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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: Charter Captain Payments API
  version: 1.0.0
  description: REST API for the Charter Captain iOS apps
servers:
- url: http://localhost:3002
  description: Development
security:
- bearerAuth: []
tags:
- name: Payments
paths:
  /api/v1/bookings/{id}/payments:
    post:
      operationId: postBookingPayment
      summary: Record a payment on a booking (captain)
      tags:
      - Payments
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      - $ref: '#/components/parameters/IdempotencyKeyHeader'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                  - DEPOSIT
                  - BALANCE
                  - TIP
                amount:
                  type: integer
                  minimum: 0
                method:
                  type: string
                  enum:
                  - CASH
                  - CHECK
                  - CONNECTED_CARD
                note:
                  type: string
                  default: ''
                connectedPaymentMethodId:
                  type:
                  - string
                  - 'null'
                source:
                  type:
                  - string
                  - 'null'
                  enum:
                  - CASH
                  - CHECK
                  - VENMO
                  - ZELLE
                  - PAYPAL
                  - OTHER
                  - null
              required:
              - type
              - amount
              - method
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMutationResponse'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/IdempotencyConflict'
  /api/v1/payments/{id}/refund:
    post:
      operationId: postPaymentRefund
      summary: Refund a payment (captain)
      tags:
      - Payments
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                  minimum: 1
                reason:
                  type: string
                  enum:
                  - REQUESTED_BY_CUSTOMER
                  - DUPLICATE
                  - FRAUDULENT
                  - OTHER
                note:
                  type: string
                  default: ''
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMutationResponse'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: The requested resource does not exist (existence is not leaked).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required, or the bearer token is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationError:
      description: Request body or query parameters failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    IdempotencyConflict:
      description: Idempotency-Key was reused with a different request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IdempotencyConflictError'
  schemas:
    IdempotencyKeyHeader:
      type: string
      format: uuid
      description: Client-supplied UUID v4. Repeat requests with the same key return the cached response.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
          required:
          - message
          - code
      required:
      - error
    PaymentMutationResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            paymentId:
              type: string
          required:
          - paymentId
      required:
      - data
    IdempotencyConflictError:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
              enum:
              - IDEMPOTENCY_CONFLICT
          required:
          - message
          - code
      required:
      - error
  parameters:
    IdempotencyKeyHeader:
      schema:
        $ref: '#/components/schemas/IdempotencyKeyHeader'
      required: false
      description: Client-supplied UUID v4. Repeat requests with the same key return the cached response.
      name: Idempotency-Key
      in: header
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Clerk JWT token