Jump to

• Request
• Response

Get all valid core accounts

get

/coreaccounts

This endpoint is used to fet all valid core accounts maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• acStatDormant(optional): string
• acStatFrozen(optional): string
• acStatNoCr(optional): string
• acStatNoDr(optional): string
• accountClass(optional): string
• address1(optional): string
• authStat(optional): string
• checkerId(optional): string
• countryCode(optional): string
• custAcCcy(optional): string
• custAcIban(optional): string
• custAcName(optional): string
• custAccountNo(optional): string
• customerNo(optional): string
• glStatBlocked(optional): string
• hostCode(optional): string
• includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
• limit(optional): integer
  limit is maximum no of records to be fetched
• makerId(optional): string
• modNo(optional): integer
• offset(optional): integer
  offset is starting no of records to be fetched
• onceAuth(optional): string
• recordStat(optional): string
• sourceSystem(optional): string
• sourceSystemAccBrn(optional): string
• sourceSystemAccNo(optional): string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string

Body ()

Root Schema : CoreAccountCollection

Type: object

Collection of coreaccount.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object CoreAccountDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : CoreAccountDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object CoreAccountDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "countryCode":{
                    "type":"string",
                    "description":"Country Code",
                    "minLength":0,
                    "maxLength":4
                },
                "address4":{
                    "type":"string",
                    "description":"Fourth line of the customer?s address",
                    "minLength":0,
                    "maxLength":105
                },
                "address3":{
                    "type":"string",
                    "description":"Third line of the customer?s address",
                    "minLength":0,
                    "maxLength":105
                },
                "address2":{
                    "type":"string",
                    "description":"Second line of the customer?s address",
                    "minLength":0,
                    "maxLength":105
                },
                "address1":{
                    "type":"string",
                    "description":"First line of the customer?s address",
                    "minLength":0,
                    "maxLength":105
                },
                "ecaCheckReq":{
                    "type":"string",
                    "description":"Indicates that ECA check is required for the external customer account",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"[Y,N]"
                },
                "accountClass":{
                    "type":"string",
                    "description":"Account class of the external customer account. It can be Normal account or Nostro account",
                    "maxLength":6
                },
                "acStatDormant":{
                    "type":"string",
                    "description":"Indicates that the account status is dormant",
                    "minLength":1,
                    "maxLength":1,
                    "pattern":"[Y,N]"
                },
                "acStatFrozen":{
                    "type":"string",
                    "description":"Indicate that the account status is frozen",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"[Y,N]"
                },
                "glStatBlocked":{
                    "type":"string",
                    "description":"Indicates that the account status is blocked",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"[Y,N]"
                },
                "acStatNoDr":{
                    "type":"string",
                    "description":"Indicates that the account does not have any debit facility",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"[Y,N]"
                },
                "acStatNoCr":{
                    "type":"string",
                    "description":"Indicates that the account does not have any credit facility",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"[Y,N]"
                },
                "acOpenDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"The date on which account is being opened"
                },
                "custAcName":{
                    "type":"string",
                    "description":"Name of the account holder",
                    "minLength":0,
                    "maxLength":105,
                    "pattern":"[a-zA-Z0-9\\s]+"
                },
                "custAcCcy":{
                    "type":"string",
                    "description":"Currency in which the account is being created",
                    "maxLength":3
                },
                "customerNo":{
                    "type":"string",
                    "description":"Customer number to which the account number is being linked",
                    "maxLength":20
                },
                "sourceSystemAccBrn":{
                    "type":"string",
                    "description":"Branch to which the account belongs to",
                    "maxLength":20
                },
                "sourceSystemAccNo":{
                    "type":"string",
                    "description":"Account number as in the source system",
                    "minLength":0,
                    "maxLength":35,
                    "pattern":"[a-zA-Z0-9]+"
                },
                "sourceSystem":{
                    "type":"string",
                    "description":"Name of the source system",
                    "maxLength":35
                },
                "custAcIban":{
                    "type":"string",
                    "description":"IBAN that is linked to the customer",
                    "minLength":0,
                    "maxLength":35,
                    "pattern":"[a-zA-Z0-9]+"
                },
                "hostCode":{
                    "type":"string",
                    "description":"The host code that is linked to the logged in user of the branch.",
                    "maxLength":8
                },
                "custAccountNo":{
                    "type":"string",
                    "description":"Account number of the External customer",
                    "minLength":1,
                    "maxLength":20,
                    "pattern":"[a-zA-Z0-9]+"
                }
            },
            "required":[
                "custAcName",
                "customerNo",
                "sourceSystemAccBrn",
                "sourceSystemAccNo",
                "sourceSystem",
                "hostCode",
                "custAccountNo"
            ]
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : CoreAccountDTO-allOf[1]

Type: object

Show Source

• accountClass(optional): string
  Maximum Length: 6

  Account class of the external customer account. It can be Normal account or Nostro account
• acOpenDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  The date on which account is being opened
• acStatDormant(optional): string
  Minimum Length: 1

  Maximum Length: 1

  Pattern: [Y,N]

  Indicates that the account status is dormant
• acStatFrozen(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: [Y,N]

  Indicate that the account status is frozen
• acStatNoCr(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: [Y,N]

  Indicates that the account does not have any credit facility
• acStatNoDr(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: [Y,N]

  Indicates that the account does not have any debit facility
• address1(optional): string
  Minimum Length: 0

  Maximum Length: 105

  First line of the customer?s address
• address2(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Second line of the customer?s address
• address3(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Third line of the customer?s address
• address4(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Fourth line of the customer?s address
• countryCode(optional): string
  Minimum Length: 0

  Maximum Length: 4

  Country Code
• custAcCcy(optional): string
  Maximum Length: 3

  Currency in which the account is being created
• custAccountNo: string
  Minimum Length: 1

  Maximum Length: 20

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

  Account number of the External customer
• custAcIban(optional): string
  Minimum Length: 0

  Maximum Length: 35

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

  IBAN that is linked to the customer
• custAcName: string
  Minimum Length: 0

  Maximum Length: 105

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

  Name of the account holder
• customerNo: string
  Maximum Length: 20

  Customer number to which the account number is being linked
• ecaCheckReq(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: [Y,N]

  Indicates that ECA check is required for the external customer account
• glStatBlocked(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: [Y,N]

  Indicates that the account status is blocked
• hostCode: string
  Maximum Length: 8

  The host code that is linked to the logged in user of the branch.
• sourceSystem: string
  Maximum Length: 35

  Name of the source system
• sourceSystemAccBrn: string
  Maximum Length: 20

  Branch to which the account belongs to
• sourceSystemAccNo: string
  Minimum Length: 0

  Maximum Length: 35

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

  Account number as in the source system

{
    "type":"object",
    "properties":{
        "countryCode":{
            "type":"string",
            "description":"Country Code",
            "minLength":0,
            "maxLength":4
        },
        "address4":{
            "type":"string",
            "description":"Fourth line of the customer?s address",
            "minLength":0,
            "maxLength":105
        },
        "address3":{
            "type":"string",
            "description":"Third line of the customer?s address",
            "minLength":0,
            "maxLength":105
        },
        "address2":{
            "type":"string",
            "description":"Second line of the customer?s address",
            "minLength":0,
            "maxLength":105
        },
        "address1":{
            "type":"string",
            "description":"First line of the customer?s address",
            "minLength":0,
            "maxLength":105
        },
        "ecaCheckReq":{
            "type":"string",
            "description":"Indicates that ECA check is required for the external customer account",
            "minLength":0,
            "maxLength":1,
            "pattern":"[Y,N]"
        },
        "accountClass":{
            "type":"string",
            "description":"Account class of the external customer account. It can be Normal account or Nostro account",
            "maxLength":6
        },
        "acStatDormant":{
            "type":"string",
            "description":"Indicates that the account status is dormant",
            "minLength":1,
            "maxLength":1,
            "pattern":"[Y,N]"
        },
        "acStatFrozen":{
            "type":"string",
            "description":"Indicate that the account status is frozen",
            "minLength":0,
            "maxLength":1,
            "pattern":"[Y,N]"
        },
        "glStatBlocked":{
            "type":"string",
            "description":"Indicates that the account status is blocked",
            "minLength":0,
            "maxLength":1,
            "pattern":"[Y,N]"
        },
        "acStatNoDr":{
            "type":"string",
            "description":"Indicates that the account does not have any debit facility",
            "minLength":0,
            "maxLength":1,
            "pattern":"[Y,N]"
        },
        "acStatNoCr":{
            "type":"string",
            "description":"Indicates that the account does not have any credit facility",
            "minLength":0,
            "maxLength":1,
            "pattern":"[Y,N]"
        },
        "acOpenDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"The date on which account is being opened"
        },
        "custAcName":{
            "type":"string",
            "description":"Name of the account holder",
            "minLength":0,
            "maxLength":105,
            "pattern":"[a-zA-Z0-9\\s]+"
        },
        "custAcCcy":{
            "type":"string",
            "description":"Currency in which the account is being created",
            "maxLength":3
        },
        "customerNo":{
            "type":"string",
            "description":"Customer number to which the account number is being linked",
            "maxLength":20
        },
        "sourceSystemAccBrn":{
            "type":"string",
            "description":"Branch to which the account belongs to",
            "maxLength":20
        },
        "sourceSystemAccNo":{
            "type":"string",
            "description":"Account number as in the source system",
            "minLength":0,
            "maxLength":35,
            "pattern":"[a-zA-Z0-9]+"
        },
        "sourceSystem":{
            "type":"string",
            "description":"Name of the source system",
            "maxLength":35
        },
        "custAcIban":{
            "type":"string",
            "description":"IBAN that is linked to the customer",
            "minLength":0,
            "maxLength":35,
            "pattern":"[a-zA-Z0-9]+"
        },
        "hostCode":{
            "type":"string",
            "description":"The host code that is linked to the logged in user of the branch.",
            "maxLength":8
        },
        "custAccountNo":{
            "type":"string",
            "description":"Account number of the External customer",
            "minLength":1,
            "maxLength":20,
            "pattern":"[a-zA-Z0-9]+"
        }
    },
    "required":[
        "custAcName",
        "customerNo",
        "sourceSystemAccBrn",
        "sourceSystemAccNo",
        "sourceSystem",
        "hostCode",
        "custAccountNo"
    ]
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top