How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Receeve Account API

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.2.0, at version 1.53.1.

Requests are made against a single base URL, /.

14 operations 14 paths 51 schemas 3 GET11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.53.1
Base URL
https://api.receive-demo.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

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…

GET
/v1/{clientId}/get_account
It retrieves the Account information
getAccount 4 params → 200400401403429500
POST
/v1/{clientId}/create_accounts
Create Accounts in Receive
createAccounts 6 params body → 200400401403429500
POST
/v1/{clientId}/update_account_meta
Update Account Meta
updateAccountMeta 6 params body → 200400401403429500
POST
/v1/{clientId}/add_account_ledger_entries
Add account ledger entries
addAccountLedgerEntries 6 params body → 200400401403429500
POST
/v1/{clientId}/add_account_products
Add Account Products
addAccountProducts 6 params body → 200400401403429500
POST
/v1/{clientId}/update_account_products
Update Account Products
updateAccountProducts 6 params body → 200400401403429500
POST
/v1/{clientId}/add_account_debtors
Add Account Debtors
addAccountDebtors 6 params body → 200400401403429500
POST
/v1/{clientId}/update_account_debtors
Update Account Debtors
updateAccountDebtors 6 params body → 200400401403429500
GET
/v1/{clientId}/get_account_claims
It retrieves the claims from a given account
getAccountClaims 7 params → 200400401403429500
POST
/v1/{clientId}/set_account_scores
Set Account Scores
SetAccountScores 6 params body → 200400401403429500
POST
/v1/{clientId}/match_account_payment
Register a payment for an account
MatchAccountPayment 6 params body → 200400401403429500
POST
/v1/{clientId}/allocate_account_payment
Allocate a payment across an account's claims
AllocateAccountPayment 6 params body → 200400401403429500
POST
/v1/{clientId}/update_account_ledger_entries_amounts
Updates the amounts of Account ledger entries
updateAccountLedgerEntriesAmounts 6 params body → 200400401403429500
GET
/v1/{clientId}/get_debtor_accounts_and_claims
It retrieves information about a debtor's accounts and claims
getDebtorAccountsAndClaims 4 params → 200400401403429500

Schemas 51

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), Account (8 properties). Each schema is shown below with its type and property counts.

AdjustmentLedgerEntry
object
3 properties 3 required
AllocateAccountPaymentInput
object
Input for allocateaccountpayment endpoint.
5 properties 3 required
CreateAccounts
Claim
EntityWithAccountReference
object
Schema definition used in composition with other Entities, that have a reference to an Account
1 property 1 required
FeeLedgerEntry
object
3 properties 3 required
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 properties 2 required
DebtorAccountsAndClaims
array
ProductReference
string
Identifier for a product in your system. It is used for grouping purposes.
DebtorResponse
ClaimResponse
object
AccountScoreResponse
Response of the setaccountscore endpoint
ContactInformation
Contact information of the debtor, used for communication purposes.
Amount
integer
Monetary value in cents (natural nuumber)
MatchAccountPayment
ClaimOrigination
object
The product/service context and origin of the claim
4 properties 2 required
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…
InvoiceLedgerEntry
object
An Invoice Ledger Entry is a type of Ledger Entry that represents a claim in the system.
3 properties 3 required
AllocateAccountPayment
BaseContactInformation
object
12 properties
DiscountLedgerEntry
object
3 properties 3 required
Repayment
object
A repayment entry in the pre-sale payment history of a claim
5 properties 1 required
DueDate
string
Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
PortfolioReference
string
This is a optional grouping field for reporting purposes.
RelatedClaim
object
A typed relation from this claim to another claim (lineage metadata; the platform does not act on it)
2 properties 2 required
CreateAccountInput
Input for createaccount endpoint.
LedgerEntry
A Ledger Entry is a record of a transaction in the Ledger.
UpdateAccountLedgerEntriesAmountsInput
object
Input for updateaccountledgerentriesamounts endpoint.
2 properties 2 required
ReportingLedgerEntry
object
3 properties 3 required
LedgerEntryResponse
Response of any action that adds ledger entries to an account.
RelativeAmount
integer
Monetary value in cents (positive or negative number)
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.
Metadata
object
Additional information related to the entity.
BaseDebtor
object
11 properties
LedgerEntryReference
string
Reference of the Ledger Entry (unique per Account)
DebtorReference
string
Your customer ID for this person or company
MatchAccountPaymentInput
object
Input for matchaccountpayment endpoint.
8 properties 3 required
UpdateAccountLedgerEntriesAmounts
Currency
string
3-digit currency code (ISO 4217)
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
ClaimScore
object
An Claim Score is a score that is calculated for a specific claim.
3 properties 2 required
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
Product
object
A product is a service or item used to give context to the Claim or Ledger Entry
6 properties 1 required
AccountProductResponse
PaymentLedgerEntry
object
3 properties 3 required
LedgerEntryCreatedAt
integer
Timestamp when the ledger entry was created in milliseconds
ChargebackLedgerEntry
object
3 properties 3 required
AccountReference
string
Account reference in your system
Fee
object
Additional expected payment amount.
2 properties 2 required
OriginalDueDate
string
Original due date in your system. This is the day when it went past due. DPD 0.
ActionResponse
object
Response of any action that causes any side effect in the platform (e.g. create, update, delete)
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

receeve-account-api-openapi.yml Raw ↑

Other APIs Receeve publishes across the network.

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
Receeve PromiseToPay API
Where this information came from

This is an independent, third-party profile of Receeve Account API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.