Initiate subscription requests on behalf of the end client into desired product(s). Supports all types of custom subscription request types for a client.
Trade Initiation (v1)
Download OpenAPI specification:Download
Initiate subscription requests on behalf of the end client into desired product(s). Supports all types of custom subscription request types for a client.
Create a transaction for an investor with either just the investor details or investor and advisor details or just the investment advisor details. Product information, request type and one of the investor/advisor details are mandatory to create a successful transaction.
header Parameters
Authorization required | string access_token value obtained from the Token endpoint.This is passed as "Bearer access_token " |
AppKey required | string This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
Content-Type required | string This is the content type of the payload being passed. Valid value is application/json. |
Request Body schema: application/json
required | Array of objects (Opportunity) |
Responses
Request samples
- Payload
{- "data": [
- {
- "requestType": "New Subscription",
- "channel": "Direct",
- "opportunityGroupId": "string",
- "externalOrderId": "WWC_{{$timestamp}}",
- "firm": "string",
- "team": "string",
- "group": "string",
- "tradeDate": "2018-09-25T00:00:000",
- "orderDate": "2018-09-25T00:00:000",
- "eSign": true,
- "products": [
- {
- "productName": "Worldwide Capital Event Driven Fund, LP",
- "classIds": [
- "string"
], - "amlRepLetter": true,
- "funds": [
- {
- "externalId": "string",
- "amount": 0,
- "currency": "string"
}
]
}
], - "advisor": {
- "externalId": "string",
- "division": "string",
- "region": "string",
- "contact": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "jdoe@gmail.com",
- "externalId": "string"
}, - "label": {
- "city": "string",
- "stateCode": "string",
- "postalCode": "string",
- "countryIsoCode": "string",
- "address1": "string",
- "address2": "string",
- "zip": "string"
}
}, - "investor": {
- "name": "John Doe Personal Trust",
- "externalId": "string",
- "subscriberType": "string",
- "accountNumber": "string",
- "contact": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "jdoe@gmail.com",
- "externalId": "string"
}, - "label": {
- "city": "string",
- "stateCode": "string",
- "postalCode": "string",
- "countryIsoCode": "string",
- "address1": "string",
- "address2": "string",
- "zip": "string"
}
}, - "manager": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "jdoe@gmail.com",
- "externalId": "string"
}, - "accessContacts": [
- {
- "access": "string",
- "contact": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "jdoe@gmail.com",
- "externalId": "string"
}, - "label": {
- "countryIsoCode": "string"
}
}
], - "formContacts": [
- {
- "contact": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "jdoe@gmail.com",
- "externalId": "string"
}, - "label": {
- "countryIsoCode": "string"
}
}
], - "custodians": [
- "string"
], - "subForms": [
- {
- "id": "string"
}
], - "placementFee": [
- 0
]
}
]
}
Response samples
- 201
- 400
- 401
- 403
- 404
- 405
- 409
- 422
- 500
{- "data": {
- "orders": [
- {
- "advisor": {
- "name": "string",
- "stateCode": "string"
}, - "createdAt": "2020-11-03T15:00:51:576Z",
- "orderId": "string",
- "products": [
- {
- "name": "string",
- "trackingNumber": "string"
}
], - "accountNumber": "string",
- "opportunityGroupId": "string",
- "investorName": "string",
- "subform": [
- {
- "id": "string"
}
], - "placementFee": "string"
}
], - "faults": [
- {
- "code": "string",
- "message": "string",
- "userMessage": "string",
- "trackingId": "string",
- "transient": true
}
]
}, - "formatters": [
- { }
], - "contentTypes": [
- { }
], - "declaredType": "string",
- "statusCode": 200
}
Returns all the transaction related attributes for a tracking number returned post the successful Transaction creation.
path Parameters
trackingNumber required | string Trade tracking id |
header Parameters
Authorization required | string access_token value obtained from the Token endpoint.This is passed as "Bearer access_token |
AppKey required | string This is the Consumer Key provided during the App Registration process and is used to identify the user's application |
Responses
Response samples
- 201
- 400
- 401
- 403
- 404
- 405
- 409
- 422
- 500
{- "data": {
- "orders": [
- {
- "advisor": {
- "name": "string",
- "stateCode": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orderId": "string",
- "products": [
- {
- "name": "string",
- "trackingNumber": "string"
}
], - "accountNumber": "string",
- "opportunityGroupId": "string",
- "investorName": "string",
- "subform": [
- {
- "id": "string"
}
], - "placementFee": "string"
}
], - "faults": [
- {
- "code": "string",
- "message": "string",
- "userMessage": "string",
- "trackingId": "string",
- "transient": true
}
]
}, - "formatters": [
- { }
], - "contentTypes": [
- { }
], - "declaredType": "string",
- "statusCode": 200
}
This API Call updates the Transaction attributes information once an Transaction is successfully created
path Parameters
trackingNumber required | string Trade tracking id |
header Parameters
Authorization required | string access_token value obtained from the Token endpoint.This is passed as "Bearer access_token |
AppKey required | string This is the Consumer Key provided during the App Registration process and is used to identify the user's application |
Content-Type required | string Valid value is application/json. This defines the content type of the request payload accepted by the API. |
Request Body schema: application/json
required | Array of objects (Opportunity) |
Responses
Request samples
- Payload
{- "data": [
- {
- "requestType": "New Subscription",
- "channel": "Direct",
- "opportunityGroupId": "string",
- "externalOrderId": "WWC_{{$timestamp}}",
- "firm": "string",
- "team": "string",
- "group": "string",
- "tradeDate": "2018-09-25T00:00:000",
- "orderDate": "2018-09-25T00:00:000",
- "eSign": true,
- "products": [
- {
- "productName": "Worldwide Capital Event Driven Fund, LP",
- "classIds": [
- "string"
], - "amlRepLetter": true,
- "funds": [
- {
- "externalId": "string",
- "amount": 0,
- "currency": "string"
}
]
}
], - "advisor": {
- "externalId": "string",
- "division": "string",
- "region": "string",
- "contact": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "jdoe@gmail.com",
- "externalId": "string"
}, - "label": {
- "city": "string",
- "stateCode": "string",
- "postalCode": "string",
- "countryIsoCode": "string",
- "address1": "string",
- "address2": "string",
- "zip": "string"
}
}, - "investor": {
- "name": "John Doe Personal Trust",
- "externalId": "string",
- "subscriberType": "string",
- "accountNumber": "string",
- "contact": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "jdoe@gmail.com",
- "externalId": "string"
}, - "label": {
- "city": "string",
- "stateCode": "string",
- "postalCode": "string",
- "countryIsoCode": "string",
- "address1": "string",
- "address2": "string",
- "zip": "string"
}
}, - "manager": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "jdoe@gmail.com",
- "externalId": "string"
}, - "accessContacts": [
- {
- "access": "string",
- "contact": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "jdoe@gmail.com",
- "externalId": "string"
}, - "label": {
- "countryIsoCode": "string"
}
}
], - "formContacts": [
- {
- "contact": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "jdoe@gmail.com",
- "externalId": "string"
}, - "label": {
- "countryIsoCode": "string"
}
}
], - "custodians": [
- "string"
], - "subForms": [
- {
- "id": "string"
}
], - "placementFee": [
- 0
]
}
]
}
Response samples
- 201
- 400
- 401
- 403
- 404
- 405
- 409
- 422
- 500
{- "data": {
- "orders": [
- {
- "advisor": {
- "name": "string",
- "stateCode": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orderId": "string",
- "products": [
- {
- "name": "string",
- "trackingNumber": "string"
}
], - "accountNumber": "string",
- "opportunityGroupId": "string",
- "investorName": "string",
- "subform": [
- {
- "id": "string"
}
], - "placementFee": "string"
}
], - "faults": [
- {
- "code": "string",
- "message": "string",
- "userMessage": "string",
- "trackingId": "string",
- "transient": true
}
]
}, - "formatters": [
- { }
], - "contentTypes": [
- { }
], - "declaredType": "string",
- "statusCode": 200
}
Returns a list of all the channels available for a given Product and Transaction type.
path Parameters
productName required | string One of three values that determine the kit which drives the process and form details that will need to be completed (i.e. WWC Event Driven Fund, L.P.). The other fields are requestType and and channel. |
transactionType required | string Describes the type of transaction. |
header Parameters
Authorization required | string access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
AppKey required | string This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
Responses
Response samples
- 201
- 400
- 401
- 403
- 404
- 405
- 409
- 422
- 500
{- "orders": [
- {
- "advisor": {
- "name": "string",
- "stateCode": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orderId": "string",
- "products": [
- {
- "name": "string",
- "trackingNumber": "string"
}
], - "accountNumber": "string",
- "opportunityGroupId": "string",
- "investorName": "string",
- "subform": [
- {
- "id": "string"
}
], - "placementFee": "string"
}
], - "faults": [
- {
- "code": "string",
- "message": "string",
- "userMessage": "string",
- "trackingId": "string",
- "transient": true
}
]
}
Notifies Trade for the Data Readiness for a given Transaction
path Parameters
trackingNumber required | string Trade tracking id |
header Parameters
Authorization required | string access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
AppKey required | string This is the Consumer Key provided during the App Registration process and is used to identify the user's application |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{ }