A formal business arrangement providing for regular dealings or services (such as banking, advertising, or store credit) and involving the establishment and maintenance of an account
Receeve Account API is one of 14 APIs that Receeve publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Account. 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
14 operations
across 14 paths,
and defines 51 schemas.
It is described by OpenAPI 3.0.3, at version 1.53.1.
Requests are made against a single base URL, /.
14 operations14 paths51 schemas3 GET11 POST
Metadata
The identity and technical contract details declared by the specification.
Receeve Account API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (api_key).
Paths & Operations 14
Across 14 paths, the API surfaces 14 operations — 3 GET, 11 POST. Each is listed below with its method, path, parameters, and response codes.
Account 14
A formal business arrangement providing for regular dealings or services (such as banking, advertising, or store credit) and involving the establishment and maintenance of an acco…
The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are BaseClaim (21 properties), BaseContactInformation (12 properties), BaseDebtor (11 properties), MatchAccountPaymentInput (8 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 properties2 required
RelatedClaim
object
A typed relation from this claim to another claim (lineage metadata; the platform does not act on it)
2 properties2 required
MatchAccountPaymentInput
object
Input for matchaccountpayment endpoint.
8 properties3 required
BaseContactInformation
object
12 properties
DiscountLedgerEntry
object
3 properties3 required
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.
AccountScore
object
An account score is a score that is calculated for a specific account. It can be used to determine the risk of a debtor or any other information that is releva…
3 properties2 required
RelativeAmount
integer
Monetary value in cents (positive or negative number)
AllocateAccountPaymentInput
object
Input for allocateaccountpayment endpoint.
5 properties3 required
LedgerEntryCreatedAt
integer
Timestamp when the ledger entry was created in milliseconds
LedgerEntry
A Ledger Entry is a record of a transaction in the Ledger.
LedgerEntryResponse
Response of any action that adds ledger entries to an account.
DueDate
string
Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
AccountScoreResponse
Response of the setaccountscore endpoint
Amount
integer
Monetary value in cents (natural nuumber)
BaseDebtor
object
11 properties
InvoiceLedgerEntry
object
An Invoice Ledger Entry is a type of Ledger Entry that represents a claim in the system.
3 properties3 required
ClaimOrigination
object
The product/service context and origin of the claim
4 properties2 required
AllocateAccountPayment
AccountReference
string
Account reference in your system
CreateAccountInput
Input for createaccount endpoint.
FeeLedgerEntry
object
3 properties3 required
DebtorReference
string
Your customer ID for this person or company
UpdateAccountLedgerEntriesAmountsInput
object
Input for updateaccountledgerentriesamounts endpoint.
2 properties2 required
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.
AdjustmentLedgerEntry
object
3 properties3 required
DebtorResponse
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…
UpdateAccountLedgerEntriesAmounts
CreateAccounts
ClaimResponse
object
Currency
string
3-digit currency code (ISO 4217)
EntityWithAccountReference
object
Schema definition used in composition with other Entities, that have a reference to an Account
1 property1 required
Repayment
object
A repayment entry in the pre-sale payment history of a claim
5 properties1 required
Metadata
object
Additional information related to the entity.
ChargebackLedgerEntry
object
3 properties3 required
Fee
object
Additional expected payment amount.
2 properties2 required
MatchAccountPayment
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 properties3 required
PaymentLedgerEntry
object
3 properties3 required
PortfolioReference
string
This is a optional grouping field for reporting purposes.
AccountProductResponse
DebtorAccountsAndClaims
array
Product
object
A product is a service or item used to give context to the Claim or Ledger Entry
6 properties1 required
LedgerEntryReference
string
Reference of the Ledger Entry (unique per Account)
Account
object
A formal business arrangement providing for regular dealings or services (such as banking, advertising, or store credit) and involving the establishment and ma…
8 properties
ReportingLedgerEntry
object
3 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
