experience-solictorinstructions-api icon

experience-solictorinstructions-api

2.0.x
(0 reviews)

API Type

  • Public Exposed Experience API

# Overview
- Provides Inbound and outbound API definitions for Loan Discharges.
The APIs will be used by Pepper and Solicitor entities to communicate information and actions regarding a Loan discharge.

This API is integrating Pepper and Solicitor systems

# Supported Protocols
- HTTPS

# Accepts
- application/json

# Responds With
- application/json
Lixi DAS 2.2.70

# Authentication
Basic Authentication

Endpoint Quick Reference

-/v2/discharge/instruction
Description - Issue Discharge instructions for a Loan to the Solicitor. Indicative Payout figure will be included in the instructions
Input :
Loan Number
Loan Variation Number
ConveyancerId
Outbound : Lixi DAS 2.2.70 schema
Functionality: Outbound (Pepper) --> Mule(tranform into lixi) --> Inbound (Solicitors)
This Endpoint should be only hit by Jackson.

-/v2/discharge/withdrawDischarge
Description- Used to withdraw a discharge instruction that has been sent previously from Pepper to the Solicitor. The loan will be returned from discharge pending to an active status in Pepper’s source system
Input:
LenderReferenceNumber
ConveyancerId
reason
Functionality: Outbound (Pepper) --> Mule --> Inbound (Solicitors)
This Endpoint should be only hit by Jackson.

-/v2/discharge/firmPayoutFigure
Description - Request a Firm payout figure and Book Settlement/Discharge Date. Loan will be moved from an active status to discharge pending.
Input :
Loan Number
Anticipated settlement date
SolicitorId- FMSAU, FMSNZ or GalileeAU
Functionality: Outbound (Solicitors) --> Mule --> Inbound (Pepper)

-/v2/discharge/indicativePayoutFigure
Description - Request an indicative payout.
Input :
LoanNumber
AnticipatedDischargeDate
SolicitorId- FMSAU, FMSNZ or GalileeAU
Functionality: Outbound (Solicitors) --> Mule --> Inbound (Pepper)

-/v2/discharge/cancelFirmPayoutFigure
Description - Used to return Loan back to active status from discharge pending andcancels the Firm Quotation
Input :
Loan Number
SolicitorId- FMSAU, FMSNZ or GalileeAU
Functionality: Outbound (Solicitors) --> Mule --> Inbound (Pepper)

-/v2/discharge/complete
Description - Confirmation that Discharge has been completed from Solicitor side. Will trigger final discharge manual and automated processes on Pepper side.
Input :
Loan Number
Amount Banked
Date Funds Banked ISO
Comment Details
SolicitorId- FMSAU, FMSNZ or GalileeAU
Functionality: Outbound (Solicitors) --> Mule --> Inbound (Pepper)

#Working of Instruct Discharge
This call contains discharge specific data with the intent to retrieve additional data to enrich and construct the payload to solicitor

resources/image-3c0c0a04-67c0-4a78-b976-5266d51e653d.png

# Sequence Diagram for this API_
resources/image-20eaf94d-ee4d-439f-8aa7-fea83e508c2f.png

# Status Response Codes

  • 200: OK
  • 201: Created (for POST and PATCH method)
  • 400: Bad Request - Check whether your request body or request headers if matched to the specification
  • 401: Unauthorized - Check whether your credentials are correct
  • 404: Resource Not Found - Check if you have correct resource URI
  • 405: Method Not Allowed - Check if you have valid methods for the resource
  • 408: Request Timeout - The API could be still processing your request, try to adjust connection timeout
  • 500: Unexpected Server Error - If this issue persists, contact support for troubleshooting
  • 503: Service Unavailable - Server is handling too many request at this moment. try again later or reach out to support if issue persists
  • 504: Gateway Timeout - There might be a problem with the load-balancer, reach out to support if issue persists

# Contact

Rutuja Matade - Rmatade@pepper.com.au
Sabeena Chelat - schelat@pepper.com.au

Reviews