Rest API for Oracle Banking Liquidity Management

Adds a new customer

post

/service/icl/customer

This endpoint is used to add a new customer.

Request

Supported Media Types

application/json
application/xml

Request Body that contains data required for creating a new customer

Root Schema : IclTmCustomerDTO

Type: object

Match All

Show Source

allOf GenericDto
object IclTmCustomerDTO-allOf[1]


{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "borrowCurrency":{
                    "type":"string",
                    "description":"",
                    "maxLength":3
                },
                "borrowLimit":{
                    "type":"number",
                    "description":"",
                    "maxLength":23
                },
                "borrowLimitUtilized":{
                    "type":"number",
                    "description":"",
                    "maxLength":23
                },
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "customerName":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "lendCurrency":{
                    "type":"string",
                    "description":"",
                    "maxLength":3
                },
                "lendLimit":{
                    "type":"number",
                    "description":"",
                    "minimum":0,
                    "maxLength":23
                },
                "lendLimitUtilized":{
                    "type":"number",
                    "description":"",
                    "maxLength":23
                },
                "parentCustomerId":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "parentCustomerName":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "sourceSystem":{
                    "type":"string",
                    "description":"",
                    "maxLength":35
                },
                "IclTmLendCustomerDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/IclTmLendCustomerDTO"
                    }
                },
                "IclTmBorrowCustomerDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/IclTmBorrowCustomerDTO"
                    }
                }
            }
        }
    ]
}

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

Type: object

Show Source

borrowCurrency(optional): string

Maximum Length: 3
borrowLimit(optional): number

Maximum Length: 23
borrowLimitUtilized(optional): number

Maximum Length: 23
customerId(optional): string

Pattern: [a-zA-Z0-9]{1,20}
customerName(optional): string

Maximum Length: 100
IclTmBorrowCustomerDTO(optional): array IclTmBorrowCustomerDTO
IclTmLendCustomerDTO(optional): array IclTmLendCustomerDTO
lendCurrency(optional): string

Maximum Length: 3
lendLimit(optional): number

Minimum Value: 0

Maximum Length: 23
lendLimitUtilized(optional): number

Maximum Length: 23
parentCustomerId(optional): string

Maximum Length: 20
parentCustomerName(optional): string

Maximum Length: 100
sourceSystem(optional): string

Maximum Length: 35


{
    "type":"object",
    "properties":{
        "borrowCurrency":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "borrowLimit":{
            "type":"number",
            "description":"",
            "maxLength":23
        },
        "borrowLimitUtilized":{
            "type":"number",
            "description":"",
            "maxLength":23
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "customerName":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "lendCurrency":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "lendLimit":{
            "type":"number",
            "description":"",
            "minimum":0,
            "maxLength":23
        },
        "lendLimitUtilized":{
            "type":"number",
            "description":"",
            "maxLength":23
        },
        "parentCustomerId":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "parentCustomerName":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "sourceSystem":{
            "type":"string",
            "description":"",
            "maxLength":35
        },
        "IclTmLendCustomerDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IclTmLendCustomerDTO"
            }
        },
        "IclTmBorrowCustomerDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IclTmBorrowCustomerDTO"
            }
        }
    }
}

Nested Schema : IclTmBorrowCustomerDTO

Type: array

Show Source

Array of: object IclTmBorrowCustomerDTO


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

Nested Schema : IclTmLendCustomerDTO

Type: array

Show Source

Array of: object IclTmLendCustomerDTO


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

Nested Schema : IclTmBorrowCustomerDTO

Type: object

Show Source

borrowerId(optional): string

Maximum Length: 20
borrowerName(optional): string

Maximum Length: 100
borrowLimit(optional): number

Maximum Length: 23
borrowLimitUtilized(optional): number

Maximum Length: 23
customerId(optional): string

Pattern: [a-zA-Z0-9]{1,20}
id(optional): string

Maximum Length: 36


{
    "type":"object",
    "properties":{
        "borrowerId":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "borrowerName":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "borrowLimit":{
            "type":"number",
            "description":"",
            "maxLength":23
        },
        "borrowLimitUtilized":{
            "type":"number",
            "description":"",
            "maxLength":23
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        }
    }
}

Nested Schema : IclTmLendCustomerDTO

Type: object

Show Source

customerId(optional): string

Pattern: [a-zA-Z0-9]{1,20}
id(optional): string

Maximum Length: 36
lenderId(optional): string

Maximum Length: 20
lenderName(optional): string

Maximum Length: 100
lendLimit(optional): number

Minimum Value: 0

Maximum Length: 23
lendLimitUtilized(optional): number

Maximum Length: 23


{
    "type":"object",
    "properties":{
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "lenderId":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "lenderName":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "lendLimit":{
            "type":"number",
            "description":"",
            "minimum":0,
            "maxLength":23
        },
        "lendLimitUtilized":{
            "type":"number",
            "description":"",
            "maxLength":23
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

URL of newly created customer

Root Schema : ResponseDtoWrapper

Type: object

Show Source

data(optional): object ResponseResourceSupport
messages(optional): object ResponseDto


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

Nested Schema : ResponseResourceSupport

Type: object

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

Oracle Account

Oracle Account

Sign in to Cloud

Rest API for Oracle Banking Liquidity Management

Adds a new customer

Request

Response

201 Response

400 Response

401 Response

403 Response

405 Response

500 Response