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

HitPay Payment Requests API

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

HitPay Payment Requests API is one of 24 APIs that HitPay 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, API documentation, and an API reference.

This API exposes 9 operations across 4 paths, and defines 2 schemas. It is described by OpenAPI 3.1.1, at version 1.0.

Requests are made against 2 base URLs: https://api.hit-pay.com, https://api.sandbox.hit-pay.com.

9 operations 4 paths 2 schemas 2 DELETE4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
API Version
1.0
Base URL
https://api.hit-pay.com/v1
Resource Areas
1

Paths & Operations 9

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

Payment Requests 9
POST
/v1/payment-requests
Create Payment Request
create-payment-request 1 param body → 200422
GET
/v1/payment-requests
Get Payment Requests
get-payment-requests 6 params → 200
PUT
/v1/payment-requests/{request_id}
Update Payment Request
update-payment-request 2 params body → 200
DELETE
/v1/payment-requests/{request_id}
Delete Payment Request
delete-payment-request 2 params → 200404
GET
/v1/payment-requests/{request_id}
Get Payment Request Status
get-payment-status 2 params → 200404
POST
/payment-requests
Create a payment request
createPaymentRequest body → 201
GET
/payment-requests
List payment requests
listPaymentRequests 1 param → 200
GET
/payment-requests/{id}
Get a payment request
getPaymentRequest 1 param → 200
DELETE
/payment-requests/{id}
Delete / cancel a payment request
deletePaymentRequest 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are PaymentRequestCreate (10 properties), PaymentRequest (7 properties). Each schema is shown below with its type and property counts.

PaymentRequest
object
7 properties
PaymentRequestCreate
object
10 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hitpay-payment-requests-api-openapi.yml Raw ↑

Other APIs HitPay publishes across the network.

HitPay Account Status API
HitPay Balances API
HitPay Beneficiaries API
HitPay Charge API
HitPay Charges API
HitPay Customers API
HitPay Invoices API
HitPay Notifications API
HitPay Orders API
HitPay Product Category API
HitPay Products API
HitPay Readers API