Skip to main content
POST
Report a payment

Authorizations

x-api-key
string
header
required

API key in the format sk_live_<token> (production) or sk_test_<token> (sandbox). Contact Cove to obtain your API key.

Body

application/json
tradeline_id
string<uuid>
required
payment_date
string<date>
required
amount_due
integer
required

In cents

Required range: x >= 0
amount_paid
integer
required

In cents

Required range: x >= 0
payment_status
enum<string>
required

Status of a reported payment

Available options:
on_time,
late_30,
late_60,
late_90,
late_120,
late_150,
late_180_plus,
missed,
partial
period_start
string<date> | null
period_end
string<date> | null
external_payment_id
string | null

Your internal transaction ID

Maximum string length: 255

Response

Payment recorded with updated tradeline status

Payment record with updated tradeline status snapshot

id
string<uuid>
tradeline_id
string<uuid>
payment_date
string<date>
period_start
string<date> | null
period_end
string<date> | null
amount_due
integer

In cents

amount_paid
integer

In cents

payment_status
enum<string>

Status of a reported payment

Available options:
on_time,
late_30,
late_60,
late_90,
late_120,
late_150,
late_180_plus,
missed,
partial
reported
boolean

Whether included in a Metro 2 submission

reported_at
string<date-time> | null
external_payment_id
string | null
created_at
string<date-time>
tradeline_status
object