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

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.

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

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

Requests are made against a single base URL, /.

10 operations 10 paths 38 schemas 2 GET8 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 Claim API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 10

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

Claim 10

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.

GET
/v1/{clientId}/get_account_claims
It retrieves the claims from a given account
getAccountClaims 7 params → 200400401403429500
GET
/v1/{clientId}/get_debtor_accounts_and_claims
It retrieves information about a debtor's accounts and claims
getDebtorAccountsAndClaims 4 params → 200400401403429500
POST
/v1/{clientId}/create_claims
Create claims in Receive
createClaims 6 params body → 200400401403429500
POST
/v1/{clientId}/recreate_claims
Recreate claims in Receive, applicable for already deleted claims.
recreateClaims 6 params body → 200400401403429500
POST
/v1/{clientId}/update_claims
Update claims in the platform
updateClaims 7 params body → 200400401403429500
POST
/v1/{clientId}/import_claims
Insert or Update Claims in the platform
importClaims 6 params body → 200400401403429500
POST
/v1/{clientId}/resolve_claims
Resolves Claims with a reason
resolveClaims 6 params body → 200400401403429500
POST
/v1/{clientId}/credit_claims
Credit claims
creditClaims 6 params body → 200400401403429500
POST
/v1/{clientId}/debit_claims
Debit claims
debitClaims 6 params body → 200400401403429500
POST
/v1/{clientId}/set_link_claims
Set link claims
setLinkClaims 5 params body → 200400401403429500

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are BaseClaim (21 properties), BaseContactInformation (12 properties), BaseDebtor (11 properties), DebitClaimInput (9 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
CreditClaimActionResponse
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.
Movement
object
A single credit/debit movement contributing to a claim import. Emit-only classification, not state: movements never drive the claim amount — they only determin…
4 properties 2 required
ProductReference
string
Identifier for a product in your system. It is used for grouping purposes.
CreditClaimInput
object
9 properties 3 required
RecreateClaims
DebitClaimInput
object
9 properties 3 required
UpdateClaimInput
Input for updateclaims endpoint.
DueDate
string
Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
CreateClaimInput
Input for createclaims endpoint.
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
ClaimInput
Used when creating or importing claims
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
DebtorReference
string
Your customer ID for this person or company
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…
ClaimResponse
object
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
DebitClaimActionResponse
Metadata
object
Additional information related to the entity.
ClaimResolutionReason
string
The reason for the claim resolution.
ImportClaimInput
Input for updateclaims endpoint.
CreateClaims
UpdateClaimOptions
object
Additional modifiers when updating claims
1 property
Claim
ContactInformation
Contact information of the debtor, used for communication purposes.
ActionResponse
object
Response of any action that causes any side effect in the platform (e.g. create, update, delete)
3 properties 3 required
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-claim-api-openapi.yml Raw ↑

Other APIs Receeve publishes across the network.

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