import cobo_waas2
from cobo_waas2.models.payment_bank_withdrawal_detail import (
PaymentBankWithdrawalDetail,
)
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)
bank_withdrawal_id = "123e4567-e89b-12d3-a456-426614174000"
try:
# Get bank withdrawal information
api_response = api_instance.get_bank_withdrawal_by_id(bank_withdrawal_id)
print("The response of PaymentApi->get_bank_withdrawal_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_bank_withdrawal_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 bankWithdrawalId = "123e4567-e89b-12d3-a456-426614174000";
try {
PaymentBankWithdrawalDetail result = apiInstance.getBankWithdrawalById(bankWithdrawalId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getBankWithdrawalById");
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() {
bankWithdrawalId := "123e4567-e89b-12d3-a456-426614174000"
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.GetBankWithdrawalById(ctx, bankWithdrawalId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetBankWithdrawalById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetBankWithdrawalById`: PaymentBankWithdrawalDetail
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetBankWithdrawalById`: %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 bank_withdrawal_id = "123e4567-e89b-12d3-a456-426614174000";
apiInstance.getBankWithdrawalById(bank_withdrawal_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"bank_withdrawal_id": "123e4567-e89b-12d3-a456-426614174000",
"request_id": "123e457-e89b-12d3-a456-426614174004",
"source_bank_account_id": "dst_ba_1234567890",
"target_bank_account_id": "dst_ba_0987654321",
"currency": "USD",
"amount": "100.00",
"status": "Pending",
"created_timestamp": 1744689600,
"source_bank_account": {
"destination_id": "123e4567-e89b-12d3-a456-426614174003",
"destination_name": "Destination A",
"destination_type": "Individual",
"bank_account_id": "123e4567-e89b-12d3-a456-426614174003",
"account_alias": "Main Payout Account",
"account_number": "4111111111111111",
"swift_code": "BOFAUS33",
"currency": "USD",
"beneficiary_name": "John Doe",
"beneficiary_address": "123 Main St, Anytown, USA",
"bank_name": "ABC Bank",
"bank_address": "456 Bank Ave, Cityville, USA",
"bank_account_status": "Pending",
"destination_email": "[email protected]",
"destination_country": "USA",
"destination_contact_address": "123 Main St, Anytown, USA",
"destination_merchant_id": "M1001",
"tag": "VA",
"iban_code": "12345678901234567890",
"further_credit": "further credit sample",
"intermediary_bank_info": {
"bank_name": "Intermediary Bank",
"bank_swift_code": "BOFAUS33",
"bank_address": "456 Bank Ave, Cityville, USA"
},
"country": "USA",
"city": "New York",
"payment_method": "Swift",
"holder_type": "Company",
"beneficiary_province": "Hong Kong",
"beneficiary_post_code": "999077",
"bank_account_name": "Example Company Limited",
"bank_branch_code": "123",
"bank_country": "HKG",
"bank_province": "Hong Kong",
"contract_file_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600
},
"target_bank_account": {
"destination_id": "123e4567-e89b-12d3-a456-426614174003",
"destination_name": "Destination A",
"destination_type": "Individual",
"bank_account_id": "123e4567-e89b-12d3-a456-426614174003",
"account_alias": "Main Payout Account",
"account_number": "4111111111111111",
"swift_code": "BOFAUS33",
"currency": "USD",
"beneficiary_name": "John Doe",
"beneficiary_address": "123 Main St, Anytown, USA",
"bank_name": "ABC Bank",
"bank_address": "456 Bank Ave, Cityville, USA",
"bank_account_status": "Pending",
"destination_email": "[email protected]",
"destination_country": "USA",
"destination_contact_address": "123 Main St, Anytown, USA",
"destination_merchant_id": "M1001",
"tag": "VA",
"iban_code": "12345678901234567890",
"further_credit": "further credit sample",
"intermediary_bank_info": {
"bank_name": "Intermediary Bank",
"bank_swift_code": "BOFAUS33",
"bank_address": "456 Bank Ave, Cityville, USA"
},
"country": "USA",
"city": "New York",
"payment_method": "Swift",
"holder_type": "Company",
"beneficiary_province": "Hong Kong",
"beneficiary_post_code": "999077",
"bank_account_name": "Example Company Limited",
"bank_branch_code": "123",
"bank_country": "HKG",
"bank_province": "Hong Kong",
"contract_file_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600
},
"timeline": [
{
"status": "Pending",
"timestamp": 1744689600
}
],
"remark": "Withdraw funds from VA to payout bank account",
"failed_reason": "The target bank account is invalid.",
"bank_tx_fee": "10.00"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}Get bank withdrawal information
This operation retrieves the information of a specific bank withdrawal.
import cobo_waas2
from cobo_waas2.models.payment_bank_withdrawal_detail import (
PaymentBankWithdrawalDetail,
)
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)
bank_withdrawal_id = "123e4567-e89b-12d3-a456-426614174000"
try:
# Get bank withdrawal information
api_response = api_instance.get_bank_withdrawal_by_id(bank_withdrawal_id)
print("The response of PaymentApi->get_bank_withdrawal_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_bank_withdrawal_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 bankWithdrawalId = "123e4567-e89b-12d3-a456-426614174000";
try {
PaymentBankWithdrawalDetail result = apiInstance.getBankWithdrawalById(bankWithdrawalId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getBankWithdrawalById");
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() {
bankWithdrawalId := "123e4567-e89b-12d3-a456-426614174000"
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.GetBankWithdrawalById(ctx, bankWithdrawalId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetBankWithdrawalById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetBankWithdrawalById`: PaymentBankWithdrawalDetail
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetBankWithdrawalById`: %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 bank_withdrawal_id = "123e4567-e89b-12d3-a456-426614174000";
apiInstance.getBankWithdrawalById(bank_withdrawal_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"bank_withdrawal_id": "123e4567-e89b-12d3-a456-426614174000",
"request_id": "123e457-e89b-12d3-a456-426614174004",
"source_bank_account_id": "dst_ba_1234567890",
"target_bank_account_id": "dst_ba_0987654321",
"currency": "USD",
"amount": "100.00",
"status": "Pending",
"created_timestamp": 1744689600,
"source_bank_account": {
"destination_id": "123e4567-e89b-12d3-a456-426614174003",
"destination_name": "Destination A",
"destination_type": "Individual",
"bank_account_id": "123e4567-e89b-12d3-a456-426614174003",
"account_alias": "Main Payout Account",
"account_number": "4111111111111111",
"swift_code": "BOFAUS33",
"currency": "USD",
"beneficiary_name": "John Doe",
"beneficiary_address": "123 Main St, Anytown, USA",
"bank_name": "ABC Bank",
"bank_address": "456 Bank Ave, Cityville, USA",
"bank_account_status": "Pending",
"destination_email": "[email protected]",
"destination_country": "USA",
"destination_contact_address": "123 Main St, Anytown, USA",
"destination_merchant_id": "M1001",
"tag": "VA",
"iban_code": "12345678901234567890",
"further_credit": "further credit sample",
"intermediary_bank_info": {
"bank_name": "Intermediary Bank",
"bank_swift_code": "BOFAUS33",
"bank_address": "456 Bank Ave, Cityville, USA"
},
"country": "USA",
"city": "New York",
"payment_method": "Swift",
"holder_type": "Company",
"beneficiary_province": "Hong Kong",
"beneficiary_post_code": "999077",
"bank_account_name": "Example Company Limited",
"bank_branch_code": "123",
"bank_country": "HKG",
"bank_province": "Hong Kong",
"contract_file_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600
},
"target_bank_account": {
"destination_id": "123e4567-e89b-12d3-a456-426614174003",
"destination_name": "Destination A",
"destination_type": "Individual",
"bank_account_id": "123e4567-e89b-12d3-a456-426614174003",
"account_alias": "Main Payout Account",
"account_number": "4111111111111111",
"swift_code": "BOFAUS33",
"currency": "USD",
"beneficiary_name": "John Doe",
"beneficiary_address": "123 Main St, Anytown, USA",
"bank_name": "ABC Bank",
"bank_address": "456 Bank Ave, Cityville, USA",
"bank_account_status": "Pending",
"destination_email": "[email protected]",
"destination_country": "USA",
"destination_contact_address": "123 Main St, Anytown, USA",
"destination_merchant_id": "M1001",
"tag": "VA",
"iban_code": "12345678901234567890",
"further_credit": "further credit sample",
"intermediary_bank_info": {
"bank_name": "Intermediary Bank",
"bank_swift_code": "BOFAUS33",
"bank_address": "456 Bank Ave, Cityville, USA"
},
"country": "USA",
"city": "New York",
"payment_method": "Swift",
"holder_type": "Company",
"beneficiary_province": "Hong Kong",
"beneficiary_post_code": "999077",
"bank_account_name": "Example Company Limited",
"bank_branch_code": "123",
"bank_country": "HKG",
"bank_province": "Hong Kong",
"contract_file_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600
},
"timeline": [
{
"status": "Pending",
"timestamp": 1744689600
}
],
"remark": "Withdraw funds from VA to payout bank account",
"failed_reason": "The target bank account is invalid.",
"bank_tx_fee": "10.00"
}{
"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_bank_withdrawal_detail import (
PaymentBankWithdrawalDetail,
)
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)
bank_withdrawal_id = "123e4567-e89b-12d3-a456-426614174000"
try:
# Get bank withdrawal information
api_response = api_instance.get_bank_withdrawal_by_id(bank_withdrawal_id)
print("The response of PaymentApi->get_bank_withdrawal_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_bank_withdrawal_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 bankWithdrawalId = "123e4567-e89b-12d3-a456-426614174000";
try {
PaymentBankWithdrawalDetail result = apiInstance.getBankWithdrawalById(bankWithdrawalId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getBankWithdrawalById");
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() {
bankWithdrawalId := "123e4567-e89b-12d3-a456-426614174000"
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.GetBankWithdrawalById(ctx, bankWithdrawalId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetBankWithdrawalById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetBankWithdrawalById`: PaymentBankWithdrawalDetail
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetBankWithdrawalById`: %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 bank_withdrawal_id = "123e4567-e89b-12d3-a456-426614174000";
apiInstance.getBankWithdrawalById(bank_withdrawal_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 bank withdrawal ID.
Response
The request was successful.
The bank withdrawal ID generated by Cobo.
"123e4567-e89b-12d3-a456-426614174000"
The request ID provided by you when creating the bank withdrawal.
"123e457-e89b-12d3-a456-426614174004"
The source bank account ID. The destination bank account must be tagged as VA.
"dst_ba_1234567890"
The target bank account ID that receives the bank withdrawal.
"dst_ba_0987654321"
The fiat currency of the bank withdrawal.
"USD"
The bank withdrawal amount.
"100.00"
The status of the bank withdrawal:
Pending: The bank withdrawal has been created and is awaiting processing.Processing: The bank withdrawal is being processed.Completed: The bank withdrawal has been completed.Failed: The bank withdrawal failed.
Pending, Processing, Completed, Failed "Pending"
The creation time of the bank withdrawal, represented as a UNIX timestamp in seconds.
1744689600
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The status timeline of the bank withdrawal.
Show child attributes
Show child attributes
The remark for the bank withdrawal.
"Withdraw funds from VA to payout bank account"
The reason why the bank withdrawal failed.
"The target bank account is invalid."
The bank transaction fee charged for the bank withdrawal.
"10.00"
