Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Highline Payment Requests API

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

Highline Payment Requests API is one of 10 APIs that Highline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Requests. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.highline.co, https://api.sandbox.highline.co.

6 operations 4 paths 1 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
https://api.highline.co
https://api.sandbox.highline.co
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Highline Payment Requests API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

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

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is PaymentRequest (5 properties). Each schema is shown below with its type and property counts.

PaymentRequest
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highline-fi-payment-requests-api-openapi.yml Raw ↑

Other APIs Highline publishes across the network.

Highline Pay by Paycheck API
Highline Auth API
Highline Companies API
Highline Connections API
Highline Employments API
Highline Payments API
Highline Products API
Highline Settlements API
Highline Users API