> ## Documentation Index
> Fetch the complete documentation index at: https://new.cove.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Report Payment

> Submit a payment against an active tradeline. This automatically updates
the tradeline's `account_status`, `current_balance`, `amount_past_due`,
`highest_balance`, `payment_history` (24-month rolling string), and
`date_of_first_delinquency`.

The response includes the payment record plus a `tradeline_status` snapshot
showing the updated tradeline fields.

Duplicate payments for the same `(tradeline_id, period_start)` return 409.




## OpenAPI

````yaml POST /payments
openapi: 3.0.3
info:
  title: Cove Data Furnishing API
  description: >
    A generic data furnishing API that accepts any recurring payment type

    (rent, child support, alimony, utilities, etc.) and reports it to credit

    bureaus (Equifax, TransUnion, Experian) in Metro 2 format.


    ## Authentication

    All requests require an `x-api-key` header with a valid API key.

    - `sk_live_*` keys operate in production mode.

    - `sk_test_*` keys operate in sandbox mode (data is created but never
    reaches bureaus).


    ## Amounts

    All monetary amounts are in **cents** (USD integers). For example, $45.00 =
    `4500`.


    ## Dates

    All date fields use `YYYY-MM-DD` format.


    ## Integration Guide

    For a full walkthrough with curl examples, see the

    [Integration Guide](./integration-guide.md).
  version: 1.0.0
  contact:
    name: Cove
    url: https://cove.dev
  license:
    name: Proprietary
    url: https://cove.dev/terms
servers:
  - url: https://vvdufluovypptsnkihyv.supabase.co/functions/v1
    description: Current deployment (Supabase)
  - url: https://furnish.cove.dev/v1
    description: Production (coming soon)
  - url: https://sandbox-furnish.cove.dev/v1
    description: Sandbox (coming soon)
security:
  - ApiKeyAuth: []
tags:
  - name: Consumers
    description: >-
      Manage consumer records (PII). Consumers represent the individuals whose
      payments are being reported to credit bureaus.
  - name: Tradelines
    description: >-
      Manage tradelines — ongoing payment obligations being reported to credit
      bureaus. Each tradeline belongs to a consumer and tracks a specific
      payment type.
  - name: Payments
    description: >-
      Report monthly payments against tradelines. Each payment automatically
      updates the tradeline's account status, balance, and 24-month payment
      history.
  - name: Submissions
    description: >-
      Track and manage bureau submission status. Submissions are created
      automatically or via manual trigger.
  - name: Webhooks
    description: Webhook event types and payloads delivered to your configured webhook URL.
paths:
  /payments:
    post:
      tags:
        - Payments
      summary: Report a payment
      description: >
        Submit a payment against an active tradeline. This automatically updates

        the tradeline's `account_status`, `current_balance`, `amount_past_due`,

        `highest_balance`, `payment_history` (24-month rolling string), and

        `date_of_first_delinquency`.


        The response includes the payment record plus a `tradeline_status`
        snapshot

        showing the updated tradeline fields.


        Duplicate payments for the same `(tradeline_id, period_start)` return
        409.
      operationId: reportPayment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentCreate'
            example:
              tradeline_id: 660e8400-e29b-41d4-a716-446655440001
              payment_date: '2026-02-01'
              period_start: '2026-02-01'
              period_end: '2026-02-28'
              amount_due: 150000
              amount_paid: 150000
              payment_status: on_time
              external_payment_id: sp-txn-abc123
      responses:
        '201':
          description: Payment recorded with updated tradeline status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentWithStatus'
              example:
                id: 770e8400-e29b-41d4-a716-446655440002
                tradeline_id: 660e8400-e29b-41d4-a716-446655440001
                payment_date: '2026-02-01'
                period_start: '2026-02-01'
                period_end: '2026-02-28'
                amount_due: 150000
                amount_paid: 150000
                payment_status: on_time
                reported: false
                reported_at: null
                external_payment_id: sp-txn-abc123
                created_at: '2026-02-16T06:17:02.898Z'
                tradeline_status:
                  account_status: current
                  current_balance: 0
                  amount_past_due: 0
                  payment_history: '0'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '409':
          $ref: '#/components/responses/ConflictError'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    PaymentCreate:
      type: object
      required:
        - tradeline_id
        - payment_date
        - amount_due
        - amount_paid
        - payment_status
      properties:
        tradeline_id:
          type: string
          format: uuid
        payment_date:
          type: string
          format: date
        period_start:
          type: string
          format: date
          nullable: true
        period_end:
          type: string
          format: date
          nullable: true
        amount_due:
          type: integer
          minimum: 0
          description: In cents
        amount_paid:
          type: integer
          minimum: 0
          description: In cents
        payment_status:
          $ref: '#/components/schemas/PaymentStatusEnum'
        external_payment_id:
          type: string
          maxLength: 255
          nullable: true
          description: Your internal transaction ID
    PaymentWithStatus:
      type: object
      description: Payment record with updated tradeline status snapshot
      allOf:
        - $ref: '#/components/schemas/Payment'
        - type: object
          properties:
            tradeline_status:
              type: object
              properties:
                account_status:
                  $ref: '#/components/schemas/AccountStatus'
                current_balance:
                  type: integer
                  description: Updated balance in cents
                amount_past_due:
                  type: integer
                  description: Updated past-due in cents
                payment_history:
                  type: string
                  description: Updated 24-char history
    PaymentStatusEnum:
      type: string
      description: Status of a reported payment
      enum:
        - on_time
        - late_30
        - late_60
        - late_90
        - late_120
        - late_150
        - late_180_plus
        - missed
        - partial
    Payment:
      type: object
      properties:
        id:
          type: string
          format: uuid
        tradeline_id:
          type: string
          format: uuid
        payment_date:
          type: string
          format: date
        period_start:
          type: string
          format: date
          nullable: true
        period_end:
          type: string
          format: date
          nullable: true
        amount_due:
          type: integer
          description: In cents
        amount_paid:
          type: integer
          description: In cents
        payment_status:
          $ref: '#/components/schemas/PaymentStatusEnum'
        reported:
          type: boolean
          description: Whether included in a Metro 2 submission
        reported_at:
          type: string
          format: date-time
          nullable: true
        external_payment_id:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
    AccountStatus:
      type: string
      description: >-
        Current status of the tradeline account (auto-computed from payment
        reports)
      enum:
        - current
        - late_30
        - late_60
        - late_90
        - late_120
        - late_150
        - late_180_plus
        - paid_in_full
        - closed
        - transferred
        - account_in_dispute
    Error:
      type: object
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              enum:
                - VALIDATION_ERROR
                - AUTHENTICATION_ERROR
                - AUTHORIZATION_ERROR
                - NOT_FOUND
                - CONFLICT
                - RATE_LIMITED
                - INTERNAL_ERROR
            message:
              type: string
              description: Human-readable error description
            field:
              type: string
              description: >-
                Dot-notation path to the field that caused the error (e.g.,
                address.state). Only present when a specific field is
                responsible.
            request_id:
              type: string
              format: uuid
  responses:
    ValidationError:
      description: Validation error (400)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: VALIDATION_ERROR
              message: payment_amount must be a positive integer (cents)
              field: payment_amount
              request_id: 4e9024e3-125d-4d08-a392-4fa34f6bda44
    AuthenticationError:
      description: Authentication error (401)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: AUTHENTICATION_ERROR
              message: Missing x-api-key header
              request_id: 4e9024e3-125d-4d08-a392-4fa34f6bda44
    NotFoundError:
      description: Resource not found (404)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Consumer not found
              request_id: 4e9024e3-125d-4d08-a392-4fa34f6bda44
    ConflictError:
      description: Resource conflict / duplicate (409)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: CONFLICT
              message: >-
                A consumer with this email or external_id already exists for
                this partner
              request_id: 4e9024e3-125d-4d08-a392-4fa34f6bda44
    InternalError:
      description: Internal server error (500)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An unexpected error occurred
              request_id: 4e9024e3-125d-4d08-a392-4fa34f6bda44
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >
        API key in the format `sk_live_<token>` (production) or
        `sk_test_<token>` (sandbox).

        Contact Cove to obtain your API key.

````