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

Event that happened in Receive systems, for example, claim created or email delivered.

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

Tagged areas include Event. 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 1 operation across 1 path, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.53.1.

Requests are made against a single base URL, /.

1 operations 1 paths 5 schemas 1 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 Event API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 1

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

Event 1

Event that happened in Receive systems, for example, claim created or email delivered.

GET
/v1/{clientId}/get_events
Get events by event type and timeframe. Paginated.
getEvents 6 params → 200400401403429500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ClaimCreatedEvent (3 properties), ClaimDebtPaymentProcessingEvent (3 properties). Each schema is shown below with its type and property counts.

ClaimDebtPaymentProcessingEvent
object
3 properties 3 required
ClaimCreatedEvent
object
3 properties 3 required
Currency
string
3-digit currency code (ISO 4217)
PaymentReference
string
Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
DueDate
string
Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

receeve-event-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 Files API
Receeve Finance Instalments V2 API
Receeve Finance Settlements API
Receeve Journey API
Receeve LandingPage API
Receeve Message API
Receeve PromiseToPay API