Ctrl+K

Exchange commitments for EdDSA transactions (full)

post/api/v2/wallet/{walletId}/txrequests/{txRequestId}/transactions/{transactionIdx}/commit

Exchange commitments for signing EdDSA transactions. This route is only valid for transaction request full. You must call this endpoint before calling Create a signature share for the transaction request.

Path Parameters

  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters
  • txRequestIdstring<uuid>Required
    The ID of the transaction request
    Example: 123e4567-e89b-12d3-a456-426614174000
    Min length: >= 1 characters
  • transactionIdxstring<number>Required

Request Body

commitmentShare object required
The user or backup to the commitment share.
type string required
The type of the commitment share
Allowed value: commitment
from string required
The source of the commitment share
Allowed values: user backup bitgo
Example: user
to string required
The recipient of the commitment share.
Allowed values: user backup bitgo
Example: bitgo
share string required
The commitment share.
encryptedSignerShare object required
The encrypted signer share.
type string required
Allowed values: encryptedSignerShare encryptedRShare
from string required
The source of the commitment share
Allowed values: user backup bitgo
Example: user
to string required
The recipient of the commitment share.
Allowed values: user backup bitgo
Example: bitgo
share string required
The commitment share.
json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "commitmentShare": {
    "type": "commitment",
    "from": "user",
    "to": "bitgo",
    "share": "string"
  },
  "encryptedSignerShare": {
    "type": "encryptedSignerShare",
    "from": "user",
    "to": "bitgo",
    "share": "string"
  }
}

200 Response

commitmentShare object required
The commitment share.
type string required
The type of the commitment share
Allowed value: commitment
from string required
The source of the commitment share
Allowed values: user backup bitgo
Example: user
to string required
The recipient of the commitment share.
Allowed values: user backup bitgo
Example: bitgo
share string required
The commitment share.
json
1
2
3
4
5
6
7
8
{
  "commitmentShare": {
    "type": "commitment",
    "from": "user",
    "to": "bitgo",
    "share": "string"
  }
}

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id
json
1
2
3
4
5
6
{
  "name": "string",
  "context": {},
  "error": "string",
  "requestId": "string"
}

401 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id
json
1
2
3
4
5
6
{
  "name": "string",
  "context": {},
  "error": "string",
  "requestId": "string"
}

403 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id
json
1
2
3
4
5
6
{
  "name": "string",
  "context": {},
  "error": "string",
  "requestId": "string"
}

404 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id
json
1
2
3
4
5
6
{
  "name": "string",
  "context": {},
  "error": "string",
  "requestId": "string"
}