import cobo_waas2
from cobo_waas2.models.trigger_test_payment_webhook_event_response import (
TriggerTestPaymentWebhookEventResponse,
)
from cobo_waas2.models.trigger_test_payments_webhook_event_request import (
TriggerTestPaymentsWebhookEventRequest,
)
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.PaymentApi(api_client)
trigger_test_payments_webhook_event_request = (
cobo_waas2.TriggerTestPaymentsWebhookEventRequest(
event_type="payment.order.status.updated",
override_data={
"chain_id": "ETH",
"transaction_id": "Test-transaction-id",
},
)
)
try:
# Trigger test Payments webhook event
api_response = api_instance.trigger_test_payments_webhook_event(
trigger_test_payments_webhook_event_request=trigger_test_payments_webhook_event_request
)
print(
"The response of PaymentApi->trigger_test_payments_webhook_event:\n"
)
pprint(api_response)
except Exception as e:
print(
"Exception when calling PaymentApi->trigger_test_payments_webhook_event: %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.PaymentApi;
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>");
PaymentApi apiInstance = new PaymentApi();
TriggerTestPaymentsWebhookEventRequest triggerTestPaymentsWebhookEventRequest =
new TriggerTestPaymentsWebhookEventRequest()
.eventType(WebhookEventType.PAYMENT_ORDER_STATUS_UPDATED);
try {
TriggerTestPaymentWebhookEventResponse result =
apiInstance.triggerTestPaymentsWebhookEvent(
triggerTestPaymentsWebhookEventRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling PaymentApi#triggerTestPaymentsWebhookEvent");
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() {
triggerTestPaymentsWebhookEventRequest := *coboWaas2.NewTriggerTestPaymentsWebhookEventRequest(
coboWaas2.WebhookEventType("payment.order.status.updated"),
)
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.PaymentAPI.TriggerTestPaymentsWebhookEvent(ctx).
TriggerTestPaymentsWebhookEventRequest(triggerTestPaymentsWebhookEventRequest).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `PaymentAPI.TriggerTestPaymentsWebhookEvent``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TriggerTestPaymentsWebhookEvent`: TriggerTestPaymentWebhookEventResponse
fmt.Fprintf(
os.Stdout,
"Response from `PaymentAPI.TriggerTestPaymentsWebhookEvent`: %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.PaymentApi();
const opts = {
TriggerTestPaymentsWebhookEventRequest:
CoboWaas2.TriggerTestPaymentsWebhookEventRequest.constructFromObject({
event_type: "payment.order.status.updated",
override_data: {
chain_id: "ETH",
transaction_id: "Test-transaction-id",
},
}),
};
apiInstance.triggerTestPaymentsWebhookEvent(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"triggered": true
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}Trigger test webhook event
This operation tests the functionality of your Payments webhook endpoint by triggering a test webhook event. The test event is sent to all endpoints you have registered on Cobo Portal.
You need to specify the event type. By default, the payload contains dummy data with no impact on your real business transactions or activities. You can optionally provide the override_data property to customize the payload.
For more information about Payments webhooks, see Cobo Payments Guide. For webhook event types and payload structure, refer to List all webhook events.
import cobo_waas2
from cobo_waas2.models.trigger_test_payment_webhook_event_response import (
TriggerTestPaymentWebhookEventResponse,
)
from cobo_waas2.models.trigger_test_payments_webhook_event_request import (
TriggerTestPaymentsWebhookEventRequest,
)
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.PaymentApi(api_client)
trigger_test_payments_webhook_event_request = (
cobo_waas2.TriggerTestPaymentsWebhookEventRequest(
event_type="payment.order.status.updated",
override_data={
"chain_id": "ETH",
"transaction_id": "Test-transaction-id",
},
)
)
try:
# Trigger test Payments webhook event
api_response = api_instance.trigger_test_payments_webhook_event(
trigger_test_payments_webhook_event_request=trigger_test_payments_webhook_event_request
)
print(
"The response of PaymentApi->trigger_test_payments_webhook_event:\n"
)
pprint(api_response)
except Exception as e:
print(
"Exception when calling PaymentApi->trigger_test_payments_webhook_event: %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.PaymentApi;
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>");
PaymentApi apiInstance = new PaymentApi();
TriggerTestPaymentsWebhookEventRequest triggerTestPaymentsWebhookEventRequest =
new TriggerTestPaymentsWebhookEventRequest()
.eventType(WebhookEventType.PAYMENT_ORDER_STATUS_UPDATED);
try {
TriggerTestPaymentWebhookEventResponse result =
apiInstance.triggerTestPaymentsWebhookEvent(
triggerTestPaymentsWebhookEventRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling PaymentApi#triggerTestPaymentsWebhookEvent");
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() {
triggerTestPaymentsWebhookEventRequest := *coboWaas2.NewTriggerTestPaymentsWebhookEventRequest(
coboWaas2.WebhookEventType("payment.order.status.updated"),
)
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.PaymentAPI.TriggerTestPaymentsWebhookEvent(ctx).
TriggerTestPaymentsWebhookEventRequest(triggerTestPaymentsWebhookEventRequest).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `PaymentAPI.TriggerTestPaymentsWebhookEvent``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TriggerTestPaymentsWebhookEvent`: TriggerTestPaymentWebhookEventResponse
fmt.Fprintf(
os.Stdout,
"Response from `PaymentAPI.TriggerTestPaymentsWebhookEvent`: %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.PaymentApi();
const opts = {
TriggerTestPaymentsWebhookEventRequest:
CoboWaas2.TriggerTestPaymentsWebhookEventRequest.constructFromObject({
event_type: "payment.order.status.updated",
override_data: {
chain_id: "ETH",
transaction_id: "Test-transaction-id",
},
}),
};
apiInstance.triggerTestPaymentsWebhookEvent(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"triggered": true
}{
"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.trigger_test_payment_webhook_event_response import (
TriggerTestPaymentWebhookEventResponse,
)
from cobo_waas2.models.trigger_test_payments_webhook_event_request import (
TriggerTestPaymentsWebhookEventRequest,
)
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.PaymentApi(api_client)
trigger_test_payments_webhook_event_request = (
cobo_waas2.TriggerTestPaymentsWebhookEventRequest(
event_type="payment.order.status.updated",
override_data={
"chain_id": "ETH",
"transaction_id": "Test-transaction-id",
},
)
)
try:
# Trigger test Payments webhook event
api_response = api_instance.trigger_test_payments_webhook_event(
trigger_test_payments_webhook_event_request=trigger_test_payments_webhook_event_request
)
print(
"The response of PaymentApi->trigger_test_payments_webhook_event:\n"
)
pprint(api_response)
except Exception as e:
print(
"Exception when calling PaymentApi->trigger_test_payments_webhook_event: %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.PaymentApi;
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>");
PaymentApi apiInstance = new PaymentApi();
TriggerTestPaymentsWebhookEventRequest triggerTestPaymentsWebhookEventRequest =
new TriggerTestPaymentsWebhookEventRequest()
.eventType(WebhookEventType.PAYMENT_ORDER_STATUS_UPDATED);
try {
TriggerTestPaymentWebhookEventResponse result =
apiInstance.triggerTestPaymentsWebhookEvent(
triggerTestPaymentsWebhookEventRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling PaymentApi#triggerTestPaymentsWebhookEvent");
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() {
triggerTestPaymentsWebhookEventRequest := *coboWaas2.NewTriggerTestPaymentsWebhookEventRequest(
coboWaas2.WebhookEventType("payment.order.status.updated"),
)
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.PaymentAPI.TriggerTestPaymentsWebhookEvent(ctx).
TriggerTestPaymentsWebhookEventRequest(triggerTestPaymentsWebhookEventRequest).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `PaymentAPI.TriggerTestPaymentsWebhookEvent``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TriggerTestPaymentsWebhookEvent`: TriggerTestPaymentWebhookEventResponse
fmt.Fprintf(
os.Stdout,
"Response from `PaymentAPI.TriggerTestPaymentsWebhookEvent`: %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.PaymentApi();
const opts = {
TriggerTestPaymentsWebhookEventRequest:
CoboWaas2.TriggerTestPaymentsWebhookEventRequest.constructFromObject({
event_type: "payment.order.status.updated",
override_data: {
chain_id: "ETH",
transaction_id: "Test-transaction-id",
},
}),
};
apiInstance.triggerTestPaymentsWebhookEvent(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
The request body used to trigger a test Payments webhook event.
You need to specify the event type. You can optionally include the override_data property to customize the payload. The provided fields must match the webhook event data structure for the specified event type.
The event type. To learn the trigger condition of each event type, refer to Webhook event types and event data.
wallets.transaction.created, wallets.transaction.updated, wallets.transaction.failed, wallets.transaction.succeeded, wallets.mpc.tss_request.created, wallets.mpc.tss_request.updated, wallets.mpc.tss_request.failed, wallets.mpc.tss_request.succeeded, wallets.addresses.created, wallets.created, wallets.updated, wallets.token_listing.failed, wallets.token_listing.succeeded, mpc_vaults.created, mpc_vaults.updated, mpc_vaults.deleted, organizations.updated, fee_station.transaction.created, fee_station.transaction.updated, fee_station.transaction.failed, fee_station.transaction.succeeded, fee_station.fiat_transaction.created, wallet.token.enabled, wallet.chain.enabled, wallet.mpc.balance.updated, wallet.web3.balance.updated, wallet.token.disabled, wallet.chain.disabled, token.suspended.deposit, token.suspended.withdraw, payment.transaction.created, payment.transaction.late, payment.transaction.completed, payment.transaction.held, payment.transaction.failed, payment.account.balance.updated, payment.status.updated, payment.order.status.updated, payment.refund.status.updated, payment.settlement.status.updated, payment.payout.status.updated, payment.bank_withdrawal.status.updated, payment.address.updated, payment.subscription.status.updated, payment.charge.status.updated, payment.bulk_send.status.updated, payment.bulk_send.item.status.updated, payment.transaction.external.created, payment.transaction.external.completed, payment.transaction.settlement_network.created, payment.transaction.settlement_network.completed, compliance.disposition.status.updated, compliance.kyt.screenings.status.updated, compliance.kya.screenings.status.updated "wallets.transaction.created"
An optional object to customize the webhook event payload. Include only the fields you want to override.
The provided fields must match the webhook event data structure for the specified event type. For the full event data structure, refer to the data.data property in the response of List all webhook events.
If this property is omitted, a default payload is returned.
{
"chain_id": "ETH",
"transaction_id": "Test-transaction-id"
}
Response
The request was successful.
Whether a test webhook event was successfully triggered.
true: The test webhook event was successfully triggered.false: The test webhook event could not be triggered.
true
