The below provides developers with essential information on how to integrate and interact with the API, covering key methods, data formats, request/response structures, and error handling protocols.
This endpoint is provided to allow CDR participants to send MogoPlus banking data in a single payload. It combines the following endpoints from the CDR OpenAPI document: * /banking/accounts/{accountId} (see notes below on implementation) * /banking/accounts/balances * /banking/accounts/direct-debits * /banking/accounts/{accountId}/transactions (see notes below on implementation) * /banking/accounts/payments/scheduled If a given dataset is not required for insights analysis - for example, balances is not required - the data can simply be omitted. The minimum requirements will, however is account and transaction data, which must be supplied for meaningful analysis to take place. API consumers can submit data from multiple customers or across multiple accounts in a single request.
Authorizations
Body
Banking data supplied by CDR participant
metaall ofRequired
Responses
201
Data received successfully and accepted for processing The `insightsId` value is provided for tracking the insights request and retrieving the request from `/banking-data-insights`.
application/json
400
Invalid input or arguments
application/json
401
Invalid credentials
403
Credentials are valid but access to the resource is forbidden due to access controls. Access must be granted for this request to succeed
application/json
405
Unsupported HTTP method sent
406
Requested content type is not supported by this API
422
Request cannot be processed by the API as the content contains errors
application/json
429
The API has receive too many requests from the client and is rate-limiting further requests based on published limits
500
API encountered an error processing the request
application/json
503
The API is not currently available due a transient network error, internal service error or planned outage
