Resolve a dispute

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    actor: '<string>',
    notes: '<string>',
    creditNoteId: '<string>',
    makegoodCampaignId: '<string>',
    adjustmentByPartyCents: {},
    originalApplicationId: '<string>'
  })
};

fetch('https://sandbox.api.enfinitos.com/v1/disputes/{disputeId}/resolve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": {
    "dispute": {
      "id": "<string>",
      "orgId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "openedBy": "<string>",
      "openedAt": "2023-11-07T05:31:56Z",
      "disputedPeriod": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "affectedSurface": {
        "campaignId": "<string>",
        "screenIds": [
          "<string>"
        ],
        "substrateId": "<string>"
      },
      "claimedShortfall": {
        "unit": "<string>",
        "amount": "<string>"
      },
      "evidenceBundle": {
        "proofPackIds": [
          "<string>"
        ],
        "meteringSnapshotIds": [
          "<string>"
        ],
        "settlementApplicationIds": [
          "<string>"
        ],
        "attachmentRefs": [
          "<string>"
        ],
        "auditorReportRef": "<string>"
      },
      "operatorResponse": {
        "at": "2023-11-07T05:31:56Z",
        "by": "<string>",
        "notes": "<string>",
        "proposedRemedy": {
          "amount": "<string>",
          "makegoodWindow": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          }
        }
      },
      "advertiserResponse": {
        "at": "2023-11-07T05:31:56Z",
        "by": "<string>",
        "notes": "<string>"
      },
      "resolution": {
        "creditNoteId": "<string>",
        "makegoodCampaignId": "<string>",
        "settlementAdjustmentId": "<string>",
        "resolvedAt": "2023-11-07T05:31:56Z",
        "resolvedBy": "<string>",
        "notes": "<string>"
      },
      "timeline": [
        {
          "at": "2023-11-07T05:31:56Z",
          "actor": "<string>",
          "notes": "<string>"
        }
      ]
    },
    "overrideApplied": true,
    "override": {},
    "originalApplicationId": "<string>",
    "overrideSkipped": {
      "message": "<string>"
    }
  },
  "contractVersion": "<string>"
}

Disputes

Resolve a dispute

Finalise a dispute with a validated resolution — the terminal ADVERTISER_RESPONDED → RESOLVED (or ESCALATED → RESOLVED) leg. When kind is SETTLEMENT_ADJUSTMENT, the route builds the settlement-application OVERRIDE that corrects the disputed attribution and appends it in the SAME atomic write as the dispute transition; the resolution’s settlementAdjustmentId carries the override id. The original application is located via the dispute’s evidenceBundle.settlementApplicationIds (or an explicit originalApplicationId when the bundle links more than one). Lookup failure is NON-FATAL: the resolve still succeeds and the response carries overrideApplied: false plus an overrideSkipped machine reason so the operator can re-run the adjustment by hand. Requires scope settlement:write.

POST

disputes

{disputeId}

resolve

Resolve a dispute

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    actor: '<string>',
    notes: '<string>',
    creditNoteId: '<string>',
    makegoodCampaignId: '<string>',
    adjustmentByPartyCents: {},
    originalApplicationId: '<string>'
  })
};

fetch('https://sandbox.api.enfinitos.com/v1/disputes/{disputeId}/resolve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": {
    "dispute": {
      "id": "<string>",
      "orgId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "openedBy": "<string>",
      "openedAt": "2023-11-07T05:31:56Z",
      "disputedPeriod": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "affectedSurface": {
        "campaignId": "<string>",
        "screenIds": [
          "<string>"
        ],
        "substrateId": "<string>"
      },
      "claimedShortfall": {
        "unit": "<string>",
        "amount": "<string>"
      },
      "evidenceBundle": {
        "proofPackIds": [
          "<string>"
        ],
        "meteringSnapshotIds": [
          "<string>"
        ],
        "settlementApplicationIds": [
          "<string>"
        ],
        "attachmentRefs": [
          "<string>"
        ],
        "auditorReportRef": "<string>"
      },
      "operatorResponse": {
        "at": "2023-11-07T05:31:56Z",
        "by": "<string>",
        "notes": "<string>",
        "proposedRemedy": {
          "amount": "<string>",
          "makegoodWindow": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          }
        }
      },
      "advertiserResponse": {
        "at": "2023-11-07T05:31:56Z",
        "by": "<string>",
        "notes": "<string>"
      },
      "resolution": {
        "creditNoteId": "<string>",
        "makegoodCampaignId": "<string>",
        "settlementAdjustmentId": "<string>",
        "resolvedAt": "2023-11-07T05:31:56Z",
        "resolvedBy": "<string>",
        "notes": "<string>"
      },
      "timeline": [
        {
          "at": "2023-11-07T05:31:56Z",
          "actor": "<string>",
          "notes": "<string>"
        }
      ]
    },
    "overrideApplied": true,
    "override": {},
    "originalApplicationId": "<string>",
    "overrideSkipped": {
      "message": "<string>"
    }
  },
  "contractVersion": "<string>"
}

Authorizations

Authorization

string

header

required

API key sent as Authorization: Bearer <api-key>.

Path Parameters

disputeId

string

required

Delivery dispute id (prefixed dispute:).

Body

application/json

kind

enum<string>

required

Available options:

CREDIT_ISSUED,

MAKEGOOD_DELIVERED,

SETTLEMENT_ADJUSTMENT,

NO_CREDIT,

OTHER

actor

string

Defaults to the key's developerId.

notes

string | null

creditNoteId

string

Required when kind is CREDIT_ISSUED.

makegoodCampaignId

string

Required when kind is MAKEGOOD_DELIVERED.

adjustmentByPartyCents

object

Required when kind is SETTLEMENT_ADJUSTMENT — map of partyRole → signed integer cents (negative reduces the party's amount). Must carry at least one finite integer.

Show child attributes

originalApplicationId

string

Optional explicit linkage to the settlement application the adjustment corrects; disambiguates when the evidence bundle links more than one.

Response

The resolved dispute, plus the override outcome for SETTLEMENT_ADJUSTMENT resolutions.

boolean

required

data

object

required

Route-specific payload. Operation responses refine this.

Show child attributes

contractVersion

string

required

Allowed value: "v1.0"

Advance a dispute Withdraw a dispute

⌘I