Skip to main content
PUT
/
payments
/
counterparty
/
{counterparty_id}
import cobo_waas2
from cobo_waas2.models.counterparty import Counterparty
from cobo_waas2.models.update_counterparty_request import UpdateCounterpartyRequest
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)
    counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384"
    update_counterparty_request = cobo_waas2.UpdateCounterpartyRequest(
        updated_counterparty_name="Counterparty A",
        updated_counterparty_type="Individual",
    )

    try:
        # Update counterparty
        api_response = api_instance.update_counterparty(
            counterparty_id, update_counterparty_request=update_counterparty_request
        )
        print("The response of PaymentApi->update_counterparty:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->update_counterparty: %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 counterpartyId = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
    UpdateCounterpartyRequest updateCounterpartyRequest =
        new UpdateCounterpartyRequest()
            .updatedCounterpartyName("Counterparty A")
            .updatedCounterpartyType(CounterpartyType.INDIVIDUAL);
    try {
      Counterparty result =
          apiInstance.updateCounterparty(counterpartyId, updateCounterpartyRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#updateCounterparty");
      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() {
	counterpartyId := "5b0ed293-f728-40b4-b1f6-86b88cd51384"
	updateCounterpartyRequest := *coboWaas2.NewUpdateCounterpartyRequest("Counterparty A", coboWaas2.CounterpartyType("Individual"))

	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.UpdateCounterparty(ctx, counterpartyId).
		UpdateCounterpartyRequest(updateCounterpartyRequest).
		Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.UpdateCounterparty``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateCounterparty`: Counterparty
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.UpdateCounterparty`: %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 counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
const opts = {
  UpdateCounterpartyRequest:
    CoboWaas2.UpdateCounterpartyRequest.constructFromObject({
      updated_counterparty_name: "Counterparty A",
      updated_counterparty_type: "Individual",
    }),
};
apiInstance.updateCounterparty(counterparty_id, opts).then(
  (data) => {
    console.log("API called successfully. Returned data: " + data);
  },
  (error) => {
    console.error(error);
  },
);

{
  "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"
}
{
  "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.counterparty import Counterparty
from cobo_waas2.models.update_counterparty_request import UpdateCounterpartyRequest
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)
    counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384"
    update_counterparty_request = cobo_waas2.UpdateCounterpartyRequest(
        updated_counterparty_name="Counterparty A",
        updated_counterparty_type="Individual",
    )

    try:
        # Update counterparty
        api_response = api_instance.update_counterparty(
            counterparty_id, update_counterparty_request=update_counterparty_request
        )
        print("The response of PaymentApi->update_counterparty:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->update_counterparty: %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 counterpartyId = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
    UpdateCounterpartyRequest updateCounterpartyRequest =
        new UpdateCounterpartyRequest()
            .updatedCounterpartyName("Counterparty A")
            .updatedCounterpartyType(CounterpartyType.INDIVIDUAL);
    try {
      Counterparty result =
          apiInstance.updateCounterparty(counterpartyId, updateCounterpartyRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#updateCounterparty");
      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() {
	counterpartyId := "5b0ed293-f728-40b4-b1f6-86b88cd51384"
	updateCounterpartyRequest := *coboWaas2.NewUpdateCounterpartyRequest("Counterparty A", coboWaas2.CounterpartyType("Individual"))

	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.UpdateCounterparty(ctx, counterpartyId).
		UpdateCounterpartyRequest(updateCounterpartyRequest).
		Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.UpdateCounterparty``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateCounterparty`: Counterparty
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.UpdateCounterparty`: %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 counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
const opts = {
  UpdateCounterpartyRequest:
    CoboWaas2.UpdateCounterpartyRequest.constructFromObject({
      updated_counterparty_name: "Counterparty A",
      updated_counterparty_type: "Individual",
    }),
};
apiInstance.updateCounterparty(counterparty_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

counterparty_id
string
required

The counterparty ID.

Body

application/json

The request body to update a counterparty.

updated_counterparty_name
string
required

The updated counterparty name.

Example:

"Counterparty A"

updated_counterparty_type
enum<string>
required

The type of the counterparty:

  • Individual: The counterparty is an individual.
  • Organization: The counterparty is an organization.
Available options:
Individual,
Organization
Example:

"Individual"

updated_country
string

The updated country of the counterparty, in ISO 3166-1 alpha-3 format.

Example:

"USA"

updated_email
string

The updated email of the counterparty.

updated_contact_address
string

The updated contact address of the counterparty.

Example:

"123 Main St, Anytown, USA"

Response

The request was successful.

counterparty_type
enum<string>
required

The type of the counterparty:

  • Individual: The counterparty is an individual.
  • Organization: The counterparty is an organization.
Available options:
Individual,
Organization
Example:

"Individual"

counterparty_name
string
required

The counterparty name.

Example:

"Counterparty A"

created_timestamp
integer
required

The created time of the counterparty, represented as a UNIX timestamp in seconds.

Example:

1744689600

updated_timestamp
integer
required

The updated time of the counterparty, represented as a UNIX timestamp in seconds.

Example:

1744689600

counterparty_id
string<uuid>

The counterparty ID.

Example:

"123e4567-e89b-12d3-a456-426614174003"

country
string

The country of the counterparty, in ISO 3166-1 alpha-3 format.

Example:

"USA"

email
string

The email of the counterparty.

contact_address
string

The contact address of the counterparty.

Example:

"123 Main St, Anytown, USA"