Bank Account

Bank Account Service APIs

APIs to store and manage financial account details of entities (individuals or organizations).

POST/bankaccount/v1/_create

Body

application/json

requestInfoRequestInfo (object)

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

bankAccountsarray of any

Response

202400

Accepted account registration request.

Body

*/*

any

Request

JavaScriptCurl

const response = await fetch('/bankaccount/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

POST/bankaccount/v1/_update

Body

application/json

requestInfoRequestInfo (object)

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

bankAccountsarray of BankAccount (object)

Response

202400

Accepted account updation request.

Body

*/*

responseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

bankAccountsarray of BankAccount (object)

paginationPagination (object)

Pagination details

Request

JavaScriptCurl

const response = await fetch('/bankaccount/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "bankAccounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "pb.amritsar",
      "serviceCode": "ORG, IND , ULB",
      "referenceId": "32e33343-7b4c-4353-9abf-4de8f5bcd764",
      "bankAccountDetails": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "tenantId": "pb.amritsar",
          "accountHolderName": "XYZ Holdings",
          "accountNumber": "text",
          "accountType": "Savings or Current or UPI or Wallet",
          "isPrimary": true,
          "bankBranchIdentifier": {
            "type": "IFSC, SWIFT",
            "code": "text",
            "isActive": false
          },
          "isActive": false,
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text"
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "totalCount": 0,
    "sortBy": "text",
    "order": {}
  }
}

POST/bankaccount/v1/_search

Body

application/json

requestInfoRequestInfo (object)

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

bankAccountDetailsBankAccountSearchCriteria (object)

paginationPagination (object)

Pagination details

Response

200400

Return search results

Body

*/*

responseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

bankAccountsarray of BankAccount (object)

paginationPagination (object)

Pagination details

Request

JavaScriptCurl

const response = await fetch('/bankaccount/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "bankAccounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "pb.amritsar",
      "serviceCode": "ORG, IND , ULB",
      "referenceId": "32e33343-7b4c-4353-9abf-4de8f5bcd764",
      "bankAccountDetails": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "tenantId": "pb.amritsar",
          "accountHolderName": "XYZ Holdings",
          "accountNumber": "text",
          "accountType": "Savings or Current or UPI or Wallet",
          "isPrimary": true,
          "bankBranchIdentifier": {
            "type": "IFSC, SWIFT",
            "code": "text",
            "isActive": false
          },
          "isActive": false,
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text"
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "totalCount": 0,
    "sortBy": "text",
    "order": {}
  }
}