import cobo_waas2
from cobo_waas2.models.get_refunds200_response import GetRefunds200Response
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)
limit = 10
before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
merchant_id = "M1001"
request_id = "random_request_id"
statuses = "Pending,Processing"
try:
# List all refund orders
api_response = api_instance.get_refunds(
limit=limit,
before=before,
after=after,
merchant_id=merchant_id,
request_id=request_id,
statuses=statuses,
)
print("The response of PaymentApi->get_refunds:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_refunds: %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();
Integer limit = 10;
String before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1";
String after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk";
String merchantId = "M1001";
String requestId = "random_request_id";
String statuses = "Pending,Processing";
try {
GetRefunds200Response result =
apiInstance.getRefunds(limit, before, after, merchantId, requestId, statuses);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getRefunds");
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() {
limit := int32(10)
before := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
after := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
merchantId := "M1001"
requestId := "random_request_id"
statuses := "Pending,Processing"
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.GetRefunds(ctx).
Limit(limit).
Before(before).
After(after).
MerchantId(merchantId).
RequestId(requestId).
Statuses(statuses).
Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetRefunds``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetRefunds`: GetRefunds200Response
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetRefunds`: %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 = {
limit: 10,
before: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
after: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
merchant_id: "M1001",
request_id: "random_request_id",
statuses: "Pending,Processing",
};
apiInstance.getRefunds(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"data": [
{
"refund_id": "R20250304-M1001-1001",
"token_id": "ETH_USDT",
"chain_id": "ETH",
"amount": "0.0025",
"to_address": "0x9876543210abcdef1234567890abcdef12345678",
"status": "Pending",
"request_id": "123e4567-e89b-12d3-a456-426614174004",
"order_id": "O20250304-M1001-1001",
"merchant_id": "M1001",
"refund_type": "Merchant",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600,
"initiator": "b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b85b81dcc15f920e9d",
"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",
"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",
"country": "USA",
"email": "[email protected]",
"contact_address": "123 Main St, Anytown, USA",
"merchant_id": "M1001"
}
}
],
"charge_merchant_fee": false,
"merchant_fee_amount": "0.0001",
"merchant_fee_token_id": "ETH_USDT",
"commission_fee": {
"fee_amount": "<string>"
}
}
],
"pagination": {
"before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
"after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
"total_count": 10000
}
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}List all refund orders
This operation retrieves the information of all refund orders.
import cobo_waas2
from cobo_waas2.models.get_refunds200_response import GetRefunds200Response
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)
limit = 10
before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
merchant_id = "M1001"
request_id = "random_request_id"
statuses = "Pending,Processing"
try:
# List all refund orders
api_response = api_instance.get_refunds(
limit=limit,
before=before,
after=after,
merchant_id=merchant_id,
request_id=request_id,
statuses=statuses,
)
print("The response of PaymentApi->get_refunds:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_refunds: %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();
Integer limit = 10;
String before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1";
String after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk";
String merchantId = "M1001";
String requestId = "random_request_id";
String statuses = "Pending,Processing";
try {
GetRefunds200Response result =
apiInstance.getRefunds(limit, before, after, merchantId, requestId, statuses);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getRefunds");
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() {
limit := int32(10)
before := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
after := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
merchantId := "M1001"
requestId := "random_request_id"
statuses := "Pending,Processing"
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.GetRefunds(ctx).
Limit(limit).
Before(before).
After(after).
MerchantId(merchantId).
RequestId(requestId).
Statuses(statuses).
Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetRefunds``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetRefunds`: GetRefunds200Response
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetRefunds`: %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 = {
limit: 10,
before: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
after: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
merchant_id: "M1001",
request_id: "random_request_id",
statuses: "Pending,Processing",
};
apiInstance.getRefunds(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"data": [
{
"refund_id": "R20250304-M1001-1001",
"token_id": "ETH_USDT",
"chain_id": "ETH",
"amount": "0.0025",
"to_address": "0x9876543210abcdef1234567890abcdef12345678",
"status": "Pending",
"request_id": "123e4567-e89b-12d3-a456-426614174004",
"order_id": "O20250304-M1001-1001",
"merchant_id": "M1001",
"refund_type": "Merchant",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600,
"initiator": "b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b85b81dcc15f920e9d",
"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",
"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",
"country": "USA",
"email": "[email protected]",
"contact_address": "123 Main St, Anytown, USA",
"merchant_id": "M1001"
}
}
],
"charge_merchant_fee": false,
"merchant_fee_amount": "0.0001",
"merchant_fee_token_id": "ETH_USDT",
"commission_fee": {
"fee_amount": "<string>"
}
}
],
"pagination": {
"before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
"after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
"total_count": 10000
}
}{
"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.get_refunds200_response import GetRefunds200Response
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)
limit = 10
before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
merchant_id = "M1001"
request_id = "random_request_id"
statuses = "Pending,Processing"
try:
# List all refund orders
api_response = api_instance.get_refunds(
limit=limit,
before=before,
after=after,
merchant_id=merchant_id,
request_id=request_id,
statuses=statuses,
)
print("The response of PaymentApi->get_refunds:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_refunds: %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();
Integer limit = 10;
String before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1";
String after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk";
String merchantId = "M1001";
String requestId = "random_request_id";
String statuses = "Pending,Processing";
try {
GetRefunds200Response result =
apiInstance.getRefunds(limit, before, after, merchantId, requestId, statuses);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getRefunds");
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() {
limit := int32(10)
before := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
after := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
merchantId := "M1001"
requestId := "random_request_id"
statuses := "Pending,Processing"
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.GetRefunds(ctx).
Limit(limit).
Before(before).
After(after).
MerchantId(merchantId).
RequestId(requestId).
Statuses(statuses).
Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetRefunds``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetRefunds`: GetRefunds200Response
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetRefunds`: %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 = {
limit: 10,
before: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
after: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
merchant_id: "M1001",
request_id: "random_request_id",
statuses: "Pending,Processing",
};
apiInstance.getRefunds(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.
Query Parameters
The maximum number of objects to return. For most operations, the value range is [1, 50].
A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.
A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.
The merchant ID.
The request ID.
A list of order, refund or payout item statuses. You can refer to the following operations for the possible status values:
