Skip to main content
POST
/
tradepayoffbalances
Add a new Trade Payoff Balance
curl --request POST \
  --url https://commerce.driv.ly/api/tradepayoffbalances \
  --header 'Content-Type: application/json' \
  --data '
{
  "trade": {
    "customer": "<string>",
    "vehicle": "<string>"
  },
  "balance": 123,
  "goodThroughDate": "2023-12-25",
  "lender": "<string>"
}
'
{
  "data": {
    "trade": {
      "customer": "<string>",
      "vehicle": "<string>"
    },
    "balance": 123,
    "goodThroughDate": "2023-12-25",
    "lender": "<string>"
  },
  "success": true
}

Query Parameters

​
depth
integer

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

Body

application/json

Trade requires payoff Balance

​
trade
object
required

Trade Payoff Balance is uniquely identified by Trade

  • Option 1
  • Trade
​
balance
number
required

Trade Payoff Balance is uniquely identified by Balance

Must be a multiple of 0.01
​
goodThroughDate
string<date>
required

Trade Payoff Balance is Good Through Date

​
lender
required

Trade Payoff Balance is to Lender

Response

Trade Payoff Balance Added

​
data
Trade Payoff Balance · object

Trade requires payoff Balance

​
success
boolean