Jump to

• Request
• Response

Get all MT Message Log

get

/service/lmg/externalMessage/getExternalMessageLog

This endpoint is used to get external message log based on input criteria.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• accountNumber: string
  accountNumber
• bicCode: string
  bicCode
• limit: integer
  limit is maximum no of records to be fetched
• messageDate: string
  messageDate
• offset: integer
  offset is starting no of records to be fetched
• status: string
  status
• swiftMsgType: string
  swiftMsgType
• transRefNum: string
  transRefNum

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : ExternalMsgLogServiceCollection

Type: object

Collection of MT messages.

Show Source

• data: array data
• paging: object PagingDto

{
    "description":"Collection of MT messages.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExternalMsgDetailsDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object ExternalMsgDetailsDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

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

Nested Schema : ExternalMsgDetailsDTO

Type: object

Show Source

• accountNumber: string
• availableBalance: number
• bicCode: string
• bookDatedBalance: number
• currencyCode: string
• dateTimeIndicator: string
• errorCode: string
• errorDesc: string
• logTimeInUserBranchTimeZone: string
• logTimeInUTCTimeZone: string
• message: string
• messageAuditList: array messageAuditList
• messageId: string
• messageStatus: string
• messageType: string
• openingBalance: number
• processedTimeInUserBranchTimeZone: string
• processedTimeInUTCTimeZone: string
• sequenceNo: integer
• statementNo: integer
• transRefNum: string
• valueDate: string

{
    "type":"object",
    "properties":{
        "messageId":{
            "type":"string",
            "description":""
        },
        "logTimeInUserBranchTimeZone":{
            "type":"string",
            "description":""
        },
        "logTimeInUTCTimeZone":{
            "type":"string",
            "description":""
        },
        "processedTimeInUserBranchTimeZone":{
            "type":"string",
            "description":""
        },
        "processedTimeInUTCTimeZone":{
            "type":"string",
            "description":""
        },
        "valueDate":{
            "type":"string",
            "description":""
        },
        "bicCode":{
            "type":"string",
            "description":""
        },
        "transRefNum":{
            "type":"string",
            "description":""
        },
        "accountNumber":{
            "type":"string",
            "description":""
        },
        "currencyCode":{
            "type":"string",
            "description":""
        },
        "statementNo":{
            "type":"integer",
            "description":""
        },
        "sequenceNo":{
            "type":"integer",
            "description":""
        },
        "openingBalance":{
            "type":"number",
            "description":""
        },
        "availableBalance":{
            "type":"number",
            "description":""
        },
        "bookDatedBalance":{
            "type":"number",
            "description":""
        },
        "dateTimeIndicator":{
            "type":"string",
            "description":""
        },
        "messageStatus":{
            "type":"string",
            "description":""
        },
        "errorCode":{
            "type":"string",
            "description":""
        },
        "errorDesc":{
            "type":"string",
            "description":""
        },
        "messageType":{
            "type":"string",
            "description":""
        },
        "message":{
            "type":"string",
            "description":""
        },
        "messageAuditList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExternalMsgLogAuditDTO"
            }
        }
    }
}

Nested Schema : messageAuditList

Type: array

Show Source

• Array of: object ExternalMsgLogAuditDTO

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

Nested Schema : ExternalMsgLogAuditDTO

Type: object

Show Source

• actionSource: string
  From date for which value dated balance is being fetched
• authStat: string
• checkerDtStamp: string
• checkerId: string
• checkerRemarks: string
• errorDesc: string
• id: string
• makerDtStamp: string
• makerId: string
• makerRemarks: string
• messageAction: string
• messageId: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "messageId":{
            "type":"string",
            "description":""
        },
        "messageAction":{
            "type":"string",
            "description":""
        },
        "actionSource":{
            "type":"string",
            "description":"From date for which value dated balance is being fetched"
        },
        "makerId":{
            "type":"string",
            "description":""
        },
        "makerDtStamp":{
            "type":"string",
            "description":""
        },
        "checkerId":{
            "type":"string",
            "description":""
        },
        "checkerDtStamp":{
            "type":"string",
            "description":""
        },
        "authStat":{
            "type":"string",
            "description":""
        },
        "errorDesc":{
            "type":"string",
            "description":""
        },
        "makerRemarks":{
            "type":"string",
            "description":""
        },
        "checkerRemarks":{
            "type":"string",
            "description":""
        }
    }
}

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