Rest API for Oracle Banking Cash Management

Captures success response of payment

post

/service/v1/updatePaymentResponse

This service is used to capturing success response of payment.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string

Application Id
authToken: string

Authorization Token
branchCode(required): string

Branch Code
branchDate: string(date-time)

Branch Date
contentType: string

Content Type
tenantId: string

Tenant Id
userId(required): string

User id for SMS

Request Body that contains data required for updateExternalSystemResponse

Root Schema : ExtSystemPaymentModelCollection

Type: object

List of External system response Payment model

Show Source

extSystemResponseModel: array extSystemResponseModel

{
    "description":"List of External system response Payment model",
    "type":"object",
    "properties":{
        "extSystemResponseModel":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExtSystemResponsePaymentModel"
            }
        }
    }
}

Nested Schema : extSystemResponseModel

Type: array

Show Source

Array of: object ExtSystemResponsePaymentModel

External system pay request model

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

Nested Schema : ExtSystemResponsePaymentModel

Type: object

External system pay request model

Show Source

accountNumber: string

accountNumber
clearingRefNo: string

clearingRefNo
extPaymentErrorCode: string

extPaymentErrorCode
paymentRefNo: string

paymentRefNo
paymentStatus: string

paymentStatus
referenceNo: string

referenceNo
seqNo: string

seqNo
txnReferenceNo: string

txnReferenceNo

{
    "description":"External system pay request model",
    "type":"object",
    "properties":{
        "referenceNo":{
            "description":"referenceNo",
            "type":"string"
        },
        "txnReferenceNo":{
            "description":"txnReferenceNo",
            "type":"string"
        },
        "seqNo":{
            "description":"seqNo",
            "type":"string"
        },
        "accountNumber":{
            "description":"accountNumber",
            "type":"string"
        },
        "clearingRefNo":{
            "description":"clearingRefNo",
            "type":"string"
        },
        "paymentStatus":{
            "description":"paymentStatus",
            "type":"string"
        },
        "paymentRefNo":{
            "description":"paymentRefNo",
            "type":"string"
        },
        "extPaymentErrorCode":{
            "description":"extPaymentErrorCode",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Successful performs the operation

Root Schema : ExtSystemResponseModelCollection

Type: object

List of External system response from accounting model

Show Source

errorCode: string

errorCode
errorDesc: string

errorDesc
extSystemResponseModel: array extSystemResponseModel
status: string

status

{
    "description":"List of External system response from accounting model",
    "type":"object",
    "properties":{
        "status":{
            "description":"status",
            "type":"string"
        },
        "errorCode":{
            "description":"errorCode",
            "type":"string"
        },
        "errorDesc":{
            "description":"errorDesc",
            "type":"string"
        },
        "extSystemResponseModel":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExtSystemResponseModel"
            }
        }
    }
}

Nested Schema : extSystemResponseModel

Type: array

Show Source

Array of: object ExtSystemResponseModel

External system accounting response model

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

Nested Schema : ExtSystemResponseModel

Type: object

External system accounting response model

Show Source

errorCode: string

errorCode
errorDesc: string

errorDesc
referenceNo: string

referenceNo
status: string

status
txnReferenceNo: string

txnReferenceNo

{
    "description":"External system accounting response model",
    "type":"object",
    "properties":{
        "referenceNo":{
            "description":"referenceNo",
            "type":"string"
        },
        "txnReferenceNo":{
            "description":"txnReferenceNo",
            "type":"string"
        },
        "status":{
            "description":"status",
            "type":"string"
        },
        "errorCode":{
            "description":"errorCode",
            "type":"string"
        },
        "errorDesc":{
            "description":"errorDesc",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error