Skip to main content
PUT
/
payments
/
destination_entry
/
{destination_entry_id}
import cobo_waas2
from cobo_waas2.models.update_destination_entry200_response import (
    UpdateDestinationEntry200Response,
)
from cobo_waas2.models.update_destination_entry_request import (
    UpdateDestinationEntryRequest,
)
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)
    destination_entry_id = "123e4567-e89b-12d3-a456-426614174003"
    update_destination_entry_request = cobo_waas2.UpdateDestinationEntryRequest(
        destination_id="46beeab4-6a8e-476e-bc69-99b89aacbc6f"
    )

    try:
        # Update destination entry
        api_response = api_instance.update_destination_entry(
            destination_entry_id,
            update_destination_entry_request=update_destination_entry_request,
        )
        print("The response of PaymentApi->update_destination_entry:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->update_destination_entry: %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.*;
import java.util.UUID;

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 destinationEntryId = "123e4567-e89b-12d3-a456-426614174003";
    UpdateDestinationEntryRequest updateDestinationEntryRequest =
        new UpdateDestinationEntryRequest()
            .destinationId(UUID.fromString("46beeab4-6a8e-476e-bc69-99b89aacbc6f"));
    try {
      UpdateDestinationEntry200Response result =
          apiInstance.updateDestinationEntry(destinationEntryId, updateDestinationEntryRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#updateDestinationEntry");
      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() {
	destinationEntryId := "123e4567-e89b-12d3-a456-426614174003"
	updateDestinationEntryRequest := *coboWaas2.NewUpdateDestinationEntryRequest("46beeab4-6a8e-476e-bc69-99b89aacbc6f")

	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.UpdateDestinationEntry(ctx, destinationEntryId).
		UpdateDestinationEntryRequest(updateDestinationEntryRequest).
		Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.UpdateDestinationEntry``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateDestinationEntry`: UpdateDestinationEntry200Response
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.UpdateDestinationEntry`: %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 destination_entry_id = "123e4567-e89b-12d3-a456-426614174003";
const opts = {
  UpdateDestinationEntryRequest:
    CoboWaas2.UpdateDestinationEntryRequest.constructFromObject({
      destination_id: "46beeab4-6a8e-476e-bc69-99b89aacbc6f",
    }),
};
apiInstance.updateDestinationEntry(destination_entry_id, opts).then(
  (data) => {
    console.log("API called successfully. Returned data: " + data);
  },
  (error) => {
    console.error(error);
  },
);

{
  "bank_account": {
    "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",
    "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"
    },
    "created_timestamp": 1744689600,
    "updated_timestamp": 1744689600,
    "country": "USA",
    "city": "New York"
  }
}
{
"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.update_destination_entry200_response import (
    UpdateDestinationEntry200Response,
)
from cobo_waas2.models.update_destination_entry_request import (
    UpdateDestinationEntryRequest,
)
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)
    destination_entry_id = "123e4567-e89b-12d3-a456-426614174003"
    update_destination_entry_request = cobo_waas2.UpdateDestinationEntryRequest(
        destination_id="46beeab4-6a8e-476e-bc69-99b89aacbc6f"
    )

    try:
        # Update destination entry
        api_response = api_instance.update_destination_entry(
            destination_entry_id,
            update_destination_entry_request=update_destination_entry_request,
        )
        print("The response of PaymentApi->update_destination_entry:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->update_destination_entry: %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.*;
import java.util.UUID;

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 destinationEntryId = "123e4567-e89b-12d3-a456-426614174003";
    UpdateDestinationEntryRequest updateDestinationEntryRequest =
        new UpdateDestinationEntryRequest()
            .destinationId(UUID.fromString("46beeab4-6a8e-476e-bc69-99b89aacbc6f"));
    try {
      UpdateDestinationEntry200Response result =
          apiInstance.updateDestinationEntry(destinationEntryId, updateDestinationEntryRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#updateDestinationEntry");
      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() {
	destinationEntryId := "123e4567-e89b-12d3-a456-426614174003"
	updateDestinationEntryRequest := *coboWaas2.NewUpdateDestinationEntryRequest("46beeab4-6a8e-476e-bc69-99b89aacbc6f")

	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.UpdateDestinationEntry(ctx, destinationEntryId).
		UpdateDestinationEntryRequest(updateDestinationEntryRequest).
		Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.UpdateDestinationEntry``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateDestinationEntry`: UpdateDestinationEntry200Response
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.UpdateDestinationEntry`: %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 destination_entry_id = "123e4567-e89b-12d3-a456-426614174003";
const opts = {
  UpdateDestinationEntryRequest:
    CoboWaas2.UpdateDestinationEntryRequest.constructFromObject({
      destination_id: "46beeab4-6a8e-476e-bc69-99b89aacbc6f",
    }),
};
apiInstance.updateDestinationEntry(destination_entry_id, opts).then(
  (data) => {
    console.log("API called successfully. Returned data: " + data);
  },
  (error) => {
    console.error(error);
  },
);

Authorizations

BIZ-API-KEY
string
header
required

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

destination_entry_id
string
required

The destination entry ID. For example, the wallet address ID or the bank account ID.

Body

application/json

The request body to update a destination entry.

destination_id
string<uuid>
required

The destination ID.

Example:

"46beeab4-6a8e-476e-bc69-99b89aacbc6f"

entry_type
enum<string>

The type of the counterparty entry.

  • Address: The entry is a wallet address.
  • BankAccount: The entry is a bank account.
Available options:
Address,
BankAccount
Example:

"Address"

bank_account
object

Response

The request was successful.

bank_account
object