Skip to main content
POST

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.

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

source
enum<string>

The source of the destination:

  • Client: The destination was created by the client.
  • System: The destination was created by the system.
Available options:
Client,
System
Example:

"Client"

country
string

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

Example:

"USA"

email
string

The email of the destination.

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"