import cobo_waas2
from cobo_waas2.models.acquiring_type import AcquiringType
from cobo_waas2.models.get_settlement_info_by_ids200_response import (
GetSettlementInfoByIds200Response,
)
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)
merchant_ids = "M1001,M1002,M1003"
currency = "USD"
acquiring_type = cobo_waas2.AcquiringType()
try:
# Get withdrawable balances
api_response = api_instance.get_settlement_info_by_ids(
merchant_ids=merchant_ids, currency=currency, acquiring_type=acquiring_type
)
print("The response of PaymentApi->get_settlement_info_by_ids:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_settlement_info_by_ids: %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 merchantIds = "M1001,M1002,M1003";
String currency = "USD";
AcquiringType acquiringType = AcquiringType.fromValue("Order");
try {
GetSettlementInfoByIds200Response result =
apiInstance.getSettlementInfoByIds(merchantIds, currency, acquiringType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getSettlementInfoByIds");
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() {
merchantIds := "M1001,M1002,M1003"
currency := "USD"
acquiringType := coboWaas2.AcquiringType("Order")
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.GetSettlementInfoByIds(ctx).
MerchantIds(merchantIds).
Currency(currency).
AcquiringType(acquiringType).
Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetSettlementInfoByIds``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetSettlementInfoByIds`: GetSettlementInfoByIds200Response
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetSettlementInfoByIds`: %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 = {
merchant_ids: "M1001,M1002,M1003",
currency: "USD",
acquiring_type: new CoboWaas2.AcquiringType(),
};
apiInstance.getSettlementInfoByIds(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"psp_token_balances": [
{
"available_amount": "500.00",
"merchant_id": "123",
"token_id": "ETH_USDT",
"available_currency_balance": "500.00",
"pending_amount": "500.00",
"pending_currency_balance": "500.00",
"settled_amount": "500.00",
"available_balance": "500.00",
"total_balance": "500.00",
"acquiring_type": "Order",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600
}
],
"token_balances": [
{
"available_amount": "500.00",
"merchant_id": "123",
"token_id": "ETH_USDT",
"available_currency_balance": "500.00",
"pending_amount": "500.00",
"pending_currency_balance": "500.00",
"settled_amount": "500.00",
"available_balance": "500.00",
"total_balance": "500.00",
"acquiring_type": "Order",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600
}
]
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}Balances
Get withdrawable balances
This operation has been deprecated.
GET
/
payments
/
settlement_info
import cobo_waas2
from cobo_waas2.models.acquiring_type import AcquiringType
from cobo_waas2.models.get_settlement_info_by_ids200_response import (
GetSettlementInfoByIds200Response,
)
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)
merchant_ids = "M1001,M1002,M1003"
currency = "USD"
acquiring_type = cobo_waas2.AcquiringType()
try:
# Get withdrawable balances
api_response = api_instance.get_settlement_info_by_ids(
merchant_ids=merchant_ids, currency=currency, acquiring_type=acquiring_type
)
print("The response of PaymentApi->get_settlement_info_by_ids:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_settlement_info_by_ids: %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 merchantIds = "M1001,M1002,M1003";
String currency = "USD";
AcquiringType acquiringType = AcquiringType.fromValue("Order");
try {
GetSettlementInfoByIds200Response result =
apiInstance.getSettlementInfoByIds(merchantIds, currency, acquiringType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getSettlementInfoByIds");
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() {
merchantIds := "M1001,M1002,M1003"
currency := "USD"
acquiringType := coboWaas2.AcquiringType("Order")
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.GetSettlementInfoByIds(ctx).
MerchantIds(merchantIds).
Currency(currency).
AcquiringType(acquiringType).
Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetSettlementInfoByIds``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetSettlementInfoByIds`: GetSettlementInfoByIds200Response
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetSettlementInfoByIds`: %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 = {
merchant_ids: "M1001,M1002,M1003",
currency: "USD",
acquiring_type: new CoboWaas2.AcquiringType(),
};
apiInstance.getSettlementInfoByIds(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"psp_token_balances": [
{
"available_amount": "500.00",
"merchant_id": "123",
"token_id": "ETH_USDT",
"available_currency_balance": "500.00",
"pending_amount": "500.00",
"pending_currency_balance": "500.00",
"settled_amount": "500.00",
"available_balance": "500.00",
"total_balance": "500.00",
"acquiring_type": "Order",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600
}
],
"token_balances": [
{
"available_amount": "500.00",
"merchant_id": "123",
"token_id": "ETH_USDT",
"available_currency_balance": "500.00",
"pending_amount": "500.00",
"pending_currency_balance": "500.00",
"settled_amount": "500.00",
"available_balance": "500.00",
"total_balance": "500.00",
"acquiring_type": "Order",
"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.acquiring_type import AcquiringType
from cobo_waas2.models.get_settlement_info_by_ids200_response import (
GetSettlementInfoByIds200Response,
)
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)
merchant_ids = "M1001,M1002,M1003"
currency = "USD"
acquiring_type = cobo_waas2.AcquiringType()
try:
# Get withdrawable balances
api_response = api_instance.get_settlement_info_by_ids(
merchant_ids=merchant_ids, currency=currency, acquiring_type=acquiring_type
)
print("The response of PaymentApi->get_settlement_info_by_ids:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_settlement_info_by_ids: %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 merchantIds = "M1001,M1002,M1003";
String currency = "USD";
AcquiringType acquiringType = AcquiringType.fromValue("Order");
try {
GetSettlementInfoByIds200Response result =
apiInstance.getSettlementInfoByIds(merchantIds, currency, acquiringType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getSettlementInfoByIds");
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() {
merchantIds := "M1001,M1002,M1003"
currency := "USD"
acquiringType := coboWaas2.AcquiringType("Order")
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.GetSettlementInfoByIds(ctx).
MerchantIds(merchantIds).
Currency(currency).
AcquiringType(acquiringType).
Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetSettlementInfoByIds``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetSettlementInfoByIds`: GetSettlementInfoByIds200Response
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetSettlementInfoByIds`: %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 = {
merchant_ids: "M1001,M1002,M1003",
currency: "USD",
acquiring_type: new CoboWaas2.AcquiringType(),
};
apiInstance.getSettlementInfoByIds(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
Authorizations
CoboAuthOAuth2
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.
Query Parameters
A list of merchant IDs to query.
The currency for the operation. Currently, only USD is supported.
This parameter has been deprecated 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.
Available options:
Order, TopUp Example:
"Order"
⌘I
