Home > API > Customer Account > Get remaining credit limit

Get remaining credit limit

Get remaining account credit limit

PATH:

/api/v3/customer-account/{accountNumber}/credit-limit

PATH PARAMETERS:

accountNumber
required

string

Account number

RESPONSES:

200 OK

RESPONSE SCHEMA:

remainingCreditLimit

number

Remaining customer account credit limit

balance

number

Current account balance excluding fees and interest

isOpenForNewTransactions

boolean

Field shows if new purchases («transactions») can be added. This indicates if the owner of the account can make more purchases or withdrawals. If the account is in dunning due to missing payments, the flag will be false

accountMessage

string

Customer account message

totalBalance

number

Customer account balance including fees and interest

400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum: BusinessError TechnicalError NotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum: Unavailable AskConsumerToConfirm AskConsumerToReEnterData OfferSecurePaymentMethods RequiresSsn AskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
500 Internal server error.

Path

get

/api/v3/customer-account/{accountNumber}/credit-limit

Response samples

200400
  • {
    • "remainingCreditLimit": 1.00,
    • "balance": 1.00,
    • "isOpenForNewTransactions": true,
    • "accountMessage": "string",
    • "totalBalance": 1.00
    }
  • [
      ...
      • {
        • "type": "string",
        • "code": "string",
        • "message": "string",
        • "customerFacingMessage": "string",
        • "actionCode": "string",
        • "fieldReference": "string"
        }
    ]