REST API›Settle (Off Exchange)›Settlement Disputes

POST

Close a dispute

Close a dispute for cases when their dispute is invalid. If the dispute was valid and instructions need to be adjusted then a bitgo admin will need to close it.

Requires access token scopes: settlement_network_read, settlement_network_write

Path Params

  • enterpriseId string required
    The enterprise identifier of the client. This identifies the client enterprise that owns the allocation.

    at least 1 characters

  • disputeId string required
    The unique identifier of the dispute to be closed. This is a UUID that uniquely identifies the dispute record.

Body Params

object

  • payload string required

    Payload formed by stringifying the object containing all other request properties.

    This includes:

    • enterpriseId
    • disputeId
    • notes
    • nonce

    The payload must be signed using your BitGo account's private key to create the signature parameter.

    at least 1 characters

  • signature string required

    Digital signature of the payload parameter.

    This signature:

    • Must be created using your BitGo account's private key.
    • Verifies that the request is authentic and hasn't been tampered with.
    • Provides non-repudiation for the allocation request.

    at least 1 characters

  • notes string required
    Notes for why the dispute is being closed with the original settlement transfers

    at least 1 characters

  • nonce string required

    Unique nonce to prevent replay attacks.

    This value:

    • Must be unique for each request requiring a nonce.
    • Should be a cryptographically strong random value.
    • Is used as part of the request signing process.
    • Helps ensure the signature can only be used once.

    at least 1 characters

Responses

200
OK

Response Body

object

  • disputeClosure object required
    disputeClosure object
    • id string required
    • createdAt string or object required
    • updatedAt string or object required
    • closedBy string enum required
      clientadmin
    • userId string required

      at least 1 characters

    • notes string required

      at least 1 characters

    • payload string
    • signature string
    • status string enum required
      pending_reviewapprovedrejected
    • reviewedBy string
    • reviewNotes string
    • adjustedTransfers map of strings required
      adjustedTransfers object
      • <key> string
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