Rest API for Oracle Banking Cash Management

Modify the counter party

put

/service/v1/noncustomer

This endpoint is used to modify the counter party and update with the given parameters any customer or counter party exists in the system.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId: string
branchCode: string

branchCode
userId: string

userId

Request Body that contains data required for creating a new counter party

Root Schema : ScfTmNonCustomerRequestDTO

Type: object

Show Source

autoApproval(optional): string

Auto Approval
data(optional): object ScfTmNonCustomerMasterDTO

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/ScfTmNonCustomerMasterDTO"
        },
        "autoApproval":{
            "type":"string",
            "description":"Auto Approval"
        }
    }
}

Nested Schema : ScfTmNonCustomerMasterDTO

Type: object

Match All

Show Source

allOf GenericDto
object ScfTmNonCustomerMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "category":{
                    "type":"string",
                    "description":"Category"
                },
                "cif":{
                    "type":"string",
                    "description":"Cif"
                },
                "countryCode":{
                    "type":"string",
                    "description":"Country Code"
                },
                "email":{
                    "type":"string",
                    "description":"Email"
                },
                "faxNumber":{
                    "type":"string",
                    "description":"Fax Number"
                },
                "giin":{
                    "type":"string",
                    "description":"Giin"
                },
                "industry":{
                    "type":"string",
                    "description":"Industry"
                },
                "mobileNumber":{
                    "type":"string",
                    "description":"Mobile Number"
                },
                "name":{
                    "type":"string",
                    "description":"Name"
                },
                "nonCustomerId":{
                    "type":"string",
                    "description":"Non Customer Id"
                },
                "phoneNumber":{
                    "type":"string",
                    "description":"Phone Number"
                },
                "prefferedCommMode":{
                    "type":"string",
                    "description":"Preffered Comm Mode"
                },
                "registrationNumber":{
                    "type":"string",
                    "description":"Registration Number"
                },
                "shortName":{
                    "type":"string",
                    "description":"Short Name"
                },
                "taxRefNo1":{
                    "type":"string",
                    "description":"Tax Reference Number1"
                },
                "taxRefNo2":{
                    "type":"string",
                    "description":"Tax Reference Number2"
                },
                "fatca":{
                    "type":"string",
                    "description":"Fatca"
                },
                "relationshipRefNo":{
                    "type":"string",
                    "description":"Relationship Reference Number"
                },
                "channel":{
                    "type":"string",
                    "description":"Channel"
                },
                "docMgmtSystemId":{
                    "type":"string",
                    "description":"Doc Management System Id"
                },
                "action":{
                    "type":"string",
                    "description":"Action"
                },
                "ScfTmNcAddressMasterDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ScfTmNcAddressMasterDTO"
                    }
                },
                "ScfTmNcRequestMasterDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ScfTmNcRequestMasterDTO"
                    }
                },
                "ScfDivisionDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ScfDivisionDetailsDTO"
                    }
                }
            }
        }
    ]
}

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

Type: object

Show Source

action(optional): string

Action
category(optional): string

Category
channel(optional): string

Channel
cif(optional): string

Cif
countryCode(optional): string

Country Code
docMgmtSystemId(optional): string

Doc Management System Id
email(optional): string

Email
fatca(optional): string

Fatca
faxNumber(optional): string

Fax Number
giin(optional): string

Giin
industry(optional): string

Industry
mobileNumber(optional): string

Mobile Number
name(optional): string

Name
nonCustomerId(optional): string

Non Customer Id
phoneNumber(optional): string

Phone Number
prefferedCommMode(optional): string

Preffered Comm Mode
registrationNumber(optional): string

Registration Number
relationshipRefNo(optional): string

Relationship Reference Number
ScfDivisionDetailsDTO(optional): array ScfDivisionDetailsDTO
ScfTmNcAddressMasterDTO(optional): array ScfTmNcAddressMasterDTO
ScfTmNcRequestMasterDTO(optional): array ScfTmNcRequestMasterDTO
shortName(optional): string

Short Name
taxRefNo1(optional): string

Tax Reference Number1
taxRefNo2(optional): string

Tax Reference Number2

{
    "type":"object",
    "properties":{
        "category":{
            "type":"string",
            "description":"Category"
        },
        "cif":{
            "type":"string",
            "description":"Cif"
        },
        "countryCode":{
            "type":"string",
            "description":"Country Code"
        },
        "email":{
            "type":"string",
            "description":"Email"
        },
        "faxNumber":{
            "type":"string",
            "description":"Fax Number"
        },
        "giin":{
            "type":"string",
            "description":"Giin"
        },
        "industry":{
            "type":"string",
            "description":"Industry"
        },
        "mobileNumber":{
            "type":"string",
            "description":"Mobile Number"
        },
        "name":{
            "type":"string",
            "description":"Name"
        },
        "nonCustomerId":{
            "type":"string",
            "description":"Non Customer Id"
        },
        "phoneNumber":{
            "type":"string",
            "description":"Phone Number"
        },
        "prefferedCommMode":{
            "type":"string",
            "description":"Preffered Comm Mode"
        },
        "registrationNumber":{
            "type":"string",
            "description":"Registration Number"
        },
        "shortName":{
            "type":"string",
            "description":"Short Name"
        },
        "taxRefNo1":{
            "type":"string",
            "description":"Tax Reference Number1"
        },
        "taxRefNo2":{
            "type":"string",
            "description":"Tax Reference Number2"
        },
        "fatca":{
            "type":"string",
            "description":"Fatca"
        },
        "relationshipRefNo":{
            "type":"string",
            "description":"Relationship Reference Number"
        },
        "channel":{
            "type":"string",
            "description":"Channel"
        },
        "docMgmtSystemId":{
            "type":"string",
            "description":"Doc Management System Id"
        },
        "action":{
            "type":"string",
            "description":"Action"
        },
        "ScfTmNcAddressMasterDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmNcAddressMasterDTO"
            }
        },
        "ScfTmNcRequestMasterDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmNcRequestMasterDTO"
            }
        },
        "ScfDivisionDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfDivisionDetailsDTO"
            }
        }
    }
}

Nested Schema : ScfDivisionDetailsDTO

Type: array

Show Source

Array of: object ScfDivisionDetailsDTO

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

Nested Schema : ScfTmNcAddressMasterDTO

Type: array

Show Source

Array of: object ScfTmNcAddressMasterDTO

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

Nested Schema : ScfTmNcRequestMasterDTO

Type: array

Show Source

Array of: object ScfTmNcRequestMasterDTO

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

Nested Schema : ScfDivisionDetailsDTO

Type: object

Show Source

buyerCode(optional): string

Buyer Code
buyerDivision(optional): string

Buyer Division
externalCode(optional): string

External Code
sellerCode(optional): string

Seller Code
sellerDivision(optional): string

Seller Division

{
    "type":"object",
    "properties":{
        "externalCode":{
            "type":"string",
            "description":"External Code"
        },
        "buyerCode":{
            "type":"string",
            "description":"Buyer Code"
        },
        "buyerDivision":{
            "type":"string",
            "description":"Buyer Division"
        },
        "sellerCode":{
            "type":"string",
            "description":"Seller Code"
        },
        "sellerDivision":{
            "type":"string",
            "description":"Seller Division"
        }
    }
}

Nested Schema : ScfTmNcAddressMasterDTO

Type: object

Show Source

addressLine1(optional): string

Address Line1
addressLine2(optional): string

Address Line2
addressLine3(optional): string

Address Line3
addressLine4(optional): string

Address Line4
addressType(optional): string

Address Type
country(optional): string

Country
countryName(optional): string

Country Name
id(optional): string

Id
nonCustMasterId(optional): string

Non Customer Master Id
nonCustomerId(optional): string

Non Customer Id
pin(optional): string

Pin
street(optional): string

Street

{
    "type":"object",
    "properties":{
        "addressLine1":{
            "type":"string",
            "description":"Address Line1"
        },
        "addressLine2":{
            "type":"string",
            "description":"Address Line2"
        },
        "addressLine3":{
            "type":"string",
            "description":"Address Line3"
        },
        "addressLine4":{
            "type":"string",
            "description":"Address Line4"
        },
        "addressType":{
            "type":"string",
            "description":"Address Type"
        },
        "country":{
            "type":"string",
            "description":"Country"
        },
        "countryName":{
            "type":"string",
            "description":"Country Name"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "nonCustMasterId":{
            "type":"string",
            "description":"Non Customer Master Id"
        },
        "pin":{
            "type":"string",
            "description":"Pin"
        },
        "street":{
            "type":"string",
            "description":"Street"
        },
        "nonCustomerId":{
            "type":"string",
            "description":"Non Customer Id"
        }
    }
}

Nested Schema : ScfTmNcRequestMasterDTO

Type: object

Show Source

anchorId: string

Anchor Id
anchorName(optional): string

Anchor Name
id(optional): string

Id
nonCustMasterId(optional): string

Non Customer Master Id
nonCustomerCode(optional): string

Non Customer Code
nonCustomerId(optional): string

Non Customer Id
status(optional): string

Status

{
    "type":"object",
    "properties":{
        "anchorId":{
            "type":"string",
            "description":"Anchor Id"
        },
        "anchorName":{
            "type":"string",
            "description":"Anchor Name"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "nonCustomerCode":{
            "type":"string",
            "description":"Non Customer Code"
        },
        "nonCustMasterId":{
            "type":"string",
            "description":"Non Customer Master Id"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "nonCustomerId":{
            "type":"string",
            "description":"Non Customer Id"
        }
    },
    "required":[
        "anchorId"
    ]
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

Root Schema : ResponseDtoWrapper

Type: object

Collection of ResponseDto and ResponseResourceSupport

Show Source

data(optional): object ResponseResourceSupport

Response DTO which extends RepresentationModel of Spring HATEOAS
messages(optional): object ResponseDto

ResponseDto stores the response status and code.

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

Nested Schema : ResponseResourceSupport

Type: object

Response DTO which extends RepresentationModel of Spring HATEOAS

Nested Schema : ResponseDto

Type: object

ResponseDto stores the response status and code.

Show Source

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

{
    "description":"ResponseDto stores the response status and code.",
    "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

ResponseCode stores the response details.

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

Nested Schema : ResponseCode

Type: object

ResponseCode stores the response details.

Show Source

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

{
    "description":"ResponseCode stores the response details.",
    "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