Jump to

• Request
• Response

Status update for margin processing

put

/obscfcm-instruments-receivables-services/web/v1/invoiceMargin/statusUpdate

This endpoint is used to update the status for margin processing.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
• branchCode: string
• userId: string
  user id for SMS

Body ()

Request Body that contains data required for updating margin.

Root Schema : MarginRefundDTOModel

Type: object

MarginRefundDTOModel

Show Source

• clearingRefNo(optional): string
  clearingRefNo
• marginRefNo(optional): string
  marginRefNo

{
    "description":"MarginRefundDTOModel",
    "properties":{
        "marginRefNo":{
            "description":"marginRefNo",
            "type":"string"
        },
        "clearingRefNo":{
            "description":"clearingRefNo",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns status update response

Body ()

Root Schema : schema

Type: object

400 Response

Bad Request

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Response DTO Wrapper

Show Source

• data(optional): object ResponseResourceSupport
  Response Resource Support
• messages(optional): object ResponseDto
  Response DTO

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

Nested Schema : ResponseResourceSupport

Type: object

Response Resource Support

Nested Schema : ResponseDto

Type: object

Response DTO

Show Source

• codes(optional): array codes
  Codes
• id(optional): string
  ID
• requestId(optional): string
  Request ID
• status(optional): string
  Status

{
    "description":"Response DTO",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "codes":{
            "type":"array",
            "description":"Codes",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"Request ID"
        }
    }
}

Nested Schema : codes

Type: array

Codes

Show Source

• Array of: object ResponseCode
  Response Code

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

Nested Schema : ResponseCode

Type: object

Response Code

Show Source

• arg(optional): string
  Arg
• args(optional): array args
  Args
• Code(optional): string
  Code
• Desc(optional): string
  Description
• Language(optional): string
  Language
• Type(optional): string
  Type

{
    "description":"Response Code",
    "type":"object",
    "properties":{
        "Code":{
            "type":"string",
            "description":"Code"
        },
        "Desc":{
            "type":"string",
            "description":"Description"
        },
        "Type":{
            "type":"string",
            "description":"Type"
        },
        "Language":{
            "type":"string",
            "description":"Language"
        },
        "args":{
            "type":"array",
            "description":"Args",
            "items":{
                "type":"object",
                "description":"Items"
            }
        },
        "arg":{
            "type":"string",
            "description":"Arg"
        }
    }
}

Nested Schema : args

Type: array

Args

Show Source

• Array of: object items
  Items

{
    "type":"array",
    "description":"Args",
    "items":{
        "type":"object",
        "description":"Items"
    }
}

Nested Schema : items

Type: object

Items

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