Transaction#

Resource and endpoints for transaction related operations.

Endpoints:#


POST Transaction/GenerateTransactionDetails#

Description:

  • Allows you to generate transaction details.

  • Only completed transactions can be generated.

  • Pending transaction will not be generated.

Request Body:

controlTransactionId
integer Required
Non-nullable

Example Request:

curl --silent --location --request POST '{{baseurl}}/api/v1/Transaction/GenerateTransactionDetails' \
--header 'Authorization: Bearer <YOUR TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
            "controlTransactionId": 2121
        }'

200 Response:

{
  "downloadUrl": "{{baseurl}}/api/v1/Transaction/GenerateTransactionDetails/CfDJ8G2a_F-j-rtGiUBjbT5isV1Ipqf4dR3GqLU2YxSgt48du3Ou-WqbxdXRIMvStv89lntvqfGdfX6LyQ2ZsxZ0WwFMw3wS_vPk4-yAYFAGb0J9Db4MTUzzBgXW3rWh-zWHKn0IEFZFbB1y9YZNc7Pqx60Ja_ATwXDQd4iFdYokEiPC/Diluted-Percentage.pdf/CfDJ8G2a_F-j-rtGiUBjbT5isV3Hu-jA7zMIrWfSA_7r-cX3Xf7T7H79utc9yZKwgwkaC3Ulo2Fs9kpX0MeahnEHr9HWBUmT5q9jCGVRizTQwdMrjFsCTm6RELhzi72RTLNi_hxxrJKwzMUFG80smDDvI5Y"
}

POST Transaction/CreateNewIssuance#

Description:

Allows user to create a new issuance. Returns controlTransactionId.

Request Body:

idempotencyId
string Optional
Non-nullable
NEW A unique identifier for the request to prevent duplicate submissions. If a request with the same idempotencyId is submitted again, the system will return a 409 Conflict response.
customerIssuerId
integer Required
Nullable
The unique identifier of the customer issuer.
effectiveDate
string Required
Nullable
processDate
string Required
Non-nullable
UTC Date
chargeAmount
number Required
Non-nullable
certificateType
enum Required
Non-nullable
securityType
string Optional
Nullable
Show child properties

Note

See Expanded Attributes and Options section for more details

securityType.securitySeriesCode
string Optional
Non-nullable

A = Series A.

B = Series B.

C = Series C.

securityType.securityTypeCode
string Optional
Non-nullable
Possible values:

P = Preferred

W = Warrant.

U = Units

B = Bond

D = Debenture

M = Interests

Note

Refer to the Expanded Attributes and Options page for more info on securityType options.

comments
string Required
Nullable
createdByEmail
string Required
Non-nullable
Email of person who created Shareholder.
createdByFirstName
string Required
Non-nullable
First name of person who is creating Shareholder.
createdByLastName
string Required
Non-nullable
Last name of person who is creating Shareholder.
restrictionCode
string Required
Nullable

N = No Restriction.

R = Rule 144.

B = Blue Sky.

A = Affiliate/Control.

S = Regulation S.

L = Lock-Up Agreement.

O = Other.

certificates
array Optional
Nullable
An array of certificate objects that contain details about each certificate being issued.
Certificate Options
restrictionCode
string Required
Nullable

N = No Restriction.

R = Rule 144.

B = Blue Sky.

A = Affiliate/Control.

S = Regulation S.

L = Lock-Up Agreement.

O = Other.

shareholder
object Required
Non-nullable
Shareholder Options
createdByEmail
string Required
Non-nullable
Email of person who created Shareholder.
createdByFirstName
string Required
Non-nullable
First name of person who is creating Shareholder.
createdByLastName
string Required
Non-nullable
Last name of person who is creating Shareholder.
customerShareholderId
string Optional
Non-nullable
The unique shareholder ID associated with the customer.
name
string Required
Non-nullable
First and last name of Shareholder.
E.g., "Zephyr Blackwood."
name2
string Optional
Nullable
First and last name of second person on account.
E.g., "Emily Johnson."
name3
string Optional
Nullable
First and last name of third person on account.
E.g., "Orion Maddox."
sortName
string Required
Non-nullable
Sorted first and last name of Shareholder.
i.e., “last name, first name”.
accountType
enum Optional
Non-nullable
The type of account for the Shareholder.

None = No specific account type.

JointTenant = Joint Tenant account.

TenantsInCommon = Tenants in Common account.

JointWithRightOfSurvivorship = Joint Account with Right of Survivorship.

Trust = Trust account.

CustodyForAMinor = Custody for a Minor account.

CustodyForTheBenefitOf = Custody for the Benefit Of account.

Individual = Individual account.

Corporation = Corporation account.

Partnership = Partnership account.

UnclaimedProperty = Unclaimed Property account.

CommunityProperty = Community Property account.

IRA = Individual Retirement Account.

ProfitSharingOrKeoghPlan = Profit Sharing or Keogh Plan account.

NomineeOrDepository = Nominee or Depository account.

SchoolsAndColleges = Schools and Colleges account.

Plan401K = 401(k) Plan account.

TransferOnDeath = Transfer on Death account.

Custodian = Custodian account.

RetirementAccounts = Retirement Accounts.

SimplifiedEmployeePension = Simplified Employee Pension account.

RothIRA = Roth IRA account.

Pensions = Pensions account.

primaryPayeeName
string Required
Nullable
Name of Primary Payee.
primaryTaxId
string Required
Nullable
Tax Id for Primary Shareholder.
primaryTaxIdType
enum Required
Non-nullable
Type of primary tax ID. Possible values: SSN , EIN , or SIN .
secondaryPayeeName
string Optional
Nullable
Name of Secondary Payee on account.
secondaryTaxId
string Optional
Nullable
Tax Id for Secondary Payee.
secondaryTaxIdType
enum Optional
Non-nullable
Type of secondary tax ID. Possible values: SSN , EIN , or SIN .
mailingAddress
object Optional
Non-nullable
Mailing address of Shareholder.
Show child properties
primaryAddress
object Required
Non-nullable
Mailing address of Shareholder.
Show child properties
TaxLots
string Required
Nullable
Show child properties

Example Request:

curl --silent --location --request POST '{{baseurl}}/api/v1/Transaction/CreateNewIssuance' \
--header 'Authorization: Bearer <YOUR TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
            "idempotencyId": "738058275223", // NEW
            "customerIssuerId": 1,
            "systemControlIssuerId": 1,
            "shares": 100
        }'

200 Response:

{
    "controlTransactionId": 20886,
    "customerTransactionId": null,
    "displayTransactionId": 20886
}

409 Response (Duplicate Request):

{
    "message": "Duplicate request detected. The idempotencyId has already been used.", // New
    "idempotencyId": "738058275223" // New
}

Note

  • Using an existing CustomerIssuerId will create a new issuance for the same issuer.

  • Using a new CustomerIssuerId will create a new issuer and a new issuance.

GET Transaction/GetTAStatusTransactions#

Description:

Allows you to get detailed information about TA Status Transactions.

Query Parameters:

customerIssuerId
integer Required
Nullable
The unique identifier of the customer issuer.
filterTransactionType
string Required
Non-nullable
Filter transactions by type.
transactionStatus
string Required
Non-nullable
Possible values:

All = All statuses included.

Pending = Pending status.

Rejected = Rejected status.

Completed = Completed status.

Canceled = Canceled status.

orderBy
string Required
Non-nullable
Possible values: Ascending , OR Descending .
sortBy
string Required
Non-nullable
Options:
SortName = sorts by last and first name.
Name = sorts by Shareholder name.
Shares = sort by shares amount.
start
integer Required
Non-nullable
The starting index for the result set.
e.g., 0, 10, 20.
numberOfRows
integer Required
Non-nullable
Generates a specific number of rows.

Example Request:

curl --silent --location '{{baseurl}}/api/v1/Transaction/GetTAStatusTransactions?CustomerIssuerId=1&SystemControlIssuerId=1' \
--header 'Authorization: Bearer <YOUR TOKEN>'

200 Response:

{
    "totalRecords": 32,
    "transactions": [
        {
            "transactionId": 1495588,
            "controlTransactionId": 13682,
            "type": "New Issuance",
            "receivedDate": "4/27/2020",
            "completedDate": "",
            "effectiveDate": "4/27/2020",
            "transferFrom": "",
            "issuedTo": "",
            "status": "Pending"
        },
        {
            "transactionId": 1495593,
            "controlTransactionId": 14686,
            "type": "New Issuance",
            "receivedDate": "6/4/2020",
            "completedDate": "6/4/2020",
            "effectiveDate": "6/4/2020",
            "transferFrom": "",
            "issuedTo": "Wayne Demo & Emily Demo JT TEN (200 shares)",
            "status": "Completed"
        }
    ]
}

POST Transaction/GenerateTransactions#

Description:

Allows you to generate transactions.

Query Parameters:

customerIssuerId
integer Required
Nullable
The unique identifier of the customer issuer.
filterDateBy
enum Required
Non-nullable
e.g., Effective Date.
startDate
string Required
Non-nullable
Start date for report. (Defaults to today.)
ISO 8601 format = standardized date-time representation.
e.g., yyyy-mm-dd (Year-Month-Day), 2023-12-21T20:36:27.089Z , etc.
endDate
string Required
Non-nullable
End date for report.
ISO 8601 format = standardized date-time representation.
e.g., yyyy-mm-dd (Year-Month-Day), 2023-12-21T20:36:27.089Z , etc.
transactionTypeCode
string Required
Nullable
The transactionTypeCode parameter can have the following values:

Empty = All Transactions.

N = New Issuances.

T = Transfers.

C = Conversions.

R = Retirements.

F = Forward Split.

V = Reverse Split.

D = Dividends.

isPDF
boolean Required
Non-nullable
Generates a PDF.
true = generates a downloadable pdf.
false = does not generate a downloadable pdf.

Example Request:

curl --silent --location --request POST '{{baseurl}}/api/v1/Transaction/GenerateTransactions' \
--header 'Authorization: Bearer <YOUR TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
            "customerIssuerId": 1,
            "systemControlIssuerId": 1
        }'

200 Response:

{
"downloadUrl": "{{baseurl}}/Api/v1/Report/DownloadReport/CfDJ8G2a_F-j-rtGiUBjbT5isV0r5B9N26nYeS0oLBfQr6SGXCBI7QfYmxow2rLNGkkF2d6sJTAJ3VDwJvoEsIkuATo0SGDxYfQwRuf8y27DsDNcXprMUr5b_GVKFZKtDRYvsfgoUbrK7tHvHb9z-0ZfR-TIohcNCtiBJhYwtnBDNeld/transactions.pdf/CfDJ8G2a_F-j-rtGiUBjbT5isV3xovmq_IewIGWxZBBXzvUTkRhWMb1htMjDslWJznRFV3zS90kRVb4vnbTS3uZ7znKVI2dG6AnCoLqFxEbi60j7irw7ivfOx_QqKavtId_KRjE44k0jepjpVvArFa23Nzg"
}