FIU API Specification

post

This API is intended to be used by AA to notify FIU about the change in consent status due to the consent management operations performed by the Customer. For more details about consent notification flow, please refer FAQ section. Note: "Request Body Example Value" and "Responses Example Value" given below is for illustrative purposes only.

Authorizations

Header parameters

aa_api_keyapiKeyRequired

aa_api_key is provided to FIU by the AA

x-jws-signaturestringRequired

Detached JWS of the body

x-request-metastringRequired

It is the Base64 encoded JSON object having the identifier of the receiver (recipient-id) to whom the API call needs to be forwarded. Ex: x-request-meta: [Base64 of {"recipient-id": "SIMULATOR"}] i.e x-request-meta: eyJyZWNpcGllbnQtaWQiOiAiU0lNVUxBVE9SIn0K

Body

verstringRequired

API version

Example: 2.0.0

timestampstring · date-timeRequired

Creation timestamp of the message

Example: 2023-06-26T11:39:57.153Z

txnidstringRequired

The unique transaction identifier used for providing an end to end traceability.

Example: 0b811819-9044-4856-b0ee-8c88035f8858

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized Access

application/json

404

Not Found

application/json

409

Conflict

application/json

412

Precondition failed

application/json

500

Internal Server Error

application/json

501

Not Implemented

application/json

503

Service Unavailable

application/json

post

HTTPcURLJavaScriptPython

POST /router/v2/Consent/Notification HTTP/1.1
Host: api.sandbox.sahamati.org.in
aa_api_key: null
x-jws-signature: text
x-request-meta: text
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "ver": "2.0.0",
  "timestamp": "2023-06-26T11:39:57.153Z",
  "txnid": "0b811819-9044-4856-b0ee-8c88035f8858",
  "Notifier": {
    "type": "AA",
    "id": "AA-1"
  },
  "ConsentStatusNotification": {
    "consentId": "XXXX0-XXXX-XXXX",
    "consentHandle": "XXXX0-XXXX-XXXX",
    "consentStatus": "PAUSED"
  }
}

{
  "ver": "2.0.0",
  "timestamp": "2023-06-26T06:13:30.967+0000",
  "txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
  "response": "OK"
}

post

This API can be used by AAs to send notifications related to Financial Information (FI) fetch to FIU/AA Client. Note: "Request Body Example Value" and "Responses Example Value" given below is for illustrative purposes only.

Authorizations

Header parameters

aa_api_keyapiKeyRequired

aa_api_key is provided to FIU by the AA

x-jws-signaturestringRequired

Detached JWS of the body

x-request-metastringRequired

It is the Base64 encoded JSON object having the identifier of the receiver (recipient-id) to whom the API call needs to be forwarded. Ex: x-request-meta: [Base64 of {"recipient-id": "SIMULATOR"}] i.e x-request-meta: eyJyZWNpcGllbnQtaWQiOiAiU0lNVUxBVE9SIn0K

Body

verstringRequired

API version

Example: 2.0.0

timestampstring · date-timeRequired

Creation timestamp of the message

Example: 2023-06-26T11:39:57.153Z

txnidstringRequired

The unique transaction identifier used for providing an end to end traceability.

Example: 0b811819-9044-4856-b0ee-8c88035f8858

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized Access

application/json

404

Not Found

application/json

409

Conflict

application/json

412

Precondition failed

application/json

500

Internal Server Error

application/json

501

Not Implemented

application/json

503

Service Unavailable

application/json

post

HTTPcURLJavaScriptPython

POST /router/v2/FI/Notification HTTP/1.1
Host: api.sandbox.sahamati.org.in
aa_api_key: null
x-jws-signature: text
x-request-meta: text
Content-Type: application/json
Accept: */*
Content-Length: 341

{
  "ver": "2.0.0",
  "timestamp": "2023-06-26T11:39:57.153Z",
  "txnid": "0b811819-9044-4856-b0ee-8c88035f8858",
  "Notifier": {
    "type": "AA",
    "id": "AA-1"
  },
  "FIStatusNotification": {
    "sessionId": "XXXX0-XXXX-XXXX",
    "sessionStatus": "ACTIVE",
    "FIStatusResponse": [
      {
        "fipID": "FIP-1",
        "Accounts": [
          {
            "linkRefNumber": "XXXX-XXXX-XXXX",
            "FIStatus": "READY",
            "description": ""
          }
        ]
      }
    ]
  }
}

{
  "ver": "2.0.0",
  "timestamp": "2023-06-26T06:13:30.967+0000",
  "txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
  "response": "OK"
}