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

The PromiseToPay API from Receeve — 1 operation(s) for promisetopay.

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

Tagged areas include PromiseToPay. 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 6 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 6 schemas 1 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 PromiseToPay 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 POST. Each is listed below with its method, path, parameters, and response codes.

PromiseToPay 1
POST
/v1/{clientId}/create_promises_to_pay
Create promises to pay, a Promise to Pay enables a debt to be paid partially by a certain minimum amount and by a particular due date.
createPromisesToPay 6 params body → 200400401403429500

Schemas 6

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

Amount
integer
Monetary value in cents (natural nuumber)
ActionResponse
object
Response of any action that causes any side effect in the platform (e.g. create, update, delete)
3 properties 3 required
Currency
string
3-digit currency code (ISO 4217)
CreatePromisesToPay
PromiseToPay
object
A promise to pay is a commitment from a debtor to pay a certain amount at a certain date.
3 properties 3 required
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-promisetopay-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 Message API