Skip to main content
POST
Error

Overview

This API decrypts the encrypted response URL that your Financial Information User (FIU) application receives from the Account Aggregator (AA) platform. You should call this API after the user is redirected back to your application from the AA, following the user’s approval or rejection of a consent request. The decrypted response contains important information about the consent status, user details, and any error codes that indicate why a consent might have failed.

Authentication

This API requires the following authentication headers to be included with every request:

Request Body

object
required
An object containing the encrypted response parameters received from the Account Aggregator when the user is redirected back to your application.

Response

string
required
Indicates the overall status of the API request. Possible values are success or failure.
string
required
The current version of the API being used for this request.
string
A human-readable message describing the result of the API call, providing success confirmation or failure details.
object
Contains the decrypted consent flow information and user details.

Example Request

Example Success Response

Example Error Response

Error Codes from Account Aggregator

The following error codes are returned by the Account Aggregator to your FIU when the user is redirected back to your application. These codes help you understand what happened during the user’s consent journey on the AA platform.

Mandatory Error Codes

These error codes will always be returned in appropriate scenarios:

Optional Error Codes

These error codes provide detailed information about specific failure scenarios:

Authentication and Session Errors

Account Discovery Errors

Account Linking Errors

Partial Success/Failure Errors

These errors occur when dealing with multiple FIPs:

General Error

Usage Notes

  • Handle All Error Codes: Implement proper error handling for all error codes in your application. The mandatory error codes (0-3) will always be returned, while optional codes (4-20) provide granular details about specific failure scenarios.
  • Success Status: A status of S and errorcode of 0 indicates successful consent approval and account linking. In this case, you can proceed to fetch financial data using the consent.
  • Failure Status: A status of F indicates that the consent was not successfully approved. Use the errorcode to determine the specific reason for failure and provide appropriate feedback to the user.
  • User Communication: Based on the error code, provide clear and actionable feedback to users. For example:
    • Error code 1: Inform the user they rejected the consent and offer to retry
    • Error codes 7-9: Suggest checking if the user has accounts at the specified FIP
    • Error codes 12-15: Guide the user on OTP verification process
    • Error code 20: Display a generic error message and suggest contacting support
  • Transaction Correlation: Use the txnid field to correlate the decrypted response with your original consent request. This is especially important in high-traffic applications where multiple consent flows may be in progress simultaneously.
  • VUA Storage: Store the userid (VUA) securely in your system as it uniquely identifies the user within the Account Aggregator ecosystem. You’ll need this for future consent requests and data fetching operations.
  • Security Considerations:
    • Always validate the resdate to ensure the response is recent and not a replay attack
    • Verify that the decrypted srcref matches your original consent handle
    • Process the decrypted response immediately and do not store the encrypted ecres for extended periods
  • Partial Success Handling: Error codes 17-19 indicate partial success scenarios where some accounts were linked successfully. Consider implementing logic to handle these cases gracefully, allowing users to proceed with linked accounts or retry failed ones.

Rate Limiting

This API is subject to rate limiting with the following limits:
  • Limit: 1000 requests per time window
  • Remaining: Returned in the X-RateLimit-Remaining header
  • Reset: The time when the rate limit resets, returned in the X-RateLimit-Reset header
Monitor these headers in the API response to ensure you stay within the allowed rate limits.

Authorizations

client_id
string
header
required

Your unique client identifier provided by MoneyOne during FIU onboarding

client_secret
string
header
required

Your confidential client secret provided by MoneyOne

organisationId
string
header
required

Your organization's unique identifier in the FinPro system

appIdentifier
string
header
required

Application-specific identifier for tracking API calls

Body

application/json

Request body for decrypting the web redirection URL received from Account Aggregator.

webRedirectionURL
object
required

An object containing the encrypted response parameters received from the Account Aggregator when the user is redirected back to your application.

Response

URL decrypted successfully

Response containing the decrypted consent flow information and user details.

ver
string

The current version of the API being used for this request.

status
string

Indicates the overall status of the API request. Possible values are success or failure.

message
string

A human-readable message describing the result of the API call, providing success confirmation or failure details.

data
object

Contains the decrypted consent flow information and user details.