Rest API for Oracle Banking Cash Management

Fetch the courier setup maintained

get

/service/v1/courier-setup

This API fetches courier setup maintained based on given parameters

Request

Supported Media Types

application/json
application/xml

Query Parameters

authStatus: string

authStatus need to be set to fetch summary record
courierCode: string

courierCode need to be set to fetch summary record
courierDesc: string

courierDesc need to be set to fetch summary record
includecloseandunauth: boolean

includecloseandunauth need to be set to fetch summary record, defult value is false
limit: integer

limit is maximum no of records to be fetched
offset: integer

offset is starting no of records to be fetched
recordStatus: string

recordStatus need to be set to fetch summary record

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

Location

Root Schema : ObcmTmCourierSetupMasterCollection

Type: object

Collection of couriersetup.

Show Source

data: array data

Data

{
    "description":"Collection of couriersetup.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "description":"Data",
            "items":{
                "$ref":"#/definitions/ObcmTmCourierSetupMasterDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Data

Show Source

Array of: object ObcmTmCourierSetupMasterDTO

Courier Setup Master

{
    "type":"array",
    "description":"Data",
    "items":{
        "$ref":"#/definitions/ObcmTmCourierSetupMasterDTO"
    }
}

Nested Schema : ObcmTmCourierSetupMasterDTO

Type: object

Courier Setup Master

Match All

Show Source

allOf GenericDto
object ObcmTmCourierSetupMasterDTO-allOf[1]

{
    "type":"object",
    "description":"Courier Setup Master",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "addrLn1":{
                    "type":"string",
                    "description":"Address Line 1"
                },
                "addrLn2":{
                    "type":"string",
                    "description":"Address Line 2"
                },
                "addrLn3":{
                    "type":"string",
                    "description":"Address Line 3"
                },
                "addrLn4":{
                    "type":"string",
                    "description":"Address Line 4"
                },
                "contactPerson":{
                    "type":"string",
                    "description":"Contact Person"
                },
                "contractEndDt":{
                    "type":"string",
                    "description":"Contract End Date"
                },
                "contractStrtDt":{
                    "type":"string",
                    "description":"Contract Start Date"
                },
                "countryCode":{
                    "type":"string",
                    "description":"Country Code"
                },
                "countryName":{
                    "type":"string",
                    "description":"Country Name"
                },
                "courierCode":{
                    "type":"string",
                    "description":"Courier Code"
                },
                "courierDesc":{
                    "type":"string",
                    "description":"Courier Description"
                },
                "designation":{
                    "type":"string",
                    "description":"Designation"
                },
                "email":{
                    "type":"string",
                    "description":"Email"
                },
                "fax":{
                    "type":"string",
                    "description":"Fax"
                },
                "landLnNo":{
                    "type":"string",
                    "description":"Land Line No"
                },
                "mobile":{
                    "type":"string",
                    "description":"Mobile"
                },
                "zipCode":{
                    "type":"string",
                    "description":"Zip Code"
                },
                "txnControllerRefNo":{
                    "type":"string",
                    "description":"txnControllerRefNo"
                }
            }
        }
    ]
}

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

Type: object

Show Source

addrLn1: string

Address Line 1
addrLn2: string

Address Line 2
addrLn3: string

Address Line 3
addrLn4: string

Address Line 4
contactPerson: string

Contact Person
contractEndDt: string

Contract End Date
contractStrtDt: string

Contract Start Date
countryCode: string

Country Code
countryName: string

Country Name
courierCode: string

Courier Code
courierDesc: string

Courier Description
designation: string

Designation
email: string

Email
fax: string

Fax
landLnNo: string

Land Line No
mobile: string

Mobile
txnControllerRefNo: string

txnControllerRefNo
zipCode: string

Zip Code

{
    "type":"object",
    "properties":{
        "addrLn1":{
            "type":"string",
            "description":"Address Line 1"
        },
        "addrLn2":{
            "type":"string",
            "description":"Address Line 2"
        },
        "addrLn3":{
            "type":"string",
            "description":"Address Line 3"
        },
        "addrLn4":{
            "type":"string",
            "description":"Address Line 4"
        },
        "contactPerson":{
            "type":"string",
            "description":"Contact Person"
        },
        "contractEndDt":{
            "type":"string",
            "description":"Contract End Date"
        },
        "contractStrtDt":{
            "type":"string",
            "description":"Contract Start Date"
        },
        "countryCode":{
            "type":"string",
            "description":"Country Code"
        },
        "countryName":{
            "type":"string",
            "description":"Country Name"
        },
        "courierCode":{
            "type":"string",
            "description":"Courier Code"
        },
        "courierDesc":{
            "type":"string",
            "description":"Courier Description"
        },
        "designation":{
            "type":"string",
            "description":"Designation"
        },
        "email":{
            "type":"string",
            "description":"Email"
        },
        "fax":{
            "type":"string",
            "description":"Fax"
        },
        "landLnNo":{
            "type":"string",
            "description":"Land Line No"
        },
        "mobile":{
            "type":"string",
            "description":"Mobile"
        },
        "zipCode":{
            "type":"string",
            "description":"Zip Code"
        },
        "txnControllerRefNo":{
            "type":"string",
            "description":"txnControllerRefNo"
        }
    }
}

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