Credit Check API

Credit Check API

Description

Performs a credit check on the requested dealer for the logged in distributor

Security

Available for distributor users

URL

Parameters        

  1. dealerCode: [Required] the bailment dealer code to check credit against

Response

Model

FieldTypeDescription
creditAvailableNumberThe amount of credit available (0 if credit is suspended)

Can be negative if dealer has exceeded credit limit
expiryDateString (optional)The expiry date of the current temporary credit limit (if applicable)
creditSuspended
Boolean
True if credit is suspended for the requested dealer
suspendedReasonCode
String (optional)
The suspended reason code if credit is suspended, null otherwise
suspendedReasonDescriptionString (optional)The suspended reason description if credit is suspended, null otherwise

Example

Notes

{                                                                                                                                         
"creditAvailable": 0,
"expiryDate": "2017-08-21T00:00:00.0Z",
"creditSuspended": true,
"suspendedReasonCode": "string",
"suspendedReasonDescription": "string"
} 

Error Codes

HTTP Status Code
Type
400
No dealer code supplied
403Forbidden (invalid Authorisation)
404
Dealer not found
503
Service Unavailable (due to maintenance)

Online Documentation




    • Related Articles

    • Reserve Credit API

      Description Reserves credit for a future order Security Available for distributor users URL POST http://exampleserver.com/api/v4/orders/reservecredit Parameters Model Field Type Description bailmentDealerCode String The bailment dealer code amount ...

    • Argos Vault Release Notes V5.146

      Release Completion Date: 30 August 2024 Please disregard the release notes for the modules you do not use. Unless otherwise indicated, more detail about any change will be included in the relevant dialog [Help] button. Other documents referred to in ...

    • Argos Vault Release Notes V5.140

      Argos Vault Release Notes V5.140 Release Completion Date: 18 August 2021 Please disregard the release notes for the modules you do not use. Unless otherwise indicated, more detail about any change will be included in the relevant dialog [Help] ...

    • Argos Vault Release Notes V5.141

      Release Completion Date: 17 May 2022 Please disregard the release notes for the modules you do not use. Unless otherwise indicated, more detail about any change will be included in the relevant dialog [Help] button. Other documents referred to in the ...

    • Argos Vault Release Notes V5.124

      Argos Vault Release Notes V5.124 Please disregard the release notes for the modules you do not use. Instructions for upgrade are attached to the release email. Unless otherwise indicated, more detail about any change will be included in the relevant ...