Rest API for Oracle Banking Liquidity Management

Get all valid default payment instruction

get

/defaultPaymentInstruction

This endpoint is used to get all valid default payment instruction maintenance records.

Request

Supported Media Types

application/json
application/xml

Query Parameters

authStat(optional): string
customerId(optional): string

exact customerId records to be fetched
description(optional): string

exact description records to be fetched
hostCode(optional): string

exact hostCode records to be fetched
includecloseandunauth(optional): boolean

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

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

offset is starting no of records to be fetched
recordStat(optional): string

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of success or failure

Headers

Location: string

Root Schema : LmmTmDefaultPaymentInstructionCollection

Type: object

Collection of payment instructions.

Show Source

data(optional): array data
paging(optional): object PagingDto

{
    "description":"Collection of payment instructions.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmDefaultPaymentInstructionDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object LmmTmDefaultPaymentInstructionDTO

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : LmmTmDefaultPaymentInstructionDTO

Type: object

Match All

Show Source

allOf GenericDto
object LmmTmDefaultPaymentInstructionDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "hostCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "description":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "customerName":{
                    "type":"string",
                    "description":"",
                    "maxLength":105
                },
                "LmmTmDefaultPaymentInstructionTemplateDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmmTmDefaultPaymentInstructionTemplateDTO"
                    }
                }
            }
        }
    ]
}

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

Type: object

Show Source

customerId(optional): string

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

Maximum Length: 105
description(optional): string

Maximum Length: 100
hostCode(optional): string

Maximum Length: 36
LmmTmDefaultPaymentInstructionTemplateDTO(optional): array LmmTmDefaultPaymentInstructionTemplateDTO

{
    "type":"object",
    "properties":{
        "hostCode":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "description":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "customerName":{
            "type":"string",
            "description":"",
            "maxLength":105
        },
        "LmmTmDefaultPaymentInstructionTemplateDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmDefaultPaymentInstructionTemplateDTO"
            }
        }
    }
}

Nested Schema : LmmTmDefaultPaymentInstructionTemplateDTO

Type: array

Show Source

Array of: object LmmTmDefaultPaymentInstructionTemplateDTO

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

Nested Schema : LmmTmDefaultPaymentInstructionTemplateDTO

Type: object

Show Source

ddaEntity(optional): string

Maximum Length: 36
ddaFromToAccount(optional): string

Maximum Length: 36
defaultPaymentInstructionId(optional): string

Maximum Length: 36
id(optional): string

Maximum Length: 36
templateName(optional): string

Maximum Length: 50
transferType(optional): string

Maximum Length: 36

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "defaultPaymentInstructionId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "ddaFromToAccount":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "ddaEntity":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "transferType":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "templateName":{
            "type":"string",
            "description":"",
            "maxLength":50
        }
    }
}

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