Dispute a Settlement

post/api/network/v1/enterprises/{enterpriseId}/clients/settlements/{settlementId}/disputes

This API call allows clients to dispute a settlement (if within the dispute window).

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters
  • settlementIdstringRequired

Request Body

connectionId string required
reason string
expectedTransfers dictionary<string, string> required
string
payload string required
Min length: >= 1 characters
signature string required
Min length: >= 1 characters
nonce string required
Min length: >= 1 characters

200 Response

dispute object required
id string required
createdAt string <date-time>required
updatedAt string <date-time>required
connectionId string required
disputedSettlementId string required
userId string required
Min length: >= 1 characters
expectedTransfers dictionary<string, string> required
retracted boolean required
settledInSettlementId string
reason string
Min length: >= 1 characters
retractedBy string
Min length: >= 1 characters
retractedAt string <date-time>
disputeClosureId string
retractedReason string
Min length: >= 1 characters

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

409 Response

error string required

422 Response

error string required

500 Response

error string required