Jump to

• Request
• Response

Notification API to be consumed by external payment integration to send instrument clearing status

post

/service/v1/clearingStatusNotification

This endpoint is a notification api to be consumed by external payment integration to send instrument clearing status.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  Application ID for SMS
• branchCode: string
  Branch Code for SMS
• contentType(optional): string
  Content of a file
• userId: string
  User ID for SMS

Body ()

Request Body that contains data required for notification api

Root Schema : ClgStatusNSRequestModel

Type: object

Outward clearing notification api request data

Show Source

• data(optional): array data

{
    "description":"Outward clearing notification api request data",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OutclgNSRequestModel"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object OutclgNSRequestModel
  Outward clearing notification request model

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

Nested Schema : OutclgNSRequestModel

Type: object

Outward clearing notification request model

Show Source

• clgTxnRefNo(optional): string
  Transaction reference No generated in OBPM for each instrument sent for clearing.
• instrumentNo(optional): string
  Instrument identification number
• instrumentStatus(optional): string
  Instrument Status
• networkCode(optional): string
  Network Code
• rejectReasonCode(optional): string
  Reason Code in case of reject
• valueDate(optional): string
  Value Date

{
    "description":"Outward clearing notification request model",
    "type":"object",
    "properties":{
        "clgTxnRefNo":{
            "type":"string",
            "description":"Transaction reference No generated in OBPM for each instrument sent for clearing."
        },
        "instrumentNo":{
            "type":"string",
            "description":"Instrument identification number"
        },
        "instrumentStatus":{
            "type":"string",
            "description":"Instrument Status"
        },
        "networkCode":{
            "type":"string",
            "description":"Network Code"
        },
        "valueDate":{
            "type":"string",
            "description":"Value Date"
        },
        "rejectReasonCode":{
            "type":"string",
            "description":"Reason Code in case of reject"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : ClgStatusNSResponseModel

Type: object

Outward clearing notification api response data

Show Source

• data(optional): array data

{
    "description":"Outward clearing notification api response data",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OutclgNSResponseModel"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object OutclgNSResponseModel
  Outward clearing notification response model

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

Nested Schema : OutclgNSResponseModel

Type: object

Outward clearing notification response model

Show Source

• msgStats(optional): string
  Message Status
• responses(optional): array responses
  Response Code List
• txnRefNo(optional): string
  Transaction Reference No

{
    "description":"Outward clearing notification response model",
    "type":"object",
    "properties":{
        "txnRefNo":{
            "type":"string",
            "description":"Transaction Reference No"
        },
        "msgStats":{
            "type":"string",
            "description":"Message Status"
        },
        "responses":{
            "type":"array",
            "description":"Response Code List",
            "items":{
                "$ref":"#/definitions/ResponseCodeModel"
            }
        }
    }
}

Nested Schema : responses

Type: array

Response Code List

Show Source

• Array of: object ResponseCodeModel
  Response Code model

{
    "type":"array",
    "description":"Response Code List",
    "items":{
        "$ref":"#/definitions/ResponseCodeModel"
    }
}

Nested Schema : ResponseCodeModel

Type: object

Response Code model

Show Source

• respCode(optional): string
  Response Code
• respDesc(optional): string
  Response Description

{
    "description":"Response Code model",
    "type":"object",
    "properties":{
        "respCode":{
            "type":"string",
            "description":"Response Code"
        },
        "respDesc":{
            "type":"string",
            "description":"Response Description"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top