Jump to

• Request
• Response

Gets all valid account products

get

/service/accountproducts

This endpoint is used to get all valid account products.

Request

Supported Media Types

• application/json

Query Parameters

• accCode(optional): string
• authStat(optional): string
• checkerId(optional): string
• codeDesc(optional): string
• includecloseandunauth(optional): boolean
  includecloseandunauth must be set to fetch summary record. By default, the value is false
• limit(optional): integer
  Fetches the maximum limit of the record.
• makerId(optional): string
• offset(optional): integer
  Fetches the starting number of the offset.
• realCustomerNo(optional): string
• recordStat(optional): string

Header Parameters

• sourceCode: string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns Success or failure messages.

Headers

• Location: string

Body ()

Root Schema : VirAccProductServiceCollection

Type: object

Collection of accountproduct.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of accountproduct.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VirAccProductServiceDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object VirAccProductServiceDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/VirAccProductServiceDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : VirAccProductServiceDTO

Type: object

Match All

Show Source

• object VirAccProductServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "accCode":{
                    "type":"string",
                    "description":"Unique Virtual Account Product",
                    "minLength":4,
                    "maxLength":4,
                    "pattern":"[a-zA-Z0-9]+"
                },
                "codeDesc":{
                    "type":"string",
                    "description":"Description of Virtual Account Product",
                    "minLength":0,
                    "maxLength":105
                },
                "realCustomerNo":{
                    "type":"string",
                    "description":"Real Customer Number for which Virtual Account Product is maintained"
                },
                "interestCalcReq":{
                    "type":"string",
                    "description":"Flag to indicate if Interest Calculation is required or not",
                    "pattern":"[Y,N]"
                },
                "debitTxnsAllowed":{
                    "type":"string",
                    "description":"Flag to indicate if Debit Transaction is allowed or not",
                    "pattern":"[Y,N]"
                },
                "creditTxnsAllowed":{
                    "type":"string",
                    "description":"Flag to indicate if Credit Transaction is allowed or not",
                    "pattern":"[Y,N]"
                },
                "overdraftAllowed":{
                    "type":"string",
                    "description":"Flag to indicate if Overdraft is allowed or not",
                    "pattern":"[Y,N]"
                },
                "inactiveDays":{
                    "type":"number",
                    "minimum":0,
                    "description":"Number of days after which virtual accounts opened under this code will be deactivated in case of no transactions"
                },
                "txnrestrAllowed":{
                    "type":"string",
                    "description":"Indicates if the Transaction code list maintained is allowed or disallowed",
                    "pattern":"[A,D]"
                },
                "ccyRestrAllowed":{
                    "type":"string",
                    "description":"Indicates if the Currency code list maintained is allowed or disallowed",
                    "pattern":"[A,D]"
                },
                "icAccGroupType":{
                    "type":"string",
                    "description":"flag to indicate vam account product is linked to customer specific/bank level ic account group -possible values are C/B/null"
                },
                "icGrpTemplate":{
                    "type":"string",
                    "description":"IC group template"
                },
                "makerId":{
                    "type":"string"
                },
                "makerDateStamp":{
                    "type":"string"
                },
                "checkerId":{
                    "type":"string"
                },
                "checkerDateStamp":{
                    "type":"string"
                },
                "modNo":{
                    "type":"number"
                },
                "recordStatus":{
                    "type":"string"
                },
                "authStatus":{
                    "type":"string"
                },
                "onceAuth":{
                    "type":"string"
                },
                "doerRemarks":{
                    "type":"string"
                },
                "approverRemarks":{
                    "type":"string"
                },
                "liqdAllowed":{
                    "type":"string",
                    "description":"Flag to indicate if Liquidity Management is allowed",
                    "pattern":"[Y,N]",
                    "default":"N"
                },
                "VirAccProdTxnRestrServiceDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/VirAccProdTxnRestrServiceDTO"
                    }
                },
                "VirAccProdCcyRestrServiceDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/VirAccProdCcyRestrServiceDTO"
                    }
                }
            },
            "required":[
                "accCode",
                "realCustomerNo"
            ]
        }
    ]
}

Nested Schema : VirAccProductServiceDTO-allOf[0]

Type: object

Show Source

• accCode: string
  Minimum Length: 4

  Maximum Length: 4

  Pattern: [a-zA-Z0-9]+

  Unique Virtual Account Product
• approverRemarks(optional): string
• authStatus(optional): string
• ccyRestrAllowed(optional): string
  Pattern: [A,D]

  Indicates if the Currency code list maintained is allowed or disallowed
• checkerDateStamp(optional): string
• checkerId(optional): string
• codeDesc(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Description of Virtual Account Product
• creditTxnsAllowed(optional): string
  Pattern: [Y,N]

  Flag to indicate if Credit Transaction is allowed or not
• debitTxnsAllowed(optional): string
  Pattern: [Y,N]

  Flag to indicate if Debit Transaction is allowed or not
• doerRemarks(optional): string
• icAccGroupType(optional): string
  flag to indicate vam account product is linked to customer specific/bank level ic account group -possible values are C/B/null
• icGrpTemplate(optional): string
  IC group template
• inactiveDays(optional): number
  Minimum Value: 0

  Number of days after which virtual accounts opened under this code will be deactivated in case of no transactions
• interestCalcReq(optional): string
  Pattern: [Y,N]

  Flag to indicate if Interest Calculation is required or not
• liqdAllowed(optional): string
  Default Value: N

  Pattern: [Y,N]

  Flag to indicate if Liquidity Management is allowed
• makerDateStamp(optional): string
• makerId(optional): string
• modNo(optional): number
• onceAuth(optional): string
• overdraftAllowed(optional): string
  Pattern: [Y,N]

  Flag to indicate if Overdraft is allowed or not
• realCustomerNo: string
  Real Customer Number for which Virtual Account Product is maintained
• recordStatus(optional): string
• txnrestrAllowed(optional): string
  Pattern: [A,D]

  Indicates if the Transaction code list maintained is allowed or disallowed
• VirAccProdCcyRestrServiceDTO(optional): array VirAccProdCcyRestrServiceDTO
• VirAccProdTxnRestrServiceDTO(optional): array VirAccProdTxnRestrServiceDTO

{
    "type":"object",
    "properties":{
        "accCode":{
            "type":"string",
            "description":"Unique Virtual Account Product",
            "minLength":4,
            "maxLength":4,
            "pattern":"[a-zA-Z0-9]+"
        },
        "codeDesc":{
            "type":"string",
            "description":"Description of Virtual Account Product",
            "minLength":0,
            "maxLength":105
        },
        "realCustomerNo":{
            "type":"string",
            "description":"Real Customer Number for which Virtual Account Product is maintained"
        },
        "interestCalcReq":{
            "type":"string",
            "description":"Flag to indicate if Interest Calculation is required or not",
            "pattern":"[Y,N]"
        },
        "debitTxnsAllowed":{
            "type":"string",
            "description":"Flag to indicate if Debit Transaction is allowed or not",
            "pattern":"[Y,N]"
        },
        "creditTxnsAllowed":{
            "type":"string",
            "description":"Flag to indicate if Credit Transaction is allowed or not",
            "pattern":"[Y,N]"
        },
        "overdraftAllowed":{
            "type":"string",
            "description":"Flag to indicate if Overdraft is allowed or not",
            "pattern":"[Y,N]"
        },
        "inactiveDays":{
            "type":"number",
            "minimum":0,
            "description":"Number of days after which virtual accounts opened under this code will be deactivated in case of no transactions"
        },
        "txnrestrAllowed":{
            "type":"string",
            "description":"Indicates if the Transaction code list maintained is allowed or disallowed",
            "pattern":"[A,D]"
        },
        "ccyRestrAllowed":{
            "type":"string",
            "description":"Indicates if the Currency code list maintained is allowed or disallowed",
            "pattern":"[A,D]"
        },
        "icAccGroupType":{
            "type":"string",
            "description":"flag to indicate vam account product is linked to customer specific/bank level ic account group -possible values are C/B/null"
        },
        "icGrpTemplate":{
            "type":"string",
            "description":"IC group template"
        },
        "makerId":{
            "type":"string"
        },
        "makerDateStamp":{
            "type":"string"
        },
        "checkerId":{
            "type":"string"
        },
        "checkerDateStamp":{
            "type":"string"
        },
        "modNo":{
            "type":"number"
        },
        "recordStatus":{
            "type":"string"
        },
        "authStatus":{
            "type":"string"
        },
        "onceAuth":{
            "type":"string"
        },
        "doerRemarks":{
            "type":"string"
        },
        "approverRemarks":{
            "type":"string"
        },
        "liqdAllowed":{
            "type":"string",
            "description":"Flag to indicate if Liquidity Management is allowed",
            "pattern":"[Y,N]",
            "default":"N"
        },
        "VirAccProdTxnRestrServiceDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VirAccProdTxnRestrServiceDTO"
            }
        },
        "VirAccProdCcyRestrServiceDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VirAccProdCcyRestrServiceDTO"
            }
        }
    },
    "required":[
        "accCode",
        "realCustomerNo"
    ]
}

Nested Schema : VirAccProdCcyRestrServiceDTO

Type: array

Show Source

• Array of: object VirAccProdCcyRestrServiceDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/VirAccProdCcyRestrServiceDTO"
    }
}

Nested Schema : VirAccProdTxnRestrServiceDTO

Type: array

Show Source

• Array of: object VirAccProdTxnRestrServiceDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/VirAccProdTxnRestrServiceDTO"
    }
}

Nested Schema : VirAccProdCcyRestrServiceDTO

Type: object

Show Source

• accCode(optional): string
• ccyCode(optional): string
• realCustomerNo(optional): string

{
    "type":"object",
    "properties":{
        "accCode":{
            "type":"string",
            "description":""
        },
        "realCustomerNo":{
            "type":"string",
            "description":""
        },
        "ccyCode":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : VirAccProdTxnRestrServiceDTO

Type: object

Show Source

• accCode(optional): string
• realCustomerNo(optional): string
• trnCode(optional): string

{
    "type":"object",
    "properties":{
        "accCode":{
            "type":"string",
            "description":""
        },
        "realCustomerNo":{
            "type":"string",
            "description":""
        },
        "trnCode":{
            "type":"string",
            "description":""
        }
    }
}

400 Response

Bad request error, the server is unable to process the request.

401 Response

Unauthorized request error, invalid credentials.

403 Response

Request denied, no permission to access the request.

405 Response

Invalid input, method is not allowed

500 Response

Internal server error

Back to Top