Bank Account

Bank Account Service APIs

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

post

Body

application/json

Responses

202

Accepted account registration request.

*/*

400

Invalid input.

*/*

post

/bankaccount/v1/_create

HTTPcURLJavaScriptPython

POST /bankaccount/v1/_create HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 726

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "bankAccounts": [
    {
      "tenantId": "pb.amritsar",
      "serviceCode": "ORG, IND , ULB",
      "referenceId": "32e33343-7b4c-4353-9abf-4de8f5bcd764",
      "bankAccountDetails": [
        {
          "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": true,
            "additionalDetails": {}
          },
          "isActive": true,
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "additionalFields": {}
        }
      ],
      "additionalFields": {}
    }
  ]
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "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": true,
            "additionalDetails": {}
          },
          "isActive": true,
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "additionalFields": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "additionalFields": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "totalCount": 1,
    "sortBy": "text",
    "order": {}
  }
}

post

Body

application/json

Responses

202

Accepted account updation request.

*/*

400

Invalid input.

*/*

post

/bankaccount/v1/_update

HTTPcURLJavaScriptPython

POST /bankaccount/v1/_update HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 726

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "bankAccounts": [
    {
      "tenantId": "pb.amritsar",
      "serviceCode": "ORG, IND , ULB",
      "referenceId": "32e33343-7b4c-4353-9abf-4de8f5bcd764",
      "bankAccountDetails": [
        {
          "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": true,
            "additionalDetails": {}
          },
          "isActive": true,
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "additionalFields": {}
        }
      ],
      "additionalFields": {}
    }
  ]
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "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": true,
            "additionalDetails": {}
          },
          "isActive": true,
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "additionalFields": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "additionalFields": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "totalCount": 1,
    "sortBy": "text",
    "order": {}
  }
}

post

Body

application/json

Responses

200

Return search results

*/*

400

Invalid input.

*/*

post

/bankaccount/v1/_search

HTTPcURLJavaScriptPython

POST /bankaccount/v1/_search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 535

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "bankAccountDetails": {
    "tenantId": "pg.cityA",
    "ids": [
      "text"
    ],
    "serviceCode": "ORG, IND or something else",
    "referenceId": [
      "text"
    ],
    "accountHolderName": "XYZ Holdings",
    "accountNumber": [
      "text"
    ],
    "isActive": true,
    "isPrimary": true,
    "bankBranchIdentifierCode": {
      "type": "IFSC, SWIFT",
      "code": "text",
      "isActive": true,
      "additionalDetails": {}
    }
  },
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "sortBy": "text",
    "order": {}
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "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": true,
            "additionalDetails": {}
          },
          "isActive": true,
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "additionalFields": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "additionalFields": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "totalCount": 1,
    "sortBy": "text",
    "order": {}
  }
}