Rest API for Oracle Banking Liquidity Management Cloud Service

Update an existing paymentInterfaceService.

put

/service/paymentinterface/{id}

This endpoint is used to update an existing payment interface service.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id(required): string

key of the paymentInterfaceService Maintenance

Header Parameters

sourceCode(required): string

Source from which request is initiated

Request Body that contains data required for updating an existing paymentinterface

Root Schema : LmxTmInterfaceMasterDTO

Type: object

Match All

Show Source

allOf GenericDto
object LmxTmInterfaceMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "externalSystemDetailsId":{
                    "type":"string",
                    "description":"",
                    "maxLength":"36"
                },
                "externalSystemId":{
                    "type":"string",
                    "description":"",
                    "maxLength":"5"
                },
                "serviceName":{
                    "type":"string",
                    "description":"",
                    "maxLength":"50"
                },
                "templateName":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9\\s]{1,50}"
                },
                "LmxTmInterfaceDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmxTmInterfaceDetailsDTO"
                    }
                },
                "LmxTmInterfaceServiceDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmxTmInterfaceServiceDetailsDTO"
                    }
                },
                "LmxTmInterfaceEventDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmxTmInterfaceEventDetailsDTO"
                    }
                }
            },
            "required":[
                "externalSystemDetailsId"
            ]
        }
    ]
}

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

Type: object

Show Source

externalSystemDetailsId(required): string

Maximum Length: 36
externalSystemId: string

Maximum Length: 5
LmxTmInterfaceDetailsDTO: array LmxTmInterfaceDetailsDTO
LmxTmInterfaceEventDetailsDTO: array LmxTmInterfaceEventDetailsDTO
LmxTmInterfaceServiceDetailsDTO: array LmxTmInterfaceServiceDetailsDTO
serviceName: string

Maximum Length: 50
templateName: string

Pattern: [a-zA-Z0-9\s]{1,50}

{
    "type":"object",
    "properties":{
        "externalSystemDetailsId":{
            "type":"string",
            "description":"",
            "maxLength":"36"
        },
        "externalSystemId":{
            "type":"string",
            "description":"",
            "maxLength":"5"
        },
        "serviceName":{
            "type":"string",
            "description":"",
            "maxLength":"50"
        },
        "templateName":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9\\s]{1,50}"
        },
        "LmxTmInterfaceDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmxTmInterfaceDetailsDTO"
            }
        },
        "LmxTmInterfaceServiceDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmxTmInterfaceServiceDetailsDTO"
            }
        },
        "LmxTmInterfaceEventDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmxTmInterfaceEventDetailsDTO"
            }
        }
    },
    "required":[
        "externalSystemDetailsId"
    ]
}

Nested Schema : LmxTmInterfaceDetailsDTO

Type: array

Show Source

Array of: object LmxTmInterfaceDetailsDTO

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

Nested Schema : LmxTmInterfaceEventDetailsDTO

Type: array

Show Source

Array of: object LmxTmInterfaceEventDetailsDTO

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

Nested Schema : LmxTmInterfaceServiceDetailsDTO

Type: array

Show Source

Array of: object LmxTmInterfaceServiceDetailsDTO

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

Nested Schema : LmxTmInterfaceDetailsDTO

Type: object

Show Source

id: string

Maximum Length: 36
interfaceMasterId: string

Maximum Length: 36
parameterName: string

Maximum Length: 50
parameterValue: string

Maximum Length: 100

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"",
            "maxLength":"36"
        },
        "interfaceMasterId":{
            "type":"string",
            "description":"",
            "maxLength":"36"
        },
        "parameterName":{
            "type":"string",
            "description":"",
            "maxLength":"50"
        },
        "parameterValue":{
            "type":"string",
            "description":"",
            "maxLength":"100"
        }
    }
}

Nested Schema : LmxTmInterfaceEventDetailsDTO

Type: object

Show Source

eventCode: string

Maximum Length: 20
eventDescription: string

Maximum Length: 50
id: string

Maximum Length: 36
interfaceMasterId: string

Maximum Length: 36

{
    "type":"object",
    "properties":{
        "eventCode":{
            "type":"string",
            "description":"",
            "maxLength":"20"
        },
        "eventDescription":{
            "type":"string",
            "description":"",
            "maxLength":"50"
        },
        "id":{
            "type":"string",
            "description":"",
            "maxLength":"36"
        },
        "interfaceMasterId":{
            "type":"string",
            "description":"",
            "maxLength":"36"
        }
    }
}

Nested Schema : LmxTmInterfaceServiceDetailsDTO

Type: object

Show Source

id: string
interfaceMasterId: string
parameterName: string
parameterValue: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "interfaceMasterId":{
            "type":"string",
            "description":""
        },
        "parameterName":{
            "type":"string",
            "description":""
        },
        "parameterValue":{
            "type":"string",
            "description":""
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Returns updated paymentinterface

Root Schema : ResponseDtoWrapper

Type: object

Show Source

data: object ResponseResourceSupport
messages: 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: array codes
id: string
requestId: string
status: 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: string
args: array args
Code: string
Desc: string
Language: string
Type: 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