How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Heron Merchants API

The Merchants API from Heron — 6 operation(s) for merchants.

Heron Merchants API is one of 48 APIs that Heron publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Merchants. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 6 operations across 6 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 2021-07-19.

Requests are made against a single base URL, https://app.herondata.io.

6 operations 6 paths 7 schemas 4 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2021-07-19
Base URL
https://app.herondata.io/api
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Heron Merchants API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 6

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

Merchants 6
POST
/api/merchants/extract
Extract merchant
body → 200
GET
/api/merchants/groups
List merchant groups
→ 200
GET
/api/merchants/list
List merchants
4 params → 200
GET
/api/merchants/search
Search merchants
2 params → 200
GET
/api/merchants/{heron_id}
Get merchant by ID
1 param → 200
PATCH
/api/merchants/{merchant_heron_id}/user_merchant_group
Set merchant group override
1 param body → 200404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Merchant1 (17 properties), Merchant (8 properties), MerchantExtract (8 properties), PaymentProcessor (5 properties). Each schema is shown below with its type and property counts.

Merchant1
object
17 properties 2 required
MerchantCategory
object
3 properties 1 required
UserMerchantGroupSchema
object
3 properties 2 required
MerchantExtract
object
8 properties
PaymentProcessor
object
5 properties
MerchantGroup
object
3 properties
Merchant
object
8 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heron-merchants-api-openapi.yml Raw ↑

Other APIs Heron publishes across the network.

Heron Analytics API
Heron App Store API
Heron Authentication API
Heron Broker Funder Policies API
Heron Broker Submissions API
Heron Categories API
Heron Clear API
Heron Credentials API
Heron CRM Integrations API
Heron Email Templates API
Heron End Users API
Heron End User Accounts API
Where this information came from

This is an independent, third-party profile of Heron Merchants API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.