Skip to main content
POST
Resolve a dispute

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.

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.

ok
boolean
required
data
object
required

Route-specific payload. Operation responses refine this.

contractVersion
string
required
Allowed value: "v1.0"