Skip to main content
GET
/
payments
List payments for a tradeline
curl --request GET \
  --url https://vvdufluovypptsnkihyv.supabase.co/functions/v1/payments \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tradeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_date": "2023-12-25",
      "period_start": "2023-12-25",
      "period_end": "2023-12-25",
      "amount_due": 123,
      "amount_paid": 123,
      "payment_status": "on_time",
      "reported": true,
      "reported_at": "2023-11-07T05:31:56Z",
      "external_payment_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

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.

Query Parameters

tradeline_id
string<uuid>
required

The tradeline UUID to list payments for (required)

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
per_page
integer
default:20

Number of records per page

Required range: 1 <= x <= 100

Response

Paginated list of payments

data
object[]
pagination
object