Developer Center›Guides›Consumer Disputes

    Consumer Disputes

    Use the public `/api/v1/disputes` routes to intake disputes, append notes, and resolve them with API-key auth.

    Public Routes

    Disputes are now part of the public contract under /api/v1/disputes and support API-key authentication.

    Implemented Routes

    • GET /api/v1/disputes lists disputes for the authenticated company and supports status filtering.
    • POST /api/v1/disputes creates a dispute with fields such as consumer_account_number, dispute_source, and dispute_reason.
    • GET /api/v1/disputes/{id} returns the dispute plus its notes.
    • PATCH /api/v1/disputes/{id} updates status, reason, assignee, and resolution fields.
    • POST /api/v1/disputes/{id}/notes appends a note.
    • POST /api/v1/disputes/{id}/resolve resolves the dispute.

    Resolution Values

    • verified
    • updated
    • deleted
    • in_dispute

    When a dispute is resolved as deleted, the current code updates the linked record's compliance_condition_codeto XR.

    Related Webhooks

    • dispute.created
    • dispute.resolved