Jump to

• Request
• Response

Adds a new customer

post

/service/customer

This endpoint is used to adds a new customer.

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 customer

Root Schema : LmmTmCustomerDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmCustomerDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[0-9a-zA-Z]{1,20}"
                },
                "customerName":{
                    "type":"string",
                    "description":"",
                    "maxLength":105
                },
                "parentCustomerId":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "addressLine1":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "addressLine2":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "addressLine3":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "addressLine4":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "bankCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":4
                },
                "branchCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":4
                },
                "sourceSystem":{
                    "type":"string",
                    "description":"",
                    "maxLength":35
                },
                "sourceSystemCustNo":{
                    "type":"string",
                    "description":"",
                    "maxLength":50
                },
                "closedStat":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "closedDtStamp":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "isForgotten":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "isProspect":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "chargePricingScheme":{
                    "type":"string",
                    "description":"The pricing scheme to be mapped to the customer being on boarded",
                    "maxLength":50
                },
                "chargeAccountNo":{
                    "type":"string",
                    "description":"The charge funding account from where the charges needs to be collected",
                    "maxLength":35
                },
                "chargeAccountBrn":{
                    "type":"string",
                    "description":"The charge funding account branch code from where the charges needs to be collected",
                    "maxLength":3
                },
                "chargeCustAccCcy":{
                    "type":"string",
                    "description":"The charge funding account branch currency from where the charges needs to be collected",
                    "maxLength":3
                },
                "chargeBranchCode":{
                    "type":"string",
                    "description":"The Branch code to be used for charge posting",
                    "maxLength":3
                },
                "isAutoAuth":{
                    "type":"string",
                    "description":"Y for autoauth. Used for LM Consumer",
                    "maxLength":1
                }
            },
            "required":[
                "customerId",
                "customerName"
            ]
        }
    ]
}

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

Type: object

Show Source

• addressLine1(optional): string
  Maximum Length: 100
• addressLine2(optional): string
  Maximum Length: 100
• addressLine3(optional): string
  Maximum Length: 100
• addressLine4(optional): string
  Maximum Length: 100
• bankCode(optional): string
  Maximum Length: 4
• branchCode(optional): string
  Maximum Length: 4
• chargeAccountBrn(optional): string
  Maximum Length: 3

  The charge funding account branch code from where the charges needs to be collected
• chargeAccountNo(optional): string
  Maximum Length: 35

  The charge funding account from where the charges needs to be collected
• chargeBranchCode(optional): string
  Maximum Length: 3

  The Branch code to be used for charge posting
• chargeCustAccCcy(optional): string
  Maximum Length: 3

  The charge funding account branch currency from where the charges needs to be collected
• chargePricingScheme(optional): string
  Maximum Length: 50

  The pricing scheme to be mapped to the customer being on boarded
• closedDtStamp(optional): string(date)
• closedStat(optional): string
  Maximum Length: 1
• customerId: string
  Pattern: [0-9a-zA-Z]{1,20}
• customerName: string
  Maximum Length: 105
• isAutoAuth(optional): string
  Maximum Length: 1

  Y for autoauth. Used for LM Consumer
• isForgotten(optional): string
  Maximum Length: 1
• isProspect(optional): string
  Maximum Length: 1
• parentCustomerId(optional): string
  Maximum Length: 20
• sourceSystem(optional): string
  Maximum Length: 35
• sourceSystemCustNo(optional): string
  Maximum Length: 50

{
    "type":"object",
    "properties":{
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[0-9a-zA-Z]{1,20}"
        },
        "customerName":{
            "type":"string",
            "description":"",
            "maxLength":105
        },
        "parentCustomerId":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "addressLine1":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "addressLine2":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "addressLine3":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "addressLine4":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "bankCode":{
            "type":"string",
            "description":"",
            "maxLength":4
        },
        "branchCode":{
            "type":"string",
            "description":"",
            "maxLength":4
        },
        "sourceSystem":{
            "type":"string",
            "description":"",
            "maxLength":35
        },
        "sourceSystemCustNo":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "closedStat":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "closedDtStamp":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "isForgotten":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "isProspect":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "chargePricingScheme":{
            "type":"string",
            "description":"The pricing scheme to be mapped to the customer being on boarded",
            "maxLength":50
        },
        "chargeAccountNo":{
            "type":"string",
            "description":"The charge funding account from where the charges needs to be collected",
            "maxLength":35
        },
        "chargeAccountBrn":{
            "type":"string",
            "description":"The charge funding account branch code from where the charges needs to be collected",
            "maxLength":3
        },
        "chargeCustAccCcy":{
            "type":"string",
            "description":"The charge funding account branch currency from where the charges needs to be collected",
            "maxLength":3
        },
        "chargeBranchCode":{
            "type":"string",
            "description":"The Branch code to be used for charge posting",
            "maxLength":3
        },
        "isAutoAuth":{
            "type":"string",
            "description":"Y for autoauth. Used for LM Consumer",
            "maxLength":1
        }
    },
    "required":[
        "customerId",
        "customerName"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string
  URL of newly created customer

Body ()

Root Schema : CustomerServiceDtoWrapper

Type: object

Show Source

• data(optional): object LmmTmCustomerDTO
• messages(optional): object ResponseDto

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

Nested Schema : LmmTmCustomerDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmCustomerDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[0-9a-zA-Z]{1,20}"
                },
                "customerName":{
                    "type":"string",
                    "description":"",
                    "maxLength":105
                },
                "parentCustomerId":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "addressLine1":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "addressLine2":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "addressLine3":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "addressLine4":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "bankCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":4
                },
                "branchCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":4
                },
                "sourceSystem":{
                    "type":"string",
                    "description":"",
                    "maxLength":35
                },
                "sourceSystemCustNo":{
                    "type":"string",
                    "description":"",
                    "maxLength":50
                },
                "closedStat":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "closedDtStamp":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "isForgotten":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "isProspect":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "chargePricingScheme":{
                    "type":"string",
                    "description":"The pricing scheme to be mapped to the customer being on boarded",
                    "maxLength":50
                },
                "chargeAccountNo":{
                    "type":"string",
                    "description":"The charge funding account from where the charges needs to be collected",
                    "maxLength":35
                },
                "chargeAccountBrn":{
                    "type":"string",
                    "description":"The charge funding account branch code from where the charges needs to be collected",
                    "maxLength":3
                },
                "chargeCustAccCcy":{
                    "type":"string",
                    "description":"The charge funding account branch currency from where the charges needs to be collected",
                    "maxLength":3
                },
                "chargeBranchCode":{
                    "type":"string",
                    "description":"The Branch code to be used for charge posting",
                    "maxLength":3
                },
                "isAutoAuth":{
                    "type":"string",
                    "description":"Y for autoauth. Used for LM Consumer",
                    "maxLength":1
                }
            },
            "required":[
                "customerId",
                "customerName"
            ]
        }
    ]
}

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

Type: object

Show Source

• addressLine1(optional): string
  Maximum Length: 100
• addressLine2(optional): string
  Maximum Length: 100
• addressLine3(optional): string
  Maximum Length: 100
• addressLine4(optional): string
  Maximum Length: 100
• bankCode(optional): string
  Maximum Length: 4
• branchCode(optional): string
  Maximum Length: 4
• chargeAccountBrn(optional): string
  Maximum Length: 3

  The charge funding account branch code from where the charges needs to be collected
• chargeAccountNo(optional): string
  Maximum Length: 35

  The charge funding account from where the charges needs to be collected
• chargeBranchCode(optional): string
  Maximum Length: 3

  The Branch code to be used for charge posting
• chargeCustAccCcy(optional): string
  Maximum Length: 3

  The charge funding account branch currency from where the charges needs to be collected
• chargePricingScheme(optional): string
  Maximum Length: 50

  The pricing scheme to be mapped to the customer being on boarded
• closedDtStamp(optional): string(date)
• closedStat(optional): string
  Maximum Length: 1
• customerId: string
  Pattern: [0-9a-zA-Z]{1,20}
• customerName: string
  Maximum Length: 105
• isAutoAuth(optional): string
  Maximum Length: 1

  Y for autoauth. Used for LM Consumer
• isForgotten(optional): string
  Maximum Length: 1
• isProspect(optional): string
  Maximum Length: 1
• parentCustomerId(optional): string
  Maximum Length: 20
• sourceSystem(optional): string
  Maximum Length: 35
• sourceSystemCustNo(optional): string
  Maximum Length: 50

{
    "type":"object",
    "properties":{
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[0-9a-zA-Z]{1,20}"
        },
        "customerName":{
            "type":"string",
            "description":"",
            "maxLength":105
        },
        "parentCustomerId":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "addressLine1":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "addressLine2":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "addressLine3":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "addressLine4":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "bankCode":{
            "type":"string",
            "description":"",
            "maxLength":4
        },
        "branchCode":{
            "type":"string",
            "description":"",
            "maxLength":4
        },
        "sourceSystem":{
            "type":"string",
            "description":"",
            "maxLength":35
        },
        "sourceSystemCustNo":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "closedStat":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "closedDtStamp":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "isForgotten":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "isProspect":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "chargePricingScheme":{
            "type":"string",
            "description":"The pricing scheme to be mapped to the customer being on boarded",
            "maxLength":50
        },
        "chargeAccountNo":{
            "type":"string",
            "description":"The charge funding account from where the charges needs to be collected",
            "maxLength":35
        },
        "chargeAccountBrn":{
            "type":"string",
            "description":"The charge funding account branch code from where the charges needs to be collected",
            "maxLength":3
        },
        "chargeCustAccCcy":{
            "type":"string",
            "description":"The charge funding account branch currency from where the charges needs to be collected",
            "maxLength":3
        },
        "chargeBranchCode":{
            "type":"string",
            "description":"The Branch code to be used for charge posting",
            "maxLength":3
        },
        "isAutoAuth":{
            "type":"string",
            "description":"Y for autoauth. Used for LM Consumer",
            "maxLength":1
        }
    },
    "required":[
        "customerId",
        "customerName"
    ]
}

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