import cobo_waas2
from cobo_waas2.models.settlement import Settlement
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)
settlement_request_id = "S20250304-1001"
try:
# Get settlement request information
api_response = api_instance.get_settlement_by_id(settlement_request_id)
print("The response of PaymentApi->get_settlement_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_settlement_by_id: %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();
String settlementRequestId = "S20250304-1001";
try {
Settlement result = apiInstance.getSettlementById(settlementRequestId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getSettlementById");
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() {
settlementRequestId := "S20250304-1001"
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.GetSettlementById(ctx, settlementRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetSettlementById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetSettlementById`: Settlement
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetSettlementById`: %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 settlement_request_id = "S20250304-1001";
apiInstance.getSettlementById(settlement_request_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"settlement_request_id": "S20250304-1001",
"request_id": "SETTLEMENT123",
"status": "Pending",
"settlements": [
{
"currency": "USD",
"token_id": "ETH_USDT",
"chain_id": "ETH",
"merchant_id": "M1001",
"amount": "500.00",
"settled_amount": "500.00",
"status": "Pending",
"bank_account": {
"bank_account_id": "123e4567-e89b-12d3-a456-426614174003",
"info": {
"beneficiary_name": "John Doe",
"beneficiary_address": "123 Main St, Anytown, USA",
"account_number": "4111111111111111",
"bank_name": "ABC Bank",
"bank_country": "USA",
"bank_address": "456 Bank Ave, Cityville, USA",
"swift_or_bic": "ABCDEFGH"
},
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600
},
"transactions": [
{
"tx_id": "tx_123e4567-e89b-12d3-a456-426614174003",
"from_address": "0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537",
"to_address": "0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15",
"amount": "0.15",
"status": "Submitted",
"created_timestamp": 1610445878970,
"updated_timestamp": 1610445878970,
"tx_hash": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
"token_id": "ETH_USDT",
"sub_status": "PendingDoubleCheck",
"failed_reason": "Rejected by signer Cobo TSS",
"counterparty": {
"counterparty_type": "Individual",
"counterparty_name": "Counterparty A",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600,
"counterparty_id": "123e4567-e89b-12d3-a456-426614174003",
"country": "USA",
"email": "[email protected]",
"contact_address": "123 Main St, Anytown, USA"
},
"destination": {
"destination_type": "Individual",
"destination_name": "Destination A",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600,
"destination_id": "123e4567-e89b-12d3-a456-426614174003",
"source": "Client",
"country": "USA",
"email": "[email protected]",
"contact_address": "123 Main St, Anytown, USA",
"merchant_id": "M1001"
}
}
],
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600,
"crypto_address_id": "addr_ethusdt_20250429T134512_a8c31f",
"crypto_address": "0xabc123456789def0000000000000000000000000",
"payout_channel": "Crypto",
"acquiring_type": "Order",
"settlement_request_id": "S20250304-1001",
"order_ids": [
"O20250304-M1001-1001"
],
"commission_fee": {
"fee_amount": "<string>"
},
"bridging_fee": {
"fee_amount": "<string>",
"received_token_id": "<string>",
"received_amount": "<string>",
"bridge_status": "Completed"
}
}
],
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600,
"initiator": "api_key_b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d",
"acquiring_type": "Order",
"payout_channel": "Crypto",
"settlement_type": "Merchant",
"currency": "USD",
"received_amount_fiat": "500.00",
"bank_account": {
"bank_account_id": "123e4567-e89b-12d3-a456-426614174003",
"info": {
"beneficiary_name": "John Doe",
"beneficiary_address": "123 Main St, Anytown, USA",
"account_number": "4111111111111111",
"bank_name": "ABC Bank",
"bank_country": "USA",
"bank_address": "456 Bank Ave, Cityville, USA",
"swift_or_bic": "ABCDEFGH"
},
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600
}
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}Get settlement request information
This operation retrieves the information of a specific settlement request.
import cobo_waas2
from cobo_waas2.models.settlement import Settlement
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)
settlement_request_id = "S20250304-1001"
try:
# Get settlement request information
api_response = api_instance.get_settlement_by_id(settlement_request_id)
print("The response of PaymentApi->get_settlement_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_settlement_by_id: %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();
String settlementRequestId = "S20250304-1001";
try {
Settlement result = apiInstance.getSettlementById(settlementRequestId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getSettlementById");
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() {
settlementRequestId := "S20250304-1001"
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.GetSettlementById(ctx, settlementRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetSettlementById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetSettlementById`: Settlement
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetSettlementById`: %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 settlement_request_id = "S20250304-1001";
apiInstance.getSettlementById(settlement_request_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"settlement_request_id": "S20250304-1001",
"request_id": "SETTLEMENT123",
"status": "Pending",
"settlements": [
{
"currency": "USD",
"token_id": "ETH_USDT",
"chain_id": "ETH",
"merchant_id": "M1001",
"amount": "500.00",
"settled_amount": "500.00",
"status": "Pending",
"bank_account": {
"bank_account_id": "123e4567-e89b-12d3-a456-426614174003",
"info": {
"beneficiary_name": "John Doe",
"beneficiary_address": "123 Main St, Anytown, USA",
"account_number": "4111111111111111",
"bank_name": "ABC Bank",
"bank_country": "USA",
"bank_address": "456 Bank Ave, Cityville, USA",
"swift_or_bic": "ABCDEFGH"
},
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600
},
"transactions": [
{
"tx_id": "tx_123e4567-e89b-12d3-a456-426614174003",
"from_address": "0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537",
"to_address": "0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15",
"amount": "0.15",
"status": "Submitted",
"created_timestamp": 1610445878970,
"updated_timestamp": 1610445878970,
"tx_hash": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
"token_id": "ETH_USDT",
"sub_status": "PendingDoubleCheck",
"failed_reason": "Rejected by signer Cobo TSS",
"counterparty": {
"counterparty_type": "Individual",
"counterparty_name": "Counterparty A",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600,
"counterparty_id": "123e4567-e89b-12d3-a456-426614174003",
"country": "USA",
"email": "[email protected]",
"contact_address": "123 Main St, Anytown, USA"
},
"destination": {
"destination_type": "Individual",
"destination_name": "Destination A",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600,
"destination_id": "123e4567-e89b-12d3-a456-426614174003",
"source": "Client",
"country": "USA",
"email": "[email protected]",
"contact_address": "123 Main St, Anytown, USA",
"merchant_id": "M1001"
}
}
],
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600,
"crypto_address_id": "addr_ethusdt_20250429T134512_a8c31f",
"crypto_address": "0xabc123456789def0000000000000000000000000",
"payout_channel": "Crypto",
"acquiring_type": "Order",
"settlement_request_id": "S20250304-1001",
"order_ids": [
"O20250304-M1001-1001"
],
"commission_fee": {
"fee_amount": "<string>"
},
"bridging_fee": {
"fee_amount": "<string>",
"received_token_id": "<string>",
"received_amount": "<string>",
"bridge_status": "Completed"
}
}
],
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600,
"initiator": "api_key_b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d",
"acquiring_type": "Order",
"payout_channel": "Crypto",
"settlement_type": "Merchant",
"currency": "USD",
"received_amount_fiat": "500.00",
"bank_account": {
"bank_account_id": "123e4567-e89b-12d3-a456-426614174003",
"info": {
"beneficiary_name": "John Doe",
"beneficiary_address": "123 Main St, Anytown, USA",
"account_number": "4111111111111111",
"bank_name": "ABC Bank",
"bank_country": "USA",
"bank_address": "456 Bank Ave, Cityville, USA",
"swift_or_bic": "ABCDEFGH"
},
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600
}
}{
"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.settlement import Settlement
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)
settlement_request_id = "S20250304-1001"
try:
# Get settlement request information
api_response = api_instance.get_settlement_by_id(settlement_request_id)
print("The response of PaymentApi->get_settlement_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_settlement_by_id: %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();
String settlementRequestId = "S20250304-1001";
try {
Settlement result = apiInstance.getSettlementById(settlementRequestId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getSettlementById");
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() {
settlementRequestId := "S20250304-1001"
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.GetSettlementById(ctx, settlementRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetSettlementById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetSettlementById`: Settlement
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetSettlementById`: %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 settlement_request_id = "S20250304-1001";
apiInstance.getSettlementById(settlement_request_id).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.
Path Parameters
The settlement request ID.
Response
The request was successful.
The settlement request ID generated by Cobo.
"S20250304-1001"
The request ID provided by you when creating the settlement request.
"SETTLEMENT123"
The current status of a settlement request:
Pending: The settlement request has been created and is awaiting processing.Processing: The settlement request is currently being processed, with at least one settlement in progress.Completed: All requested settlements have been completed.PartiallyCompleted: Some requested settlements have been completed successfully, while others have failed.Failed: All requested settlements have failed.Canceled: The settlement request has been canceled due to bank transfer failure. Contact Cobo's support team through [email protected] for assistance.
Pending, Processing, Completed, PartiallyCompleted, Failed, Canceled "Pending"
Show child attributes
Show child attributes
The created time of the settlement request, represented as a UNIX timestamp in seconds.
1744689600
The updated time of the settlement request, represented as a UNIX timestamp in seconds.
1744689600
The initiator of this settlement request. Can return either an API key or the Payments App's ID.
- Format
api_key_<API_KEY>: Indicates the settlement request was initiated via the Payments API using the API key. - Format
app_<APP_ID>: Indicates the settlement request was initiated through the Payments App using the App ID.
"api_key_b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d"
The payment acquisition type.
Order: Payers pay by fixed-amount orders. Ideal for specific purchases and one-time transactions.TopUp: Account recharge flow where payers deposit funds to their dedicated top-up addresses. Ideal for flexible or usage-based payment models.
Order, TopUp "Order"
The channel through which the payout will be processed. Possible values include:
Crypto: The payout will be processed as a cryptocurrency transfer to a crypto address.OffRamp: The payout will be processed as a fiat currency transfer to a registered bank account.
Crypto, OffRamp "Crypto"
Specifies the source of funds for the settlement:
Merchant: The settlement amount will be deducted from the merchant balance.Psp: The settlement amount will be deducted from the developer balance.
Merchant, Psp "Merchant"
The fiat currency for the off-ramp.
"USD"
The estimated amount of the fiat currency to receive after off-ramping. This amount is subject to change due to bank transfer fees.
"500.00"
Show child attributes
Show child attributes
