NF Car API
Overview
The Car Finance Credit Application API is created to support the Car (or leisure vehicle) credit application process towards Nordea Finance. It can be used as a part of car dealership sales person creating the credit application on behalf of customer in the car purchase journey or it can be directly integrated into an online purchase flow.
With Create Application call a credit applications can be sent to Nordea Finance on household customers given that necessary information regarding financing details, customer and asset is provided. With Get Application Status the credit status of an application (i.e. Approved, Trial, Rejected) can be fetched.
Changes from the previous version
This is first version, no previous changes.
Sample flow
On the picture below you can see the sample NF Car API flow.
NF Car Partners application call to token API first to get token for Nordea. Token need to be passed in header to NF Car API. NF Car API will validate token and the allow access if token is valid.
Swagger Definition
The NF Car API specification is also available in the swagger format. Swagger is the world’s largest framework of API developer tools for the OpenAPI Specification(OAS), more information about it can be found here.
API Endpoints
NF Car API has following end points
Sandbox
| Endpoint | Supported HTTP Methods | Purpose |
|---|---|---|
| car/household/loan/applications | Post | Create Application |
| car/household/loan/applications/{application-id} | Put | Update Application |
| car/household/loan/applications/{application-id} | Get | Get the Application Details |
| car/household/loan/applications/{application-id}/status | Put | Update Application |
Request Header Parameter
| Sr.No. | Field Name | Type | Mandatory Information | Example | |
|---|---|---|---|---|---|
| 1 | x-ibm-client-id | String | Mandatory | you will get it from developer portal. | |
| 2 | x-ibm-client-secret | String | Mandatory | you will get it from developer portal. | |
| 3 | crm-id | String | Mandatory | Identifier for CRM system consuming this service. Provided by Nordea Finance. | 262 |
| 4 | country | String | Mandatory | Country of application origin. | SE |
| 5 | channel | String | Mandatory | Type of Application, Internal Nordea or External Partners Application or CRM. | CRM |
| 6 | language | String | Mandatory | Language Id in ISO 3166-1 standard. | en |
| 7 | vendor-id | String | Mandatory | Vendor company Id. | 5534553531 |
| 8 | branch-id | String | Mandatory | Unique Identifier for the dealer branch. Should be agreed with Nordea Finance. | 345 |
| 9 | sales-person-id | String | Mandatory | Unique identifier identifying the salesperson. | 195504554537 |
Examples: Get application status details
This endpoint URL has the following form:
GET /car/household/loan/applications/<Application_Id>/statusSample Request
/car/household/loan/applications/90007220/statusSample Response
{
"status": {
"trafficLight": "Yellow",
"status": "Application in tentative mode"
}
}Examples: Get application details
This endpoint URL has the following form:
GET /car/household/loan/applications/<Application_Id>Sample Request
/car/household/loan/applications/90007220Sample Response
{ "applicationStatus": {
"trafficLight": "Yellow",
"status": "Trial"
},
"creditCaseId": null,
"applicationReferenceId": "90007220",
"lastModified": "2018-04-10T04:00:00.000+00:00",
"customerRate": 5.50,
"effectiveCustomerRateAPR": 6.50,
"debitorRate": 0,
"rateType": "FIXED",
"agreementLengthMonths": 36,
"paymentInterval": "MONTHLY",
"periodicCustomerPayment": 0,
"financedAmount": 0,
"totalInterestCost": 0,
"totalCreditCost": 0,
"totalFees": 0,
"fees": null,
"pricelist": null,
"productVariant": "HIRE_PURCHASE",
"repaymentType": "ANNUITY",
"alerts": null }Examples: Create Application
This endpoint URL has the following form:
POST /car/household/loan/applicationsThis API create new Hire purchase car loan application in NCVS for household customer and it return reference number and other details in response. Sample Request
{
"currency": "SEK",
"calculation": {
"assetCost": 20000000,
"downpayment": {
"cashContribution": 5000000,
"tradeInAsset": {
"amount": 0,
"outstandingDebt": 0,
"registrationNumber": "",
"terminateCurrentAgreement": true
}
}
},
"agreementLengthMonths": 36 ,
"paymentInterval": "MONTHLY",
"rateType": "FIXED",
"extraEquipment": 0,
"prepayment": 0,
"customerRate": 550,
"fees": {
"establishmentFee": 35000,
"invoiceFee": 3000
},
"priceList": "20",
"frameAgreement": "",
"productVariant": "HIRE_PURCHASE",
"services": {
"tyreStorage": 0,
"PPI": 0,
"serviceAgreement": 0,
"maintenance": 0,
"extendedGuarantee": {
"amount": 0,
"engineSize": 0
}
},
"structuredPayments": {
"amount": 0,
"startTerm": 0
},
"extraAmortization": {
"amount": 0,
"inTerm": 0
},
"balloonPayment": 10000000,
"repaymentType": "ANNUITY",
"firstPaymentDate": "2023-09-12T13:33:20.664Z",
"informationToNordea": "",
"applicant": {
"customerId": "4201053768",
"contactInformation": {
"phone": "12121212",
"email": "customeremail@nordea.com",
"address": "",
"postalCode": ""
},
"otherInformation": {
"creditConsent": true,
"hasDrivingLicense": true,
"grossEarningsPerMonth": 20000,
"numberOfAdultsInHousehold": 4,
"numberOfChildrenInHousehold": 2,
"accommodationType": "OWNED_HOUSE",
"residencyType": "PERMANENT",
"yearlyAgreedMileage": 0,
"employer": "",
"employmentType": "employed",
"profession": "2"
},
"kyc": {
"sourceOfFunds": "string",
"mainBank": "string",
"citizenship": [
"string"
],
"taxResidencyCountry": [
"string"
],
"countryOfBirth": "string",
"beneficiaryOtherThanSelf": true,
"pepList": [
{
"role": "Head of state",
"countryCode": "string",
"endDate": "2023-09-12T13:33:20.664Z",
"name": "string",
"relation": "Spouse"
}
]
}
},
"coApplicant": {
"customerId": "4409136332",
"contactInformation": {
"phone": "15151515",
"email": "ocustomeremail@nordea.com",
"address": "",
"postalCode": ""
},
"otherInformation": {
"creditConsent": true,
"hasDrivingLicense": true,
"grossEarningsPerMonth": 1000,
"numberOfAdultsInHousehold": 0,
"numberOfChildrenInHousehold": 0,
"accommodationType": "OWNED_HOUSE",
"residencyType": "PERMANENT",
"yearlyAgreedMileage": 0,
"employer": "string",
"employmentType": "employed",
"profession": "2"
},
"kyc": {
"sourceOfFunds": "string",
"mainBank": "string",
"citizenship": [
"string"
],
"taxResidencyCountry": [
"string"
],
"countryOfBirth": "string",
"beneficiaryOtherThanSelf": true,
"pepList": [
{
"role": "Head of state",
"countryCode": "string",
"endDate": "2023-09-12T13:33:20.664Z",
"name": "string",
"relation": "Spouse"
}
]
}
},
"asset": {
"deliveryDate": "2023-09-12T13:33:20.664Z",
"registrationNumber": "XX12345",
"vin": "",
"currentMileage": 2000,
"condition": "NEW",
"type": "PASSENGER_CAR",
"brand": "KB",
"yearOfManufacture": 2023,
"model": "Clio",
"description": "string",
"package": "string",
"engineType": "ELECTRIC",
"standardEquipment": "standardEquipment",
"extraEquipment": "extraEquipment"
}
}
}Sample Responses
{
"applicationReferenceId": "90007411",
"creditCaseId": null,
"lastModified": null,
"customerRate": 550,
"effectiveCustomerRateAPR": 604,
"debitorRate": null,
"rateType": "VARIABLE",
"agreementLengthMonths": null,
"paymentInterval": "MONTHLY",
"periodicCustomerPayment": 196800,
"financedAmount": 15000000,
"totalInterestCost": 2085300,
"totalCreditCost": 17228300,
"totalFees": 143000,
"fees": [
{
"type": "Establishment Fees",
"amount": 350
},
{
"type": "Term Fees",
"amount": 30
}
],
"pricelist": "Pandurang Test Car Price List",
"productVariant": null,
"repaymentType": "ANNUITY",
"alerts": []
} Examples: Update Application
This endpoint URL has the following form:
PUT/car/household/loan/applications/<Application_ID>This API update Hire purchase car loan application in NCVS for household customer and it return reference number and other details in response. Sample Request
/car/household/loan/applications/90007220 {
"currency": "SEK",
"calculation": {
"assetCost": 20000000,
"downpayment": {
"cashContribution": 5000000,
"tradeInAsset": {
"amount": 0,
"outstandingDebt": 0,
"registrationNumber": "",
"terminateCurrentAgreement": true
}
}
},
"agreementLengthMonths": 36 ,
"paymentInterval": "MONTHLY",
"rateType": "FIXED",
"extraEquipment": 0,
"prepayment": 0,
"customerRate": 550,
"fees": {
"establishmentFee": 35000,
"invoiceFee": 3000
},
"priceList": "20",
"frameAgreement": "",
"productVariant": "HIRE_PURCHASE",
"services": {
"tyreStorage": 0,
"PPI": 0,
"serviceAgreement": 0,
"maintenance": 0,
"extendedGuarantee": {
"amount": 0,
"engineSize": 0
}
},
"structuredPayments": {
"amount": 0,
"startTerm": 0
},
"extraAmortization": {
"amount": 0,
"inTerm": 0
},
"balloonPayment": 10000000,
"repaymentType": "ANNUITY",
"firstPaymentDate": "2023-09-12T13:33:20.664Z",
"informationToNordea": "",
"applicant": {
"customerId": "4201053768",
"contactInformation": {
"phone": "12121212",
"email": "customeremail@nordea.com",
"address": "",
"postalCode": ""
},
"otherInformation": {
"creditConsent": true,
"hasDrivingLicense": true,
"grossEarningsPerMonth": 20000,
"numberOfAdultsInHousehold": 4,
"numberOfChildrenInHousehold": 2,
"accommodationType": "OWNED_HOUSE",
"residencyType": "PERMANENT",
"yearlyAgreedMileage": 0,
"employer": "",
"employmentType": "employed",
"profession": "2"
},
"kyc": {
"sourceOfFunds": "string",
"mainBank": "string",
"citizenship": [
"string"
],
"taxResidencyCountry": [
"string"
],
"countryOfBirth": "string",
"beneficiaryOtherThanSelf": true,
"pepList": [
{
"role": "Head of state",
"countryCode": "string",
"endDate": "2023-09-12T13:33:20.664Z",
"name": "string",
"relation": "Spouse"
}
]
}
},
"coApplicant": {
"customerId": "4409136332",
"contactInformation": {
"phone": "15151515",
"email": "ocustomeremail@nordea.com",
"address": "",
"postalCode": ""
},
"otherInformation": {
"creditConsent": true,
"hasDrivingLicense": true,
"grossEarningsPerMonth": 1000,
"numberOfAdultsInHousehold": 0,
"numberOfChildrenInHousehold": 0,
"accommodationType": "OWNED_HOUSE",
"residencyType": "PERMANENT",
"yearlyAgreedMileage": 0,
"employer": "string",
"employmentType": "employed",
"profession": "2"
},
"kyc": {
"sourceOfFunds": "string",
"mainBank": "string",
"citizenship": [
"string"
],
"taxResidencyCountry": [
"string"
],
"countryOfBirth": "string",
"beneficiaryOtherThanSelf": true,
"pepList": [
{
"role": "Head of state",
"countryCode": "string",
"endDate": "2023-09-12T13:33:20.664Z",
"name": "string",
"relation": "Spouse"
}
]
}
},
"asset": {
"deliveryDate": "2023-09-12T13:33:20.664Z",
"registrationNumber": "XX12345",
"vin": "",
"currentMileage": 2000,
"condition": "NEW",
"type": "PASSENGER_CAR",
"brand": "KB",
"yearOfManufacture": 2023,
"model": "Clio",
"description": "string",
"package": "string",
"engineType": "ELECTRIC",
"standardEquipment": "standardEquipment",
"extraEquipment": "extraEquipment"
}
}
}Sample Responses
{
"applicationReferenceId": "90007411",
"creditCaseId": null,
"lastModified": null,
"customerRate": 550,
"effectiveCustomerRateAPR": 604,
"debitorRate": null,
"rateType": "VARIABLE",
"agreementLengthMonths": null,
"paymentInterval": "MONTHLY",
"periodicCustomerPayment": 196800,
"financedAmount": 15000000,
"totalInterestCost": 2085300,
"totalCreditCost": 17228300,
"totalFees": 143000,
"fees": [
{
"type": "Establishment Fees",
"amount": 350
},
{
"type": "Term Fees",
"amount": 30
}
],
"pricelist": "Pandurang Test Car Price List",
"productVariant": null,
"repaymentType": "ANNUITY",
"alerts": []
}