Sign in
latestSwagger 2.02026-08-1021419.9 KB

26f19f79f17b

Notifications

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

post/FI/Notification

Headers

{"stackTrail":"paths:/FI/Notification:post:parameters:0:schema","oasType":"schema","type":"unknown"}

aa_api_key is provided to FIU by the AA

x-jws-signaturestring required

Detached JWS of the body

x-request-metastring required

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

Request body

verstring required

API version

timestampstring date-time required

Creation timestamp of the message

txnidstring required

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

Example request

{
  "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"
          }
        ]
      }
    ]
  }
}

Response

OK

verstring required

API version

timestampstring date-time required

Creation timestamp of the message

txnidstring required

Unique transaction identifier used for providing an end to end traceability.

responsestring required

Response description

Example response

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