Jump to

• Request
• Response

Get all valid rtl transaction

get

/service/lrt/RtlTransaction/fetch

This endpoint is used to get all valid real time liquidity transaction.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}
• rtlStructureId(optional): string
• txnDateFrom(optional): string
• txnDateTo(optional): string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string

Body ()

Root Schema : LrtTmRtlTxnMasterDTOCollection

Type: object

Collection of RTL txn.

Show Source

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

{
    "description":"Collection of RTL txn.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LrtTmRtlTxnMasterDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object LrtTmRtlTxnMasterDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : LrtTmRtlTxnMasterDTO

Type: object

Show Source

• blockAmt(optional): number
• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}
• ddaRefId(optional): string
  Maximum Length: 50
• ddaTxnId(optional): string
  Maximum Length: 50
• errorReference(optional): string
  Maximum Length: 36
• headerAccBrn(optional): string
  Maximum Length: 3
• headerAccCcy(optional): string
  Maximum Length: 3
• headerAccNo(optional): string
  Maximum Length: 30
• id(optional): string
  Maximum Length: 36
• isPartialAllowed(optional): string
• LrtTmRtlTxnGroupDTO(optional): array LrtTmRtlTxnGroupDTO
• LrtTmRtlTxnLogDTO(optional): array LrtTmRtlTxnLogDTO
• postAmt(optional): number
• processedAmt(optional): number
• processedCcy(optional): string
  Maximum Length: 3
• rtlStructureId(optional): string
  Maximum Length: 30
• rtlStructureMasterId(optional): string
  Maximum Length: 36
• rtlTxnId(optional): string
• status(optional): string
• statusMessage(optional): string
  Maximum Length: 500
• toAccountDescription(optional): string
• toCountryCode(optional): string
• toIBan(optional): string
• totalAmt(optional): number
• txnAmt(optional): number
• txnCcy(optional): string
  Maximum Length: 36
• txnClosureTime(optional): string
• txnDate(optional): string
• txnDateFrom(optional): string
• txnDateTo(optional): string
• txnInitTime(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "rtlTxnId":{
            "type":"string",
            "description":""
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "headerAccNo":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "headerAccCcy":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "headerAccBrn":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "rtlStructureId":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "rtlStructureMasterId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "txnAmt":{
            "type":"number",
            "description":""
        },
        "txnCcy":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "processedAmt":{
            "type":"number",
            "description":""
        },
        "blockAmt":{
            "type":"number",
            "description":""
        },
        "postAmt":{
            "type":"number",
            "description":""
        },
        "totalAmt":{
            "type":"number",
            "description":""
        },
        "processedCcy":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "txnDate":{
            "type":"string",
            "description":""
        },
        "txnDateFrom":{
            "type":"string",
            "description":""
        },
        "txnDateTo":{
            "type":"string",
            "description":""
        },
        "txnInitTime":{
            "type":"string",
            "description":""
        },
        "txnClosureTime":{
            "type":"string",
            "description":""
        },
        "status":{
            "type":"string",
            "description":""
        },
        "statusMessage":{
            "type":"string",
            "description":"",
            "maxLength":500
        },
        "errorReference":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "ddaRefId":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "ddaTxnId":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "isPartialAllowed":{
            "type":"string",
            "description":""
        },
        "toIBan":{
            "type":"string",
            "description":""
        },
        "toAccountDescription":{
            "type":"string",
            "description":""
        },
        "toCountryCode":{
            "type":"string",
            "description":""
        },
        "LrtTmRtlTxnLogDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LrtTmRtlTxnLogDTO"
            }
        },
        "LrtTmRtlTxnGroupDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LrtTmRtlTxnGroupDTO"
            }
        }
    }
}

Nested Schema : LrtTmRtlTxnGroupDTO

Type: array

Show Source

• Array of: object LrtTmRtlTxnGroupDTO

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

Nested Schema : LrtTmRtlTxnLogDTO

Type: array

Show Source

• Array of: object LrtTmRtlTxnLogDTO

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

Nested Schema : LrtTmRtlTxnGroupDTO

Type: object

Show Source

• blockAmt(optional): number
• groupDescription(optional): string
  Maximum Length: 200
• groupName(optional): string
  Maximum Length: 20
• groupPriority(optional): number
  Minimum Value: 1

  Maximum Value: 100
• id(optional): string
  Maximum Length: 36
• postAmt(optional): number
• totalAmt(optional): number

{
    "type":"object",
    "properties":{
        "groupDescription":{
            "type":"string",
            "description":"",
            "maxLength":200
        },
        "groupName":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "groupPriority":{
            "type":"number",
            "description":"",
            "minimum":1,
            "maximum":100
        },
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "blockAmt":{
            "type":"number",
            "description":""
        },
        "postAmt":{
            "type":"number",
            "description":""
        },
        "totalAmt":{
            "type":"number",
            "description":""
        }
    }
}

Nested Schema : LrtTmRtlTxnLogDTO

Type: object

Show Source

• accountCurrency(optional): string
• accountDescription(optional): string
• accountNumber(optional): string
• accPriority(optional): integer
  Minimum Value: 1

  Maximum Value: 100
• blkAmount(optional): number
• branchCode(optional): string
• branchName(optional): string
• ddaBlockRefId(optional): string
  Maximum Length: 50
• exchangeRate(optional): string
• externalSystem(optional): string
• groupDescription(optional): string
  Maximum Length: 200
• groupId(optional): string
  Maximum Length: 36
• handoffType(optional): string
• id(optional): string
  Maximum Length: 36
• rtlStructureMasterId(optional): string
  Maximum Length: 36
• rtlTxnId(optional): string
• status(optional): string
• statusMessage(optional): string
  Maximum Length: 500
• txnAmount(optional): number
• txnAmountInAccCcy(optional): number
• txnCcy(optional): string
  Maximum Length: 3

{
    "type":"object",
    "properties":{
        "rtlTxnId":{
            "type":"string",
            "description":""
        },
        "groupDescription":{
            "type":"string",
            "description":"",
            "maxLength":200
        },
        "groupId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "accountCurrency":{
            "type":"string",
            "description":""
        },
        "accountNumber":{
            "type":"string",
            "description":""
        },
        "accountDescription":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "branchName":{
            "type":"string",
            "description":""
        },
        "handoffType":{
            "type":"string",
            "description":""
        },
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "externalSystem":{
            "type":"string",
            "description":""
        },
        "ddaBlockRefId":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "txnAmount":{
            "type":"number",
            "description":""
        },
        "txnAmountInAccCcy":{
            "type":"number",
            "description":""
        },
        "txnCcy":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "accPriority":{
            "type":"integer",
            "description":"",
            "minimum":1,
            "maximum":100
        },
        "exchangeRate":{
            "type":"string",
            "description":""
        },
        "status":{
            "type":"string",
            "description":""
        },
        "statusMessage":{
            "type":"string",
            "description":"",
            "maxLength":500
        },
        "rtlStructureMasterId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "blkAmount":{
            "type":"number",
            "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