Jump to

• Request
• Response

Get all valid virtual identifier for a given customer

get

/service/idmaps/fetchIdentifier

This endpoint is used to get all valid virtual identifiers for a given customer.

Request

Supported Media Types

• application/json

Query Parameters

• realCustomerNo: string
  Real Customer No of remittance list id
• virtualIdentifier(optional): string
  virtual identifier for which details to be checked

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : IdentifierMapLOVDTOServiceCollection

Type: object

Collection of idmap.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object IdentifierMapLOVServiceDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : IdentifierMapLOVServiceDTO

Type: object

Show Source

• accountGroupId(optional): string
  VMCA
• branchName(optional): string
  branch name
• maxLength(optional): number
  maximum length of VI account number as per rule
• minLength(optional): number
  Minimum length of VI account number as per rule
• realAccountNo(optional): string
  real account number
• realCustomerNo(optional): string
  Real Customer Name
• remitteridMask(optional): string
  Remitter Id mask at branch level
• remitterListId(optional): string
  Remitter List Id
• remitterListIdDesc(optional): string
  Remitter List Description
• validationRuleId(optional): string
  corporate rule of the identifier
• virtualIdentifier(optional): string
  virtual identifier
• virtualIdentifierBranch(optional): string
  virtual Identifier branch
• virtualIdentifierDesc(optional): string
  identifier Description

{
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "type":"string",
            "description":"Real Customer Name"
        },
        "virtualIdentifier":{
            "type":"string",
            "description":"virtual identifier"
        },
        "virtualIdentifierDesc":{
            "type":"string",
            "description":"identifier Description"
        },
        "virtualIdentifierBranch":{
            "type":"string",
            "description":"virtual Identifier branch"
        },
        "branchName":{
            "type":"string",
            "description":"branch name"
        },
        "realAccountNo":{
            "type":"string",
            "description":"real account number"
        },
        "accountGroupId":{
            "type":"string",
            "description":"VMCA"
        },
        "remitteridMask":{
            "type":"string",
            "description":"Remitter Id mask at branch level"
        },
        "remitterListId":{
            "type":"string",
            "description":"Remitter List Id"
        },
        "remitterListIdDesc":{
            "type":"string",
            "description":"Remitter List Description"
        },
        "validationRuleId":{
            "type":"string",
            "description":"corporate rule of the identifier"
        },
        "minLength":{
            "type":"number",
            "description":"Minimum length of VI account number as per rule"
        },
        "maxLength":{
            "type":"number",
            "description":"maximum length of VI account number as per rule"
        }
    }
}

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