Registers a proposal for the Headless Wallet to listen to and interact with the Atomic Swap Service

POST 
https://localhost:8000/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

Schema

any

success

Success

{
  "success": {
    "summary": "Successful registration",
    "value": {
      "success": true
    }
  }
}

service-failure

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

No wallet id parameter

{
  "success": false,
  "message": "Parameter 'wallet-id' is required."
}

invalid-wallet-id

Wallet id parameter is invalid

{
  "success": false,
  "message": "Invalid wallet-id parameter."
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://localhost:8000/wallet/atomic-swap/tx-proposal/register/:proposalId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "password": "string"
}'

Request Collapse all

Base URL

https://localhost:8000

Parameters

proposalId — pathrequired

x-wallet-id — headerrequired

Body required

• Example (from schema)
• fetch

{
  "password": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!