Jump to

• Request
• Response

Calculate the Payment details through a Backoffice Service

post

/backoffice-services/backoffice/loans/payment/calculate

This operation calculates the loan payment details through a Backoffice Service.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• branchCode: string
  branch code from headers

Body ()

Request Body that contains data required for modifying loan through a backoffice services

Root Schema : String

Type: object

string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the loan details for the loan reference number

Body ()

Root Schema : QueryPaymentDTOWrapper

Type: object

Query Payment Dto Wrapper

Show Source

• data(optional): object QueryPaymentDTO
  PaymentDTO
• messages(optional): object ResponseDto
  ResponseDto model

{
    "description":"Query Payment Dto Wrapper",
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/QueryPaymentDTO"
        }
    }
}

Nested Schema : QueryPaymentDTO

Type: object

PaymentDTO

Show Source

• ComponentDetails(optional): object ComponentDetails
  ComponentDetails
• status(optional): string
  Status
• warningCode(optional): array warningCode
  WarningCodes

{
    "description":"PaymentDTO",
    "type":"object",
    "properties":{
        "warningCode":{
            "description":"WarningCodes",
            "type":"array",
            "items":{
                "$ref":"#/definitions/warningCode"
            }
        },
        "ComponentDetails":{
            "description":"Contract Details",
            "$ref":"#/definitions/ComponentDetails"
        },
        "status":{
            "description":"Status",
            "type":"string"
        }
    }
}

Nested Schema : ResponseDto

Type: object

ResponseDto model

Show Source

• codes(optional): string
  Codes
• httpStatusCode(optional): array httpStatusCode
  Schedule Details
• keyId(optional): string
  KeyId
• overrideAuthLevelsReqd(optional): string
  OverrideAuthLevelsReqd
• requestId(optional): string
  RequestId
• status(optional): string
  Status

{
    "description":"ResponseDto model",
    "properties":{
        "keyId":{
            "description":"KeyId",
            "type":"string"
        },
        "status":{
            "description":"Status",
            "type":"string"
        },
        "codes":{
            "description":"Codes",
            "type":"string"
        },
        "httpStatusCode":{
            "type":"array",
            "description":"Schedule Details",
            "items":{
                "$ref":"#/definitions/responseCodes"
            }
        },
        "overrideAuthLevelsReqd":{
            "description":"OverrideAuthLevelsReqd",
            "type":"string"
        },
        "requestId":{
            "description":"RequestId",
            "type":"string"
        }
    }
}

Nested Schema : ComponentDetails

Type: object

ComponentDetails

Show Source

• advance(optional): string
  Advance
• amountDue(optional): string
  Amount Due
• componentCurrency(optional): string
  Component Currency
• componentName(optional): string
  Component Name
• outStanding(optional): string
  Out Standing
• overDue(optional): string
  Over Due

{
    "description":"ComponentDetails",
    "type":"object",
    "properties":{
        "componentName":{
            "description":"Component Name",
            "type":"string"
        },
        "amountDue":{
            "description":"Amount Due",
            "type":"string"
        },
        "overDue":{
            "description":"Over Due",
            "type":"string"
        },
        "outStanding":{
            "description":"Out Standing",
            "type":"string"
        },
        "advance":{
            "description":"Advance",
            "type":"string"
        },
        "componentCurrency":{
            "description":"Component Currency",
            "type":"string"
        }
    }
}

Nested Schema : warningCode

Type: array

WarningCodes

Show Source

• Array of: object warningCode
  warningCode

{
    "description":"WarningCodes",
    "type":"array",
    "items":{
        "$ref":"#/definitions/warningCode"
    }
}

Nested Schema : warningCode

Type: object

warningCode

Show Source

• warningCode(optional): string
  Warning Code
• warningDesc(optional): string
  Warning Description

{
    "description":"warningCode",
    "type":"object",
    "properties":{
        "warningDesc":{
            "description":"Warning Description",
            "type":"string"
        },
        "warningCode":{
            "description":"Warning Code",
            "type":"string"
        }
    }
}

Nested Schema : httpStatusCode

Type: array

Schedule Details

Show Source

• Array of: object responseCodes
  ResponseCodes

{
    "type":"array",
    "description":"Schedule Details",
    "items":{
        "$ref":"#/definitions/responseCodes"
    }
}

Nested Schema : responseCodes

Type: object

ResponseCodes

Show Source

• code(optional): string
  Code
• desc(optional): string
  Description
• error(optional): string
  Error
• info(optional): string
  Info
• language(optional): string
  Language
• override(optional): string
  Override
• type(optional): string
  Type

{
    "description":"ResponseCodes",
    "type":"object",
    "properties":{
        "code":{
            "description":"Code",
            "type":"string"
        },
        "desc":{
            "description":"Description",
            "type":"string"
        },
        "type":{
            "description":"Type",
            "type":"string"
        },
        "language":{
            "description":"Language",
            "type":"string"
        },
        "error":{
            "description":"Error",
            "type":"string"
        },
        "override":{
            "description":"Override",
            "type":"string"
        },
        "info":{
            "description":"Info",
            "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