Previous Next JavaScript must be enabled to correctly display this content

## Retrieves the List of Existing Cross Border Sweeps

get

/service/lmd/crossborder

This endpoint is used to get the list of existing cross border sweeps.

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- currency(optional): string
  currency base on which the data to be fetched

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 200 Response

Successful performs the operation
Body ()
Root Schema : LmdTbTopCrossborderSweepsServiceCollection
Type: `object`
Collection of CrossborderSweeps
Show Source

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

    {
        "description":"Collection of CrossborderSweeps",
        "type":"object",
        "properties":{
            "data":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmdTbTopCrossborderSweepsDTO"
                }
            },
            "paging":{
                "$ref":"#/definitions/PagingDto"
            }
        }
    }

Nested Schema : data
Type: `array`
Show Source

- Array of: object LmdTbTopCrossborderSweepsDTO
  CrossborderSweeps DTO

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

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

Nested Schema : LmdTbTopCrossborderSweepsDTO
Type: `object`
CrossborderSweeps DTO
Match All
Show Source

- allOf GenericDto
- object LmdTbTopCrossborderSweepsDTO-allOf[1]

    {
        "description":"CrossborderSweeps DTO",
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "fromAccountNumber":{
                        "description":"fromAccountNumber",
                        "type":"string",
                        "maxLength":35
                    },
                    "fromCountryCode":{
                        "description":"fromCountryCode",
                        "type":"string",
                        "maxLength":4
                    },
                    "fromCurrencyCode":{
                        "description":"fromCurrencyCode",
                        "type":"string",
                        "maxLength":3
                    },
                    "structureId":{
                        "description":"structureId",
                        "type":"string",
                        "pattern":"[A-Z0-9]{1,30}"
                    },
                    "toAccountNumber":{
                        "description":"toAccountNumber",
                        "type":"string",
                        "maxLength":35
                    },
                    "toCountryCode":{
                        "description":"toCountryCode",
                        "type":"string",
                        "maxLength":4
                    },
                    "toCurrencyCode":{
                        "description":"toCurrencyCode",
                        "type":"string",
                        "maxLength":3
                    },
                    "fromAmount":{
                        "description":"fromAmount",
                        "type":"number"
                    },
                    "toAmount":{
                        "description":"toAmount",
                        "type":"number"
                    },
                    "lcyAmount":{
                        "description":"lcyAmount",
                        "type":"number"
                    },
                    "customerId":{
                        "description":"customerId",
                        "type":"string",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "customerName":{
                        "description":"customerName",
                        "type":"string",
                        "maxLength":100
                    },
                    "userId":{
                        "description":"userId",
                        "type":"string",
                        "maxLength":12
                    },
                    "valueDate":{
                        "description":"value Date",
                        "type":"string",
                        "format":"date"
                    }
                }
            }
        ]
    }

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

- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
  customerId
- customerName(optional): string
  Maximum Length: `100`
  customerName
- fromAccountNumber(optional): string
  Maximum Length: `35`
  fromAccountNumber
- fromAmount(optional): number
  fromAmount
- fromCountryCode(optional): string
  Maximum Length: `4`
  fromCountryCode
- fromCurrencyCode(optional): string
  Maximum Length: `3`
  fromCurrencyCode
- lcyAmount(optional): number
  lcyAmount
- structureId(optional): string
  Pattern: `[A-Z0-9]{1,30}`
  structureId
- toAccountNumber(optional): string
  Maximum Length: `35`
  toAccountNumber
- toAmount(optional): number
  toAmount
- toCountryCode(optional): string
  Maximum Length: `4`
  toCountryCode
- toCurrencyCode(optional): string
  Maximum Length: `3`
  toCurrencyCode
- userId(optional): string
  Maximum Length: `12`
  userId
- valueDate(optional): string(date)
  value Date

    {
        "type":"object",
        "properties":{
            "fromAccountNumber":{
                "description":"fromAccountNumber",
                "type":"string",
                "maxLength":35
            },
            "fromCountryCode":{
                "description":"fromCountryCode",
                "type":"string",
                "maxLength":4
            },
            "fromCurrencyCode":{
                "description":"fromCurrencyCode",
                "type":"string",
                "maxLength":3
            },
            "structureId":{
                "description":"structureId",
                "type":"string",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "toAccountNumber":{
                "description":"toAccountNumber",
                "type":"string",
                "maxLength":35
            },
            "toCountryCode":{
                "description":"toCountryCode",
                "type":"string",
                "maxLength":4
            },
            "toCurrencyCode":{
                "description":"toCurrencyCode",
                "type":"string",
                "maxLength":3
            },
            "fromAmount":{
                "description":"fromAmount",
                "type":"number"
            },
            "toAmount":{
                "description":"toAmount",
                "type":"number"
            },
            "lcyAmount":{
                "description":"lcyAmount",
                "type":"number"
            },
            "customerId":{
                "description":"customerId",
                "type":"string",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "customerName":{
                "description":"customerName",
                "type":"string",
                "maxLength":100
            },
            "userId":{
                "description":"userId",
                "type":"string",
                "maxLength":12
            },
            "valueDate":{
                "description":"value Date",
                "type":"string",
                "format":"date"
            }
        }
    }

#### 400 Response

Malformed syntax.

#### 401 Response

Request does not have sufficient credentials.

#### 403 Response

Request is not authorized.

#### 500 Response

Internal error
Back to Top