Jump to

• Request
• Response

Adds a new Top Cross Border Sweep

post

/crossborder

This endpoint is used to add a new Top Cross Border Sweep.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for creating a new crossborder

Root Schema : LmdTbTopCrossborderSweepsCollection

Type: object

Collection of CrossborderSweeps

Show Source

• data(optional): array data

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

Nested Schema : data

Type: array

Show Source

• Array of: object LmdTbTopCrossborderSweepsDTO
  CrossborderSweeps DTO

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

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"
                },
                "fromCountryCode":{
                    "description":"fromCountryCode",
                    "type":"string"
                },
                "fromCurrencyCode":{
                    "description":"fromCurrencyCode",
                    "type":"string"
                },
                "structureId":{
                    "description":"structureId",
                    "type":"string",
                    "pattern":"[0-9a-fA-Z-]{1,36}"
                },
                "toAccountNumber":{
                    "description":"toAccountNumber",
                    "type":"string"
                },
                "toCountryCode":{
                    "description":"toCountryCode",
                    "type":"string"
                },
                "toCurrencyCode":{
                    "description":"toCurrencyCode",
                    "type":"string"
                },
                "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"
                },
                "userId":{
                    "description":"userId",
                    "type":"string"
                },
                "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
  customerName
• fromAccountNumber(optional): string
  fromAccountNumber
• fromAmount(optional): number
  fromAmount
• fromCountryCode(optional): string
  fromCountryCode
• fromCurrencyCode(optional): string
  fromCurrencyCode
• lcyAmount(optional): number
  lcyAmount
• structureId(optional): string
  Pattern: [0-9a-fA-Z-]{1,36}

  structureId
• toAccountNumber(optional): string
  toAccountNumber
• toAmount(optional): number
  toAmount
• toCountryCode(optional): string
  toCountryCode
• toCurrencyCode(optional): string
  toCurrencyCode
• userId(optional): string
  userId
• valueDate(optional): string(date)
  value Date

{
    "type":"object",
    "properties":{
        "fromAccountNumber":{
            "description":"fromAccountNumber",
            "type":"string"
        },
        "fromCountryCode":{
            "description":"fromCountryCode",
            "type":"string"
        },
        "fromCurrencyCode":{
            "description":"fromCurrencyCode",
            "type":"string"
        },
        "structureId":{
            "description":"structureId",
            "type":"string",
            "pattern":"[0-9a-fA-Z-]{1,36}"
        },
        "toAccountNumber":{
            "description":"toAccountNumber",
            "type":"string"
        },
        "toCountryCode":{
            "description":"toCountryCode",
            "type":"string"
        },
        "toCurrencyCode":{
            "description":"toCurrencyCode",
            "type":"string"
        },
        "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"
        },
        "userId":{
            "description":"userId",
            "type":"string"
        },
        "valueDate":{
            "description":"value Date",
            "type":"string",
            "format":"date"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string
  URL of newly created Top Cross Border Sweep

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