Previous Next JavaScript must be enabled to correctly display this content

## Run sweep service for a structure

post

/reversesweepservice/accpair

This endpoint is used to run sweep service for account pair.

### Request

Supported Media Types

- application/json
- application/xml

Body ()
Request Body that contains data required for running a sweep batch
Root Schema : LmsSweepStructuresDTO
Type: `object`
Match All
Show Source

- object LmsSweepStructuresDTO-allOf[0]

    {
        "type":"object",
        "allOf":[
            {
                "type":"object",
                "properties":{
                    "customerId":{
                        "type":"string",
                        "description":"",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "mode":{
                        "type":"string",
                        "description":""
                    },
                    "overRidePending":{
                        "type":"string",
                        "description":""
                    },
                    "branchCode":{
                        "type":"string",
                        "description":""
                    },
                    "jobschedulerId":{
                        "type":"string",
                        "description":""
                    },
                    "allowMBCCAccPair":{
                        "type":"string",
                        "description":""
                    },
                    "simulate":{
                        "type":"string",
                        "description":""
                    },
                    "simulateFromDt":{
                        "type":"string",
                        "format":"date",
                        "description":""
                    },
                    "simulateToDt":{
                        "type":"string",
                        "format":"date",
                        "description":""
                    },
                    "simulateExecDt":{
                        "type":"string",
                        "format":"date",
                        "description":""
                    },
                    "adhocId":{
                        "type":"string",
                        "description":""
                    },
                    "remarks":{
                        "type":"string",
                        "description":""
                    },
                    "allStructure":{
                        "type":"string",
                        "description":""
                    },
                    "checkAccPairSweep":{
                        "type":"string",
                        "description":""
                    },
                    "structureList":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/StructureListDTO"
                        }
                    },
                    "branchMap":{
                        "$ref":"#/definitions/BranchMap"
                    }
                }
            }
        ]
    }

Nested Schema : LmsSweepStructuresDTO-allOf[0]
Type: `object`
Show Source

- adhocId(optional): string
- allowMBCCAccPair(optional): string
- allStructure(optional): string
- branchCode(optional): string
- branchMap(optional): object BranchMap
  Additional Properties Allowed: LmmTmBranchParametersDTO
- checkAccPairSweep(optional): string
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
- jobschedulerId(optional): string
- mode(optional): string
- overRidePending(optional): string
- remarks(optional): string
- simulate(optional): string
- simulateExecDt(optional): string(date)
- simulateFromDt(optional): string(date)
- simulateToDt(optional): string(date)
- structureList(optional): array structureList

    {
        "type":"object",
        "properties":{
            "customerId":{
                "type":"string",
                "description":"",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "mode":{
                "type":"string",
                "description":""
            },
            "overRidePending":{
                "type":"string",
                "description":""
            },
            "branchCode":{
                "type":"string",
                "description":""
            },
            "jobschedulerId":{
                "type":"string",
                "description":""
            },
            "allowMBCCAccPair":{
                "type":"string",
                "description":""
            },
            "simulate":{
                "type":"string",
                "description":""
            },
            "simulateFromDt":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "simulateToDt":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "simulateExecDt":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "adhocId":{
                "type":"string",
                "description":""
            },
            "remarks":{
                "type":"string",
                "description":""
            },
            "allStructure":{
                "type":"string",
                "description":""
            },
            "checkAccPairSweep":{
                "type":"string",
                "description":""
            },
            "structureList":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/StructureListDTO"
                }
            },
            "branchMap":{
                "$ref":"#/definitions/BranchMap"
            }
        }
    }

Nested Schema : BranchMap
Type: `object`
Additional Properties Allowed
Show Source

- object LmmTmBranchParametersDTO

    {
        "additionalProperties":{
            "$ref":"#/definitions/LmmTmBranchParametersDTO"
        }
    }

Nested Schema : structureList
Type: `array`
Show Source

- Array of: object StructureListDTO

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

Nested Schema : LmmTmBranchParametersDTO
Type: `object`
Match All
Show Source

- allOf GenericDto
- object LmmTmBranchParametersDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "bankCode":{
                        "type":"string",
                        "description":""
                    },
                    "bicCode":{
                        "type":"string",
                        "description":""
                    },
                    "branchCode":{
                        "type":"string",
                        "description":""
                    },
                    "branchCurrency":{
                        "type":"string",
                        "description":""
                    },
                    "branchName":{
                        "type":"string",
                        "description":""
                    },
                    "branchDate":{
                        "type":"string",
                        "description":""
                    },
                    "isExternal":{
                        "type":"string",
                        "description":""
                    },
                    "cityId":{
                        "type":"string",
                        "description":""
                    },
                    "countryId":{
                        "type":"string",
                        "description":""
                    },
                    "crossBorderHybridPool":{
                        "type":"string",
                        "description":""
                    },
                    "crossBorderHybridSweep":{
                        "type":"string",
                        "description":""
                    },
                    "crossBorderPool":{
                        "type":"string",
                        "description":""
                    },
                    "crossBorderSweep":{
                        "type":"string",
                        "description":""
                    },
                    "crossCcyHybridPool":{
                        "type":"string",
                        "description":""
                    },
                    "crossCcyHybridSweep":{
                        "type":"string",
                        "description":""
                    },
                    "crossCcyPool":{
                        "type":"string",
                        "description":""
                    },
                    "crossCcySweep":{
                        "type":"string",
                        "description":""
                    },
                    "domesticHybridPool":{
                        "type":"string",
                        "description":""
                    },
                    "domesticHybridSweep":{
                        "type":"string",
                        "description":""
                    },
                    "domesticPool":{
                        "type":"string",
                        "description":""
                    },
                    "domesticSweep":{
                        "type":"string",
                        "description":""
                    },
                    "externalSystemId":{
                        "type":"string",
                        "description":""
                    },
                    "fax":{
                        "type":"string",
                        "description":""
                    },
                    "hybrid":{
                        "type":"string",
                        "description":""
                    },
                    "isBalanceOnline":{
                        "type":"string",
                        "description":""
                    },
                    "latitude":{
                        "type":"number",
                        "description":""
                    },
                    "line1":{
                        "type":"string",
                        "description":""
                    },
                    "line2":{
                        "type":"string",
                        "description":""
                    },
                    "line3":{
                        "type":"string",
                        "description":""
                    },
                    "line4":{
                        "type":"string",
                        "description":""
                    },
                    "longitude":{
                        "type":"number",
                        "description":""
                    },
                    "phoneNumber":{
                        "type":"string",
                        "description":""
                    },
                    "pool":{
                        "type":"string",
                        "description":""
                    },
                    "region":{
                        "type":"string",
                        "description":""
                    },
                    "sourceSystem":{
                        "type":"string",
                        "description":""
                    },
                    "sourceSystemBranchCode":{
                        "type":"string",
                        "description":""
                    },
                    "stateId":{
                        "type":"string",
                        "description":""
                    },
                    "sweep":{
                        "type":"string",
                        "description":""
                    },
                    "timeZone":{
                        "type":"string",
                        "description":""
                    },
                    "hostCode":{
                        "type":"string",
                        "description":""
                    },
                    "zip":{
                        "type":"string",
                        "description":""
                    },
                    "entityID":{
                        "type":"string",
                        "description":""
                    },
                    "entityName":{
                        "type":"string",
                        "description":""
                    },
                    "today":{
                        "type":"string"
                    },
                    "prevWorkingDay":{
                        "type":"string"
                    },
                    "nextWorkingDay":{
                        "type":"string"
                    },
                    "LmmTmBranchAddnParametersDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmmTmBranchAddnParametersDTO"
                        }
                    },
                    "LmmTmBranchExternalSystemDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmmTmBranchExternalSystemDTO"
                        }
                    }
                },
                "required":[
                    "bankCode",
                    "branchCode",
                    "branchCurrency",
                    "branchName",
                    "cityId"
                ]
            }
        ]
    }

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 : LmmTmBranchParametersDTO-allOf[1]
Type: `object`
Show Source

- bankCode: string
- bicCode(optional): string
- branchCode: string
- branchCurrency: string
- branchDate(optional): string
- branchName: string
- cityId: string
- countryId(optional): string
- crossBorderHybridPool(optional): string
- crossBorderHybridSweep(optional): string
- crossBorderPool(optional): string
- crossBorderSweep(optional): string
- crossCcyHybridPool(optional): string
- crossCcyHybridSweep(optional): string
- crossCcyPool(optional): string
- crossCcySweep(optional): string
- domesticHybridPool(optional): string
- domesticHybridSweep(optional): string
- domesticPool(optional): string
- domesticSweep(optional): string
- entityID(optional): string
- entityName(optional): string
- externalSystemId(optional): string
- fax(optional): string
- hostCode(optional): string
- hybrid(optional): string
- isBalanceOnline(optional): string
- isExternal(optional): string
- latitude(optional): number
- line1(optional): string
- line2(optional): string
- line3(optional): string
- line4(optional): string
- LmmTmBranchAddnParametersDTO(optional): array LmmTmBranchAddnParametersDTO
- LmmTmBranchExternalSystemDTO(optional): array LmmTmBranchExternalSystemDTO
- longitude(optional): number
- nextWorkingDay(optional): string
- phoneNumber(optional): string
- pool(optional): string
- prevWorkingDay(optional): string
- region(optional): string
- sourceSystem(optional): string
- sourceSystemBranchCode(optional): string
- stateId(optional): string
- sweep(optional): string
- timeZone(optional): string
- today(optional): string
- zip(optional): string

    {
        "type":"object",
        "properties":{
            "bankCode":{
                "type":"string",
                "description":""
            },
            "bicCode":{
                "type":"string",
                "description":""
            },
            "branchCode":{
                "type":"string",
                "description":""
            },
            "branchCurrency":{
                "type":"string",
                "description":""
            },
            "branchName":{
                "type":"string",
                "description":""
            },
            "branchDate":{
                "type":"string",
                "description":""
            },
            "isExternal":{
                "type":"string",
                "description":""
            },
            "cityId":{
                "type":"string",
                "description":""
            },
            "countryId":{
                "type":"string",
                "description":""
            },
            "crossBorderHybridPool":{
                "type":"string",
                "description":""
            },
            "crossBorderHybridSweep":{
                "type":"string",
                "description":""
            },
            "crossBorderPool":{
                "type":"string",
                "description":""
            },
            "crossBorderSweep":{
                "type":"string",
                "description":""
            },
            "crossCcyHybridPool":{
                "type":"string",
                "description":""
            },
            "crossCcyHybridSweep":{
                "type":"string",
                "description":""
            },
            "crossCcyPool":{
                "type":"string",
                "description":""
            },
            "crossCcySweep":{
                "type":"string",
                "description":""
            },
            "domesticHybridPool":{
                "type":"string",
                "description":""
            },
            "domesticHybridSweep":{
                "type":"string",
                "description":""
            },
            "domesticPool":{
                "type":"string",
                "description":""
            },
            "domesticSweep":{
                "type":"string",
                "description":""
            },
            "externalSystemId":{
                "type":"string",
                "description":""
            },
            "fax":{
                "type":"string",
                "description":""
            },
            "hybrid":{
                "type":"string",
                "description":""
            },
            "isBalanceOnline":{
                "type":"string",
                "description":""
            },
            "latitude":{
                "type":"number",
                "description":""
            },
            "line1":{
                "type":"string",
                "description":""
            },
            "line2":{
                "type":"string",
                "description":""
            },
            "line3":{
                "type":"string",
                "description":""
            },
            "line4":{
                "type":"string",
                "description":""
            },
            "longitude":{
                "type":"number",
                "description":""
            },
            "phoneNumber":{
                "type":"string",
                "description":""
            },
            "pool":{
                "type":"string",
                "description":""
            },
            "region":{
                "type":"string",
                "description":""
            },
            "sourceSystem":{
                "type":"string",
                "description":""
            },
            "sourceSystemBranchCode":{
                "type":"string",
                "description":""
            },
            "stateId":{
                "type":"string",
                "description":""
            },
            "sweep":{
                "type":"string",
                "description":""
            },
            "timeZone":{
                "type":"string",
                "description":""
            },
            "hostCode":{
                "type":"string",
                "description":""
            },
            "zip":{
                "type":"string",
                "description":""
            },
            "entityID":{
                "type":"string",
                "description":""
            },
            "entityName":{
                "type":"string",
                "description":""
            },
            "today":{
                "type":"string"
            },
            "prevWorkingDay":{
                "type":"string"
            },
            "nextWorkingDay":{
                "type":"string"
            },
            "LmmTmBranchAddnParametersDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmBranchAddnParametersDTO"
                }
            },
            "LmmTmBranchExternalSystemDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmBranchExternalSystemDTO"
                }
            }
        },
        "required":[
            "bankCode",
            "branchCode",
            "branchCurrency",
            "branchName",
            "cityId"
        ]
    }

Nested Schema : LmmTmBranchAddnParametersDTO
Type: `array`
Show Source

- Array of: object LmmTmBranchAddnParametersDTO

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

Nested Schema : LmmTmBranchExternalSystemDTO
Type: `array`
Show Source

- Array of: object LmmTmBranchExternalSystemDTO

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

Nested Schema : LmmTmBranchAddnParametersDTO
Type: `object`
Show Source

- branchParametersId(optional): string
- id(optional): string
- parameterName(optional): string
- parameterValue(optional): string

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

Nested Schema : LmmTmBranchExternalSystemDTO
Type: `object`
Show Source

- branchParametersId(optional): string
- externalSystemId(optional): string
- id(optional): string
- messageType(optional): string
- methodName(optional): string
- networkType(optional): string
- serviceType(optional): string

    {
        "type":"object",
        "properties":{
            "branchParametersId":{
                "type":"string",
                "description":""
            },
            "externalSystemId":{
                "type":"string",
                "description":""
            },
            "id":{
                "type":"string",
                "description":""
            },
            "messageType":{
                "type":"string",
                "description":""
            },
            "methodName":{
                "type":"string",
                "description":""
            },
            "networkType":{
                "type":"string",
                "description":""
            },
            "serviceType":{
                "type":"string",
                "description":""
            }
        }
    }

Nested Schema : StructureListDTO
Type: `object`
Show Source

- accountList(optional): array accountList
- lastSuccessfulSweepDate(optional): string(date)
- structureId(optional): string
  Pattern: `[0-9a-fA-Z-]{1,36}`
- versionNo(optional): integer

    {
        "type":"object",
        "properties":{
            "structureId":{
                "type":"string",
                "pattern":"[0-9a-fA-Z-]{1,36}"
            },
            "versionNo":{
                "type":"integer"
            },
            "lastSuccessfulSweepDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "accountList":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmsSweepAccountDTO"
                }
            }
        }
    }

Nested Schema : accountList
Type: `array`
Show Source

- Array of: object LmsSweepAccountDTO

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

Nested Schema : LmsSweepAccountDTO
Type: `object`
Show Source

- accountCurrency(optional): string
- accountNumber(optional): string
- batchDataId(optional): string
- branchCode(optional): string
- extTransactionNo(optional): string
  Sweep Log ID
- frequencyId(optional): string
- fromDate(optional): string
  starting Date
- id(optional): string
- instructionId(optional): string
- lastSuccessfulSweepDate(optional): string(date)
- structureMasterId(optional): string
- toDate(optional): string
  ending Date

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":""
            },
            "structureMasterId":{
                "type":"string",
                "description":""
            },
            "accountNumber":{
                "type":"string",
                "description":""
            },
            "branchCode":{
                "type":"string",
                "description":""
            },
            "batchDataId":{
                "type":"string",
                "description":""
            },
            "accountCurrency":{
                "type":"string",
                "description":""
            },
            "instructionId":{
                "type":"string",
                "description":""
            },
            "frequencyId":{
                "type":"string",
                "description":""
            },
            "lastSuccessfulSweepDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "fromDate":{
                "description":"starting Date",
                "type":"string"
            },
            "toDate":{
                "description":"ending Date",
                "type":"string"
            },
            "extTransactionNo":{
                "description":"Sweep Log ID",
                "type":"string"
            }
        }
    }

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 201 Response

Returns message of succes or failure
Headers

- Location: string
  URL of newly created sweepmaster data

Body ()
Root Schema : ResponseDtoWrapper
Type: `object`
Show Source

- data(optional): object ResponseResourceSupport
- messages(optional): 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(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 : 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