Ctrl+K

Close a dispute

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

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.

Path Parameters

  • enterpriseIdstringRequired
    The enterprise identifier of the client. This identifies the client enterprise that owns the allocation.
    Min length: >= 1 characters
  • disputeIdstringRequired
    The unique identifier of the dispute to be closed. This is a UUID that uniquely identifies the dispute record.

Request Body

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.
Min length: >= 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.
Min length: >= 1 characters
notes string required
Notes for why the dispute is being closed with the original settlement transfers
Min length: >= 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.
Min length: >= 1 characters

200 Response

disputeClosure object required
id string required
createdAtOne ofrequired
updatedAtOne ofrequired
closedBy string required
Allowed values: client admin
userId string required
Min length: >= 1 characters
notes string required
Min length: >= 1 characters
payload string
signature string

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