Jump to

• Request
• Response

Update external system response status

post

/service/v1/updateExternalSystemResponse

This endpoint is used to update external system response status.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  Application Id
• branchCode: string
  Branch Code
• userId: string
  User Id

Body ()

Request Body that contains response status for external systems

Root Schema : ExternalSystemResponseStatus

Type: object

Request body to update external system response

Show Source

• accountList(optional): array accountList
  External System Response Model
• referenceNo(optional): string
  Transaction Reference Number
• seqNo(optional): integer(int64)
  Sequence Number
• txnReferenceNo(optional): string
  Transaction Reference Number

{
    "description":"Request body to update external system response",
    "type":"object",
    "properties":{
        "referenceNo":{
            "description":"Transaction Reference Number",
            "type":"string"
        },
        "seqNo":{
            "description":"Sequence Number",
            "type":"integer",
            "format":"int64"
        },
        "txnReferenceNo":{
            "description":"Transaction Reference Number",
            "type":"string"
        },
        "accountList":{
            "description":"External System Response Model",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExternalSystemResponseStatusModel"
            }
        }
    }
}

Nested Schema : accountList

Type: array

External System Response Model

Show Source

• Array of: object ExternalSystemResponseStatusModel
  Request body to update external system response

{
    "description":"External System Response Model",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ExternalSystemResponseStatusModel"
    }
}

Nested Schema : ExternalSystemResponseStatusModel

Type: object

Request body to update external system response

Show Source

• accountNumber(optional): string
  Account Number
• blkRefNo(optional): string
  Block Reference Number
• clearingRefNo(optional): string
  Clearing Reference Number
• ecaErrorCode(optional): string
  ECA Error Codes
• ecaRefNo(optional): string
  ECA Reference Number
• ecaStatus(optional): string
  ECA Status
• extPaymentErrorCode(optional): string
  External Payment Error Codes
• paymentRefNo(optional): string
  Payment Reference Number
• paymentStatus(optional): string
  Payment Status
• postingErrorCode(optional): string
  Posting Error Codes
• postingRefNo(optional): string
  Posting Reference Number
• postingStatus(optional): string
  Posting Status
• vamPostingStatus(optional): string
  VAM Posting Status
• vamReferenceNumber(optional): string
  VAM Reference Number

{
    "description":"Request body to update external system response",
    "type":"object",
    "properties":{
        "accountNumber":{
            "description":"Account Number",
            "type":"string"
        },
        "ecaStatus":{
            "description":"ECA Status",
            "type":"string"
        },
        "ecaRefNo":{
            "description":"ECA Reference Number",
            "type":"string"
        },
        "blkRefNo":{
            "description":"Block Reference Number",
            "type":"string"
        },
        "ecaErrorCode":{
            "description":"ECA Error Codes",
            "type":"string"
        },
        "postingStatus":{
            "description":"Posting Status",
            "type":"string"
        },
        "postingRefNo":{
            "description":"Posting Reference Number",
            "type":"string"
        },
        "postingErrorCode":{
            "description":"Posting Error Codes",
            "type":"string"
        },
        "vamPostingStatus":{
            "description":"VAM Posting Status",
            "type":"string"
        },
        "vamReferenceNumber":{
            "description":"VAM Reference Number",
            "type":"string"
        },
        "clearingRefNo":{
            "description":"Clearing Reference Number",
            "type":"string"
        },
        "paymentStatus":{
            "description":"Payment Status",
            "type":"string"
        },
        "paymentRefNo":{
            "description":"Payment Reference Number",
            "type":"string"
        },
        "extPaymentErrorCode":{
            "description":"External Payment Error Codes",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Body ()

Root Schema : ExternalSystemStatusUpdateResponse

Type: object

External Syatem Status Update Response

Show Source

• eventCode(optional): string
  Event Code
• status(optional): string
  Status

{
    "description":"External Syatem Status Update Response",
    "type":"object",
    "properties":{
        "status":{
            "description":"Status",
            "type":"string"
        },
        "eventCode":{
            "description":"Event Code",
            "type":"string"
        }
    }
}

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