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

The Debtor API from Receeve — 1 operation(s) for debtor.

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

Tagged areas include Debtor. 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 23 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 23 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 Debtor 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.

Debtor 1
GET
/v1/{clientId}/get_debtor_accounts_and_claims
It retrieves information about a debtor's accounts and claims
getDebtorAccountsAndClaims 4 params → 200400401403429500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are BaseClaim (21 properties), BaseContactInformation (12 properties), BaseDebtor (11 properties), Product (6 properties). Each schema is shown below with its type and property counts.

ClaimScore
object
An Claim Score is a score that is calculated for a specific claim.
3 properties 2 required
RelatedClaim
object
A typed relation from this claim to another claim (lineage metadata; the platform does not act on it)
2 properties 2 required
BaseContactInformation
object
12 properties
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.
ProductReference
string
Identifier for a product in your system. It is used for grouping purposes.
DueDate
string
Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
Amount
integer
Monetary value in cents (natural nuumber)
ClaimOrigination
object
The product/service context and origin of the claim
4 properties 2 required
BaseDebtor
object
11 properties
AccountReference
string
Account reference in your system
DebtorReference
string
Your customer ID for this person or company
BaseClaim
object
A claim is an outstanding payment that is owed. You can always update this balance if multiple payments are missed and you want to aggregate the amounts.
21 properties
OriginalDueDate
string
Original due date in your system. This is the day when it went past due. DPD 0.
Debtor
The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName a…
Currency
string
3-digit currency code (ISO 4217)
Repayment
object
A repayment entry in the pre-sale payment history of a claim
5 properties 1 required
Metadata
object
Additional information related to the entity.
Claim
ContactInformation
Contact information of the debtor, used for communication purposes.
PortfolioReference
string
This is a optional grouping field for reporting purposes.
DebtorAccountsAndClaims
array
Product
object
A product is a service or item used to give context to the Claim or Ledger Entry
6 properties 1 required
Fee
object
Additional expected payment amount.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

receeve-debtor-api-openapi.yml Raw ↑

Other APIs Receeve publishes across the network.

Receeve Account API
Receeve AccountMandate API
Receeve Claim API
Receeve CustomTriggers 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
Receeve PromiseToPay API