Skip to main content
POST
/
payments
/
destination
import cobo_waas2
from cobo_waas2.models.create_destination_request import CreateDestinationRequest
from cobo_waas2.models.destination_detail import DestinationDetail
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)
    create_destination_request = cobo_waas2.CreateDestinationRequest(
        destination_name="Destination A", destination_type="Individual"
    )

    try:
        # Create destination
        api_response = api_instance.create_destination(
            create_destination_request=create_destination_request
        )
        print("The response of PaymentApi->create_destination:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->create_destination: %s\n" % e)


{
  "destination_id": "123e4567-e89b-12d3-a456-426614174003",
  "destination_type": "Individual",
  "destination_name": "Destination A",
  "created_timestamp": 1744689600,
  "updated_timestamp": 1744689600,
  "country": "USA",
  "email": "[email protected]",
  "contact_address": "123 Main St, Anytown, USA",
  "wallet_addresses": [
    {
      "wallet_address_id": "123e4567-e89b-12d3-a456-426614174003",
      "address": "0x1234567890abcdef...",
      "chain_id": "TRON",
      "updated_timestamp": 1744689600,
      "risk_level": "Low",
      "screening_timestamp": 1744689600
    }
  ],
  "bank_accounts": [
    {
      "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_address": "456 Bank Ave, Cityville, USA",
        "bank_swift_code": "BOFAUS33"
      },
      "created_timestamp": 1744689600,
      "updated_timestamp": 1744689600
    }
  ],
  "merchant_id": "M1001"
}
import cobo_waas2
from cobo_waas2.models.create_destination_request import CreateDestinationRequest
from cobo_waas2.models.destination_detail import DestinationDetail
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)
    create_destination_request = cobo_waas2.CreateDestinationRequest(
        destination_name="Destination A", destination_type="Individual"
    )

    try:
        # Create destination
        api_response = api_instance.create_destination(
            create_destination_request=create_destination_request
        )
        print("The response of PaymentApi->create_destination:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->create_destination: %s\n" % e)

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.

Body

application/json

The request body to create a destination.

​
destination_name
string
required

The destination name.

Example:

"Destination A"

​
destination_type
enum<string>
required

The type of the destination.

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

"Individual"

​
wallet_addresses
object[]

The wallet addresses of the destination.

​
bank_accounts
object[]

The bank accounts of the destination.

​
merchant_id
string

The ID of the merchant linked to the destination.

Example:

"M1001"

​
country
string

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

Example:

"USA"

​
email
string

The email of the destination.

Example:

"[email protected]"

​
contact_address
string

The contact address of the destination.

Example:

"123 Main St, Anytown, USA"

Response

The request was successful.

​
destination_id
string<uuid>
required

The destination ID.

Example:

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

​
destination_type
enum<string>
required

The type of the destination.

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

"Individual"

​
destination_name
string
required

The destination name.

Example:

"Destination A"

​
created_timestamp
integer
required

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

Example:

1744689600

​
updated_timestamp
integer
required

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

Example:

1744689600

​
country
string

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

Example:

"USA"

​
email
string

The email of the destination.

Example:

"[email protected]"

​
contact_address
string

The contact address of the destination.

Example:

"123 Main St, Anytown, USA"

​
wallet_addresses
object[]

The wallet addresses of the destination.

​
bank_accounts
object[]

The bank accounts of the destination.

​
merchant_id
string

The ID of the merchant linked to the destination.

Example:

"M1001"