Ctrl+K

Add Trading Partner

post/api/trade/v1/enterprise/{enterpriseId}/account/{accountId}/tradingpartners

The Add Trading Partners API lets you add a trading partner given your trading partner's referral code

Path Parameters

  • enterpriseIdstringRequired
    Enterprise ID
  • accountIdstringRequired
    Trading Account ID

Request Body

referralCode string required
Trading partner's referral code
Example: FC8G
type string required
Partnership type between two trading accounts
Allowed values: direct agency
Example: direct
requesterSide string required
Requester is the primary or the secondary account in the trading partnership. e.g. If the requester wants their partner as the agent, then they are secondary account and their partner is the primary account.
Allowed values: primary secondary
Example: primary

200 Response

id string <uuid>
unique ID of the trading partnership, used for updating partnerships
primaryAccountId string
primary account ID of the partnership
primaryEnterpriseName string
enterprise name of the primary account ID
secondaryAccountId string
secondary account ID of the partnership
secondaryEnterpriseName string
enterprise name of the secondary account ID
status string
Partnership status between two trading accounts
Allowed values: accepted rejected canceled pending unknown
Example: accepted
type string
Partnership type between two trading accounts
Allowed values: direct agency
Example: direct
updatedAt string <date-time>
ISO date string
requesterAccountId string
account ID that initiated the trading partner request

400 Response

error string required
Human-readable error message
errorName string required
Immutable error code for API integration
reqId string required
Client request id