Highline Payment Requests API

The Payment Requests API from Highline — 4 operation(s) for payment requests.

Operations 6

GET /payment-requests List Payment Requests
GET /payment-requests/{payment-request-id} Get a Payment Request
PUT /payment-requests/{payment-request-id} Update a Payment Request
DELETE /payment-requests/{payment-request-id} Cancel a Payment Request
POST /connections/{connection-id}/payment-requests Create Payment Requests
POST /payment-requests/{payment-request-id}/simulate-due-date Simulate Due Date (sandbox)

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/highline-fi-payment-requests-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.

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

OpenAPI Specification

highline-fi-payment-requests-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Highline Auth Payment Requests API
  description: 'Highline is a payment solution enabling direct paycheck deductions

    (pay-by-paycheck). This OpenAPI definition is generated best-effort

    from public docs at https://docs.highline.co/.

    '
  version: 1.0.0
  contact:
    name: Highline
    url: https://docs.highline.co/
servers:
- url: https://api.highline.co
  description: Production
- url: https://api.sandbox.highline.co
  description: Sandbox
security:
- bearerAuth: []
tags:
- name: Payment Requests
paths:
  /payment-requests:
    get:
      tags:
      - Payment Requests
      summary: List Payment Requests
      responses:
        '200':
          description: OK
  /payment-requests/{payment-request-id}:
    get:
      tags:
      - Payment Requests
      summary: Get a Payment Request
      parameters:
      - $ref: '#/components/parameters/PaymentRequestId'
      responses:
        '200':
          description: OK
    put:
      tags:
      - Payment Requests
      summary: Update a Payment Request
      parameters:
      - $ref: '#/components/parameters/PaymentRequestId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRequest'
      responses:
        '200':
          description: OK
    delete:
      tags:
      - Payment Requests
      summary: Cancel a Payment Request
      parameters:
      - $ref: '#/components/parameters/PaymentRequestId'
      responses:
        '204':
          description: Cancelled
  /connections/{connection-id}/payment-requests:
    post:
      tags:
      - Payment Requests
      summary: Create Payment Requests
      parameters:
      - $ref: '#/components/parameters/ConnectionId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRequest'
      responses:
        '201':
          description: Created
  /payment-requests/{payment-request-id}/simulate-due-date:
    post:
      tags:
      - Payment Requests
      summary: Simulate Due Date (sandbox)
      parameters:
      - $ref: '#/components/parameters/PaymentRequestId'
      responses:
        '200':
          description: OK
components:
  parameters:
    ConnectionId:
      name: connection-id
      in: path
      required: true
      schema:
        type: string
    PaymentRequestId:
      name: payment-request-id
      in: path
      required: true
      schema:
        type: string
  schemas:
    PaymentRequest:
      type: object
      properties:
        connection_id:
          type: string
        amount:
          type: integer
          description: Amount in cents
        currency:
          type: string
          example: USD
        start_date:
          type: string
          format: date
        due_date:
          type: string
          format: date
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT