API Reference/Lender APIs/Onboarding Suite

PSB Xchange Lender Onboarding Suite

Complete suite of APIs for Lenders to manage Program Leads, Channel Partner Leads, and Partnerships on the PSB Xchange Digital Supply Chain Financing Platform.

This document will provide schemas for APIs exposed by PSB Xchange Platform for any Lender Integration. Please find the Key Terminologies before you proceed ahead with PSB Xchange API Integrations:

Category	Details
Applicable Products	Dealer Finance (DF), Vendor Finance (VF), Sales Invoice Discounting (SID), Purchase Invoice Discounting (PID), Factoring (FACT), Reverse Factoring (REVFACT)
Different Types of Lead Possible	Program Lead (PGL), Channel Partner Lead (CPL)
What is a Program Lead?	For any Anchor Led Financing or Non Anchor Financing facility a Program needs to be setup on the Anchor/Corporate. In Anchor Led Financing (Dealer Finance / Vendor Finance), the program governs broad criterias to onboard Channel Partners (associated with the Program). In Non Anchor Led Financing, the program created is actually the limit/facility setup on the Corporate.
What is a Channel Partner Lead?	Channel Partner Lead is used to refer to Leads of Dealers / Distributors / Suppliers associated with a Program (Dealer Finance / Vendor Finance).
Applicable Products for Program Lead (PGL)	Dealer Finance (DF), Vendor Finance (VF), Sales Invoice Discounting (SID), Purchase Invoice Discounting (PID), Factoring (FACT), Reverse Factoring (REVFACT)
Applicable Products for Channel Partner Lead (CPL)	Dealer Finance (DF), Vendor Finance (VF)

PSB Xchange Platform <> Lender LOS Integrations Touchpoints

Program Lead: https://bit.ly/3CMAWIV
Channel Partner Lead: https://bit.ly/3ZrGCki

API Overview

This contains all the details of APIs required by Lender to perform the following actions on PSB Xchange Platform:

APIs for Program Lead (PGL)

Action	Description	API Name
Submit an Offer for Program Lead	This API is used to submit an offer for a Program Lead (which is in Offer Awaited stage for Lender) on PSB Xchange Platform	Submit Program Offer API
Activate Program for Program Lead	This API is used to activate a Program (for a Lead which is in Offer Accepted Stage) on PSB Xchange Platform.	Activate Program API
Update Program Details for an Active Program	This API is used to update the Program details for an Active Program on PSB Xchange Platform.	Update Program Details API
De-Activate a Program	This API is used to De-Activate an Active Program on PSB Xchange Platform.	De-Activate Program API
Get Additional Lead Data	This API is used to get Additional Data for a Program Lead on PSB Xchange Platform. A Lender can access Additional Details (pertaining to the Lead) only post providing expression of interest for the Lead (through APIs / Manually on Platform)	Additional Details API
Submit Expression of Interest for a Lead	This API is used by the Lender to Submit Expression of Interest (EOI) (Refer Platform T&C to understand the implications of accepting EOI for a Lead) for a Program Lead on PSB Xchange Lead.	Submit EOI API
Get Lead Status	This API is used by the Lender to get the status of the Program Lead on PSB Xchange Platform	Get Lead Status API

APIs for Channel Partner Lead (CPL)

Action	Description	API Name
Submit an Offer for Channel Partner Lead	This API is used to submit an offer for a Channel Partner Lead (which is in Offer Awaited stage for Lender) on PSB Xchange Platform	Submit Channel Partner Offer API
Activate Channel Partner for Channel Partner Lead	This API is used to activate a Channel Partner (for a Lead which is in Offer Accepted Stage) on PSB Xchange Platform.	Activate Channel Partner Mapping API
Update Channel Partner Mapping Details for an Active Program	This API is used to update the Channel Partner Mapping details for an Active Channel Partner Mapping on PSB Xchange Platform.	Update Channel Partner Mapping API
De-Activate an Active Channel Partner Mapping	This API is used to De-Activate an Active Channel Partner Mapping on PSB Xchange Platform.	De-Activate Channel Partner Mapping API
Get Additional Lead Data	This API is used to get Additional Data for a Channel Partner Lead on PSB Xchange Platform. A Lender can access Additional Details (pertaining to the Lead) only post providing expression of interest for the Lead (through APIs / Manually on Platform)	Additional Details API
Submit Expression of Interest for a Channel Partner Lead	This API is used by the Lender to Submit Expression of Interest (EOI) (Refer Platform T&C to understand the implications of accepting EOI for a Lead) for a Channel Partner Lead on PSB Xchange Lead.	Submit EOI API
Get Lead Status	This API is used by the Lender to get the status of the Channel Partner Lead on PSB Xchange Platform	Get Lead Status API

Other APIs

API Name	Description
Get Partnership Details	This allows the Lender to get the details of All/Active/Inactive partnerships between the Lenders & Sourcing Partners on the PSB Xchange Platform
Get Channel Partner Details for a Program	This allows the Lender to get the details of All Channel Partners mapped to a particular program on PSB Xchange Platform
Get Additional Sourcing Partner	This allows the Lender to get the details of all sourcing partners onboarded on the PSB Xchange Platform but not partnered with the Lender

Master Reference Values

View the complete set of master values required for PSB Xchange API integrations including Lead Types, Product Codes, Constitution Types, Credit Ratings, Industry Classifications, and more.

View All Masters

Program Lead APIs

APIs for Lenders to manage Program Leads on the PSB Xchange platform — from submitting offers to activating and managing programs.

POST

Submit Program Offer API

/api/lender/offer

POST

Activate Program API

/api/lender/offer

POST

Update Program Details API

/api/lender/offer

POST

De-Activate Program API

/api/lender/offer

POST

Additional Details API

/api/lender/additional-details

POST

Submit EOI API

/v2/api/lender/offer

POST

Get Lead Status API

/v2/api/get-lender-status

POST

Lead Status Callback

{{customerCallbackURI}}

Channel Partner Lead APIs

APIs for Lenders to manage Channel Partner Leads on the PSB Xchange platform — from submitting offers to activating and managing channel partner mappings.

POST

Submit Channel Partner Offer API

/v2/api/lender/cp-offer

POST

Activate Channel Partner Mapping API

/v2/api/lender/cp-offer

POST

Update Channel Partner Mapping API

/v2/api/lender/cp-offer

POST

De-Activate Channel Partner Mapping API

/v2/api/lender/cp-offer

POST

Additional Details API

/api/lender/additional-details

POST

Submit EOI API

/v2/api/lender/cp-offer

POST

Get Lead Status API

/v2/api/get-lender-status

POST

Lead Status Callback

{{customerCallbackURI}}

Other APIs

Additional utility APIs for Lenders to manage partnerships, channel partner details, and sourcing partner information on the PSB Xchange platform.

POST

Get Sourcing Partner Partnership Details API

/v2/api/lender/partnership-details

POST

Get Channel Partner Details for a Program API

/v2/api/lender/channel-partner-details

POST

Get Remaining Sourcing Partner Details API

/v2/api/lender/remaining-sourcing-partner-details