Prepare to invest in new opportunity

  • APIs
  • Get Credit Request Status

Get Credit Request Status

The Get Credit Request Status method will allow the requesting application to retrieve the latest HPFS credit request decision status in the scenarios where the credit request is not auto approved as part of the original Credit Request Method.

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.
Parameters
Name Type Values
CreditHeaderDetails
 Object
TransmissionId
 Int
ClientProgramId
 String
PartnerId
 String
LanguageCode
 String
DistributorId
 String
ClientAuthenticationKey
 String
CreditRequestId
 Integer
submit


Making API Request...
Output
Credit Request Id Credit Request Status Final Credit Decision Indicator Response Comments
1234 Approved True Response Comments
This is the raw JSON response view
This is the raw JSON request view
Parameters

This API accepts the following parameters:

Name Type Description
CreditHeaderDetails
 Object Credit request header

Name Type Description
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
DistributorId String Unique Distributor ID provided by HPFS
LanguageCode String ISO2 Language used to identify Language of the validation messages send to calling client
CreditRequestId
 Integer CreditRequestId for which to retrive credit details for.
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"
	},
	"CreditRequestId":2147483647
}
XML Request Model Schema
This is a XML schema that describes the syntax of the request. 

<CreditRequestStatus>
  <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>
  </CreditHeaderDetails>
  <CreditRequestId>2147483647</CreditRequestId>
</CreditRequestStatus>

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

Response Properties
This table describes each of the properties that will be returned.
Name Type Description
CreditHeaderDetails
 Object Credit request header

Name Type Description
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
DistributorId String Unique Distributor ID provided by HPFS
LanguageCode String ISO2 Language used to identify Language of the validation messages send to calling client
Validation Object Validation message from service
Name Type Description
ValidationId String Validation id
ValidationText String validation message
CreditRequestId
 Integer Credit Request Id
CreditDecision
 String Credit decision
Comments
 String Credit comments
FinalCreditDecisionInd
 Bool Credit decistion indicator
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"
		}]
	},
	"CreditRequestId":2147483647,
	"CreditDecision":"String content",
	"Comments":"String content",
	"FinalCreditDecisionInd":true
}
XML Request Model Schema
This is a XML schema that describes the syntax of the request. 

<CreditRequestStatus>
  <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>
  <CreditRequestId>2147483647</CreditRequestId>
  <CreditDecision>String content</CreditDecision>
  <Comments>String content</Comments>
  <FinalCreditDecisionInd>true</FinalCreditDecisionInd>
</CreditRequestStatus>