GET v3/credit

Allows an agent to determine how much of their credit limit has been used, and how much remains.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

AgentCredit
NameDescriptionTypeAdditional information
CreditLimit

decimal number

None.
SpentCredit

decimal number

None.
AvailableCredit

decimal number

None.

Response Formats

application/json

Sample: 
{
  "creditLimit": 1.0,
  "spentCredit": 2.0,
  "availableCredit": -1.0
}

text/xml

Sample:

The response/request for text/xml format is no longer supported for this endpoint.