REST API›Settle (Off Exchange)›Settlement Disputes

POST

Dispute a Settlement

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

Requires access token scopes: settlement_network_read, settlement_network_write

Path Params

  • enterpriseId string required

    at least 1 characters

  • settlementId string required

Body Params

object

  • connectionId string required
  • reason string
  • expectedTransfers map of strings required
  • payload string required

    at least 1 characters

  • signature string required

    at least 1 characters

  • nonce string required

    at least 1 characters

Responses

200
OK

Response Body

object

  • dispute object required
    dispute object
    • id string required
    • createdAt string date-time required
    • updatedAt string date-time required
    • connectionId string required
    • disputedSettlementId string required
    • userId string required

      at least 1 characters

    • expectedTransfers map of strings required
      expectedTransfers object
      • <key> string
    • retracted boolean required
    • settledInSettlementId string
    • reason string

      at least 1 characters

    • retractedBy string

      at least 1 characters

    • retractedAt string date-time
    • disputeClosureId string
    • retractedReason string

      at least 1 characters

400
Bad Request
No response body
401
Unauthorized

Response Body

object

  • error string required
403
Forbidden

Response Body

object

  • error string required
404
Not Found

Response Body

object

  • error string required
409
Conflict

Response Body

object

  • error string required
422
Unprocessable Entity

Response Body

object

  • error string required
500
Internal Server Error

Response Body

object

  • error string required