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

Receeve Message API

Communication message in .eml format that was sent to Debtor.

Receeve Message API is one of 14 APIs that Receeve publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.53.1.

Requests are made against a single base URL, /.

2 operations 2 paths 1 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.53.1
Base URL
https://api.receive-demo.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Receeve Message API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 2

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

Message 2

Communication message in .eml format that was sent to Debtor.

GET
/v1/{clientId}/get_message
Get message in .eml format.
getMessage 3 params → 200400401403429500
GET
/v1/{clientId}/get_communication_message_urls
Get communication message URLs by communication type, timeframe. Paginated.
getCommunicationMessageURLs 7 params → 200400401403429500

Schemas 1

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

CommunicationMessageURL
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

receeve-message-api-openapi.yml Raw ↑

Other APIs Receeve publishes across the network.

Receeve Account API
Receeve AccountMandate API
Receeve Claim API
Receeve CustomTriggers API
Receeve Debtor API
Receeve Event API
Receeve Files API
Receeve Finance Instalments V2 API
Receeve Finance Settlements API
Receeve Journey API
Receeve LandingPage API
Receeve PromiseToPay API