API ReferenceBill Reporting

Retrieve Trade Line View Set

  1. Validate the Request Token and get the Partner
  2. Get the tradeline for the consumer associated with the request
  3. Return the TradeLine

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

consumer_idstringRequired
tradeline_idstringRequired

Query parameters

searchstringOptional
A search term.

Response

idstringformat: "uuid"
merchantstring
categorystring
statusstring
is_eligibleboolean
payment_frequencystring
transactionsobject
List of transactions associated with the tradeline
created_atstringformat: "date-time"
updated_atstringformat: "date-time"
service_addressstringRead-only
service_phonestringRead-only
lease_start_datestringRead-only
utility_typesstringRead-only
service_address_typestringRead-only
transaction_countintegerRead-only
amountdoubleRead-only