PUT api/LoanApplication/Amend

Amend loan application

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RateCardProductId	globally unique identifier	None.
RateCardProductCode	string	None.
Price	decimal number	None.
Deposit	decimal number	None.
ReturnDocumentsForSign	ReturnDocumentsEnum	None.
LoanApplicationId	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "RateCardProductId": "c748355d-3445-40e1-b306-0131ee42549e",
  "RateCardProductCode": "sample string 1",
  "Price": 2.0,
  "Deposit": 3.0,
  "ReturnDocumentsForSign": 1,
  "LoanApplicationId": "3f9f0de7-9739-49a3-bc1e-2dc7f2e16fc5"
}

text/html

Sample:

{"RateCardProductId":"c748355d-3445-40e1-b306-0131ee42549e","RateCardProductCode":"sample string 1","Price":2.0,"Deposit":3.0,"ReturnDocumentsForSign":1,"LoanApplicationId":"3f9f0de7-9739-49a3-bc1e-2dc7f2e16fc5"}

application/xml, text/xml

Sample:

<AmendLoanApplicationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIRequests.CreditCheckRequestModels">
  <LoanApplicationId xmlns="http://schemas.datacontract.org/2004/07/OmniPort.ViewModel">3f9f0de7-9739-49a3-bc1e-2dc7f2e16fc5</LoanApplicationId>
  <Deposit>3</Deposit>
  <Price>2</Price>
  <RateCardProductCode>sample string 1</RateCardProductCode>
  <RateCardProductId>c748355d-3445-40e1-b306-0131ee42549e</RateCardProductId>
  <ReturnDocumentsForSign>NoDocuments</ReturnDocumentsForSign>
</AmendLoanApplicationModel>

Response Information

Resource Description

Possible error responses: 1. Invalid input fields - {"errors": {"invalidFieldName": ["Error message containing more details about the failure."], "invalidFieldName2": ["Error message containing more details about the failure."]}} 2. Error on validation bank details /Experian/ - {"LoanApplicationId" : "Id", "ErrorMessage" : "Error message from Experian"}

UpdateCustomerBankDetailsResponse

Name	Type	Additional information
LoanApplicationId	globally unique identifier	None.
CreditCheckId	globally unique identifier	None.
Status	string	None.
StatusNumber	integer	None.
Documents	Dictionary of string [key] and string [value]	None.
DocumentsFormat	DocumentFormatEnum	None.
SignDocumentsUrl	string	None.
LoanReferenceNumber	string	None.
CreditCheckStatus	string	None.
CreditCheckStatusNumber	integer	None.
Info	string	None.
UpperAmendValue	decimal number	None.
InitialFinanceOfferDetails	FinanceOfferDetails	None.
NewFinanceOfferDetails	FinanceOfferDetails	None.

Response Formats

application/json, text/json

Sample:

{
  "LoanApplicationId": "b5d24b58-d726-4d53-9bf1-3bb58252ede3",
  "CreditCheckId": "cae96826-266b-4eff-878d-f8a247d0fc79",
  "Status": "sample string 2",
  "StatusNumber": 3,
  "Documents": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "DocumentsFormat": 1,
  "SignDocumentsUrl": "sample string 4",
  "LoanReferenceNumber": "sample string 5",
  "CreditCheckStatus": "sample string 6",
  "CreditCheckStatusNumber": 7,
  "Info": "sample string 8",
  "UpperAmendValue": 1.0,
  "InitialFinanceOfferDetails": {
    "FirstPayment": 1.0,
    "MonthlyPayment": 2.0,
    "MonthlyInterestRate": 3.1,
    "APR": 4.1,
    "TotalInterestPayable": 5.0,
    "ProductCode": "sample string 6"
  },
  "NewFinanceOfferDetails": {
    "FirstPayment": 1.0,
    "MonthlyPayment": 2.0,
    "MonthlyInterestRate": 3.1,
    "APR": 4.1,
    "TotalInterestPayable": 5.0,
    "ProductCode": "sample string 6"
  }
}

text/html

Sample:

{"LoanApplicationId":"b5d24b58-d726-4d53-9bf1-3bb58252ede3","CreditCheckId":"cae96826-266b-4eff-878d-f8a247d0fc79","Status":"sample string 2","StatusNumber":3,"Documents":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"DocumentsFormat":1,"SignDocumentsUrl":"sample string 4","LoanReferenceNumber":"sample string 5","CreditCheckStatus":"sample string 6","CreditCheckStatusNumber":7,"Info":"sample string 8","UpperAmendValue":1.0,"InitialFinanceOfferDetails":{"FirstPayment":1.0,"MonthlyPayment":2.0,"MonthlyInterestRate":3.1,"APR":4.1,"TotalInterestPayable":5.0,"ProductCode":"sample string 6"},"NewFinanceOfferDetails":{"FirstPayment":1.0,"MonthlyPayment":2.0,"MonthlyInterestRate":3.1,"APR":4.1,"TotalInterestPayable":5.0,"ProductCode":"sample string 6"}}

application/xml, text/xml

Sample:

<UpdateCustomerBankDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses.CreditCheckResponses">
  <CreditCheckId>cae96826-266b-4eff-878d-f8a247d0fc79</CreditCheckId>
  <CreditCheckStatus>sample string 6</CreditCheckStatus>
  <CreditCheckStatusNumber>7</CreditCheckStatusNumber>
  <Documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Documents>
  <DocumentsFormat>PDF</DocumentsFormat>
  <Info>sample string 8</Info>
  <InitialFinanceOfferDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">
    <d2p1:APR>4.1</d2p1:APR>
    <d2p1:FirstPayment>1</d2p1:FirstPayment>
    <d2p1:MonthlyInterestRate>3.1</d2p1:MonthlyInterestRate>
    <d2p1:MonthlyPayment>2</d2p1:MonthlyPayment>
    <d2p1:ProductCode>sample string 6</d2p1:ProductCode>
    <d2p1:TotalInterestPayable>5</d2p1:TotalInterestPayable>
  </InitialFinanceOfferDetails>
  <LoanApplicationId>b5d24b58-d726-4d53-9bf1-3bb58252ede3</LoanApplicationId>
  <LoanReferenceNumber>sample string 5</LoanReferenceNumber>
  <NewFinanceOfferDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">
    <d2p1:APR>4.1</d2p1:APR>
    <d2p1:FirstPayment>1</d2p1:FirstPayment>
    <d2p1:MonthlyInterestRate>3.1</d2p1:MonthlyInterestRate>
    <d2p1:MonthlyPayment>2</d2p1:MonthlyPayment>
    <d2p1:ProductCode>sample string 6</d2p1:ProductCode>
    <d2p1:TotalInterestPayable>5</d2p1:TotalInterestPayable>
  </NewFinanceOfferDetails>
  <SignDocumentsUrl>sample string 4</SignDocumentsUrl>
  <Status>sample string 2</Status>
  <StatusNumber>3</StatusNumber>
  <UpperAmendValue>1</UpperAmendValue>
</UpdateCustomerBankDetailsResponse>