Quick Integration

Here’s how you can quickly integrate your Android or iOS mobile application, or your web application to Onemoney and start receiving consent-based data from your customers.

Redirect to Onemoney AA client interfaces

Drop in the Onemoney web URL and do a simple invocation
LIVE
Pass a redirection URL to Onemoney web app and get the user back to your app after consent/registration activities
LIVE
Use the Onemoney Android app for consent/registration activities
LIVE
Intent calls to Onemoney Android app on the user’s device
Invoke the Onemoney mobile app on your user’s device through your app [coming soon]
Coming soon

Quick Integration with Onemoney web app

Here's how you can quickly integrate with Onemoney web application.

Pre-requisites

1. Create a Onemoney Developer Account.
2. Get test API keys.

Steps to follow

1. Drop in this URL of Onemoney web application into your application. https://aa-sandbox.onemoney.in/
2. Write code to redirect the user to the web application.
3. The web application provides new user registration (sign-up) and existing user sign-in flows.
4. Use the test VUAs provided on the developer portal to test the consent approval flow.

  • Sign to the Onemoney web application, after placing a consent request through your server-side code.
  • Navigate to the Consent Details page and approve the consent.

If you have set up your notification endpoints on our developer portal properly (Settings > Webhooks), your server will receive a notification about the consent artefact being ready.

This is the quickest way for you to test your flow.

Redirect Integration with Onemoney web app

Here’s how you can quickly drop in a redirection mechanism, to guide your customer to perform consent management and registration activities using Onemoney web app and be redirected back to your mobile or web application.

Pre-requisites

1. Create a Onemoney Developer Account.
2. Get Test API Keys

Note: In the production environment, all personally identifiable information (PII) should be encrypted to protect confidentiality. In addition, information such as transaction ID(s), IDs identifiying the FIU/AA and their applications, redirect URL(s) should also be encrypted. To implement this, encryption keys have to be exchanged between the FIU and Onemoney.
In the sandbox environment, such encryption is currently not required. Hence, not separate exchange of encryption keys is required.

Consent Flow

Steps to follow:

1. Drop in this URL of Onemoney web application into your application. https://aa-sandbox.onemoney.in/

Note: In the production environment, the URL of Onemoney has to be obtained through a call to the Central Registry hosted by Sahamati. The Central Registry (CR) contains information about web URLs and other details of all AAs.

2. To redirect a user to perform consent approval using Onemoney, perform the following steps:

a. Get the VUA from the user

b. Place a consent request through your backend to Onemoney and get a consent handle in return.

c. Construct a URL to redirect the user to Onemoney web app, as follows:

https://aa-sandbox.onemoney.in?redirect=<FIU'S REDIRECT URL> &consenthandle=<CONSENT HANDLE VALUE>&txnid=<FIU TRANSACTION ID>&sessionid=<FIU SESSION ID>&srcref= <FIU SRC REF>

The details of the fields are:

txnid: The Transaction ID that your application generates for that particular event during which the redirection is sought.
sessionid: The Session ID generated by your application for that particular user session during which the redirection is sought.
srcref: The Source Reference ID representing your application
consenthandle: The consent handle generated by Onemoney in acknowledgement of the consent request placed by your application
redirect: The URL of your application that you would like Onemoney to bring the user back to, once she has approved or rejected your consent request

d. Receive a response from Onemoney, in the following format:
<FIU REDIRECT URL>?txnid=<FIU'S TRANSACTION_ID>&sessionid=<FIU'S SESSION_ID>&srcref=<FIU'S SRC_REF>&status=<STATUS>&errorCode=<ERROR CODE>
The details of the response fields are:

FIU REDIRECT URL: This the same URL sent in the “redirect” parameter by the FIU
txnid: The same transaction ID as sent by you in your request above
sessionid: The same session ID as sent by you in your request above
srcref: The same Source Reference ID as sent by you in your request above
status: A field that indicates whether the user has successfully concluded her interaction with Onemoney or not. S = Success; F = Failure.
errorcode: A field that indicates if the consent was approved (Error code = 0), or rejected (Error code = 1) or if the consent handle sent itself was invalid (Error code = 2).

The table below indicates what your application’s next action could be, based on the values of Status and Error Code:

Status
Error Code
Next Action
S
0
The customer has approved your consent request. Show a success message.
F
1
The customer has rejected your consent request. Show a suitable message indicating if it was in error and if required, place a consent request again.
S
2
The customer could not approve the consent request because it was not a valid consent handle for Onemoney. Redirect the customer again, by checking the consent handle and correcting it if there was an error the first time. Also check from the customer if the vua used by the customer to log in into Onemoney was the same as what was provided in your app. If the consent handle and vua were valid, contact [email protected] for help.

Registration Flow

If your customer does not have a Onemoney profile, the steps below help her complete her registration on Onemoney. She can then proceed to complete the Consent Flow.

Steps to follow:

1. Drop in this URL of Onemoney web application into your application. https://aa-sandbox.onemoney.in/

Note: In the production environment, the URL of Onemoney has to be obtained through a call to the Central Registry hosted by Sahamati. The Central Registry (CR) contains information about web URLs and other details of all AAs.

2. To redirect a user to register using Onemoney, perform the following steps:

a. Get the name and mobile number of the user. In all probability, this information would already be available with you prior to the user being guided through this flow.
b. Construct a URL to redirect the user to Onemoney web app, as follows:
https://aa-sandbox.onemoney.in?redirect=<FIU'S REDIRECT URL>&mobile=<CUSTOMER'S MOBILE NUMBER>&customername=<CUSTOMER'S NAME>&txnid=<FIU TRANSACTION ID>&sessionid=<FIU SESSION ID>&srcref=<FIU SRC REF>
The details of the fields are:

txnid: The Transaction ID that your application generates for that particular event during which the redirection is sought.
sessionid: The Session ID generated by your application for that particular user session during which the redirection is sought.
srcref: The Source Reference ID representing your application
mobile: The mobile number of the customer that your application acquires.
customername: The name of the customer
redirect: The URL of your application that you would like Onemoney to bring the user back to, once she has approved or rejected your consent request

c. Receive a response from Onemoney, in the following format:
<FIU REDIRECT URL>?txnid=<FIU'S TRANSACTION_ID>&sessionid=<FIU'S SESSION_ID>&srcref=<FIU'S SRC_REF>&status=<STATUS>&errorCode=<ERROR CODE>&vua= <USER VUA>
The details of the response fields are:

FIU REDIRECT URL: This the same URL sent in the “redirect” parameter by the FIU
txnid: The same transaction ID as sent by you in your request above
sessionid: The same session ID as sent by you in your request above
srcref: The same Source Reference ID as sent by you in your request above
status: A field that indicates whether the user has successfully concluded her interaction with Onemoney or not. S = Success; F = Failure.
errorcode: A field that indicates if the consent was approved (Error code = 0), or rejected (Error code = 1) or if the consent handle sent itself was invalid (Error code = 2).
vua: The VUA (Virtual User Address) that the customer chose during her registration with Onemoney.

The table below indicates what your application’s next action could be, based on the values of Status and Error Code:

Status
Error Code
Next Action
S
0
The customer has registered herself with Onemoney. She is now ready to go through the consent flow by providing your application the VUA.
F
1
This means that the mobile number provided is already linked with a valid Onemoney VUA. Ask your customer to either provide a different name or use the vua already issued by Onemoney for the consent flow.
S
2
This error occurs if either the mobile number passed to Onemoney is invalid, i.e. (does not start with a 7,8,9 or is not equal to 10 digits in length) or if the name is invalid (i.e. has less than 3 alphabets)

Quick Integration with Onemoney Android app

Here's how you can quickly integrate with Onemoney Android app.

Pre-requisites

1. Create a Onemoney Developer Account.
2. Get test API keys.

Click here to download Onemoney Android App.

Steps to follow

1. The Onemoney Android application provides new user registration (sign-up) and existing user sign-in flows.
2. Use the test VUAs provided on the developer portal to test the consent approval flow.

  • Sign to the Onemoney Android application, after placing a consent request through your server-side code.
  • Navigate to the Consent Details screen and approve the consent.

If you have set up your notification endpoints on our developer portal properly (Settings > Webhooks), your server will receive a notification about the consent artefact being ready.

This is the quickest way for you to test your flow.