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

The AccountMandate API from Receeve — 3 operation(s) for accountmandate.

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

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

Requests are made against a single base URL, /.

3 operations 3 paths 15 schemas 1 GET2 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 AccountMandate API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 3

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

AccountMandate 3
POST
/v1/{clientId}/create_account_mandates
Create account mandates in the platform
createAccountMandates 6 params body → 200400401403429500
POST
/v1/{clientId}/delete_account_mandates
Delete account mandates in the platform
deleteAccountMandates 6 params body → 200400401403429500
GET
/v1/{clientId}/get_account_mandates
Get account mandates
getAccountMandates 4 params → 200400401403429500

Schemas 15

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

FerratumV2AccountMandateInput
ProductReference
string
Identifier for a product in your system. It is used for grouping purposes.
AccountMandateDeleteInput
object
Input for deleteaccountmandates endpoint.
2 properties 2 required
AccountReference
string
Account reference in your system
AccountMandate
object
6 properties 3 required
CreateAccountMandates
DebtorReference
string
Your customer ID for this person or company
TrustlyAccountMandateInput
SplitAccountMandateInput
BaseAccountMandateInput
object
6 properties 5 required
ActionResponse
object
Response of any action that causes any side effect in the platform (e.g. create, update, delete)
3 properties 3 required
MandateAccountTypeRepresentation
object
3 properties 2 required
PaylandsAccountMandateInput
AccountMandateInput
MandateCardTypeRepresentation
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

receeve-accountmandate-api-openapi.yml Raw ↑

Other APIs Receeve publishes across the network.

Receeve Account 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