Jump to

• Request
• Response

Save settlement initiation details

post

/obcr-Settlement-services/settlementDetails/saveSettlementInitDetails

This endpoint is used to save account related details when the account is marked with a settlement collection status.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId(required): string
• branchCode(required): string
• contentType: string
• userId(required): string

Body ()

This is the payload for storing account related details when the account was marked in settlement collection status

Root Schema : SettlementInitDetailsDto

Type: object

Settlement Initiation Details

Show Source

• accountId: string
  Account ID
• interestAmt: number
  Interest Amount
• otherCharges: number
  Fees and Other Charges
• outstandingAmt: number
  Outstanding Amount
• principalAmt: number
  Principal Amount
• settlementInitDate: string
  Settlement Initiation Date

{
    "description":"Settlement Initiation Details",
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "description":"Account ID"
        },
        "outstandingAmt":{
            "type":"number",
            "description":"Outstanding Amount"
        },
        "principalAmt":{
            "type":"number",
            "description":"Principal Amount"
        },
        "interestAmt":{
            "type":"number",
            "description":"Interest Amount"
        },
        "otherCharges":{
            "type":"number",
            "description":"Fees and Other Charges"
        },
        "settlementInitDate":{
            "type":"string",
            "description":"Settlement Initiation Date"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the list of fact values.

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