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

The Finance Settlements API from Receeve — 5 operation(s) for finance settlements.

Receeve Finance Settlements 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 Settlements. 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 10 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 10 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 Settlements 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 Settlements 5
POST
/finance/v1/{clientId}/set_settlement_definition
Create or Update a Settlement Definition
setSettlementDefinition 4 params body → 200400401403429500
POST
/finance/v1/{clientId}/apply_settlement
Apply a DIRECT Settlement
applySettlement 4 params body → 200400401403429500
POST
/finance/v1/{clientId}/withdraw_settlement
Withdraw a Settlement
withdrawSettlement 4 params body → 200400401403429500
GET
/finance/v1/{clientId}/settlement
Get a Settlement by id
getSettlement 4 params → 200400401403429500
GET
/finance/v1/{clientId}/settlements
List Settlements for an Account
getSettlements 4 params → 200400401403429500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Settlement (13 properties), SettlementDefinitionInput (6 properties), ApplySettlementInput (5 properties), ActionResponse (3 properties). Each schema is shown below with its type and property counts.

Settlement
object
13 properties 9 required
GetSettlement
SettlementSelector
What the settlement definition materialises against.
GetSettlements
WithdrawSettlementInput
object
2 properties 1 required
SettlementDiscount
The discount rule a settlement applies.
SettlementDefinitionInput
object
6 properties 5 required
SetSettlementDefinition
ActionResponse
object
Response of any action that causes any side effect in the platform (e.g. create, update, delete)
3 properties 3 required
ApplySettlementInput
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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