Skip to main content
GET
/
payments
/
destination
import cobo_waas2
from cobo_waas2.models.destination_type import DestinationType
from cobo_waas2.models.list_destinations200_response import ListDestinations200Response
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)
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
    keyword = "keyword"
    destination_type = "Individual"
    country = "USA"
    merchant_ids = "M1001,M1002,M1003"

    try:
        # List all destinations
        api_response = api_instance.list_destinations(
            limit=limit,
            before=before,
            after=after,
            keyword=keyword,
            destination_type=destination_type,
            country=country,
            merchant_ids=merchant_ids,
        )
        print("The response of PaymentApi->list_destinations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->list_destinations: %s\n" % e)


{
  "data": [
    {
      "destination_type": "Individual",
      "destination_name": "Destination A",
      "created_timestamp": 1744689600,
      "updated_timestamp": 1744689600,
      "destination_id": "123e4567-e89b-12d3-a456-426614174003",
      "country": "USA",
      "email": "[email protected]",
      "contact_address": "123 Main St, Anytown, USA",
      "merchant_id": "M1001"
    }
  ],
  "pagination": {
    "before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
    "after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
    "total_count": 10000
  }
}
import cobo_waas2
from cobo_waas2.models.destination_type import DestinationType
from cobo_waas2.models.list_destinations200_response import ListDestinations200Response
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)
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
    keyword = "keyword"
    destination_type = "Individual"
    country = "USA"
    merchant_ids = "M1001,M1002,M1003"

    try:
        # List all destinations
        api_response = api_instance.list_destinations(
            limit=limit,
            before=before,
            after=after,
            keyword=keyword,
            destination_type=destination_type,
            country=country,
            merchant_ids=merchant_ids,
        )
        print("The response of PaymentApi->list_destinations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->list_destinations: %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.

Query Parameters

​
limit
integer<int32>
default:10

The maximum number of objects to return. For most operations, the value range is [1, 50].

​
before
string

A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.

​
after
string

A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.

​
keyword
string

A search term for performing fuzzy matches in the search query. The keyword.

​
destination_type
enum<string>

DestinationType defines the type of the destination:

  • Individual: The destination is an individual.
  • Organization: The destination is an organization.

The type of the destination.

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

"Individual"

​
country
string

Country code, in ISO 3166-1 alpha-3 format.

​
merchant_ids
string

A list of merchant IDs to query.

Response

The request was successful.

​
data
object[]
​
pagination
object

The pagination information of the returned data.