Jump to

• Request
• Response

Retrieves the multi currency accounts linkage by ID

get

/multi-currency-accounts/linkage/{id}

This endpoint is used to retrieve the multi currency accounts linkage by ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  Id of the multiccyaccounts linkage that needs to be fetched

Query Parameters

• version(optional): string
  version of the multiccyaccounts linkage that needs to be fetched

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the multiccyaccounts linkage based on given id.

Body ()

Root Schema : MultiCcyAccLinkageWrapperDTO

Type: object

Show Source

• data(optional): object MultiCcyAccLinkageDTO

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/MultiCcyAccLinkageDTO"
        }
    }
}

Nested Schema : MultiCcyAccLinkageDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object MultiCcyAccLinkageDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "customerNo":{
                    "type":"string",
                    "description":"Customer Number",
                    "minLength":0,
                    "maxLength":80
                },
                "branchCode":{
                    "type":"string",
                    "description":"branch code",
                    "minLength":0,
                    "maxLength":12
                },
                "multiCurrencyAccNo":{
                    "type":"string",
                    "description":"Multi-Currency Account Number",
                    "minLength":0,
                    "maxLength":80
                },
                "subAccounts":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SubAccount"
                    },
                    "description":"List of Sub Accounts"
                }
            },
            "required":[
                "customerNo",
                "branchCode",
                "multiCurrencyAccNo",
                "subAccounts"
            ]
        }
    ]
}

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 : MultiCcyAccLinkageDTO-allOf[1]

Type: object

Show Source

• branchCode: string
  Minimum Length: 0

  Maximum Length: 12

  branch code
• customerNo: string
  Minimum Length: 0

  Maximum Length: 80

  Customer Number
• multiCurrencyAccNo: string
  Minimum Length: 0

  Maximum Length: 80

  Multi-Currency Account Number
• subAccounts: array subAccounts
  List of Sub Accounts

{
    "type":"object",
    "properties":{
        "customerNo":{
            "type":"string",
            "description":"Customer Number",
            "minLength":0,
            "maxLength":80
        },
        "branchCode":{
            "type":"string",
            "description":"branch code",
            "minLength":0,
            "maxLength":12
        },
        "multiCurrencyAccNo":{
            "type":"string",
            "description":"Multi-Currency Account Number",
            "minLength":0,
            "maxLength":80
        },
        "subAccounts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SubAccount"
            },
            "description":"List of Sub Accounts"
        }
    },
    "required":[
        "customerNo",
        "branchCode",
        "multiCurrencyAccNo",
        "subAccounts"
    ]
}

Nested Schema : subAccounts

Type: array

List of Sub Accounts

Show Source

• Array of: object SubAccount

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SubAccount"
    },
    "description":"List of Sub Accounts"
}

Nested Schema : SubAccount

Type: object

Show Source

• keyId(optional): string
  id
• modNo(optional): integer
  modification number
• primaryAccount(optional): boolean
  denotes if account is primary
• subAccountCcy: string
  Minimum Length: 0

  Maximum Length: 12

  sub account currency
• subAccountNo: string
  Minimum Length: 0

  Maximum Length: 80

  sub account Number

{
    "type":"object",
    "properties":{
        "keyId":{
            "type":"string",
            "description":"id"
        },
        "modNo":{
            "type":"integer",
            "description":"modification number"
        },
        "subAccountNo":{
            "type":"string",
            "description":"sub account Number",
            "minLength":0,
            "maxLength":80
        },
        "subAccountCcy":{
            "type":"string",
            "description":"sub account currency",
            "minLength":0,
            "maxLength":12
        },
        "primaryAccount":{
            "type":"boolean",
            "description":"denotes if account is primary"
        }
    },
    "required":[
        "subAccountNo",
        "subAccountCcy"
    ]
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top