API Endpoints
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.
Banking data supplied by CDR participant
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.
Invalid input or arguments
Invalid credentials
Credentials are valid but access to the resource is forbidden due to access controls. Access must be granted for this request to succeed
Unsupported HTTP method sent
Requested content type is not supported by this API
Request cannot be processed by the API as the content contains errors
The API has receive too many requests from the client and is rate-limiting further requests based on published limits
API encountered an error processing the request
The API is not currently available due a transient network error, internal service error or planned outage
This endpoint provides the insights report. If processing is ongoing the endpoint will return a 204 to indicate no data is available.
A valid V4 UUID
^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$The banking data insights report
Provides both the state of processing and the response data. Whilst processing is ongoing the data object will be omitted.
Invalid input or arguments
Invalid credentials
Credentials are valid but access to the resource is forbidden due to access controls. Access must be granted for this request to succeed
Unsupported HTTP method sent
Requested content type is not supported by this API
The API has receive too many requests from the client and is rate-limiting further requests based on published limits
API encountered an error processing the request
The API is not currently available due a transient network error, internal service error or planned outage
Allows an API consumer to purge the result set for a given insights Id
A valid V4 UUID
^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$Purge completed successfully. All insights data has been removed
Invalid credentials
Credentials are valid but access to the resource is forbidden due to access controls. Access must be granted for this request to succeed
Unsupported HTTP method sent
Requested content type is not supported by this API
The API has receive too many requests from the client and is rate-limiting further requests based on published limits
API encountered an error processing the request
The API is not currently available due a transient network error, internal service error or planned outage
No content
This endpoint provides the insights report. If processing is ongoing the endpoint will return a 204 to indicate no data is available.
A valid V4 UUID
^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$A valid V4 UUID
^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$The banking data insights report
Provides both the state of processing and the response data. Whilst processing is ongoing the data object will be omitted.
Invalid input or arguments
Invalid credentials
Credentials are valid but access to the resource is forbidden due to access controls. Access must be granted for this request to succeed
Unsupported HTTP method sent
Requested content type is not supported by this API
The API has receive too many requests from the client and is rate-limiting further requests based on published limits
API encountered an error processing the request
The API is not currently available due a transient network error, internal service error or planned outage
Last updated
Was this helpful?

