GET
/
tradepayoffbalances
/
{customer}
/
{vehicle}
/
{balance}
Retrieve a Trade Payoff Balance
curl --request GET \
  --url https://commerce.driv.ly/api/tradepayoffbalances/{customer}/{vehicle}/{balance}
{
  "data": {
    "trade": {
      "customer": "<string>",
      "vehicle": "<string>"
    },
    "balance": 123,
    "goodThroughDate": "2023-12-25",
    "lender": "<string>"
  },
  "success": true
}

Path Parameters

​
customer
string
required

Trade Payoff Balance is uniquely identified by Trade

​
vehicle
string
required

Trade Payoff Balance is uniquely identified by Trade

​
balance
number
required

Trade Payoff Balance is uniquely identified by Balance

Query Parameters

​
depth
integer

The number of levels of related objects to include in the response

Response

200
application/json

Trade Payoff Balance Found

The response is of type object.