Bank Account

Bank Account Service APIs

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

PreviousAttendance NextBilling Calculator

Last updated 1 year ago

Was this helpful?

post

/bankaccount/v1/_create

Body

requestInfoobject

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.

bankAccountsobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/bankaccount/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"bankAccounts":[{"tenantId":"pb.amritsar","serviceCode":"ORG, IND , ULB","referenceId":"32e33343-7b4c-4353-9abf-4de8f5bcd764","additionalFields":{},"auditDetails":{},"bankAccountDetails":[{"tenantId":"pb.amritsar","accountHolderName":"XYZ Holdings","accountNumber":"text","accountType":"Savings or Current or UPI or Wallet","isPrimary":true,"bankBranchIdentifier":{"type":"IFSC, SWIFT","additionalDetails":{}},"additionalFields":{},"auditDetails":{},"documents":[{"additionalDetails":{}}]}]}]}'

202

400

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

Accepted account registration request.

post

/bankaccount/v1/_update

Body

requestInfoobject

bankAccountsobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/bankaccount/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"bankAccounts":[{"tenantId":"pb.amritsar","serviceCode":"ORG, IND , ULB","referenceId":"32e33343-7b4c-4353-9abf-4de8f5bcd764","additionalFields":{},"auditDetails":{},"bankAccountDetails":[{"tenantId":"pb.amritsar","accountHolderName":"XYZ Holdings","accountNumber":"text","accountType":"Savings or Current or UPI or Wallet","isPrimary":true,"bankBranchIdentifier":{"type":"IFSC, SWIFT","additionalDetails":{}},"additionalFields":{},"auditDetails":{},"documents":[{"additionalDetails":{}}]}]}]}'

202

400

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

Accepted account updation request.

post

/bankaccount/v1/_search

Body

requestInfoobject

bankAccountDetailsobject

paginationobject

Pagination details

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/bankaccount/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"bankAccountDetails":{"tenantId":"pg.cityA","serviceCode":"ORG, IND or something else","accountHolderName":"XYZ Holdings","bankBranchIdentifierCode":{"type":"IFSC, SWIFT","additionalDetails":{}},"ids":[null],"referenceId":[null],"accountNumber":[null]},"pagination":{"limit":10,"offSet":0,"order":{"0":"a","1":"s","2":"c"}}}'

200

400

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

Return search results