Prepare to invest in new opportunity

  • APIs
  • Create a Credit Request

Create a Credit Request

The Create Credit Request API creates HP Financial Service Credit Request and returns Credit Decision within seconds.

Our Automated Credit Scoring Engine is utilized to provide fast high precision decisions.

Quick Start

URL


Authenication


HP Security Certificate is required and it is supplied on demand

See this API for yourself - select one of our examples below to prepopulate the values below.
Input Parameters
Name Type Value
CreditHeaderDetails
 Object
ClientProgramId
 String
SourceEntryPerson
 Object
Email
 String
CustomerDetails
Object
CustomerLegalName
 string
CustomerAddress
 Object
Name Type Value
AddressLine1
 string
City
 String
CountryCodeIso2
 String
DNBNumber
 string
DirectCustomer
 bool
CreditRequest
 Object
HardwareAmount
 decimal
PrinterAmount
 decimal
SoftwareAmount
 decimal
ServicesAmount
 decimal
RequestAmountCurrency
 decimal
Comments
 string
submit


Making API Request...
Output
Credit Request Id Credit Application Id Status Comments
This is the raw JSON response view
This is the raw JSON request view
This is the raw XML response view
This is the raw XML request view
Parameters

This API accepts the following parameters:

Name Type Description
CreditHeaderDetails
 Object
TransmissionId
 string Unique transaction id supplied by the calling service client
ClientProgramId
 String Unique client calling source application name -provided by HPFS
PartnerId
 String Unique Partner ID provided by HPFS
LanguageCode
 String ISO2 Language used to identify Language of the validation messages send to calling client
DistributorId
 String Unique Distributor ID provided by HPFS
ClientAuthenticationKey
 String Unique Client Authentication key provided by HFS(not utilized at the moment)
SourceEntryPerson
 Object
FirstName
 string Source entry person first name
LastName
 String Source entry person last name
Email
 String Source entry person e-mail
Phone
 String Source entry person phone
CustomerDetails
Object
CustomerLegalName *
 string Legal Customer Name
CustomerAddress
 Object
Name Type Description
AddressLine1 *
 string Customer Address Line1
AddressLine2
 String Customer Address Line2
City *
 String Customer Address City
StateCode
 String Customer Address State code - mandatory in certain countries
PostalCode
 String Customer Postal Code - mandatory in certain countries
CountryCodeIso2 *
 String Customer Country Address ISO2
Phone
 string Customer Phone Number
CustomerTaxOrRegistrationID
 string Customer unique Tax ID or Registration Number
HpfsCustomerNumber
 string Unique HPFS Customer Number
DNBNumber
 string Unique Dun and Bradstreet customer ID
SICCode
 int Unique Customer Standard Industrial Classification
NAICCode
 int Unique Customer North America Industry Classification System
NumberOfEmployees
 int Customer number of employee
DirectCustomer *
 bool Indicates Wheether the request is submitted by a customer directly or not
Equipment
Object
Name Type Description
InstallLocation
 Object
Name Type Description
Address
 Object
Name Type Description
AddressLine1 *
 string Installation Address Line1
AddressLine2
 String Installation Address Line2
City
 String Installation Address City
StateCode
 String Installation Address State code - mandatory in certain countries
PostalCode
 String Installation Postal Code - mandatory in certain countries
CountryCodeIso2 *
 String Installation Country Address ISO2
CreditRequest
 Object
HardwareAmount
 decimal Hardware Amount
PrinterAmount
 decimal Printer Amount
SoftwareAmount
 decimal Software Amount
ServicesAmount
 decimal Services and others Amount
TotalRequestAmount *
 decimal Credit request total amount
RequestAmountCurrency *
 decimal Request currency ISO3
Comments
 string Additional comments - will be provided to HPFS Credit Analyst
JSON Request Model Schema
This is a JSON schema that describes the syntax of the request. 
                                            
{
	"CreditHeaderDetails":{
		"TransmissionId":"String content",
		"ClientProgramId":"String content",
		"PartnerId":"String content",
		"DistributorId":"String content",
		"ClientAuthenticationKey":"String content",
		"LanguageCode":"String content",
		"Validation":[{
			"ValidationId":"String content",
			"ValidationText":"String content"
		}]
	},
	"SourceEntryPerson":{
		"FirstName":"String content",
		"LastName":"String content",
		"Email":"String content",
		"Phone":"String content"
	},
	"CustomerDetails":{
		"CustomerLegalName":"String content",
		"CustomerAddress":{
			"AddressLine1":"String content",
			"AddressLine2":"String content",
			"City":"String content",
			"StateCode":"String content",
			"PostalCode":"String content",
			"CountryCodeIso2":"String content"
		},
		"Phone":"String content",
		"CustomerTaxOrRegistrationID":"String content",
		"HpfsCustomerNumber":"String content",
		"DNBNumber":"String content",
		"SICCode":int,
		"NAICCode":int,
		"NumberOfEmployees":int,
		"DirectCustomer":bool
	},
	"Equipment":{
		"InstallLocation":{
			"Address":{
				"AddressLine1":"String content",
				"AddressLine2":"String content",
				"City":"String content",
				"StateCode":"String content",
				"PostalCode":"String content",
				"CountryCodeIso2":"String content"
			}
		}
	},
	"CreditRequest":{
		"HardwareAmount":decimal,
		"PrinterAmount":decimal,
		"SoftwareAmount":decimal,
		"ServicesAmount":decimal,
		"TotalRequestAmount":decimal,
		"RequestAmountCurrency":"String content", 
		"Comments":"String content"
	}
}
XML Request Model Schema
This is a XML schema that describes the syntax of the request. 
                                            
<CreditRequestCustMatching>
  <CreditHeaderDetails>
    <TransmissionId>String content</TransmissionId>
    <ClientProgramId>String content</ClientProgramId>
    <PartnerId>String content</PartnerId>
    <DistributorId>String content</DistributorId>
    <ClientAuthenticationKey>String content</ClientAuthenticationKey>
    <LanguageCode>String content</LanguageCode>
    <Validation>
      <ValidationMessage>
        <ValidationId>String content</ValidationId>
        <ValidationText>String content</ValidationText>
      </ValidationMessage>
      <ValidationMessage>
        <ValidationId>String content</ValidationId>
        <ValidationText>String content</ValidationText>
      </ValidationMessage>
    </Validation>
  </CreditHeaderDetails>
  <SourceEntryPerson>
    <FirstName>String content</FirstName>
    <LastName>String content</LastName>
    <Email>String content</Email>
    <Phone>String content</Phone>
  </SourceEntryPerson>
  <CustomerDetails>
    <CustomerLegalName>String content</CustomerLegalName>
    <CustomerAddress>
      <AddressLine1>String content</AddressLine1>
      <AddressLine2>String content</AddressLine2>
      <City<String content</City>
      <StateCode>String content</StateCode>
      <PostalCode>String content</PostalCode>
      <CountryCodeIso2>String content</CountryCodeIso2>
    </CustomerAddress>
    <Phone>String content</Phone>
    <CustomerTaxOrRegistrationID>String content</CustomerTaxOrRegistrationID>
    <HpfsCustomerNumber>String content</HpfsCustomerNumber>
    <DNBNumber>String content</DNBNumber>
    <SICCode>int</SICCode>
    <NAICCode>int</NAICCode>
    <NumberOfEmployees>int</NumberOfEmployees>
    <DirectCustomer>bool</DirectCustomer>
  </CustomerDetails>
  <Equipment>
    <InstallLocation>
      <Address>
        <AddressLine1>String content</AddressLine1>
        <AddressLine2>String content</AddressLine2>
        <City>String content</City>
        <StateCode>String content</StateCode>
        <PostalCode>String content</PostalCode>
        <CountryCodeIso2>String content</CountryCodeIso2>
      </Address>
    </InstallLocation>
  </Equipment>
  <CreditRequest>
    <HardwareAmount>decimal</HardwareAmount>
    <PrinterAmount>decimal</PrinterAmount>
    <SoftwareAmount>decimal</SoftwareAmount>
    <ServicesAmount<decimal</ServicesAmount>
    <TotalRequestAmount>decimal</TotalRequestAmount>
    <RequestAmountCurrency>String content</RequestAmountCurrency> 
    <Comments>String content</Comments>
  </CreditRequest>
</CreditRequestCustMatching>

This API returns XML or JSON response that is described by the model below:

Response Model Properties
This table describes each of the properties that will be returned.
Name Type Description
CreditHeaderDetails
 Object
TransmissionId
 string TransmissionId for which to retrive credit details for.
Validation Object
Name Type Description
ValidationId String Validation id
ValidationText String validation message
CreditRequest
 Object
CreditRequestID
 int Created request id
CreditApplicationID
 int Created application id
CreditDecision
 string Credit decision
FinalCreditDecisionInd
 bool Is the final decision
Comments
 string Comments for this request
JSON Response Model Schema
This is a JSON schema that describes the syntax of the response. 
                                            
{
    "CreditHeaderDetails":{
	    "TransmissionId":"String content", 
	    "Validation":[{
		    "ValidationId":"String content",
		    "ValidationText":"String content"
	    }]
    },   
    "CreditRequest":{
	    "CreditRequestID":int,
	    "CreditApplicationID":int,
	    "CreditDecision":"String content",
	    "FinalCreditDecisionInd":bool,
	    "Comments":"String content"
    }
}
XML Response Model Schema
This is a XML schema that describes the syntax of the response. 
                                            
<CreditRequestCustMatching>
    <CreditHeaderDetails>
        <TransmissionId>String content</TransmissionId> 
        <Validation>
            <ValidationMessage>
                <ValidationId>String content</ValidationId>
                <ValidationText>String content</ValidationText>
            </ValidationMessage>
            <ValidationMessage>
                <ValidationId>String content</ValidationId>
                <ValidationText>String content</ValidationText>
            </ValidationMessage>
        </Validation>
    </CreditHeaderDetails>   
    <CreditRequest> 
        <CreditRequestID>int</CreditRequestID>
        <CreditApplicationID>int</CreditApplicationID>
        <CreditDecision>String content</CreditDecision>
        <FinalCreditDecisionInd>bool</FinalCreditDecisionInd>
        <Comments>String content</Comments>
    </CreditRequest>
</CreditRequestCustMatching>