Registers a proposal for the Headless Wallet to listen to and interact with the Atomic Swap Service
POST/wallet/atomic-swap/tx-proposal/register/:proposalId
Registers a proposal for the Headless Wallet to listen to and interact with the Atomic Swap Service
Request
Path Parameters
proposalId stringrequired
Proposal identifier on the Atomic Swap Service
Header Parameters
x-wallet-id stringrequired
Defines the key of the wallet on which the request will be executed.
- application/json
Body
required
Request the registration of a proposal id with the service.
password stringrequired
Proposal password on the Atomic Swap Service.
Responses
- 200
Successful proposal registration.
- application/json
- Schema
- success
- service-failure
- no-wallet-id
- invalid-wallet-id
Schema
any
Success
{
"success": {
"summary": "Successful registration",
"value": {
"success": true
}
}
}
Failure validating the proposal data with the service side
{
"success": {
"summary": "Unsuccessful validation with the Atomic Swap Service",
"value": {
"success": false,
"error": "Failure description on the swap service"
}
}
}
No wallet id parameter
{
"success": false,
"message": "Parameter 'wallet-id' is required."
}
Wallet id parameter is invalid
{
"success": false,
"message": "Invalid wallet-id parameter."
}
Loading...