FIP API (Simulator)

This is a simulator implementation of the FIP API and can be used for testing the Account Aggregator flows as part of the ecosystem.

Request headers

Below http headers need to be set as part of each request

Key	Value
`content-Type`	`application/xml`
`aa_api_key`	`Please email us on info@cookiejar.co.in for obtaining the key`

API Request

The API URL to be used is <Root API Endpoint>/<FIP API> as per ReBIT FIP API Specs.

Account Discover

HTTP METHOD: POST

URL: http://api.finvu.in/ConnectHub/V1/Accounts/discover

Request Body

{
  "ver": "1.0",
  "timestamp": "2019-04-29T04:04:44.955Z",
  "txnid": "8399263c-4a15-11e8-bcd1-0277a9fbfedc",
  "Customer": {
    "id": "cust123",
    "Identifiers": [
      {
        "category": "STRONG",
        "type": "MOBILE",
        "value": "9834795713"
      }
    ]
  },
   "FITypes": [
    "DEPOSIT"
  ]
}

Response Expected:

{
    "ver": "1.0",
    "timestamp": "2019-05-16T06:20:34.639+0000",
    "txnid": "8399263c-4a15-11e8-bcd1-0277a9fbfedc",
    "DiscoveredAccounts": [
        {
            "FIType": "DEPOSIT",
            "accType": "SAVINGS",
            "accRefNumber": "UBI48596",
            "maskedAccNumber": "XXXXX1788"
        },
        {
            "FIType": "DEPOSIT",
            "accType": "SAVINGS",
            "accRefNumber": "UBI4859645",
            "maskedAccNumber": "XXXXXXX8812"
        },
        {
            "FIType": "DEPOSIT",
            "accType": "SAVINGS",
            "accRefNumber": "UBI485964578",
            "maskedAccNumber": "XXXXXXXXX1278"
        }
    ]
}

Account Linking

For simulation purpose, the customer account authentication is TOKEN based and an OTP is sent to the mobile no of the account holder.

HTTP METHOD: POST

URL: http://api.finvu.in/ConnectHub/V1/Accounts/link

Request Body

{
  "ver": "1.0",
  "timestamp": "2018-05-09T17:51:18.412Z",
  "txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
  "Customer": {
    "id": "cust123",
    "Accounts": [
       {
           "FIType": "DEPOSIT",
            "accType": "SAVINGS",
            "accRefNumber": "UBI48596",
            "maskedAccNumber": "XXXXX1788"
        },
        {
            "FIType": "DEPOSIT",
            "accType": "SAVINGS",
            "accRefNumber": "UBI4859645",
            "maskedAccNumber": "XXXXXXX8812"
        }
    ]
  }
}

Response Expected:

{
    "ver": "1.0",
    "timestamp": "2019-05-16T06:24:35.040+0000",
    "txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
    "AuthenticatorType": "TOKEN",
    "RefNumber": "bea579b8-f5f3-4fce-ba1f-5148db0cbf59"
}

Account Unlinking

For simulation purpose, The method is used to delete a previously established account linkage to the user’s profile.

HTTP METHOD: DELETE

URL: http://api.finvu.in/ConnectHub/V1/Accounts/link

Request Body

{
  "ver": "1.0",
  "timestamp": "2018-05-09T17:51:18.412Z",
  "txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
  "Account": {
    "customerAddress": "cust123",
    "linkRefNumber": "UBI48596"
  }
}

Response Expected:

{
    "ver": "1.0",
    "timestamp": "2018-05-09T17:51:18.412+0000",
    "txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
    "AccLinkDetails": {
        "customerAddress": "cust123",
        "linkRefNumber": "UBI48596",
        "status": "DELINKED"
    }
}

Account Confirm Token

HTTP METHOD: GET

URL: http://api.finvu.in/ConnectHub/V1/Accounts/link/{RefNumber}/{Token}

Request Body

Put the SMS received on mobile in {OTP sms}

e.g.
http://api.finvu.in/ConnectHub/V1/Accounts/link/9d4dd3b3-7510-401a-b148-a79f03ac01d9/689612

Response Expected:

{
    "ver": "1.0",
    "timestamp": "2019-05-16T06:29:29.865+0000",
    "txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
    "AccLinkDetails": [
        {
            "customerAddress": "cust123",
            "linkRefNumber": "9d4dd3b3-7510-401a-b148-a79f03ac01d9",
            "accRefNumber": "UBI48596",
            "status": "LINKED"
        },
        {
            "customerAddress": "cust123",
            "linkRefNumber": "9d4dd3b3-7510-401a-b148-a79f03ac01d9",
            "accRefNumber": "UBI4859645",
            "status": "LINKED"
        }
    ]
}

FI request

HTTP METHOD: POST

URL: http://api.finvu.in/ConnectHub/V1/FI/request

Request Body

{
  "ver": "1.0",
  "timestamp": "2018-06-09T09:58:50.505Z",
  "txnid": "c4a1450c-d08a-45b4-a475-0468bd10e380",
  "Consent": {
    "id": "700a08bf-be40-411e-9edb-281735ddff0a",
    "digitalSignature": "Digital signature of the consentDetail section in the consent Artefact"
  },
  "FIDataRange": {
    "from": "2018-11-27T06:26:29.761Z",
    "to": "2018-12-27T06:26:29.761Z"
  },
  "KeyMaterial": {
    "cryptoAlg": "ECDHE",
    "curve": "Curve25519",
    "params": "string",
    "DHPublicKey": {
      "expiry": "2019-06-01T09:58:50.505Z",
      "Parameters": "Param 1",
      "KeyValue": "MAY1oK05Ga/MM3vMitixfSmuf0xm6/ROw2tle09tt1M="
    },
    "Nonce": "32b32a1a-44cc-4fd0-bad2-86114912732e",
    "Signature": "AA signature"
  }
}

Response Expected:

{
    "ver": "1.0",
    "timestamp": "2019-05-28T11:33:13.693+0000",
    "txnid": "c4a1450c-d08a-45b4-a475-0468bd10e380",
    "consentId": "700a08bf-be40-411e-9edb-281735ddff0a",
    "sessionId": "352f1a7c-326d-4256-aa94-8c8c8094be1c"
}

FI Fetch

HTTP METHOD: GET

URL: http://api.finvu.in/ConnectHub/V1/FI/fetch/{SessionID}

Response Expected:

{
    "ver": "1.0",
    "timestamp": "2019-05-28T11:06:51.245+0000",
    "txnid": "c4a1450c-d08a-45b4-a475-0468bd10e380",
    "FI": [
        {
            "fipID": "BARB0KIMXXX",
            "data": [
                {
                    "linkRefNumber": "UBI485964579",
                    "maskedAccNumber": "UBI85217881279",
                    "encryptedFI": "EbhvV8yLvu/Da2BB8L5C00XXlgERVHmPeoJNletxnXVVHhY4KGiDvMANu+bNVVGmb1yc0u+MkxUL+wsScQCdXY+gUULSdZy7klkNclNRk2Vg/jNqNGcht9+ErwA6ynQBHed/IF7IDtGyprmBXcuRTIrJD2wJOrV9Szdf2d/Zky5hk1nd8asxroBGIhSdNGV0hZoaWaSk2UAt2JBgGVqdC5uZinELE9klohKSb4NjlUUK8HNnMdotmjc+aX6PUC3wo9ydU2KZvxuZDtljX7glZNbgyuleFsnWtUOYle66drDAg4Mv+PaHm+8I/FktQ5k+eb2LEir5UieOlrE2JgbHeZybmsT81W4P1qKb5l+JGY010B8xbr1pWmiJ7tCzv3HxgQdKpRuvpLXSwldBXk5k8vAopJiWJKYyZbA11WBiegE0HO2rTH5P+vPuqGAlR9Vb86zeZYnzMSkMAAv2M1fRsx4s4QV/AHaEcRvIR0dkJke7E8v8FgDIi58At097V9tLCsGS3EQIm8SfSDA7FTGAMPpECA4ZmOBQ19lhqzek5lgc1Uzb+CZTqYTcangZAX07kaYrwkc0HsX+pgMQZQAvonLgytdTxqeapgE4DiQoZfjMzFFvkC9Xoi1w48S/BdGTMohPqn3BfoBIOncg6qpJNPPowb/PdM8iFNgf6BquzmqrlF9gvXOSGCY8PmcbqAxTGrg1OD/1V3m6rdwc7jOWdmorydWJcoJLEY+B1a82Y3lOBqFtASlcrHtNetoGLIH6fVlSIUNv5se9da3mcObvSeTlLTWNW0HZiFIi5+ZQztnhoYlO4PtzqeaFcC267NNv/gdOaAgd+unovX2rqJ/vr0z91i0L6vfnJZzZaV60Ej+OnDpRPK32mthdAOIRZScL6uMmPp3F58g4pDiqqzar+73OS/wqdFPn0WLV2L/7xygvUXdFCnLR0hi49g4wdvfrrMzx+14WnKyXI1PKaMvNlo2yT87JYsQIBZeL4rjFytC8LR5BQbCG3Q4IybdmIuqRfWUzoIzMDKDhUPglxpGG20fou1iCw+nHAzQmhXKwiPUpKF8JO19Taw70e3c7JjDsd05xXexmAkElL++uMTy9TZzdOhj13m9/yU5j7hr2iMpuJVz7SlbdvuLfCai89bYtsI7pEx5G8BMbzsitcUdLkKznO1C4cRP5ZYrpli6Q9gAa87QticxSixuOqV++uOsB"
                },
                {
                    "linkRefNumber": "UBI4859645",
                    "maskedAccNumber": "UBI852178812",
                    "encryptedFI": "EbhvV8yLvu/Da2BB8L5C00XXlgERVHmPeoJNletxnXVVHhY4KGiDvMANu+bNVVGmb1yc0u+MkxUL+wsScQCdXY+gUULSdZy7klkNclNRk2Vg/jNqNGcht9+ErwA6ynQBHed/IF7IDtGyprmBXcuRTIrJD2wJOrV9Szdf2d/Zky5hk1nd8asxroBGIhSdNGV0hZoaWaSk2UAt2JBgGVqdC5uZinELE9klohKSb4NjlUUK8HNnMdotmjc+aX6PUC3wo9ydU2KZvxuZDtljX7glZNbgyuleFsnWtUOYle66drDAg4Mv+PaHm+8I/FktQ5k+eb2LEir5UieOlrE2JgbHeera3EYUW+vDKn303NtWscAyiv0kLtrpaE+hXg5nHcG47yyW76XsGlIe2hYMJGwjMc6+B79ex+79QnbPhTtY+yLOQdgVcrIr1mzAuRP8XX3Ohz6x8y/Nxcd9cULBRnV1CWxRb7jeG+QxKWZwTO9iezDgCztC7/wySUzqo55957RJK9W0xRH+kIOwgX0VV15t3GdzCO3eybBMiNHqoS/rXGCLFfY7BwgT+VPMyUTcnjewJt7gPyWlDgSEKNaM9Z09HhfjKC6bf+fbZgy6Zgb0I3qH2sX9piUbdv3zMCEL3kamWbpweqBzBoIrKLxKJq4g3FmgSw9nURxjfjgvGFF/88GeXXrK+x9ljP8IwCG7RBXe64/iqsh95OsvxtQ5uNwX7j+7s4DvOs8bB35+NTwNoJh8KFekOEy+/CSPODRrc8YHX2/Y7bUoYodzKQqQu3CtU3DxZ5RAK0D50FML+BGepiGCsH3/kaD3mcxVgmuI+aE1sgAIooS9aG2HmQ83hE4+2B9e+d7/BJ1bddYx3B509pBxlq+dIPLmNrigyRWqHhFawmUxEcuKtbTHoYrkSx3GNfvDYCGnXb7PT2CpCgFC/5ufhdefat2EG4sK9NmzZ+xFmijv/KjJn7rMZnlC0YhKqhLARdNXXaxLpB1wCetBizUrVx7/vVaY8ZU7RZCj/WIequPNlQZTgV6RWdyhWfN4N4tx7yvFPFLZ3z9RnRqO7fGtKwmRqvHENLT/VDKQ4kRP5aqWbwyaLjNXXrYPAOpQFrplU3cXgcyAh8Hlohu+uRXsJIri6aulg9pCj/lIuouDTGpsEVxUaA33riiSbdCt0OG2zsm9ACNw64rvMbvO5tfKRZx1s1zm9H+Tf9vWfI3+"
                }
            ],
            "KeyMaterial": {
                "cryptoAlg": "ECDHE",
                "curve": "Curve25519",
                "params": "None",
                "DHPublicKey": {
                    "expiry": "2019-05-29",
                    "Parameters": "BBBlTIJo9SUqxChDFvGpBHmc",
                    "KeyValue": "CJDtAYbYef7crq+GRRomK9PDrQ90JuEBqSLnPhAo2AA="
                },
                "Nonce": "a10a763d-bf1c-46d7-b3e8-6d4a026bf7be",
                "Signature": "Signature of AA"
            }
        }
    ]
}

HTTP METHOD: POST

URL: http://api.finvu.in/ConnectHub/V1/Consent/Notification

Request Body

{
  "ver": "1.0",
  "timestamp": "2018-12-06T11:39:57.153Z",
  "txnid": "0b811819-9044-4856-b0ee-8c88035f8858",
  "Notifier": {
    "type": "AA",
    "id": "cookiejar-aa@finvu.in"
  },
  "ConsentStatusNotification": {
    "consentId": "5bd5728a-1f19-4679-add9-fd5f626af2f8",
    "ConsentStatus": "REVOKED"
  }
}

Response Expected:

200 OK

HTTP METHOD: POST

URL: http://api.finvu.in/ConnectHub/V1/Consent

Request Body

{
  "ver": "1.0",
  "txnid": "0b811819-9044-4856-b0ee-8c88035f8858",
  "consentId": "229dcbe7-2d9b-49e2-a512-f9ed8d4cccd5",
  "status": "ACTIVE",
  "createTimestamp": "2018-12-06T11:39:57.153Z",
  "ConsentDetail": {
    "consentStart": "2019-12-06T11:39:57.153Z",
    "consentExpiry": "2019-12-06T11:39:57.153Z",
    "consentMode": "VIEW",
    "fetchType": "ONETIME",
     "consentTypes": [
      "BALANCE"
    ],
    "fiTypes": [
      "DEPOSIT"
    ],
    "DataConsumer": {
      "id": "cookiejar-aa@finvu.in",
      "type": "AA"
    },
    "DataProvider": {
      "id": "SBIN",
      "type": "FIP"
    },
    "Customer": {
      "id": "test10@finvu.in"
    },
    "Accounts": [
      {
        "fiType": "DEPOSIT",
        "fipId": "SBIN",
        "accType": "SAVINGS",
        "linkRefNumber": "SBIREF8857501",
        "maskedAccNumber": "XXXXXXXXX8701"
      },
      {
        "fiType": "DEPOSIT",
        "fipId": "SBIN",
        "accType": "SAVINGS",
        "linkRefNumber": "SBIREF8857501",
        "maskedAccNumber": "XXXXXXXXX8701"
      }
    ],
    "Purpose": {
      "code": "101",
      "refUri": "https://api.rebit.org.in/aa/purpose/101.xml",
      "text": "Wealth management service",
      "Category": {
        "type": "string"
      }
    },
    "FIDataRange": {
      "from": "2017-07-13T11:33:34.509Z",
      "to": "2018-07-13T11:33:34.509Z"
    },
    "DataLife": {
      "unit": "DAY",
      "value": 0
    },
    "Frequency": {
      "unit": "HOUR",
      "value": 0
    },
    "DataFilter": [
      {
        "type": "TRANSACTIONAMOUNT",
        "operator": ">=",
        "value": "string"
      }
    ]
  },
  "consentDetailDigitalSignature": "Digital Signature of the ConsentDetail Section.",
  "ConsentUse": {
    "logUri": "string",
    "count": 1,
    "lastUseDateTime": "2018-12-06T11:39:57.153Z"
    }

}

Response Expected:

200 OK

Heartbeat

HTTP METHOD: GET

URL: http://api.finvu.in/ConnectHub/V1/Heartbeat

Request Body

No Request Body expected

Response Expected:

{
    "ver": "1.0",
    "timestamp": "2019-01-23T04:08:25.132+0000",
    "Status": "UP"
}

FIP API (Simulator)

Request headers

API Request

Account Discover

Account Linking

Account Unlinking

Account Confirm Token

FI request

FI Fetch

Consent Notifications

Consent

Heartbeat