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.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Banking data supplied by CDR participant
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
application/json
post/cdr-data/v2/banking-data-insights
POST /cdr-data/v2/cdr-data/v2/banking-data-insights HTTP/1.1
Host: apigateway.auuat.mogoplus.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4706
{
"meta": {
"orderIds": [
"9e58813c-7c2a-11ee-b962-0242ac120002"
],
"clientId": "9e58f48813c-6c4a-11ee-b962-0242ac120002",
"reference": "text",
"applicationType": "PERSONAL_LOAN"
},
"applicantsData": [
{
"applicant": {
"crn": "text",
"firstName": "text",
"lastName": "text",
"emailAddress": "text",
"employerNames": [
"text"
],
"declaredIncome": {
"amount": 1,
"currency": "text"
},
"declaredExpenses": {
"amount": 1,
"currency": "text"
}
},
"bankingTransactionData": [
{
"consentProperty": {
"institutionName": "text",
"consent": {
"arrangementId": "0a29c52b-df25-4bfd-83e1-c0ba53fc218e",
"scopes": [
"bank:accounts.basic:read"
],
"sharingStartDateTime": "2026-01-01T00:00:00.000Z",
"sharingDuration": 86400
}
},
"accountProperty": {
"accounts": [
{
"accountId": "text",
"creationDate": "text",
"displayName": "text",
"nickname": "text",
"openStatus": "OPEN",
"isOwned": true,
"accountOwnership": "ONE_PARTY",
"maskedNumber": "text",
"productCategory": "BUSINESS_LOANS",
"productName": "text",
"balance": {
"accountId": "accountId",
"purses": [
{
"amount": "amount",
"currency": "currency"
},
{
"amount": "amount",
"currency": "currency"
}
],
"amortisedLimit": "amortisedLimit",
"currentBalance": "currentBalance",
"creditLimit": "creditLimit",
"currency": "currency",
"availableBalance": "availableBalance"
},
"transactions": [
{
"accountId": "d6fe752c-219b-4453-adbf-6d258538b7fb",
"transactionId": "219b-4453-adbf-6d258538b7fb-d6fe752c",
"isDetailAvailable": false,
"type": "PAYMENT",
"status": "POSTED",
"description": "eCommerce transaction",
"amount": "58.67",
"reference": "Menulog Order Reference #23347506",
"valueDateTime": "2022-10-12T17:56:51.6Z"
},
{
"accountId": "d6fe752c-219b-4453-adbf-6d258538b7fb",
"transactionId": "219b-4453-adbf-6d258538b7fb-d6fe752c",
"isDetailAvailable": false,
"type": "TRANSFER_INCOMING",
"status": "PENDING",
"description": "Inter-account transfer",
"amount": "100.00",
"reference": "Birthday money from Mum",
"valueDateTime": "2022-11-12T17:56:51.6Z"
}
],
"directDebitAuthorisations": [
{
"lastDebitAmount": "lastDebitAmount",
"accountId": "accountId",
"lastDebitDateTime": "lastDebitDateTime",
"authorisedEntity": {
"arbn": "arbn",
"description": "description",
"financialInstitution": "financialInstitution",
"abn": "abn",
"acn": "acn"
}
}
],
"scheduledPayments": [
{
"recurrence": {
"nextPaymentDate": "nextPaymentDate",
"eventBased": {
"description": "description"
},
"onceOff": {
"paymentDate": "paymentDate"
},
"recurrenceUType": "eventBased",
"intervalSchedule": {
"intervals": [
{
"interval": "interval",
"dayInInterval": "dayInInterval"
},
{
"interval": "interval",
"dayInInterval": "dayInInterval"
}
],
"paymentsRemaining": 1,
"finalPaymentDate": "finalPaymentDate",
"nonBusinessDayTreatment": "ON"
},
"lastWeekDay": {
"paymentsRemaining": 1,
"interval": "interval",
"finalPaymentDate": "finalPaymentDate",
"lastWeekDay": "FRI",
"nonBusinessDayTreatment": "ON"
}
},
"scheduledPaymentId": "scheduledPaymentId",
"payeeReference": "payeeReference",
"payerReference": "payerReference",
"nickname": "nickname",
"from": {
"accountId": "accountId"
},
"paymentSet": [
{
"isAmountCalculated": true,
"amount": "amount",
"currency": "currency",
"to": {
"domestic": {
"payeeAccountUType": "account",
"payId": {
"identifier": "identifier",
"name": "name",
"type": "ABN"
},
"account": {
"bsb": "bsb",
"accountName": "accountName",
"accountNumber": "accountNumber"
},
"card": {
"cardNumber": "cardNumber"
}
},
"accountId": "accountId",
"biller": {
"billerName": "billerName",
"crn": "crn",
"billerCode": "billerCode"
},
"payeeReference": "payeeReference",
"toUType": "accountId",
"nickname": "nickname",
"payeeId": "payeeId",
"international": {
"bankDetails": {
"country": "country",
"routingNumber": "routingNumber",
"fedWireNumber": "fedWireNumber",
"chipNumber": "chipNumber",
"legalEntityIdentifier": "legalEntityIdentifier",
"accountNumber": "accountNumber",
"bankAddress": {
"address": "address",
"name": "name"
},
"sortCode": "sortCode",
"beneficiaryBankBIC": "beneficiaryBankBIC"
},
"beneficiaryDetails": {
"country": "country",
"name": "name",
"message": "message"
}
}
}
},
{
"isAmountCalculated": true,
"amount": "amount",
"currency": "currency",
"to": {
"domestic": {
"payeeAccountUType": "account",
"payId": {
"identifier": "identifier",
"name": "name",
"type": "ABN"
},
"account": {
"bsb": "bsb",
"accountName": "accountName",
"accountNumber": "accountNumber"
},
"card": {
"cardNumber": "cardNumber"
}
},
"accountId": "accountId",
"biller": {
"billerName": "billerName",
"crn": "crn",
"billerCode": "billerCode"
},
"payeeReference": "payeeReference",
"toUType": "accountId",
"nickname": "nickname",
"payeeId": "payeeId",
"international": {
"bankDetails": {
"country": "country",
"routingNumber": "routingNumber",
"fedWireNumber": "fedWireNumber",
"chipNumber": "chipNumber",
"legalEntityIdentifier": "legalEntityIdentifier",
"accountNumber": "accountNumber",
"bankAddress": {
"address": "address",
"name": "name"
},
"sortCode": "sortCode",
"beneficiaryBankBIC": "beneficiaryBankBIC"
},
"beneficiaryDetails": {
"country": "country",
"name": "name",
"message": "message"
}
}
}
}
],
"status": "ACTIVE"
}
]
}
]
}
}
]
}
]
}{
"data": {
"insightsId": {
"insightsId": "text"
},
"orderReports": [
{
"orderId": "9e58813c-7c2a-11ee-b962-0242ac120002",
"report": "https://apigateway.auuat.mogoplus.com/cdr-data/v2/banking-data-insights/c8c7d799-fe50-43bb-8e61-f08cd8a9434/orders/31456b3a-7cf4-11ee-b962-0242ac120002"
}
]
},
"links": {
"self": "https://apigateway.auuat.mogoplus.com/cdr-data/v2/banking-data-insights/c8c7d799-fe50-43bb-8e61-f08cd8a9434f"
}
}This endpoint provides the insights report. If processing is ongoing the endpoint will return a 204 to indicate no data is available.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
insightsIdstringRequiredPattern:
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}$Responses
200
The banking data insights report
application/json
Provides both the state of processing and the response data. Whilst processing is ongoing the data object will be omitted.
reportStringstringOptional
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
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
application/json
get/cdr-data/v2/banking-data-insights/{insightsId}
GET /cdr-data/v2/cdr-data/v2/banking-data-insights/{insightsId} HTTP/1.1
Host: apigateway.auuat.mogoplus.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"meta": {
"status": "ACCEPTED"
},
"insightsHeader": {
"insightsId": "text",
"insightsPublishDate": "text",
"clientId": "text",
"clientName": "text",
"reports": [
{
"reportHeader": {
"reportId": "text",
"reportPublishDate": "text",
"reportingPeriodStartDate": "text",
"reportingPeriodEndDate": "text",
"applicationType": "text",
"numberOfApplicants": 1,
"numberOfDaysInReportingPeriod": 1,
"applicants": [
{
"applicantId": "text",
"applicantName": "text"
}
]
},
"combinedSummary": {
"combinedNumberOfInstitutions": 1,
"combinedNumberOfAccounts": 1,
"combinedNumberOfTransactions": 1,
"currency": "text",
"combinedTotalSummary": {
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
},
"combinedCategoryGroupSummary": {
"combinedCategoryGroups": [
{
"categoryGroup": "text",
"categoryGroupDescription": "text",
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"combinedCategorySummary": {
"combined": [
{
"categoryCode": "text",
"categoryCodeDescription": "text",
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"netMonthlyPosition": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"combinedIncomeInsights": {
"basicIncomeInsights": {
"currency": "text",
"income": {
"sumAmount": 1,
"numberOfTransactions": 1,
"averageMonthly": 1
},
"incomeBuckets": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
}
},
"applicantSummary": {
"applicants": [
{
"applicantName": "text",
"numberOfInstitutions": 1,
"numberOfAccounts": 1,
"numberOfTransactions": 1,
"currency": "text",
"applicantTotalSummary": {
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
},
"applicantCategoryGroupSummary": {
"applicantCategoryGroups": [
{
"categoryGroup": "text",
"categoryGroupDescription": "text",
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"applicantCategorySummary": {
"categories": [
{
"categoryCode": "text",
"categoryCodeDescription": "text",
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"applicantDetailedTransaction": {
"institutions": [
{
"institutionId": "text",
"institutionName": "text",
"accounts": [
{
"accountNumber": "text",
"accountName": "text",
"currentBalance": 1,
"availableBalance": 1,
"creditLimit": 1,
"numberOfTransactionsInTotal": 1,
"numberOfTransactionsCategorised": 1,
"transactions": [
{
"transactionId": "text",
"transactionDate": "text",
"transactionCategoryGroup": "text",
"transactionCategoryCode": "text",
"transactionDescription": "text",
"transactionAmount": 1,
"transactionCurrency": "text"
}
]
}
]
}
]
},
"netMonthlyPosition": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"alerts": [
{
"categoryCode": "text",
"categoryCodeDescription": "text",
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"transactions": [
{
"transactionId": "text",
"transactionDate": "text",
"transactionCategoryGroup": "text",
"transactionCategoryCode": "text",
"transactionDescription": "text",
"transactionAmount": 1,
"transactionCurrency": "text"
}
]
}
]
}
]
},
"incomeSummary": {
"applicants": [
{
"applicantName": "text",
"employmentInsights": [
{
"declaredEmployerName": "text",
"employerNameVerified": true,
"latestEmployerVerifiedSalaryDate": "text",
"latestEmployerVerifiedSalaryAmount": 1
}
],
"IncomeInsights": {
"basicIncomeInsights": {
"currency": "text",
"income": {
"sumAmount": 1,
"numberOfTransactions": 1,
"averageMonthly": 1
},
"incomeBuckets": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"inferentialIncomeInsights": [
{
"type": "text",
"employer": "text",
"recency": {
"daysInLastPeriod": 1,
"numberOfTransactionsInLastPeriod": 1
},
"regularity": {
"numberOfTransactions": 1,
"incomeDates": [
"text"
],
"statisticsOfDayIntervals": {
"max": 1,
"min": 1,
"mean": 1,
"median": 1,
"mode": 1,
"standardDeviation": 1
}
},
"reliability": {
"numberOfTransactions": 1,
"incomeAmounts": [
{
"date": "text",
"amount": 1
}
],
"statisticsOfSalaryAmount": {
"average": 1,
"median": 1,
"mode": 1,
"range": 1,
"standardDeviation": 1
}
}
}
]
}
}
]
}
}
]
},
"reportString": "text"
}Allows an API consumer to purge the result set for a given insights Id
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
insightsIdstringRequiredPattern:
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}$Responses
204
Purge completed successfully. All insights data has been removed
No content
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
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
application/json
delete/cdr-data/v2/banking-data-insights/{insightsId}
DELETE /cdr-data/v2/cdr-data/v2/banking-data-insights/{insightsId} HTTP/1.1
Host: apigateway.auuat.mogoplus.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
This endpoint provides the insights report. If processing is ongoing the endpoint will return a 204 to indicate no data is available.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
insightsIdstringRequiredPattern:
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}$orderIdstringRequiredPattern:
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}$Responses
200
The banking data insights report
application/json
Provides both the state of processing and the response data. Whilst processing is ongoing the data object will be omitted.
reportStringstringOptional
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
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
application/json
get/cdr-data/v2/banking-data-insights/{insightsId}/orders/{orderId}
GET /cdr-data/v2/cdr-data/v2/banking-data-insights/{insightsId}/orders/{orderId} HTTP/1.1
Host: apigateway.auuat.mogoplus.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"meta": {
"status": "ACCEPTED"
},
"insightsHeader": {
"insightsId": "text",
"insightsPublishDate": "text",
"clientId": "text",
"clientName": "text",
"reports": [
{
"reportHeader": {
"reportId": "text",
"reportPublishDate": "text",
"reportingPeriodStartDate": "text",
"reportingPeriodEndDate": "text",
"applicationType": "text",
"numberOfApplicants": 1,
"numberOfDaysInReportingPeriod": 1,
"applicants": [
{
"applicantId": "text",
"applicantName": "text"
}
]
},
"combinedSummary": {
"combinedNumberOfInstitutions": 1,
"combinedNumberOfAccounts": 1,
"combinedNumberOfTransactions": 1,
"currency": "text",
"combinedTotalSummary": {
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
},
"combinedCategoryGroupSummary": {
"combinedCategoryGroups": [
{
"categoryGroup": "text",
"categoryGroupDescription": "text",
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"combinedCategorySummary": {
"combined": [
{
"categoryCode": "text",
"categoryCodeDescription": "text",
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"netMonthlyPosition": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"combinedIncomeInsights": {
"basicIncomeInsights": {
"currency": "text",
"income": {
"sumAmount": 1,
"numberOfTransactions": 1,
"averageMonthly": 1
},
"incomeBuckets": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
}
},
"applicantSummary": {
"applicants": [
{
"applicantName": "text",
"numberOfInstitutions": 1,
"numberOfAccounts": 1,
"numberOfTransactions": 1,
"currency": "text",
"applicantTotalSummary": {
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
},
"applicantCategoryGroupSummary": {
"applicantCategoryGroups": [
{
"categoryGroup": "text",
"categoryGroupDescription": "text",
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"applicantCategorySummary": {
"categories": [
{
"categoryCode": "text",
"categoryCodeDescription": "text",
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
}
}
]
},
"applicantDetailedTransaction": {
"institutions": [
{
"institutionId": "text",
"institutionName": "text",
"accounts": [
{
"accountNumber": "text",
"accountName": "text",
"currentBalance": 1,
"availableBalance": 1,
"creditLimit": 1,
"numberOfTransactionsInTotal": 1,
"numberOfTransactionsCategorised": 1,
"transactions": [
{
"transactionId": "text",
"transactionDate": "text",
"transactionCategoryGroup": "text",
"transactionCategoryCode": "text",
"transactionDescription": "text",
"transactionAmount": 1,
"transactionCurrency": "text"
}
]
}
]
}
]
},
"netMonthlyPosition": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"alerts": [
{
"categoryCode": "text",
"categoryCodeDescription": "text",
"credit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"debit": {
"sumAmount": 1,
"numberOfTransactions": 1,
"monthlyAverage": 1
},
"transactions": [
{
"transactionId": "text",
"transactionDate": "text",
"transactionCategoryGroup": "text",
"transactionCategoryCode": "text",
"transactionDescription": "text",
"transactionAmount": 1,
"transactionCurrency": "text"
}
]
}
]
}
]
},
"incomeSummary": {
"applicants": [
{
"applicantName": "text",
"employmentInsights": [
{
"declaredEmployerName": "text",
"employerNameVerified": true,
"latestEmployerVerifiedSalaryDate": "text",
"latestEmployerVerifiedSalaryAmount": 1
}
],
"IncomeInsights": {
"basicIncomeInsights": {
"currency": "text",
"income": {
"sumAmount": 1,
"numberOfTransactions": 1,
"averageMonthly": 1
},
"incomeBuckets": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"inferentialIncomeInsights": [
{
"type": "text",
"employer": "text",
"recency": {
"daysInLastPeriod": 1,
"numberOfTransactionsInLastPeriod": 1
},
"regularity": {
"numberOfTransactions": 1,
"incomeDates": [
"text"
],
"statisticsOfDayIntervals": {
"max": 1,
"min": 1,
"mean": 1,
"median": 1,
"mode": 1,
"standardDeviation": 1
}
},
"reliability": {
"numberOfTransactions": 1,
"incomeAmounts": [
{
"date": "text",
"amount": 1
}
],
"statisticsOfSalaryAmount": {
"average": 1,
"median": 1,
"mode": 1,
"range": 1,
"standardDeviation": 1
}
}
}
]
}
}
]
}
}
]
},
"reportString": "text"
}Last updated
Was this helpful?