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 Finance Instalments V2 API

The Finance Instalments V2 API from Receeve — 5 operation(s) for finance instalments v2.

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

Tagged areas include Finance Instalments V2. 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 5 operations across 5 paths, and defines 22 schemas. It is described by OpenAPI 3.0.3, at version 1.53.1.

Requests are made against a single base URL, /.

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

Paths & Operations 5

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

Finance Instalments V2 5
GET
/finance/v1/{clientId}/instalment_plan_definitions
List Instalment Plan Definitions
getInstalmentPlanDefinitions 7 params → 200400401403429500
POST
/finance/v1/{clientId}/compute_instalment_plan_definition
Compute Instalment Plan Definition
computeInstalmentPlanDefinition 4 params body → 200400401403429500
POST
/finance/v1/{clientId}/create_instalment_plan
Create Instalment Plan
createInstalmentPlan 4 params body → 200400401403429500
POST
/finance/v1/{clientId}/update_instalment_plan
Update Instalment Plan
updateInstalmentPlan 4 params body → 200400401403429500
GET
/finance/v1/{clientId}/instalment_plans
Get Instalment Plans
getInstalmentPlans 8 params → 200400401403429500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ComputedInstalmentPlanDefinitionFixedAmountsV2 (18 properties), InstalmentPlanV2 (18 properties), ComputedInstalmentPlanDefinitionProgrammaticV2 (15 properties), InstalmentPlanDefinitionV2 (10 properties). Each schema is shown below with its type and property counts.

ComputedInstalmentPlanDefinitionPercentageAmountsV2
object
9 properties 9 required
ComputedInstalmentPlanDefinitionChoiceV2
object
9 properties 8 required
ComputeInstalmentPlanDefinitions
InstalmentPlanBaseV2
object
Base structure for an instalment plan
5 properties
InstalmentTransactionV2
ComputedInstalmentPlanDefinitionNullV2
object
7 properties 7 required
PaginatedInstalmentPlans
object
2 properties 1 required
InstalmentPlanDefinitionV2
object
10 properties 6 required
GetInstalmentPlans
GetInstalmentPlanDefinitions
InstalmentV2
object
9 properties 5 required
ComputedInstalmentPlanDefinitionFixedAmountsV2
object
18 properties 13 required
ComputedInstalmentPlanDefinitionProgrammaticV2
object
15 properties 10 required
ActionResponse
object
Response of any action that causes any side effect in the platform (e.g. create, update, delete)
3 properties 3 required
ComputeInstalmentPlanDefinitionInput
object
Input for computing instalment plan definition. Supports additional dynamic context properties.
4 properties 1 required
InstalmentPlanV2
object
18 properties 5 required
PaginatedInstalmentPlanDefinitions
object
2 properties 1 required
InstalmentTransactionBaseV2
object
5 properties 3 required
InstalmentPlanStatusV2
string
Status of the instalment plan
CreateInstalmentPlans
UpdateInstalmentPlanInput
object
4 properties 3 required
CreateInstalmentPlanInput
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

receeve-finance-instalments-v2-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 Settlements API
Receeve Journey API
Receeve LandingPage API
Receeve Message API
Receeve PromiseToPay API