Resolve a dispute by release, refund, or split

POST

escrows

{escrowId}

disputes

{disputeId}

resolve

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "disputeId": "dsp_01hxyz",
    "escrowId": "esc_01hxyz",
    "status": "open",
    "openedBy": "customer",
    "reasonCode": "ITEM_NOT_RECEIVED",
    "releasedAmount": 0,
    "refundedAmount": 0,
    "description": "<string>",
    "resolution": "release"
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

Authorizations

Authorization

string

header

required

Secret API key. Use sk_test_... for sandbox data or sk_live_... for live data (after verification and live mode). Do not use pk_ keys.

Headers

Idempotency-Key

string

required

Path Parameters

escrowId

string

required

disputeId

string

required

Body

application/json

action (release, refund, or split). For split, both releaseAmount and refundAmount in naira; they must sum to remaining held.

action

enum<string>

required

How remaining held funds should move.

Available options:

release,

refund,

split

releaseAmount

number

Naira to release. Required for split when releasing some funds.

refundAmount

number

Naira to refund. Required for split when refunding some funds.

Response

Resource created

success

boolean

Example:

true

data

object

Show child attributes

meta

object

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "disputeId": "dsp_01hxyz",
    "escrowId": "esc_01hxyz",
    "status": "open",
    "openedBy": "customer",
    "reasonCode": "ITEM_NOT_RECEIVED",
    "releasedAmount": 0,
    "refundedAmount": 0,
    "description": "<string>",
    "resolution": "release"
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

customers

escrows

checkout

transactions

wallets

payouts

fees

identity

Resolve a dispute by release, refund, or split

Authorizations

Headers

Path Parameters

Body

Response