import cobo_waas2
from cobo_waas2.models.payment_payout_detail import PaymentPayoutDetail
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)
payout_id = "aff0e1cb-15b2-4e1f-9b9d-a9133715986f"
try:
# Get payout information
api_response = api_instance.get_payout_by_id(payout_id)
print("The response of PaymentApi->get_payout_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_payout_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 payoutId = "aff0e1cb-15b2-4e1f-9b9d-a9133715986f";
try {
PaymentPayoutDetail result = apiInstance.getPayoutById(payoutId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getPayoutById");
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() {
payoutId := "aff0e1cb-15b2-4e1f-9b9d-a9133715986f"
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.GetPayoutById(ctx, payoutId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetPayoutById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetPayoutById`: PaymentPayoutDetail
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetPayoutById`: %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 payout_id = "aff0e1cb-15b2-4e1f-9b9d-a9133715986f";
apiInstance.getPayoutById(payout_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"payout_id": "123e457-e89b-12d3-a456-426614174004",
"request_id": "123e457-e89b-12d3-a456-426614174004",
"payout_channel": "Crypto",
"status": "Pending",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600,
"source_account": "<string>",
"payout_items": [
{
"token_id": "ETH_USDT",
"amount": "500.00",
"bridging_fee": {
"fee_amount": "<string>",
"received_token_id": "<string>",
"received_amount": "<string>",
"bridge_status": "Completed"
}
}
],
"recipient_info": {
"address": "0x9876543210abcdef1234567890abcdef12345678",
"token_id": "TRON_USDT",
"currency": "USD",
"bank_account_id": "123e4567-e89b-12d3-a456-426614174003",
"transfer_via_va": false
},
"initiator": "b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d",
"actual_payout_amount": "500.00",
"commission_fees": [
{
"fee_amount": "<string>"
}
],
"remark": "Payout for customer 123",
"failed_reason": "Cannot charge payout fee: Fee Station balance is insufficient. Please add funds to Fee Station and try again.",
"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"
}
}
]
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}Get payout information
This operation retrieves the information of a specific payout.
import cobo_waas2
from cobo_waas2.models.payment_payout_detail import PaymentPayoutDetail
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)
payout_id = "aff0e1cb-15b2-4e1f-9b9d-a9133715986f"
try:
# Get payout information
api_response = api_instance.get_payout_by_id(payout_id)
print("The response of PaymentApi->get_payout_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_payout_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 payoutId = "aff0e1cb-15b2-4e1f-9b9d-a9133715986f";
try {
PaymentPayoutDetail result = apiInstance.getPayoutById(payoutId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getPayoutById");
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() {
payoutId := "aff0e1cb-15b2-4e1f-9b9d-a9133715986f"
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.GetPayoutById(ctx, payoutId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetPayoutById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetPayoutById`: PaymentPayoutDetail
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetPayoutById`: %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 payout_id = "aff0e1cb-15b2-4e1f-9b9d-a9133715986f";
apiInstance.getPayoutById(payout_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"payout_id": "123e457-e89b-12d3-a456-426614174004",
"request_id": "123e457-e89b-12d3-a456-426614174004",
"payout_channel": "Crypto",
"status": "Pending",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600,
"source_account": "<string>",
"payout_items": [
{
"token_id": "ETH_USDT",
"amount": "500.00",
"bridging_fee": {
"fee_amount": "<string>",
"received_token_id": "<string>",
"received_amount": "<string>",
"bridge_status": "Completed"
}
}
],
"recipient_info": {
"address": "0x9876543210abcdef1234567890abcdef12345678",
"token_id": "TRON_USDT",
"currency": "USD",
"bank_account_id": "123e4567-e89b-12d3-a456-426614174003",
"transfer_via_va": false
},
"initiator": "b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d",
"actual_payout_amount": "500.00",
"commission_fees": [
{
"fee_amount": "<string>"
}
],
"remark": "Payout for customer 123",
"failed_reason": "Cannot charge payout fee: Fee Station balance is insufficient. Please add funds to Fee Station and try again.",
"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"
}
}
]
}{
"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.payment_payout_detail import PaymentPayoutDetail
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)
payout_id = "aff0e1cb-15b2-4e1f-9b9d-a9133715986f"
try:
# Get payout information
api_response = api_instance.get_payout_by_id(payout_id)
print("The response of PaymentApi->get_payout_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_payout_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 payoutId = "aff0e1cb-15b2-4e1f-9b9d-a9133715986f";
try {
PaymentPayoutDetail result = apiInstance.getPayoutById(payoutId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getPayoutById");
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() {
payoutId := "aff0e1cb-15b2-4e1f-9b9d-a9133715986f"
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.GetPayoutById(ctx, payoutId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetPayoutById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetPayoutById`: PaymentPayoutDetail
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetPayoutById`: %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 payout_id = "aff0e1cb-15b2-4e1f-9b9d-a9133715986f";
apiInstance.getPayoutById(payout_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 payout ID.
Response
The request was successful.
The payout ID generated by Cobo.
"123e457-e89b-12d3-a456-426614174004"
The request ID provided by you when creating the payout.
"123e457-e89b-12d3-a456-426614174004"
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"
The current status of the payout. Possible values include:
Pending: The payout has been created and is awaiting processing.Preparing: The payout is being prepared for transfer.Transferring: The payout is currently being transferred to the recipient's destination.Completed: The payout has been successfully completed and all transactions have been processed.PartiallyCompleted: The payout has been partially completed, with some transactions succeeding and others failing.Failed: The payout has failed and no transactions were completed successfully.RejectedByBank: The payout was rejected by the recipient's bank (applicable to OffRamp payouts only).
Pending, Preparing, Transferring, Completed, PartiallyCompleted, Failed, RejectedByBank "Pending"
The created time of the payout, represented as a UNIX timestamp in seconds.
1744689600
The updated time of the payout, represented as a UNIX timestamp in seconds.
1744689600
The source account from which the payout will be made.
- If the source account is a merchant account, provide the merchant's ID (e.g., "M1001").
- If the source account is the developer account, use the string
"developer".
required
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The initiator of this payout, usually the user's API key.
"b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d"
- For
Cryptopayouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified inrecipient_info.token_id. - For
OffRamppayouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified inrecipient_info.currency. (Note: The actual amount received may be lower due to additional bank transfer fees.)
"500.00"
The commission fees. Not returned when no fee has been incurred, the actual charged amounts once incurred, or 0 if refunded.
Show child attributes
Show child attributes
A note or comment about the payout.
"Payout for customer 123"
The reason why the payout failed.
"Cannot charge payout fee: Fee Station balance is insufficient. Please add funds to Fee Station and try again."
An array of payout transactions.
Show child attributes
Show child attributes
