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

HitchPin instant-invoice-share API

Invoices shared with a buyer.

HitchPin instant-invoice-share API is one of 3 APIs that HitchPin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include instant-invoice-share. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.1.1, at version 2.0.0.

Requests are made against 5 base URLs: https://localhost, https://apiv2.sandbox.hitchpin.com, https://apiv2.staging.hitchpin.com, https://apiv2.demo.hitchpin.com, https://apiv2.hitchpin.com.

3 operations 3 paths 5 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
API Version
2.0.0
Base URL
https://apiv2.hitchpin.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

HitchPin instant-invoice-share API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Authorization (tokenAuth).

  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 3

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

instant-invoice-share 3

Invoices shared with a buyer.

GET
/instant-invoice-share/{share_hash}/
Used for viewing and paying shared InstantInvoices
retrieve_shared_instant_invoice 1 param → 200400404
POST
/instant-invoice-share/{share_hash}/pay/
Action that allows a guest or user to pay an InstantInvoice.
pay_instant_invoice 1 param body → 200400404
GET
/instant-invoice-share/{share_hash}/receipt/
Action that returns a receipt if a paid InstantInvoice (via share).
get_instant_invoice_receipt 1 param → 200400404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Nested (10 properties), InstantInvoiceShare (10 properties), ShareableInstantInvoice (6 properties), InstantInvoiceReceipt (4 properties). Each schema is shown below with its type and property counts.

ShareableInstantInvoice
object
6 properties
InstantInvoiceReceipt
object
4 properties
InstantInvoiceShareRequest
object
3 properties
InstantInvoiceShare
object
10 properties
Nested
object
10 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hitchpin-instant-invoice-share-api-openapi.yml Raw ↑

Other APIs HitchPin publishes across the network.

HitchPin instant-invoices API
HitchPin rendering API