FIU API Specification

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.

POSThttps://api.sandbox.sahamati.org.in/proxy/v2/Consent/Notification

Header parameters

Body

ver*string

API version

Example: "2.0.0"

timestamp*string (date-time)

Creation timestamp of the message

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

txnid*string

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

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

Notifier*object

Information about the notifier

ConsentStatusNotification*object

Contains the Consent ID, Consent Handle and Consent Status details.

Response

Headers

Body

ver*string

API version

Example: "2.0.0"

timestamp*string (date-time)

Creation timestamp of the message

Example: "2023-06-26T06:13:30.967+0000"

txnid*string

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

Example: "f35761ac-4a18-11e8-96ff-0277a9fbfedc"

response*string

Response description

Example: "OK"

Request

const response = await fetch('https://api.sandbox.sahamati.org.in/proxy/v2/Consent/Notification', {
    method: 'POST',
    headers: {
      "x-jws-signature": "text",
      "x-recipient-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ver": "2.0.0",
      "timestamp": "2023-06-26T11:39:57.153Z",
      "txnid": "0b811819-9044-4856-b0ee-8c88035f8858",
      "Notifier": {
        "type": "AA",
        "id": "AA-1"
      },
      "ConsentStatusNotification": {
        "consentStatus": "PAUSED"
      }
    }),
});
const data = await response.json();

Response

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

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.

POSThttps://api.sandbox.sahamati.org.in/proxy/v2/FI/Notification

Header parameters

Body

ver*string

API version

Example: "2.0.0"

timestamp*string (date-time)

Creation timestamp of the message

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

txnid*string

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

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

Notifier*object

Information about the notifier

FIStatusNotification*object

Contains the financial information fetch session id and session status details.

Response

Headers

Body

ver*string

API version

Example: "2.0.0"

timestamp*string (date-time)

Creation timestamp of the message

Example: "2023-06-26T06:13:30.967+0000"

txnid*string

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

Example: "f35761ac-4a18-11e8-96ff-0277a9fbfedc"

response*string

Response description

Example: "OK"

Request

const response = await fetch('https://api.sandbox.sahamati.org.in/proxy/v2/FI/Notification', {
    method: 'POST',
    headers: {
      "x-jws-signature": "text",
      "x-recipient-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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": ""
              }
            ]
          }
        ]
      }
    }),
});
const data = await response.json();

Response

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

PreviousFIP API Specification NextIntegration using Simulator

Last updated 1 month ago

const response = await fetch('https://api.sandbox.sahamati.org.in/proxy/v2/Consent/Notification', { method: 'POST', headers: { "x-jws-signature": "text", "x-recipient-id": "text", "Content-Type": "application/json" }, body: JSON.stringify({ "ver": "2.0.0", "timestamp": "2023-06-26T11:39:57.153Z", "txnid": "0b811819-9044-4856-b0ee-8c88035f8858", "Notifier": { "type": "AA", "id": "AA-1" }, "ConsentStatusNotification": { "consentStatus": "PAUSED" } }), }); const data = await response.json();

const response = await fetch('https://api.sandbox.sahamati.org.in/proxy/v2/FI/Notification', { method: 'POST', headers: { "x-jws-signature": "text", "x-recipient-id": "text", "Content-Type": "application/json" }, body: JSON.stringify({ "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": "" } ] } ] } }), }); const data = await response.json();