Jump to

• Request
• Response

Create a External Response

post

/OLExternalResponseService/OLExternalResponse/CreateExResponse

This operation creates a External Response using OLExternalResponse Service(OLDEXRES).

Request

Header Parameters

• BRANCH: string
  Enter Transaction Branch
• ENTITY(optional): string
  Enter Entity ID
• SOURCE: string
  Enter Source Code of External System
• USERID: string
  Enter User ID

Body ()

Root Schema : ExresMasDto

Type: object

Show Source

• exresDetList(optional): array exresDetList
• masCommMode(optional): string
  Indicates MasCommMode
• masDestinationSource(optional): string
  Indicates MasDestinationSource
• masExtStatus(optional): string
  Indicates MasExtStatus
• masForcePost(optional): string
  Indicates MasForcePost
• masKeyid(optional): string
  Indicates MasKeyid
• masLogTime(optional): string
  Indicates MasLogTime
• masMsgid: string
  Indicates MasMsgid
• masProcessStatus(optional): string
  Indicates MasProcessStatus
• masRetryCount(optional): number
  Indicates MasRetryCount
• masSeqNo: number
  Indicates MasSeqNo
• masServiceCode(optional): string
  Indicates MasServiceCode

{
    "type":"object",
    "required":[
        "masMsgid",
        "masSeqNo"
    ],
    "properties":{
        "masMsgid":{
            "type":"string",
            "description":"Indicates MasMsgid"
        },
        "masCommMode":{
            "type":"string",
            "description":"Indicates MasCommMode"
        },
        "masForcePost":{
            "type":"string",
            "description":"Indicates MasForcePost"
        },
        "masProcessStatus":{
            "type":"string",
            "description":"Indicates MasProcessStatus"
        },
        "masRetryCount":{
            "type":"number",
            "description":"Indicates MasRetryCount"
        },
        "masKeyid":{
            "type":"string",
            "description":"Indicates MasKeyid"
        },
        "masExtStatus":{
            "type":"string",
            "description":"Indicates MasExtStatus"
        },
        "masLogTime":{
            "type":"string",
            "description":"Indicates MasLogTime"
        },
        "masSeqNo":{
            "type":"number",
            "description":"Indicates MasSeqNo"
        },
        "masDestinationSource":{
            "type":"string",
            "description":"Indicates MasDestinationSource"
        },
        "masServiceCode":{
            "type":"string",
            "description":"Indicates MasServiceCode"
        },
        "exresDetList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExresDetDto"
            }
        }
    }
}

Nested Schema : exresDetList

Type: array

Show Source

• Array of: object ExresDetDto

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

Nested Schema : ExresDetDto

Type: object

Show Source

• detErrorCodes(optional): string
  Indicates DetErrorCodes
• detErrorParam(optional): string
  Indicates DetErrorParam
• detExtStatus(optional): string
  Indicates DetExtStatus
• detMsgid: string
  Indicates DetMsgid
• detReqSerialNo: number
  Indicates DetReqSerialNo
• detRequestTime(optional): string
  Indicates DetRequestTime
• detRequestXml(optional): string
  Indicates DetRequestXml
• detResponseTime(optional): string
  Indicates DetResponseTime
• detResponseXml(optional): string
  Indicates DetResponseXml
• detSeqNo: number
  Indicates DetSeqNo
• detVersioned(optional): string
  Indicates DetVersioned

{
    "type":"object",
    "required":[
        "detMsgid",
        "detReqSerialNo",
        "detSeqNo"
    ],
    "properties":{
        "detReqSerialNo":{
            "type":"number",
            "description":"Indicates DetReqSerialNo"
        },
        "detErrorCodes":{
            "type":"string",
            "description":"Indicates DetErrorCodes"
        },
        "detErrorParam":{
            "type":"string",
            "description":"Indicates DetErrorParam"
        },
        "detResponseXml":{
            "type":"string",
            "description":"Indicates DetResponseXml"
        },
        "detRequestTime":{
            "type":"string",
            "description":"Indicates DetRequestTime"
        },
        "detVersioned":{
            "type":"string",
            "description":"Indicates DetVersioned"
        },
        "detSeqNo":{
            "type":"number",
            "description":"Indicates DetSeqNo"
        },
        "detResponseTime":{
            "type":"string",
            "description":"Indicates DetResponseTime"
        },
        "detMsgid":{
            "type":"string",
            "description":"Indicates DetMsgid"
        },
        "detExtStatus":{
            "type":"string",
            "description":"Indicates DetExtStatus"
        },
        "detRequestXml":{
            "type":"string",
            "description":"Indicates DetRequestXml"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : RESTResponse

Type: object

Show Source

• Cstbs-Contract-Pmt-Hdr-Full(optional): object CstbsContractPmtHdrDto
• FCUBS_ERROR_RESP(optional): object FCUBSErrorResponse
• FCUBS_WARNING_RESP(optional): object FCUBSWarnResponse

{
    "type":"object",
    "properties":{
        "Cstbs-Contract-Pmt-Hdr-Full":{
            "$ref":"#/definitions/CstbsContractPmtHdrDto"
        },
        "FCUBS_ERROR_RESP":{
            "$ref":"#/definitions/FCUBSErrorResponse"
        },
        "FCUBS_WARNING_RESP":{
            "$ref":"#/definitions/FCUBSWarnResponse"
        }
    }
}

Nested Schema : CstbsContractPmtHdrDto

Type: object

Show Source

• assetCcy(optional): string
  Indicates AssetCcy
• balance(optional): number
  Indicates Balance
• btnauthui(optional): string
  Indicates Btnauthui
• btnSetlinfo(optional): string
  Indicates BtnSetlinfo
• contrrefno(optional): string
  Indicates Contrrefno
• contstat(optional): string
  Indicates Contstat
• counterparty(optional): string
  Indicates Counterparty
• currentesnui(optional): number
  Indicates Currentesnui
• curreventcode(optional): string
  Indicates Curreventcode
• latevnseqno(optional): number
  Indicates Latevnseqno
• latverno(optional): number
  Indicates Latverno
• moducd(optional): string
  Indicates Moducd
• oltbsContractLiqSummary(optional): object OltbsContractLiqSummaryDto
• paymentstat(optional): string
  Indicates Paymentstat

{
    "type":"object",
    "properties":{
        "assetCcy":{
            "type":"string",
            "description":"Indicates AssetCcy"
        },
        "contstat":{
            "type":"string",
            "description":"Indicates Contstat"
        },
        "moducd":{
            "type":"string",
            "description":"Indicates Moducd"
        },
        "curreventcode":{
            "type":"string",
            "description":"Indicates Curreventcode"
        },
        "counterparty":{
            "type":"string",
            "description":"Indicates Counterparty"
        },
        "latverno":{
            "type":"number",
            "description":"Indicates Latverno"
        },
        "latevnseqno":{
            "type":"number",
            "description":"Indicates Latevnseqno"
        },
        "contrrefno":{
            "type":"string",
            "description":"Indicates Contrrefno"
        },
        "balance":{
            "type":"number",
            "description":"Indicates Balance"
        },
        "paymentstat":{
            "type":"string",
            "description":"Indicates Paymentstat"
        },
        "currentesnui":{
            "type":"number",
            "description":"Indicates Currentesnui"
        },
        "btnSetlinfo":{
            "type":"string",
            "description":"Indicates BtnSetlinfo"
        },
        "btnauthui":{
            "type":"string",
            "description":"Indicates Btnauthui"
        },
        "oltbsContractLiqSummary":{
            "$ref":"#/definitions/OltbsContractLiqSummaryDto"
        }
    }
}

Nested Schema : FCUBSErrorResponse

Type: object

Show Source

• ERROR(optional): array ERROR

{
    "type":"object",
    "properties":{
        "ERROR":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FCUBSError"
            }
        }
    }
}

Nested Schema : FCUBSWarnResponse

Type: object

Show Source

• WARNING(optional): array WARNING

{
    "type":"object",
    "properties":{
        "WARNING":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FCUBSWarn"
            }
        }
    }
}

Nested Schema : OltbsContractLiqSummaryDto

Type: object

Show Source

• amtblkrmks(optional): string
  Indicates Amtblkrmks
• asstdate(optional): string
  Indicates Asstdate
• contrrefno(optional): string
  Indicates Contrrefno
• eventSeqNo1(optional): number
  Indicates EventSeqNo1
• oltbsContractLiqPmtList(optional): array oltbsContractLiqPmtList
• oltbsContractOvdList(optional): array oltbsContractOvdList
• paymentstatus(optional): string
  Indicates Paymentstatus
• prepaymentPenaltyAmount(optional): number
  Indicates PrepaymentPenaltyAmount
• prepaymentpenaltyrate(optional): number
  Indicates Prepaymentpenaltyrate
• rekytotlpaid(optional): number
  Indicates Rekytotlpaid
• showDet(optional): string
  Indicates ShowDet

{
    "type":"object",
    "properties":{
        "rekytotlpaid":{
            "type":"number",
            "description":"Indicates Rekytotlpaid"
        },
        "asstdate":{
            "type":"string",
            "description":"Indicates Asstdate"
        },
        "eventSeqNo1":{
            "type":"number",
            "description":"Indicates EventSeqNo1"
        },
        "contrrefno":{
            "type":"string",
            "description":"Indicates Contrrefno"
        },
        "paymentstatus":{
            "type":"string",
            "description":"Indicates Paymentstatus"
        },
        "amtblkrmks":{
            "type":"string",
            "description":"Indicates Amtblkrmks"
        },
        "prepaymentPenaltyAmount":{
            "type":"number",
            "description":"Indicates PrepaymentPenaltyAmount"
        },
        "prepaymentpenaltyrate":{
            "type":"number",
            "description":"Indicates Prepaymentpenaltyrate"
        },
        "showDet":{
            "type":"string",
            "description":"Indicates ShowDet"
        },
        "oltbsContractLiqPmtList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OltbsContractLiqPmtDto"
            }
        },
        "oltbsContractOvdList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OltbsContractOvdDto"
            }
        }
    }
}

Nested Schema : oltbsContractLiqPmtList

Type: array

Show Source

• Array of: object OltbsContractLiqPmtDto

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

Nested Schema : oltbsContractOvdList

Type: array

Show Source

• Array of: object OltbsContractOvdDto

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

Nested Schema : OltbsContractLiqPmtDto

Type: object

Show Source

• amountdue(optional): number
  Indicates Amountdue
• amountpaid(optional): number
  Indicates Amountpaid
• amountTagg(optional): string
  Indicates AmountTagg
• contractrefno(optional): string
  Indicates Contractrefno
• eventseqno(optional): number
  Indicates Eventseqno
• odDays(optional): number
  Indicates OdDays
• taxpaid(optional): number
  Indicates Taxpaid

{
    "type":"object",
    "properties":{
        "taxpaid":{
            "type":"number",
            "description":"Indicates Taxpaid"
        },
        "odDays":{
            "type":"number",
            "description":"Indicates OdDays"
        },
        "amountpaid":{
            "type":"number",
            "description":"Indicates Amountpaid"
        },
        "amountdue":{
            "type":"number",
            "description":"Indicates Amountdue"
        },
        "amountTagg":{
            "type":"string",
            "description":"Indicates AmountTagg"
        },
        "eventseqno":{
            "type":"number",
            "description":"Indicates Eventseqno"
        },
        "contractrefno":{
            "type":"string",
            "description":"Indicates Contractrefno"
        }
    }
}

Nested Schema : OltbsContractOvdDto

Type: object

Show Source

• acstatus(optional): string
  Indicates Acstatus
• authdtstamp(optional): string
  Indicates Authdtstamp
• checker(optional): string
  Indicates Checker
• confirmed(optional): string
  Indicates Confirmed
• contractrefno(optional): string
  Indicates Contractrefno
• errcode(optional): string
  Indicates Errcode
• errmsg(optional): string
  Indicates Errmsg
• eventseqno(optional): number
  Indicates Eventseqno
• module(optional): string
  Indicates Module
• onlineauthid(optional): string
  Indicates Onlineauthid
• ovdseqno(optional): number
  Indicates Ovdseqno
• ovdstatus(optional): string
  Indicates Ovdstatus
• ovdtype(optional): string
  Indicates Ovdtype
• parameters(optional): string
  Indicates Parameters
• remarks(optional): string
  Indicates Remarks
• txtstatus(optional): string
  Indicates Txtstatus

{
    "type":"object",
    "properties":{
        "ovdtype":{
            "type":"string",
            "description":"Indicates Ovdtype"
        },
        "confirmed":{
            "type":"string",
            "description":"Indicates Confirmed"
        },
        "ovdstatus":{
            "type":"string",
            "description":"Indicates Ovdstatus"
        },
        "txtstatus":{
            "type":"string",
            "description":"Indicates Txtstatus"
        },
        "authdtstamp":{
            "type":"string",
            "description":"Indicates Authdtstamp"
        },
        "checker":{
            "type":"string",
            "description":"Indicates Checker"
        },
        "remarks":{
            "type":"string",
            "description":"Indicates Remarks"
        },
        "onlineauthid":{
            "type":"string",
            "description":"Indicates Onlineauthid"
        },
        "parameters":{
            "type":"string",
            "description":"Indicates Parameters"
        },
        "errcode":{
            "type":"string",
            "description":"Indicates Errcode"
        },
        "module":{
            "type":"string",
            "description":"Indicates Module"
        },
        "ovdseqno":{
            "type":"number",
            "description":"Indicates Ovdseqno"
        },
        "eventseqno":{
            "type":"number",
            "description":"Indicates Eventseqno"
        },
        "contractrefno":{
            "type":"string",
            "description":"Indicates Contractrefno"
        },
        "acstatus":{
            "type":"string",
            "description":"Indicates Acstatus"
        },
        "errmsg":{
            "type":"string",
            "description":"Indicates Errmsg"
        }
    }
}

Nested Schema : ERROR

Type: array

Show Source

• Array of: object FCUBSError

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

Nested Schema : FCUBSError

Type: object

Show Source

• ECODE(optional): string
• EDESC(optional): string

{
    "type":"object",
    "properties":{
        "ECODE":{
            "type":"string"
        },
        "EDESC":{
            "type":"string"
        }
    }
}

Nested Schema : WARNING

Type: array

Show Source

• Array of: object FCUBSWarn

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

Nested Schema : FCUBSWarn

Type: object

Show Source

• WCODE(optional): string
• WDESC(optional): string

{
    "type":"object",
    "properties":{
        "WCODE":{
            "type":"string"
        },
        "WDESC":{
            "type":"string"
        }
    }
}

201 Response

CreateExResponse Successfully Performed

400 Response

Failed while processing request

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top