Jump to

• Request
• Response

Record payment on an existing loan

patch

/loan/{sweepLogId}/recordRepayment

This endpoint is used to record the payment on an existing loan.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• sweepLogId: string
  Maximum Length: 20

  sweep log ID of the loan Maintenance

Body ()

Request Body that contains data required for creating a new loan

Root Schema : IclRepayLoanDTO

Type: object

Show Source

• borrowerAccountNumber(optional): string
  Loan borrower
• borrowerCurrency(optional): string
• checkForSettlement(optional): string
• days(optional): number
• endDate(optional): string
• interestMethod(optional): string
• interestPaidBC(optional): number
  Interest paid in Borrower currency
• interestPaidLC(optional): number
  Interest paid in Lender currency
• lenderAccountNumber(optional): string
  Loan lender
• lenderCurrency(optional): string
• paymentDate(optional): string
• principalPaidBC(optional): number
  Principal paid in Borrower currency
• principalPaidLC(optional): number
  Principal paid in Lender currency
• rate(optional): number
• repaymentSource(optional): string
• reverseSweepId(optional): string
• reverseSweepLogId(optional): string
• startDate(optional): string
• transactionReference(optional): string

{
    "type":"object",
    "properties":{
        "principalPaidLC":{
            "type":"number",
            "description":"Principal paid in Lender currency"
        },
        "interestPaidLC":{
            "type":"number",
            "description":"Interest paid in Lender currency"
        },
        "principalPaidBC":{
            "type":"number",
            "description":"Principal paid in Borrower currency"
        },
        "interestPaidBC":{
            "type":"number",
            "description":"Interest paid in Borrower currency"
        },
        "lenderCurrency":{
            "type":"string",
            "description":""
        },
        "borrowerCurrency":{
            "type":"string",
            "description":""
        },
        "paymentDate":{
            "type":"string",
            "description":""
        },
        "lenderAccountNumber":{
            "type":"string",
            "description":"Loan lender"
        },
        "borrowerAccountNumber":{
            "type":"string",
            "description":"Loan borrower"
        },
        "days":{
            "type":"number",
            "description":""
        },
        "endDate":{
            "type":"string",
            "description":""
        },
        "interestMethod":{
            "type":"string",
            "description":""
        },
        "rate":{
            "type":"number",
            "description":""
        },
        "startDate":{
            "type":"string",
            "description":""
        },
        "checkForSettlement":{
            "type":"string",
            "description":""
        },
        "repaymentSource":{
            "type":"string",
            "description":""
        },
        "reverseSweepId":{
            "type":"string",
            "description":""
        },
        "reverseSweepLogId":{
            "type":"string",
            "description":""
        },
        "transactionReference":{
            "type":"string",
            "description":""
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated loan

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): 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(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): 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(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): 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

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created loan

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): 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(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): 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(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): 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