Jump to

• Request
• Response

Update an Existing Offer Status

put

/obcr-Settlement-services/settlementDetails/updateStatus

This endpoint is used to Update an existing settlement status of an offer.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId(required): string
  Application identifier for identification.
• branchCode(required): string
  Branch code of the user or request origin.
• contentType: string
  Content type of the request payload.
• userId(required): string
  User identifier for authentication and authorization.

Body ()

This is the payload for saving settlement offer related details

Root Schema : OfferStatusUpdateDto

Type: object

Settlement Offer Update

Show Source

• accountId: string
  Account ID
• caseId: string
  Case ID
• offerId: string
  Offer ID
• promiseAmount: number
  Settlement Amount
• promiseDate: string
  Last Date for settlement
• ptpCreatedBy: string
  User Id of valid user who can create the promise
• ptpTypeCode: string
  PTP Type Code
• settlementStatusCode: string
  Settlement Status Code
• taskId: string
  Task Id
• taskTypeCd: string
  Task Type Code

{
    "description":"Settlement Offer Update",
    "type":"object",
    "properties":{
        "offerId":{
            "type":"string",
            "description":"Offer ID"
        },
        "accountId":{
            "type":"string",
            "description":"Account ID"
        },
        "settlementStatusCode":{
            "type":"string",
            "description":"Settlement Status Code"
        },
        "taskId":{
            "type":"string",
            "description":"Task Id"
        },
        "ptpTypeCode":{
            "type":"string",
            "description":"PTP Type Code"
        },
        "promiseAmount":{
            "type":"number",
            "description":"Settlement Amount"
        },
        "promiseDate":{
            "type":"string",
            "description":"Last Date for settlement"
        },
        "taskTypeCd":{
            "type":"string",
            "description":"Task Type Code"
        },
        "caseId":{
            "type":"string",
            "description":"Case ID"
        },
        "ptpCreatedBy":{
            "type":"string",
            "description":"User Id of valid user who can create the promise"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated Promise to Pay Type.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: object ResponseResourceSupport
• messages: object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes: array codes
• id: string
• requestId: string
• status: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

• arg: string
• args: array args
• Code: string
• Desc: string
• Language: string
• Type: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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