Previous Next JavaScript must be enabled to correctly display this content

## Adds a new country code

post

/service/countrycodes

This endpoint is used to add a new country code.

### Request

Supported Media Types

- application/json
- application/xml

Header Parameters

- sourceCode: string
  Source from which request is initiated

Body ()
Request Body that contains data required for creating a new countrycodes
Root Schema : CmcTmCountryDto
Type: `object`
Match All
Show Source

- allOf GenericDto
- object CmcTmCountryDto-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "countryCode":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3,
                        "pattern":"^[A-Z0-9]*$"
                    },
                    "description":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":105
                    },
                    "altCountryCode":{
                        "type":"string",
                        "minLength":2,
                        "maxLength":10,
                        "pattern":"^[A-Z]*$"
                    },
                    "regionCode":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3
                    },
                    "blacklisted":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1,
                        "pattern":"^(?:Y|N)$"
                    },
                    "ibanCheckReqd":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1,
                        "pattern":"^(?:Y|N)$"
                    },
                    "intraEuropean":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1,
                        "pattern":"^(?:Y|N)$"
                    },
                    "clrCodeBic":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1,
                        "pattern":"^(?:Y|N)$"
                    },
                    "clearingNetwork":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1
                    },
                    "isoNumCountryCode":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3
                    },
                    "genMt205":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1,
                        "pattern":"^(?:Y|N)$"
                    },
                    "isdCode":{
                        "type":"number",
                        "minLength":0,
                        "maxLength":10
                    },
                    "euCountry":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1
                    }
                },
                "required":[
                    "countryCode",
                    "description",
                    "ibanCheckReqd"
                ]
            }
        ]
    }

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 : CmcTmCountryDto-allOf[1]
Type: `object`
Show Source

- altCountryCode(optional): string
  Minimum Length: `2`
  Maximum Length: `10`
  Pattern: `^[A-Z]*$`
- blacklisted(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
  Pattern: `^(?:Y|N)$`
- clearingNetwork(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
- clrCodeBic(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
  Pattern: `^(?:Y|N)$`
- countryCode: string
  Minimum Length: `0`
  Maximum Length: `3`
  Pattern: `^[A-Z0-9]*$`
- description: string
  Minimum Length: `0`
  Maximum Length: `105`
- euCountry(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
- genMt205(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
  Pattern: `^(?:Y|N)$`
- ibanCheckReqd: string
  Minimum Length: `0`
  Maximum Length: `1`
  Pattern: `^(?:Y|N)$`
- intraEuropean(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
  Pattern: `^(?:Y|N)$`
- isdCode(optional): number
  Minimum Length: `0`
  Maximum Length: `10`
- isoNumCountryCode(optional): string
  Minimum Length: `0`
  Maximum Length: `3`
- regionCode(optional): string
  Minimum Length: `0`
  Maximum Length: `3`

    {
        "type":"object",
        "properties":{
            "countryCode":{
                "type":"string",
                "minLength":0,
                "maxLength":3,
                "pattern":"^[A-Z0-9]*$"
            },
            "description":{
                "type":"string",
                "minLength":0,
                "maxLength":105
            },
            "altCountryCode":{
                "type":"string",
                "minLength":2,
                "maxLength":10,
                "pattern":"^[A-Z]*$"
            },
            "regionCode":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "blacklisted":{
                "type":"string",
                "minLength":0,
                "maxLength":1,
                "pattern":"^(?:Y|N)$"
            },
            "ibanCheckReqd":{
                "type":"string",
                "minLength":0,
                "maxLength":1,
                "pattern":"^(?:Y|N)$"
            },
            "intraEuropean":{
                "type":"string",
                "minLength":0,
                "maxLength":1,
                "pattern":"^(?:Y|N)$"
            },
            "clrCodeBic":{
                "type":"string",
                "minLength":0,
                "maxLength":1,
                "pattern":"^(?:Y|N)$"
            },
            "clearingNetwork":{
                "type":"string",
                "minLength":0,
                "maxLength":1
            },
            "isoNumCountryCode":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "genMt205":{
                "type":"string",
                "minLength":0,
                "maxLength":1,
                "pattern":"^(?:Y|N)$"
            },
            "isdCode":{
                "type":"number",
                "minLength":0,
                "maxLength":10
            },
            "euCountry":{
                "type":"string",
                "minLength":0,
                "maxLength":1
            }
        },
        "required":[
            "countryCode",
            "description",
            "ibanCheckReqd"
        ]
    }

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 201 Response

Returns message of succes or failure
Headers

- Location: string
  URL of newly created countrycodes

Body ()
Root Schema : CmcTmCountryResponseDtoWrapper
Type: `object`
Show Source

- data(optional): object CmcTmCountryDto
- messages(optional): object ResponseDto

    {
        "type":"object",
        "properties":{
            "messages":{
                "$ref":"#/definitions/ResponseDto"
            },
            "data":{
                "$ref":"#/definitions/CmcTmCountryDto"
            }
        }
    }

Nested Schema : CmcTmCountryDto
Type: `object`
Match All
Show Source

- allOf GenericDto
- object CmcTmCountryDto-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "countryCode":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3,
                        "pattern":"^[A-Z0-9]*$"
                    },
                    "description":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":105
                    },
                    "altCountryCode":{
                        "type":"string",
                        "minLength":2,
                        "maxLength":10,
                        "pattern":"^[A-Z]*$"
                    },
                    "regionCode":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3
                    },
                    "blacklisted":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1,
                        "pattern":"^(?:Y|N)$"
                    },
                    "ibanCheckReqd":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1,
                        "pattern":"^(?:Y|N)$"
                    },
                    "intraEuropean":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1,
                        "pattern":"^(?:Y|N)$"
                    },
                    "clrCodeBic":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1,
                        "pattern":"^(?:Y|N)$"
                    },
                    "clearingNetwork":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1
                    },
                    "isoNumCountryCode":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3
                    },
                    "genMt205":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1,
                        "pattern":"^(?:Y|N)$"
                    },
                    "isdCode":{
                        "type":"number",
                        "minLength":0,
                        "maxLength":10
                    },
                    "euCountry":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1
                    }
                },
                "required":[
                    "countryCode",
                    "description",
                    "ibanCheckReqd"
                ]
            }
        ]
    }

Nested Schema : ResponseDto
Type: `object`
Show Source

- codes(optional): array codes
- id(optional): string
- requestId(optional): string
- status(optional): string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string"
            },
            "status":{
                "type":"string"
            },
            "codes":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ResponseCode"
                }
            },
            "requestId":{
                "type":"string"
            }
        }
    }

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 : CmcTmCountryDto-allOf[1]
Type: `object`
Show Source

- altCountryCode(optional): string
  Minimum Length: `2`
  Maximum Length: `10`
  Pattern: `^[A-Z]*$`
- blacklisted(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
  Pattern: `^(?:Y|N)$`
- clearingNetwork(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
- clrCodeBic(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
  Pattern: `^(?:Y|N)$`
- countryCode: string
  Minimum Length: `0`
  Maximum Length: `3`
  Pattern: `^[A-Z0-9]*$`
- description: string
  Minimum Length: `0`
  Maximum Length: `105`
- euCountry(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
- genMt205(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
  Pattern: `^(?:Y|N)$`
- ibanCheckReqd: string
  Minimum Length: `0`
  Maximum Length: `1`
  Pattern: `^(?:Y|N)$`
- intraEuropean(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
  Pattern: `^(?:Y|N)$`
- isdCode(optional): number
  Minimum Length: `0`
  Maximum Length: `10`
- isoNumCountryCode(optional): string
  Minimum Length: `0`
  Maximum Length: `3`
- regionCode(optional): string
  Minimum Length: `0`
  Maximum Length: `3`

    {
        "type":"object",
        "properties":{
            "countryCode":{
                "type":"string",
                "minLength":0,
                "maxLength":3,
                "pattern":"^[A-Z0-9]*$"
            },
            "description":{
                "type":"string",
                "minLength":0,
                "maxLength":105
            },
            "altCountryCode":{
                "type":"string",
                "minLength":2,
                "maxLength":10,
                "pattern":"^[A-Z]*$"
            },
            "regionCode":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "blacklisted":{
                "type":"string",
                "minLength":0,
                "maxLength":1,
                "pattern":"^(?:Y|N)$"
            },
            "ibanCheckReqd":{
                "type":"string",
                "minLength":0,
                "maxLength":1,
                "pattern":"^(?:Y|N)$"
            },
            "intraEuropean":{
                "type":"string",
                "minLength":0,
                "maxLength":1,
                "pattern":"^(?:Y|N)$"
            },
            "clrCodeBic":{
                "type":"string",
                "minLength":0,
                "maxLength":1,
                "pattern":"^(?:Y|N)$"
            },
            "clearingNetwork":{
                "type":"string",
                "minLength":0,
                "maxLength":1
            },
            "isoNumCountryCode":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "genMt205":{
                "type":"string",
                "minLength":0,
                "maxLength":1,
                "pattern":"^(?:Y|N)$"
            },
            "isdCode":{
                "type":"number",
                "minLength":0,
                "maxLength":10
            },
            "euCountry":{
                "type":"string",
                "minLength":0,
                "maxLength":1
            }
        },
        "required":[
            "countryCode",
            "description",
            "ibanCheckReqd"
        ]
    }

Nested Schema : codes
Type: `array`
Show Source

- Array of: object ResponseCode

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

Nested Schema : ResponseCode
Type: `object`
Show Source

- arg(optional): string
- args(optional): array args
- Code(optional): string
- Desc(optional): string
- Language(optional): string
- Type(optional): string

    {
        "type":"object",
        "properties":{
            "Code":{
                "type":"string"
            },
            "Desc":{
                "type":"string"
            },
            "Type":{
                "type":"string"
            },
            "Language":{
                "type":"string"
            },
            "args":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            },
            "arg":{
                "type":"string"
            }
        }
    }

Nested Schema : args
Type: `array`
Show Source

- Array of: object items

    {
        "type":"array",
        "items":{
            "type":"object"
        }
    }

Nested Schema : items
Type: `object`

#### 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