import cobo_waas2
from cobo_waas2.models.cancel_satoshi_test_challenge_request import (
CancelSatoshiTestChallengeRequest,
)
from cobo_waas2.models.satoshi_test_cancel_result import SatoshiTestCancelResult
from cobo_waas2.rest import ApiException
from pprint import pprint
# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
# Replace `<YOUR_PRIVATE_KEY>` with your private key
api_private_key="<YOUR_PRIVATE_KEY>",
# Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = cobo_waas2.TravelRuleApi(api_client)
cancel_satoshi_test_challenge_request = (
cobo_waas2.CancelSatoshiTestChallengeRequest()
)
try:
# Cancel Satoshi Test challenge
api_response = api_instance.cancel_satoshi_test_challenge(
cancel_satoshi_test_challenge_request=cancel_satoshi_test_challenge_request
)
print("The response of TravelRuleApi->cancel_satoshi_test_challenge:\n")
pprint(api_response)
except Exception as e:
print(
"Exception when calling TravelRuleApi->cancel_satoshi_test_challenge: %s\n"
% e
)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.TravelRuleApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
TravelRuleApi apiInstance = new TravelRuleApi();
CancelSatoshiTestChallengeRequest cancelSatoshiTestChallengeRequest =
new CancelSatoshiTestChallengeRequest();
try {
SatoshiTestCancelResult result =
apiInstance.cancelSatoshiTestChallenge(cancelSatoshiTestChallengeRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TravelRuleApi#cancelSatoshiTestChallenge");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
cancelSatoshiTestChallengeRequest := *coboWaas2.NewCancelSatoshiTestChallengeRequest("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.TravelRuleAPI.CancelSatoshiTestChallenge(ctx).
CancelSatoshiTestChallengeRequest(cancelSatoshiTestChallengeRequest).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `TravelRuleAPI.CancelSatoshiTestChallenge``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CancelSatoshiTestChallenge`: SatoshiTestCancelResult
fmt.Fprintf(os.Stdout, "Response from `TravelRuleAPI.CancelSatoshiTestChallenge`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.TravelRuleApi();
const opts = {
CancelSatoshiTestChallengeRequest:
new CoboWaas2.CancelSatoshiTestChallengeRequest(),
};
apiInstance.cancelSatoshiTestChallenge(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"challenge_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "DELETED"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}Cancel Satoshi Test challenge
This operation cancels a Satoshi Test challenge that is currently in PREPARE or PENDING status. Typical use case: the counterparty decides to switch verification methods before transferring.
Once cancelled, the challenge status becomes DELETED and the on-chain match will no longer be observed. Challenges already in MATCHED, VERIFIED, EXPIRED, or DELETED state cannot be cancelled.
import cobo_waas2
from cobo_waas2.models.cancel_satoshi_test_challenge_request import (
CancelSatoshiTestChallengeRequest,
)
from cobo_waas2.models.satoshi_test_cancel_result import SatoshiTestCancelResult
from cobo_waas2.rest import ApiException
from pprint import pprint
# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
# Replace `<YOUR_PRIVATE_KEY>` with your private key
api_private_key="<YOUR_PRIVATE_KEY>",
# Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = cobo_waas2.TravelRuleApi(api_client)
cancel_satoshi_test_challenge_request = (
cobo_waas2.CancelSatoshiTestChallengeRequest()
)
try:
# Cancel Satoshi Test challenge
api_response = api_instance.cancel_satoshi_test_challenge(
cancel_satoshi_test_challenge_request=cancel_satoshi_test_challenge_request
)
print("The response of TravelRuleApi->cancel_satoshi_test_challenge:\n")
pprint(api_response)
except Exception as e:
print(
"Exception when calling TravelRuleApi->cancel_satoshi_test_challenge: %s\n"
% e
)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.TravelRuleApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
TravelRuleApi apiInstance = new TravelRuleApi();
CancelSatoshiTestChallengeRequest cancelSatoshiTestChallengeRequest =
new CancelSatoshiTestChallengeRequest();
try {
SatoshiTestCancelResult result =
apiInstance.cancelSatoshiTestChallenge(cancelSatoshiTestChallengeRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TravelRuleApi#cancelSatoshiTestChallenge");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
cancelSatoshiTestChallengeRequest := *coboWaas2.NewCancelSatoshiTestChallengeRequest("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.TravelRuleAPI.CancelSatoshiTestChallenge(ctx).
CancelSatoshiTestChallengeRequest(cancelSatoshiTestChallengeRequest).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `TravelRuleAPI.CancelSatoshiTestChallenge``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CancelSatoshiTestChallenge`: SatoshiTestCancelResult
fmt.Fprintf(os.Stdout, "Response from `TravelRuleAPI.CancelSatoshiTestChallenge`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.TravelRuleApi();
const opts = {
CancelSatoshiTestChallengeRequest:
new CoboWaas2.CancelSatoshiTestChallengeRequest(),
};
apiInstance.cancelSatoshiTestChallenge(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"challenge_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "DELETED"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}import cobo_waas2
from cobo_waas2.models.cancel_satoshi_test_challenge_request import (
CancelSatoshiTestChallengeRequest,
)
from cobo_waas2.models.satoshi_test_cancel_result import SatoshiTestCancelResult
from cobo_waas2.rest import ApiException
from pprint import pprint
# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
# Replace `<YOUR_PRIVATE_KEY>` with your private key
api_private_key="<YOUR_PRIVATE_KEY>",
# Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = cobo_waas2.TravelRuleApi(api_client)
cancel_satoshi_test_challenge_request = (
cobo_waas2.CancelSatoshiTestChallengeRequest()
)
try:
# Cancel Satoshi Test challenge
api_response = api_instance.cancel_satoshi_test_challenge(
cancel_satoshi_test_challenge_request=cancel_satoshi_test_challenge_request
)
print("The response of TravelRuleApi->cancel_satoshi_test_challenge:\n")
pprint(api_response)
except Exception as e:
print(
"Exception when calling TravelRuleApi->cancel_satoshi_test_challenge: %s\n"
% e
)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.TravelRuleApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
TravelRuleApi apiInstance = new TravelRuleApi();
CancelSatoshiTestChallengeRequest cancelSatoshiTestChallengeRequest =
new CancelSatoshiTestChallengeRequest();
try {
SatoshiTestCancelResult result =
apiInstance.cancelSatoshiTestChallenge(cancelSatoshiTestChallengeRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TravelRuleApi#cancelSatoshiTestChallenge");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
cancelSatoshiTestChallengeRequest := *coboWaas2.NewCancelSatoshiTestChallengeRequest("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.TravelRuleAPI.CancelSatoshiTestChallenge(ctx).
CancelSatoshiTestChallengeRequest(cancelSatoshiTestChallengeRequest).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `TravelRuleAPI.CancelSatoshiTestChallenge``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CancelSatoshiTestChallenge`: SatoshiTestCancelResult
fmt.Fprintf(os.Stdout, "Response from `TravelRuleAPI.CancelSatoshiTestChallenge`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.TravelRuleApi();
const opts = {
CancelSatoshiTestChallengeRequest:
new CoboWaas2.CancelSatoshiTestChallengeRequest(),
};
apiInstance.cancelSatoshiTestChallenge(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
Authorizations
The API key. For more details, refer to API key.
In the API playground, enter your API secret, and your API key will be accordingly calculated.
Body
Request body for cancelling a Satoshi Test challenge that is in PREPARE or PENDING status.
The challenge ID to cancel.
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Response
The challenge has been cancelled.
Returned by Cancel Satoshi Test challenge.
Was this page helpful?
