Skip to main content

Loan Information

This endpoint returns all loans or all loans associated with given customer. Authorization is required.

HTTP REQUEST

Development

  • GET: https://dev.vendorintegration.growersedge.com/LoanInformation
  • GET: https://dev.vendorintegration.growersedge.com/LoanInformation/{customerId}

Production

  • GET: https://vendorintegration.growersedge.com/LoanInformation
  • GET: https://vendorintegration.growersedge.com/LoanInformation/{customerId}

Responses

CodeDescription
200Success
500Internal Server Error
401Unauthorized
502Bad Gateway

Path Parameters

Property NameTypeRequired
customerIdstringNo

Successful Response

Response will be an array of the following object:

Property NameTypeNullable
loanFirstNamestringtrue
loanLastNamestringtrue
loanNumberintegertrue
loanTypestringtrue
loanStatusstringtrue
loanCommitmentdoublefalse
availableCreditdoublefalse
currentLoanBalancedoublefalse
ltdFeesdoublefalse
maturityDatestring(date-time)false
dailyPayoffAmountdoublefalse
thirdPartyCustomerIdstringtrue
partnerIdentifierinttrue
interestRatedoublefalse
dailyInterestdoublefalse
canMakeDrawRequestsbooleanfalse

Loan Status

Loan Status is a calculated field with following possible values.

Loan Status Values
Ready To Use
Transaction Pending
No More Available Credit
Paid in Full
Past Due
Unknown

Examples

Python:

from azure.identity import CertificateCredential
import requests

TENANT_ID = '***'
CLIENT_ID = '***'
CLIENT_SECRET = '***'
CLIENT_SCOPE = '***'
API_URL = 'https://vendorintegration.growersedge.com/LoanInformation/{growerId}'

def getPartnerLoans( token : str, growerId : str ):
partnerLoansResponse = requests.get(
API_URL.format( growerId = growerId ),
headers = { 'Authorization' : f'Bearer {token}'}
)

if( partnerLoansResponse.status_code == 200 ):
content = partnerLoansResponse.json()
return content;
else:
raise( Exception( 'API Call failed.' ) )


def main():
credential = ClientSecretCredential( TENANT_ID, CLIENT_ID, CLIENT_SECRET )
access_token = credential.get_token( CLIENT_SCOPE )

print( getPartnerLoans( access_token.token, 249991 ) )

if __name__ == '__main__':
main()

curl --request GET \
--url https://vendorintegration.growersedge.com/LoanInformation/ \
--header 'Authorization: Bearer <INSERT YOUR TOKEN>'