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

This is the overall strategy to resolve the outstanding payment or debt.

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

Tagged areas include Journey. 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 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.53.1.

Requests are made against a single base URL, /.

3 operations 3 paths 2 schemas 3 POST

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

Paths & Operations 3

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

Journey 3

This is the overall strategy to resolve the outstanding payment or debt.

POST
/v1/{clientId}/pause_journeys
Pause Journeys for particular claims. You may restart them at a later date if you choose. It will resume where it left off.
pauseJourneys 6 params body → 200400401403429500
POST
/v1/{clientId}/resume_journeys
Resume Journeys for particular claims.
resumeJourneys 6 params body → 200400401403429500
POST
/v1/{clientId}/stop_journeys
Stop Journeys for particular claims. This ends all processing on those claims.
stopJourneys 6 params body → 200400401403429500

Schemas 2

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

ActionResponse
object
Response of any action that causes any side effect in the platform (e.g. create, update, delete)
3 properties 3 required
ClaimResolutionReason
string
The reason for the claim resolution.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

receeve-journey-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 LandingPage API
Receeve Message API
Receeve PromiseToPay API