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 Beneficiaries API

The Beneficiaries API from HitPay — 3 operation(s) for beneficiaries.

HitPay Beneficiaries API is one of 24 APIs that HitPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Beneficiaries. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 6 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.

6 operations 3 paths 6 schemas 1 DELETE2 GET1 PATCH2 POST

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 6

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

Beneficiaries 6
POST
/v1/beneficiaries/schema
Get the API schema
get-schema 1 param body → 200422
POST
/v1/beneficiaries
Create a new beneficiary
create-beneficiary 1 param body → 201422
GET
/v1/beneficiaries
Get list of beneficiaries
get-all-beneficiary 3 params → 200
PATCH
/v1/beneficiaries/{beneficiary_id}
Update existing beneficiary
update-beneficiary 2 params body → 200422
DELETE
/v1/beneficiaries/{beneficiary_id}
Delete existing beneficiary
delete-beneficiary 2 params → 204
GET
/v1/beneficiaries/{beneficiary_id}
Get a beneficiary by ID
get-beneficiary-detail 2 params → 200404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are beneficiary-bd-local (13 properties), beneficiary-php-local (13 properties), beneficiary-sqd-fast (12 properties), beneficiary-bd-tap (11 properties). Each schema is shown below with its type and property counts.

beneficiary-bd-bkash
object
11 properties 7 required
beneficiary-bd-upay
object
11 properties 7 required
beneficiary-sqd-fast
object
12 properties 7 required
beneficiary-bd-tap
object
11 properties 7 required
beneficiary-php-local
object
13 properties 8 required
beneficiary-bd-local
object
13 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hitpay-beneficiaries-api-openapi.yml Raw ↑

Other APIs HitPay publishes across the network.

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