mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg
mobo_img.jpg

API Documentation


Version 2

SCROLL DOWN

API Documentation


Version 2

Introduction

The CrowdPay API is a REST-based interface to our CrowdPay Escrow services. Before making API calls, you will need to contact GoldStar Trust to receive credentials and get your server IP addresses whitelisted.

URL

The URL schema for the API is:

Version 1

https://{domain}/crowdfunding/api/{resource}

Click HERE for Api Documentation Version 1

Version 2 (and Beyond)

https://{domain}/crowdfunding/api/{version}/{resource}

The meaning of each token is:

Token Description
{domain} You will receive the domain name at the time you receive your credentials.
{version} The version you want to communicate with (ex. v1 or v2).
{resource} The resource you want to perform operations on.

Example
The Endpoint POST https://qaservices.goldstartrust.com/crowdfunding/api/Investor with the investor model posted will create an investor resource.

Request Headers

All CrowdPay api calls must have the following request headers with the provided Api key and Portal / Escrow key.

Header Description
X-ApiKey You will receive your api key from Goldstar Trust. All api calls will require this header.
X-PortalKey You will receive your portal key from Goldstar Trust. All api calls will require this header. – This identifies the escrow (offering).
X-ByPassValidation Set to True or False. Only functional in QA (sandbox). It will be ignored in Production. This header is used to bypass production validation that would normally prevent transactional processing.
  1. Allows you to execute FundEscrow transactions regardless of account available balance. In production and when value is set to False or header is not passed in, FundEscrow transaction will be rejected if amount is greater than available balance. Normal workflow is:
    • FundAccount transaction is initiated
    • After 3 work days, the account’s available balance reflects the amount of the FundAccount transaction.
    • The FundEscrow calls will now accept transactions less than or equal to account’s available balance.
  2. Returns status of “Processed” for transactions when querying transactions. Normally, the status would be “Pending” until the transactions were posted by GoldStar.

Security

We require all calls to be made securely with HTTP over SSL. All API calls with require the HTTP header X-ApiKey  and X--PortalKey listed above.

Tools

We like using Postman when working with the API.

mobo_img.jpg

Status Codes


Status Codes


status codes

Response will have one of the following status codes.

Code Description
200 Success -- requested resource is in the response.
201 Success -- the newly created resource is in the response.
400 Bad Request -- could not be understood by the server. API Call failed.
Possible reasons:
  • Requested method or operation is not implemented (e.g. trying to do a POST for an endpoint that does not support a POST)
  • Unhandled Exception - an exception thrown by the API that the code is not handling. Contact GoldStar so that we can investigate.
401 Unauthorized - requested resource requires authentication.
Error Code 80000 - Unauthorized Access to Account
Error Code 80002 - Unauthorized Access to Account - Account is NOT setup for Crowdfunding (Can occur for any of the API calls below
Error Code 89999 - Unauthorized Access to API. Missing credentials. Can occur for any of the API calls below:
  • Create Account
  • Get Account
    • Error Code 80003 - Unauthorized Access to Account - Unauthorized Access to Account - Account is not associated with Portal/Escrow.
  • Get Account with Assets
    • Error Code 80003 - Unauthorized Access to Account - Unauthorized Access to Account - Account is not associated with Portal/Escrow.
  • Get Account with Assets using asset_id
    • Error Code 80003 - Unauthorized Access to Account - Unauthorized Access to Account - Account is not associated with Portal/Escrow.
  • Get Account with Transactions
    • Error Code 80003 - Unauthorized Access to Account - Unauthorized Access to Account - Account is not associated with Portal/Escrow.
  • Get Transaction using transaction_id
  • Fund Account
    • 80001 - Unauthorized access to Account - Account setup has not passed CIP
    • Error code 80003 - Unauthorized Access to Account – Unauthorized Access to Account - Account is not associated with Portal/Escrow
  • Fund Escrow
    • Error code 80003 - Unauthorized Access to Account – Unauthorized Access to Account - Account is not associated with Portal/Escrow
  • Fund Deb Escrow
    • Error code 80003 - Unauthorized Access to Account – Unauthorized Access to Account - Account is not associated with Portal/Escrow
  • Reinvest Debt
    • Error code 80003 - Unauthorized Access to Account – Unauthorized Access to Account - Account is not associated with Portal/Escrow
  • Update Account
    • Error code 80003 - Unauthorized Access to Account – Unauthorized Access to Account - Account is not associated with Portal/Escrow
  • Withdraw Funds
    • Error code 80003 - Unauthorized Access to Account – Unauthorized Access to Account - Account is not associated with Portal/Escrow
404 Not Found - 10000 -requested resource does not exist on the server.
  • Get Investor
  • Get Account
  • Get Account with Assets
  • Get Account with Assets using asset_id
  • Get Account with Transactions
  • Get Transaction using transaction_id
  • Fund Account
  • Fund Escrow
  • Fund Deb Escrow
  • Create Account - additional possible reasons
    • Investor record not found using investor_id provided in the model
    • Bank routing number invalid. Unable to find bank record
  • Update Account
    • Investor record not found using investor_id provided in the model.
  • Reinvest Debt
    • Asset not found with provided id
409 Validation Error
  • Create Investor - 200000 - Investor with the same tax id already exists
  • Fund Escrow - numeric error code with error message returned in response
    • 85000 - Unauthorized Transaction - Account does not have sufficient funds for transaction (available funds)
  • Fund Debt Escrow - numeric error code with error message returned in response
    • 86000 - Escrow is not set up as Debt Offering - Please contact GoldStar Trust
    • 86001 - Invalid Operation - Escrow is not set up as Debt Offering - Please contact GoldStar Trust
  • Reinvest Debt - numeric error code with error message returned in response
    • 86000 - Fund Escrow not set up correctly - Please contact GoldStar Trust
    • 86001 - Invalid Operation - Fund Escrow not set up correctly - Please contact GoldStar Trust
    • 86002 - Invalid Transaction - Amount must equal zero or cost basis amount - This is when activity_code = 707
    • 86003 - Invalid Transaction - Amount must be less than cost basis amount - This occurs when activity_code = 708
    • 86004 - Invalid Transaction - Asset is not active
  • Withdraw Funds - numeric error code with error message returned in response
    • 10006 - Withdraw funds Transaction failed - Please call GoldStar Trust
    • 85000 - Unauthorized Transaction - Account does not have sufficient funds for transaction (Available Balance)
    • 85001 - Unauthorized Transaction - Account does not have a bank account set up
    • 86000 - Fund Escrow not set up correctly - Please call GoldStar Truse
  • Equity Pay - numeric error code with error message returned in response
    • 10007 - Equity Pay Transaction Failed - Please contact GoldStar Trust
    • 86006 - Invalid Operation - Escrow is not set up as Equity Offering - Please contact Goldstar Trust
500 Internal Server Error - Generic error occurred on the server. - API call failed. Can occur with any API call
 
 
mobo_img.jpg

Investor Object Model


Investor Object Model


Investor Object

 

Parameter Required Type Description
id N Long Identifier for account
investor_key N GUID Portal's key used when calling the “Get Investor Information” api.
tax_id_number Y String MinLength(9) MaxLength(9)
first_name N String MaxLength(50)
middle_name N String MaxLength(50)
last_name N String MaxLength(50)
name N String MaxLength(150)
birth_date N Date  
mailing_address_1 N String MaxLength(40)
mailing_address_2 N String MaxLength(40)
mailing_city N String MaxLength(40)
mailing_state N String MaxLength(30)
mailing_zip N String MaxLength(9)
mailing_country N String MaxLength(40)
is_mailing_address_foreign Y Bool  
legal_address_1 N String MaxLength(40)
legal_address_2 N String MaxLength(40)
legal_city N String MaxLength(40)
legal_state N String MaxLength(30)
legal_zip N String MaxLength(9)
legal_country N String MaxLength(40)
is_legal_address_foreign N Bool  
primary_phone N String MaxLength(10)
secondary_phone N String MaxLength(10)
is_person Y Bool True indicates the investor is a person
email N String MaxLength(50)
is_cip_satisfied Y Bool  
portal_investor_number N String MaxLength(30)
created_by_ip_address Y String MaxLength(25)
Accounts N Icollection<Accounts>  
mobo_img.jpg

Account Object Model


Account Object Model


Account Object

If name_1, name_2, name_3 and name_4 are left null, Investor's name information will be used to value these properties

Parameter Required Type Description
id N Long Identifier for account
number N String MaxLength(15)
portal_account_number N String MaxLength(30)
investor_id Y Long  
name_1 N String MaxLength(50)
name_2 N String MaxLength(50)
name_3 N String MaxLength(50)
name_4 N String MaxLength(50)
mailing_address_1 N String MaxLength(40)
mailing_address_2 N String MaxLength(40)
mailing_city N String MaxLength(40)
mailing_state N String MaxLength(30)
mailing_zip N String MaxLength(9)
mailing_country N String MaxLength(40)
is_mailing_address_foreign Y Bool  
current_uninvested_cash  N Decimal  
uninvested_cash  N Decimal  
is_cip_satisfied Y Bool is a valid user - is who they say they are
draft_account_type_id Y Int 1=Checking, 2=Savings
draft_routing_number Y String MaxLength(9)
draft_account_number Y String MaxLength(17)
draft_account_name Y String MaxLength(50)
status_id Y Int 1=Open, 2=Closed, 3=Pending
account_type_id Y Int 2=Traditional IRA, 11=Roth IRA 12=Non IRA
w9_code_id Y Int 1=Received W-9/No Withholding
2=W-9 Not Received/Withholding
3=Mandatory Withholding
4=Exempt From Reporting
5=Corporate - No Reporting
6=Foreign Resident
7=W-8 Non US Citizen
contact_name N String MaxLength(75)
contact_phone  N String MaxLength(20)
contact_email N String MaxLength(50)
idology_id N Long  
created_by_ip_address Y String MaxLength(45)
Assets N ICollection<Assets> Collection of escrows
Transactions N ICollection<Transaction>  
mobo_img.jpg

Asset Object Model


Asset Object Model


Asset OBJECT

Parameter Required Type Description
id N Long Identifier for asset
description N String  
number N String  
sold_date N DateTime  
market_value N Decimal  
Transactions N ICollection<Transaction>  
mobo_img.jpg

Asset (Version 2) Object Model


Asset (Version 2) Object Model


Asset(Version 2) OBJECT

Parameter Required Type Description
id N Long Identifier for asset
description N String  
number N String  
sold_date N DateTime  
market_value N Decimal  
term N Decimal  
effective_date N DateTime  
interest_type N decimal 1=simple; 2=compound
interest_frequency N decimal 1=Monthly; 2=Quarterly; 3=Semi-Annually
4=Annually
interest_rate Y decimal IR must be between 0.00 and 99.999 inclusively
maturity_date N DateTime  
third_party_asset_number N String  
Transactions N ICollection<Transaction>  
mobo_img.jpg

Transaction Object Model


Transaction Object Model


TRANSACTION OBJECT

For Fund Account and Fund Escrow API function

Parameter Required Type Description
id N Long Identifier for transaction
account_id Y Long  
asset_id N Long  
date N DateTime  
reference N String MaxLength(20)
description N String MaxLength(50)
amount Y Decimal  
status N String Pending, Processed
created_by_ip_address Y String MaxLength(45)
mobo_img.jpg

Debt Transaction Object Model


Debt Transaction Object Model


Debt TRANSACTION OBJECT

For Fund Debt Escrow API function

Parameter Required Type Description
id N Long Identifier for transaction
account_id Y Long  
asset_id N Long  
date N DateTime  
reference N String MaxLength(20)
description N String MaxLength(50)
amount Y Decimal  
status N String Pending, Processed
created_by_ip_address Y String MaxLength(45)
term N Decimal  
effective_date N DateTime  
interest_type N Decimal 1=simple, 2=compound
interest_frequency N Decimal 1 = Monthly
2 = Quarterly
3 = Semi-Annually
4 = Annually
interest_rate Y Decimal Interest Rate must be netween 0.00 and 99.999 inclusively
maturity_date N DateTime  
third_party_asset_number N String MaxLength(30)
asset_description N String MaxLength(100)
cusip_number N String MaxLength(30)
mobo_img.jpg

Debt Reinvest/Pay Transaction Object Model


Debt Reinvest/Pay Transaction Object Model


Debt reinvest/pay TRANSACTION OBJECT

For Debt Reinvest and Debt Pay API functions

Parameter Required Type Description
id N Long Identifier for transaction
account_id Y Long  
asset_id N Long  
date N DateTime  
reference N String MaxLength(20)
description N String MaxLength(50)
amount Y Decimal  
Status N String Pending, Processed
created_by_ip_address Y String MaxLength(45)
activity_code Y String 707 - Total Reinvestment
708 - Partial Reinvestment
sold_date N DateTime  
term N Decimal  
effective_date N DateTime  
interest_type N Decimal 1=simple, 2=compound
interest_frequency N Decimal 1 = Monthly
2 = Quarterly
3 = Semi-Annually
4 = Annually
interest_rate Y Decimal Interest Rate must be netween 0.00 and 99.999 inclusively
maturity_date N DateTime  
third_party_asset_number N String MaxLength(30)
asset_description N String MaxLength(100)
cusip_number N String MaxLength(30)
mobo_img.jpg

Debt Pay Transaction Object Model


Debt Pay Transaction Object Model


Debt pay TRANSACTION OBJECT

For Debt Reinvest and Debt Pay API functions

Parameter Required Type Description
id N Long Identifier for transaction
account_id Y Long  
asset_id N Long  
date N DateTime  
reference N String MaxLength(20)
description N String MaxLength(50)
amount Y Decimal  
status N String Pending, Processed
created_by_ip_address Y String MaxLength(45)
activity_code Y String 301 - Interest Income
304 - Non-cash dividend
305 - Asset Sold/Matured
sold_date N DateTime  
mobo_img.jpg

Equity Pay Transaction Object Model


Equity Pay Transaction Object Model


Equity PAy Transaction OBJECT

For Equity Pay API function

Parameter Required Type Description
id N Long Identifier for transaction
account_id Y Long  
asset_id Y Long  
date N DateTime  
reference N String MaxLength(20)
description N String MaxLength(50)
amount Y Decimal  
status N String Pending, Processed
created_by_ip_address Y String MaxLength(45)
mobo_img.jpg

Withdraw Funds Transaction Object Model


Withdraw Funds Transaction Object Model


withdraw funds Transaction OBJECT

For Withdraw Funds API function

Parameter Required Type Description
id N Long Identifier for transaction
account_id Y Long  
date N DateTime  
reference N String MaxLength(20)
description N String MaxLength(50)
damount Y Decimal  
status N String Pending, Processed
created_by_ip_address Y String MaxLength(45)
mobo_img.jpg

Escrow Object Model


Escrow Object Model


ESCROW OBJECT

 

ESCROW OBJECT

Parameter Required Type Description
id N Long  
issue_number N Number  
portal_issue_number N Number  
offering_type N String  
minimum_investment_amount N Decimal  
maximum_investment_amount N Decimal  
issue_amount N Decimal  
cash_balance N Decimal  
principal_balance N Decimal  
Register N ICollection<EscrowRegister>  
Transactions N ICollection<EscrowTransaction>  
mobo_img.jpg

Escrow Register Object Model


Escrow Register Object Model


ESCROW REGISTER OBJECT

 

Parameter Required Type Description
account_id N Long  
asset_id N Long  
asset_number N String  
date N DateTime  
quantity N Decimal  
amount N Decimal  
status N String  
mobo_img.jpg

Escrow Transaction Object Model


Escrow Transaction Object Model


ESCROW TRANSACTION OBJECT

 

Parameter Required Type Description
date N DateTime  
description N String  
amount N Decimal  
status N String  
 
 
mobo_img.jpg

Create Investor


Create Investor


Create investor

Creates a new investor resource. The id and investor_key attributes are assigned by the system and returned in Response payload. Subsequent calls to GET the investor must use the investor_key.

For compliance reasons, the following properties will be required.

  • If the is_person = true, first_name and last_name is required.
  • If the is_person = false, name is required.
  • legal_address_1, legal_city, legal_state, legal_zip

Request

Content-Type: application/json

POST https://qaservices.goldstartrust.com/Crowdfunding/api/Investor

{
    "id": 0,
    "tax_id_number": "111223334",
    "first_name": "InvestorFirst",
    "middle_name": "InvestorMiddle",
    "last_name": "InvestorLast",
    "name": null,
    "birth_date": "1960-12-31T00:00:00",
    "mailing_address_1": "123 Ave A",
    "mailing_address_2": null,
    "mailing_city": "Somewhere",
    "mailing_state": "TX",
    "mailing_zip": "79109",
    "mailing_country": null,
    "is_mailing_address_foreign": false,
    "legal_address_1": "123 Ave A",
    "legal_address_2": null,
    "legal_city": "Somewhere",
    "legal_state": "TX",
    "legal_zip": "79109",
    "legal_country": null,
    "is_legal_address_foreign": false,
    "primary_phone": "1112223333",
    "secondary_phone": "2223334444",
    "is_person": true,
    "email": "[email protected]",
    "is_cip_satisfied": false,
    "portal_investor_number": "yourinvestornumber",
    "created_by_ip_address": "123.456.789.012"
}

Response

Notice the payload includes the system-assigned id and investor_key attributes. The id attribute must be used when creating accounts associated with this investor.  The investor_key attribute must be used to GET this investor.

{
    "id": 76866, 
    "investor_key": “abababab-cdcd-efef-ghgh-jkjkjkjkjkjk,
    "tax_id_number": "111223334",
    "first_name": "InvestorFirst",
    "middle_name": "InvestorMiddle",
    "last_name": "InvestorLast",
    "name": null,
    "birth_date": "1960-12-31T00:00:00",
    "mailing_address_1": "123 Ave A",
    "mailing_address_2": null,
    "mailing_city": "Somewhere",
    "mailing_state": "TX",
    "mailing_zip": "79109",
    "mailing_country": null,
    "is_mailing_address_foreign": false,
    "legal_address_1": "123 Ave A",
    "legal_address_2": null,
    "legal_city": "Soemwhere",
    "legal_state": "TX",
    "legal_zip": "79109",
    "legal_country": null,
    "is_legal_address_foreign": false,
    "primary_phone": "1112223333",
    "secondary_phone": "2223334444",
    "is_person": true,
    "email": "[email protected]",
    "is_cip_satisfied": false,
    "portal_investor_number": "yourinvestornumber",
    "created_by_ip_address": "123.456.789.012",
    "Accounts": [],
    "Transactions": []
}

Create Investor example using Postman:

mobo_img.jpg

Get Investor


Get Investor


Get Investor

Get information on investor specified by the investor_key attribute.  Will include all accounts associated to the investor.

 

Request

GET https://qaservices.goldstartrust.com/Crowdfunding/api/Investor/investor_key

Response

{
    "id": 123456,
    "investor_key": "abababab-cdcd-efef-ghgh-jkjkjkjkjkjk",
    "tax_id_number": "111223333",
    "first_name": "InvestorFirst",
    "middle_name": "InvestorMiddle",
    "last_name": "InvestorLast",
    "name": null,
    "birth_date": "1960-12-31T00:00:00",
    "mailing_address_1": "123 Ave A",
    "mailing_address_2": null,
    "mailing_city": "Somewhere",
    "mailing_state": "TX",
    "mailing_zip": "79109",
    "mailing_country": null,
    "is_mailing_address_foreign": false,
    "legal_address_1": "123 Ave A",
    "legal_address_2": null,
    "legal_city": "Soemwhere",
    "legal_state": "TX",
    "legal_zip": "79109",
    "legal_country": null,
    "is_legal_address_foreign": false,
    "primary_phone": "1112223333",
    "secondary_phone": "2223334444",
    "is_person": true,
    "email": "[email protected]",
    "is_cip_satisfied": false,
    "portal_investor_number": "yourinvestornumber",
    "created_by_ip_address": "123.456.789.012",
    "Accounts": []
}

Get Investor example using Postman:

mobo_img.jpg

Create Account


Create Account


CREATe Account

Creates Investor Account record – id returned must be used for subsequent “Funding” and “Investment” API calls.  Make sure investor_id attribute is populated.  This is what is used to tie account to investor.

If name_1, name_2, name_3 and name_4 attributes are null, the investor’s name information will be used to value the name properties.

If mailing_address_1, mailing_address_2, mailing_city, mailing_state, mailing_zip, and mailing_country attributes are null, the investor’s address information will be used to value the account address properties.

Request

QA Environment

Content-Type: application/json

POST https://qaservices.goldstartrust.com/Crowdfunding/api/Account/

{
    "portal_account_number": "youraccountnumber",
    "investor_id": 76866,
    "name_1": null,
    "name_2": null,
    "name_3": null,
    "name_4": null,
    "mailing_address_1": "123 Ave A",
    "mailing_address_2": null,
    "mailing_city": "Somewhere",
    "mailing_state": "TX",
    "mailing_zip": "79109",
    "mailing_country": null,
    "is_mailing_address_foreign": "false",
    "is_cip_satisfied": true,
    "draft_account_type_id": 1,
    "draft_routing_number": "111310870",
    "draft_account_number": "1234567890",
    "draft_account_name": "First Last",
    "status_id": 1,
    "account_type_id": 12,
    "w9_code_id": 1,
    "contact_name": "InvestorFirst InvestorLast",
    "contact_phone": "8061234567",
    "contact_email": "[email protected]",
    "idology_id": 123456,
    "created_by_ip_address": "123.456.789.012"
}

response

Account Model is returned.  Notice the id attribute returned; it must be used when making “Funding” and “Escrow” API calls.

{
    "id": 81686,
    "number": "$1000604176",
    "portal_account_number": "9876431",
    "investor_id": 76866,
    "name_1": "InvestorFirst InvestorMiddle InvestorLast",
    "name_2": null,
    "name_3": null,
    "name_4": null,
    "mailing_address_1": "123 Ave A",
    "mailing_address_2": null,
    "mailing_city": "Somewhere",
    "mailing_state": "TX",
    "mailing_zip": "79109",
    "mailing_country": null,
    "is_mailing_address_foreign": false,
    "current_uninvested_cash": 0,
    "uninvested_cash": 0,
    "is_cip_satisfied": false,
    "draft_account_type_id": null,
    "draft_routing_number": null,
    "draft_account_number": "1234567890",
    "draft_account_name": "First Last",
    "status_id": 1,
    "account_type_id": 12,
    "w9_code_id": 1,
    "contact_name": "InvestorFirst InvestorLast",
    "contact_phone": "8061234567",
    "contact_email": "[email protected]",
    "idology_id": 123456,
    "created_by_ip_address": "123.456.789.012"
}
mobo_img.jpg

Get Account


Get Account


GET Account

Get information on account specified by the account_id parameter.

Request

QA Environment

GET https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id

Response

{
    "id": 81690,
    "number": "$1000604180",
    "portal_account_number": "9876431",
    "investor_id": 123456,
    "name_1": "InvestorFirst InvestorMiddle InvestorLast",
    "name_2": null,
    "name_3": null,
    "name_4": null,
    "mailing_address_1": "3700 Rutson Drive test123 Ave. A",
    "mailing_address_2": null,
    "mailing_city": "Amarillo",
    "mailing_state": "TX",
    "mailing_zip": "79109",
    "mailing_country": null,
    "is_mailing_address_foreign": false,
    "available_balance": 0,
    "current_balance": 0,
    "is_cip_satisfied": false,
    "draft_account_type_id": 1,
    "draft_routing_number": "111111222310333870",
    "draft_account_number": "1234567890",
    "draft_account_name": "InvestorFirst InvestorLast",
    "status_id": 1,
    "account_type_id": 12,
    "w9_code_id": 1,
    "contact_name": "InvestorFirst InvestorLast",
    "contact_phone": "806-123-4567",
    "contact_email": "[email protected]",
    "idology_id": 123456,
    "created_by_ip_address": "123.456.789.012"
    "Assets": [],
    "Transactions": []
}
mobo_img.jpg

Get Account With Assets


Get Account With Assets


GET Account with assets

Get information on account specified by the account_id parameter along with all assets for the account. The “All” keyword will return all assets for the account at the api key level. The original GET continues to return assests for the account at the api key and portal key level.

Request

QA Environment

GET https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Assets

GET https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Assets/All

Response

{
    "id": 81690,
    "number": "$1000604180",
    "portal_account_number": "9876431",
    "investor_id": 123456,
    "name_1": "InvestorFirst InvestorMiddle InvestorLast",
    "name_2": null,
    "name_3": null,
    "name_4": null,
    "mailing_address_1": "3700 Rutson Drive test",
    "mailing_address_2": null,
    "mailing_city": "Amarillo",
    "mailing_state": "TX",
    "mailing_zip": "79109",
    "mailing_country": null,
    "is_mailing_address_foreign": false,
    "available_balance": 0,
    "current_balance": 0,
    "is_cip_satisfied": false,
    "draft_account_type_id": 1,
    "draft_routing_number": "111222333",
    "draft_account_number": "1234567890",
    "draft_account_name": "InvestorFirst InvestorLast",
    "status_id": 1,
    "account_type_id": 12,
    "w9_code_id": 1,
    "contact_name": "InvestorFirst InvestorLast",
    "contact_phone": "806-123-4567",
    "contact_email": "[email protected]",
    "idology_id": 123456,
    "created_by_ip_address": "123.456.789.012"

    "Assets": [
        {
            "id": 471277,
            "description": "ACME Wealth Agriculture 101, LLC",
            "number": "2000001",
            "sold_date": null,
            "market_value": 250,
            "Transactions": []
        }
    ],
    "Transactions": []
}

mobo_img.jpg

Get Account With Assets (Version 2)


Get Account With Assets (Version 2)


GET Account with assets (Version 2)

Same as original version except that Asset model will be the version 2 model for Asset.

Request

QA Environment

GET https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Assets

GET https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Assets/All

Response

{
    "id": 81690,
    "number": "$1000604180",
    "portal_account_number": "9876431",
    "investor_id": 123456,
    "name_1": "InvestorFirst InvestorMiddle InvestorLast",
    "name_2": null,
    "name_3": null,
    "name_4": null,
    "mailing_address_1": "3700 Rutson Drive test",
    "mailing_address_2": null,
    "mailing_city": "Amarillo",
    "mailing_state": "TX",
    "mailing_zip": "79109",
    "mailing_country": null,
    "is_mailing_address_foreign": false,
    "available_balance": 0,
    "current_balance": 0,
    "is_cip_satisfied": false,
    "draft_account_type_id": 1,
    "draft_routing_number": "111222333",
    "draft_account_number": "1234567890",
    "draft_account_name": "InvestorFirst InvestorLast",
    "status_id": 1,
    "account_type_id": 12,
    "w9_code_id": 1,
    "contact_name": "InvestorFirst InvestorLast",
    "contact_phone": "806-123-4567",
    "contact_email": "[email protected]",
    "idology_id": 123456,
    "created_by_ip_address": "123.456.789.012"

    "Assets": [
        {
            "id": 471277,
            "description": "ACME Wealth Agriculture 101, LLC",
            "number": "2000001",
            "sold_date": null,
            "market_value": 250,
            "Transactions": []
        }
    ],
    "Transactions": []
}

mobo_img.jpg

Get Account With Transactions


Get Account With Transactions


GET ACCOUNT WITH Transactions

Get information on account specified by the account_id parameter along with all transactions for the account. The “All” keyword will return all transactions for the account at the api key level. The original GET continues to return transactions for the account at the api key and portal key level.

Request

QA Environment

GET https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Transaction

GET https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Transaction/All

Response

{
    "id": 81690,
    "number": "$1000604180",
    "portal_account_number": "9876431",
    "investor_id": 123456,
    "name_1": "InvestorFirst InvestorMiddle InvestorLast",
    "name_2": null,
    "name_3": null,
    "name_4": null,
    "mailing_address_1": "3700 Rutson Drive test",
    "mailing_address_2": null,
    "mailing_city": "Amarillo",
    "mailing_state": "TX",
    "mailing_zip": "79109",
    "mailing_country": null,
    "is_mailing_address_foreign": false,
    "available_balance": 0,
    "current_balance": 0,
    "is_cip_satisfied": false,
    "draft_account_type_id": 1,
    "draft_routing_number": "111222333",
    "draft_account_number": "1234567890",
    "draft_account_name": "InvestorFirst InvestorLast",
    "status_id": 1,
    "account_type_id": 12,
    "w9_code_id": 1,
    "contact_name": "InvestorFirst InvestorLast",
    "contact_phone": "806-123-4567",
    "contact_email": "[email protected]",
    "idology_id": 123456,
    "created_by_ip_address": "123.456.789.012"

    "Assets": [],
    "Transactions": [
        {
            "id": 681354,
            "account_id": 81690,
            "asset_id": null,
            "date": "2015-01-02T00:00:00",
            "reference": "ref123",
            "description": "Cash Deposit",
            "amount": 5000,
            "status": "Processed",
            "created_by_ip_address": "123.456.789.012"
        },
        {
            "id": 6829651,
            "account_id": 81690,
            "asset_id": 471277,
            "date": "2015-01-02T00:00:00",
            "reference": "ref321",
            "description": "Purchase Assets",
            "amount": 250,
            "status": "Pending",
            "created_by_ip_address": "123.456.789.012"
        }
    ]
}
mobo_img.jpg

Update Account


Update Account


update ACCOUNT

Update Account – The only fields that are updatable are listed below.  All other properties must be changed by communicating with GoldStar Trust.  Please provide account_id of account to update.

  • mailing_address_1
  • mailing_address_2
  • mailing_city
  • mailing_state
  • mailing_zip
  • mailing_country
  • is_mailing_address_foreign
  • portal_account_number
  • contact_name
  • contact_phone
  • contact_email

 

Request

Content-Type: application/json

QA Environment

PUT https://qaservices.goldstartrust.com/Crowdfunding/api/Account/81700

{
    "id": 81700,
    "number": "$1000604199",
    "portal_account_number": "youraccountnumber2",
    "investor_id": 76873,
    "name_1": "Changed Name",
    "name_2": null,
    "name_3": null,
    "name_4": null,
    "mailing_address_1": "123 Ave B",
    "mailing_address_2": null,
    "mailing_city": "Somewhere 2",
    "mailing_state": "TX",
    "mailing_zip": "79119",
    "mailing_country": null,
    "is_mailing_address_foreign": "false",
    "is_cip_satisfied": true,
    "draft_account_type_id": 1,
    "draft_routing_number": "111310870",
    "draft_account_number": "1234567892",
    "draft_account_name": "First Last 2",
    "status_id": 1,
    "account_type_id": 12,
    "w9_code_id": 1,
    "contact_name": "InvestorFirst InvestorLast 2",
    "contact_phone": "8061234562",
    "contact_email": "fi+rst.l+ast[email protected]",
    "idology_id": 123452,
    "created_by_ip_address": "123.456.789.012"
}


Response

{
    "id": 81700,
    "number": "$1000604199",
    "portal_account_number": "youraccountnumber2",
    "investor_id": 76873,
    "name_1": "Changed Name",
    "name_2": null,
    "name_3": null,
    "name_4": null,
    "mailing_address_1": "123 Ave B",
    "mailing_address_2": null,
    "mailing_city": "Somewhere 2",
    "mailing_state": "TX",
    "mailing_zip": "79119",
    "mailing_country": null,
    "is_mailing_address_foreign": "false",
    "is_cip_satisfied": true,
    "draft_account_type_id": 1,
    "draft_routing_number": "111310870",
    "draft_account_number": "1234567892",
    "draft_account_name": "First Last 2",
    "status_id": 1,
    "account_type_id": 12,
    "w9_code_id": 1,
    "contact_name": "InvestorFirst InvestorLast 2",
    "contact_phone": "8061234562",
    "contact_email": "[email protected]",
    "idology_id": 123452,
    "created_by_ip_address": "123.456.789.012",
    "Assets": [],
    "Transactions": []
}
mobo_img.jpg

Get Asset


Get Asset


GET Asset

Get information on asset specified by the account_id and asset_id parameters. The “All” keyword will return the asset using the asset_id searching at the api key level. The original GET continues to return the asset using the asset_id searching at the api key and portal key level.

Request

QA Environment

GET https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Assets/asset_id

Response

{
    "id": 471277,
    "description": "ACME Wealth Agriculture 101, LLC",
    "number": "2000001",
    "sold_date": null,
    "market_value": 250,
    "Transactions": []
}
mobo_img.jpg

Get Asset (Version 2)


Get Asset (Version 2)


GET Asset (version 2)

Get information on asset specified by the account_id and asset_id parameters. The “All” keyword will return the asset using the asset_id searching at the api key level. The original GET continues to return the asset using the asset_id searching at the api key and portal key level.

Request

QA Environment

GET https://qaservices.goldstartrust.com/Crowdfunding/api/V2/Account/account_id/Assets/asset_id

GET https://qaservices.goldstartrust.com/Crowdfunding/api/V2/Account/account_id/Assets/asset_id/All

Response

{
    "id": 471277,
    "description": "ACME Wealth Agriculture 101, LLC",
    "number": "2000001",
    "sold_date": null,
    "market_value": 250,
    "term": null,
    "effective_date": "2015-04-15T00:00:00",
    "interest_type": "Simple",
    "interest_frequency": "Monthly",
    "interest_rate": 3.25,
    "maturity_date": "2017-10-15T00:00:00",
    "third_party_asset_number": "yourassetnumber",
    "quantity": 1,
    "Transactions": []
}
mobo_img.jpg

Get Asset With Transactions


Get Asset With Transactions


Get Asset with Transactions

Get information on asset specified by the account_id and asset_id parameters along with all transactions for the asset. The “All” keyword will return the asset and associated transactions using the asset_id searching at the api key level. The original GET continues to return the asset and associated transactions using the asset_id searching at the api key and portal key level.

Request

QA Environment

GET https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Assets/asset_id/transactions

GET https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Assets/asset_id/transactions/All

Response

{
    "id": 471277,
    "description": "ACME Wealth Agriculture 101, LLC",
    "number": "2000001",
    "sold_date": null,
    "market_value": 250,
    "Transactions": [
        {
            "id": 6829651,
            "account_id": 81690,
            "asset_id": 471277,
            "date": "2015-01-02T00:00:00",
            "reference": "ref321",
            "description": "Purchase Assets",
            "amount": 250,
            "status": "Pending",
            "created_by_ip_address": "123.456.789.012"
        }
    ]
}

mobo_img.jpg

Get Asset With Transactions (Version 2)


Get Asset With Transactions (Version 2)


Get Asset with Transactions (Version 2)

Get information on asset specified by the account_id and asset_id parameters along with all transactions for the asset. The “All” keyword will return the asset and associated transactions using the asset_id searching at the api key level. The original GET continues to return the asset and associated transactions using the asset_id searching at the api key and portal key level.

Request

QA Environment

GET https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Assets/asset_id/transactions

GET https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Assets/asset_id/transactions/All

Response

{
    "id": 471277,
    "description": "ACME Wealth Agriculture 101, LLC",
    "number": "2000001",
    "sold_date": null,
    "market_value": 250,
    "term": null,
    "effective_date": "2015-04-15T00:00:00",
    "interest_type": "Simple",
    "interest_frequency": "Monthly",
    "interest_rate": 3.25,
    "maturity_date": "2017-10-15T00:00:00",
    "third_party_asset_number": "yourassetnumber",
    "quantity": 1,
    "Transactions": [
      {
        "id": 6829651,
        "account_id": 81690,
        "asset_id": 471277,
        "date": "2015-01-02T00:00:00",
        "reference": "ref321",
        "description": "Purchase Assets",
        "amount": 250,
        "status": "Pending",
        "created_by_ip_address": "123.456.789.012"
        }
                    ]
}
mobo_img.jpg

Get Escrows


Get Escrows


Get Escrows

Returns a list of escrows associated with the X-PortalKey header value.

Request

QA Environment

GET https://qaservices.goldstartrust.com/crowdfunding/api/Escrows

Response

[
        {
            "id": 2935,
            "issue_number": "2000002",
            "portal_issue_number": null,
            "offering_type": "Equity - Common",
            "minimum_investment_amount": 50000,
            "maximum_investment_amount": 100000,
            "issue_amount": 15000000,
            "cash_balance": 0,
            "principal_balance": 0
    }
]
mobo_img.jpg

Get Escrow


Get Escrow


Get Escrow

Returns the escrow by the given id parameter.

Request

QA Environment

GET https://qaservices.goldstartrust.com/crowdfunding/api/Escrows/id

Response

{
    "id": 2935,
    "issue_number": "2000002",
    "portal_issue_number": null,
    "offering_type": "Equity - Common",
    "minimum_investment_amount": 50000,
    "maximum_investment_amount": 100000,
    "issue_amount": 15000000,
    "cash_balance": 0,
    "principal_balance": 0,
    "Register": [ ],
    "Transactions": [ ]
}
mobo_img.jpg

Get Register


Get Register


Get Register

Returns a list of registrations for the given escrow id parameter.

 

Request

QA Environment

GET https://qaservices.goldstartrust.com/crowdfunding/api/escrows/id/Register

 

Response

{
    "id": 2935,
    "issue_number": "2000002",
    "portal_issue_number": null,
    "offering_type": "Equity - Common",
    "minimum_investment_amount": 50000,
    "maximum_investment_amount": 100000,
    "issue_amount": 15000000,
    "cash_balance": 0,
    "principal_balance": 0,
    "Register": 
     [
        {
            "account_id": 81925,
            "asset_id": 471372,
            "asset_number": "2000002",
            "date": "2015-03-03T00:00:00",
            "quantity": 1,
            "amount": 2500,
            "status": "Processed"
        },
        {
            "account_id": 81700,
            "asset_id": 471374,
            "asset_number": "2000002",
            "date": "2015-03-03T00:00:00",
            "quantity": 1,
            "amount": 500,
            "status": "Pending"
        },
        {
            "account_id": 81700,
            "asset_id": 471401,
            "asset_number": "2000002",
            "date": "2015-03-07T00:00:00",
            "quantity": 1,
            "amount": 500,
            "status": "Pending"
        }
    ],
    "Transactions": [ ]
}
mobo_img.jpg

Get Transactions


Get Transactions


Get Transactions

Returns a list of funding transactions or proceeds for the given escrow id parameter.

 

Request

QA Environment

GET https://qaservices.goldstartrust.com/crowdfunding/api/Escrows/id/Transactions

 

Response

{
    "id": 2935,
    "issue_number": "2000002",
    "portal_issue_number": null,
    "offering_type": "Equity - Common",
    "minimum_investment_amount": 50000,
    "maximum_investment_amount": 100000,
    "issue_amount": 15000000,
    "cash_balance": 0,
    "principal_balance": 0,
    "Register": [ ],
    "Transactions":
     [
        {
            "date": "2015-02-19T00:00:00",
            "description": "Purchase preferred stock",
            "amount": 10000,
            "status": “Processed
        },
        {
            "date": "2015-02-20T00:00:00",
            "description": "Purchase preferred stock",
            "amount": 10000,
            "status": “Processed
        },
        {
            "date": "2015-02-21T00:00:00",
            "description": "Purchase preferred stock",
            "amount": 10000,
            "status": “Pending
        }
    ]
}
mobo_img.jpg

Get Transaction


Get Transaction


Get Transaction

Returns the transaction for the given the account_id and transaction_id parameter. The “All” keyword will return the transaction using the tranaction_id searching at the API key level. The original GET continues to return the transaction using the tranaction_id searching at the API key and portal key level.

Request

QA Environment

GET https://qaservices.goldstartrust.com/crowdfunding/api/Account/account_id/Transaction/transaction_id

Response

{
 "amount": 100,
"id": 6550796,
"account_id": 82901,
"asset_id": 471825,
"date": "2015-04-07T00:00:00",
"reference": "998877",
"description": "funding escrow",
"status": "Processed",
"quantity": 0,
"created_by_ip_address": "123.456.789.123"
}
mobo_img.jpg

Fund Account


Fund Account


Fund Account

Create ACH transaction to fund the Investor’s crowd pay account. account_id parameter must be provided to associate transaction with the correct Crowd Pay account. Notice the id and date attributes returned in Response. The id attribute is GoldStar Trust’s internal unique identifier for a transaction. The date attribute is the date that the funds will become available in the crowd pay account. There will be a cutoff time for determining current date. The date attribute will be “plus 3” working days from the current date. If the transaction is submitted past 3:00 p.m. C.S.T., the current date will be the next date. Please see table below for examples.

Please see table below for examples.

Submission Current Date Transaction Date Example Transaction Status Account Available Balance
01/05/2015 2:30 PM 01/05/2015 01/06/2015 $100 - Before 3:00 PM PENDING changes to PROCESSED on transaction date + 2 bank days 01/06/15 $100 – added to available balance on transaction date + 2 bank days 01/06/15
01/05/2015 3:30 PM 01/05/2015 01/07/2015 $100 - After 3:00 PM PENDING changes to PROCESSED on transaction date + 2 bank days 01/9/15 $100 – added to available balance on transaction date + 2 bank days 01/9/15
01/09/2015 2:30 PM 01/09/2015 01/12/2015 $100 - Weekend Before 3:00 PM PENDING changes to PROCESSED on transaction date + 2 bank days 01/14/15 $100 – added to available balance on transaction date + 2 bank days (01/14/15)
01/09/2015 3:30 PM 01/09/2015 01/13/2015 $100 - Weekend After 3:00 PM PENDING changes to PROCESSED on transaction date + 2 bank days (01/15/15) $100 – added to available balance on transaction date + 2 bank days (01/15/15)
11/25/2015 2:30 p.m. 11/25/2015 11/27/2015 $100 - Day before bank holiday PENDING changes to PROCESSED on transaction date + 2 bank days (12/01/15) $100 – added to available balance on transaction date + 2 bank days (12/01/15)

REQUEST

Content-Type: application/json

QA Environment

POST https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Transaction/FundAccount

{
    "id": 0,
    "account_id": 1234567,
    "date": null,
    "reference": "yourreferencenumber",
    "description": "description you would like placed on transaction",
    "amount": 100.00,
    "created_by_ip_address": "123.456.789.012"
}

RESPONSE

Notice the “id” attribute returned.  This “id” attribute is GoldStar Trust’s internal unique identifier for the transaction.

{
    "id": 9876543,
    "account_id": 1234567,
    "date": "2015-01-01T00:00:00",
    "reference": "yourreferencenumber",
    "description": "description you would like placed on transaction",
    "amount": 100.00,
    "created_by_ip_address": "123.456.789.012"
}
mobo_img.jpg

Fund Escrow


Fund Escrow


Fund Escrow

Initiate a CrowdPay transaction to move funds from the investor account to the selected escrow account.

  • Please populate the number_of_shares property with 0 or null. The system will calculate the quantity.

REQUEST

Content-Type: application/json

QA Environment

POST https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Transaction/FundEscrow

{
    "account_id": 1234567,
    "date": null,
    "reference": "yourtransactionreferencenumber",
    "description": "description you would like placed on transaction",
    "amount": 100.00,
    "quantity": 10,
    "created_by_ip_address": "123.456.789.012"
}

 

RESPONSE

Notice the “id” attribute returned.  This attribute is GoldStar Trust’s internal unique identifier for the transaction.

{
    "id": 9876544,
    "account_id": 1234567,
    "asset_id": 456789,
    "date": "2015-01-06T00:00:00",
    "reference": "yourreferencenumber",
    "description": "description you would like placed on transaction",
    "amount": 100.00,
    "quantity": 10,
    "created_by_ip_address": "123.456.789.012"
}
mobo_img.jpg

Fund Debt Escrow


Fund Debt Escrow


Fund DEBT Escrow

Initiate a CrowdPay transaction to move funds from the investor account to the selected escrow account with additional debt asset properties.

Submission Current Date Transaction Date Example Transaction Status Account Available Balance
01/05/2015 2:30 PM 01/05/2015 01/05/2015 Before 3:00 PM PENDING changes to PROCESSED when GoldStar posts transactions on 01/05/2015 Transaction amount subtracted from available balance after GoldStar posts transactions on 01/05/2015
01/05/2015 3:30 PM 01/06/2015 01/06/2015 After 3:00 PM PENDING changes to PROCESSED when GoldStar posts transactions on 01/06/2015 Transaction amount subtracted from available balance after GoldStar posts transactions on 01/06/2015


REQUEST

Content-Type: application/json

QA Environment

POST https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Transaction/FundDebtEscrow

{
    "account_id": 1234567,
    "date": null,
    "reference": "yourtransactionreferencenumber",
    "description": "description you would like placed on transaction",
    "amount": 100.00,
    "quantity": 10,
    "created_by_ip_address": "123.456.789.012"
    "term": 3.0,
    "effective date": "2015-01-15T00:00:00",
    "interest_type": 1,
    "interest_frequency": 3,
    "interest_rate": 1.50,
    "maturity_date": "2015-07-01T00:00:00",
    "third_party_asset_number": "yourassetnumber",
    "asset_description": "custom asset description",
    "cusip_number": "1315020180115"  
}

 

RESPONSE

Notice the "id" and asset_id attribute returned. This id is GoldStar Trust’s internal unique identifier for the transaction. The asset_id is GoldStar Trust’s internal unique identifier for the asset created. The asset_id can be used with Get Asset and Get Asset with Transactions api functions.

{
    "id": 9876544,
    "account_id": 1234567,
    "asset_id": 456789,
    "date": "2015-01-06T00:00:00",
    "reference": "yourreferencenumber",
    "description": "description you would like placed on transaction",
    "amount": 100.00,
    "quantity": 10,
    "created_by_ip_address": "123.456.789.012"
    "term": 10.5,
    "effective_date": "2015-01-15T00:00:00",
    "interest_type": 1,
    "interest_frequency": 1,
    "interest_rate": 3.250,
    "maturity_date": "2015-07-01T00:00:00",
    "third_party_asset_number": "yourassetnumber",
    "asset_description": "custom asset description",
    "cusip_number": "1315020180115"  
}


mobo_img.jpg

Debt Reinvest


Debt Reinvest


DEBT REINVEST

Initiate a crowd pay transaction to mature a debt asset and reinvest partial or total amount of the funds into another debt asset.

Submission Current Date Transaction Date Example Transaction Status Account Available Balance
01/05/2015 2:30 PM 01/05/2015 01/08/2015 Before 3:00 PM PENDING changes to PROCESSED when GoldStar posts transactions on 01/05/2015 For 707, the balance is not affected. For 708, the difference in amount entered and book value/cost basis is added to available balance after GoldStar posts transactions on 01/05/2015
01/05/2015 3:30 PM 01/06/2015 01/06/2015 After 3:00 PM PENDING changes to PROCESSED when GoldStar posts transactions on 01/06/2015 For 707, the balance is not affected. For 708, The difference in amount entered and book value/cost basis is added to available balance after GoldStar posts transactions on 01/06/2015

 

REQUEST

Content-Type: application/json

QA Environment

POST https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Transaction/ReinvestDebt

*****VERY IMPORTANT*****

asset_id in content must represent the asset_id of the debt asset that you wish to mature.
sold_date – if null, we will use transaction date (you should leave as null unless you know what you want valued in this field)
description – we will provide default description and return in response if you leave blank

activity_code

  • 707 – Total Reinvestment
    • Enter amount = 0 or book value/cost basis
  • 708 – Partial Reinvestment
    • Enter amount = to amount that you wish to reinvest
    • The difference in amount entered and book value/cost basis will show up as cash in crowd pay account
{
    "account_id": 1234567,
    "asset_id": 987654,  
    "sold_date": null,
    "reference": "yourtransactionreferencenumber",
    "description": "description you would like placed on transaction",
    "amount": 100.00,
    "quantity": 10,
    "created_by_ip_address": "123.456.789.012"
    "term": 3.0,
    "effective date": "2015-01-15T00:00:00",
    "interest_type": 1,
    "interest_frequency": 3,
    "interest_rate": 1.50,
    "maturity_date": "2015-07-01T00:00:00",
    "third_party_asset_number": "yourassetnumber",
    "asset_description": "custom asset description",
    "cusip_number": "1315020180115"  
}

 

RESPONSE

Notice the "id" and asset_id attribute returned. This id is GoldStar Trust’s internal unique identifier for the transaction. The asset_id is GoldStar Trust’s internal unique identifier for the asset created. The asset_id can be used with Get Asset and Get Asset with Transactions api functions.

{
    "id": 9876544,
    "account_id": 1234567,
    "asset_id": 456789,
    "activity_code": "707"  
    "sold_date": null,
    "reference": "yourreferencenumber",
    "description": "description you would like placed on transaction",
    "amount": 100.00,
    "quantity": 10,
    "created_by_ip_address": "123.456.789.012"
    "term": 3.0,
    "effective_date": "2015-01-15T00:00:00",
    "interest_type": 1,
    "interest_frequency": 3,
    "interest_rate": 1.50,
    "maturity_date": "2015-07-01T00:00:00",
    "third_party_asset_number": "yourassetnumber",
    "asset_description": "custom asset description",
    "cusip_number": "1315020180115",
    "status": "Pending",
}
mobo_img.jpg

Debt Pay


Debt Pay


DEBT Pay

Initiate a crowd pay transaction to post interest or principal to a debt asset. In addition, this api function can also mature an asset and apply the cash to the crowd pay account of the matured asset.

Submission Current Date Transaction Date Example Transaction Status Account Available Balance
01/05/2015 2:30 PM 01/05/2015 01/08/2015 Before 3:00 PM PENDING changes to PROCESSED when GoldStar posts transactions on 01/05/2015 For 301 and 305 Transactions, amount is added to available balance after GoldStar posts transactions on 01/05/2015
01/05/2015 3:30 PM 01/06/2015 01/06/2015 After 3:00 PM PENDING changes to PROCESSED when GoldStar posts transactions on 01/06/2015 For 301 and 305 Transactions, amount is added to available balance after GoldStar posts transactions on 01/06/2015

 

REQUEST

Content-Type: application/json

QA Environment

POST https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Transaction/DebtPay

*****VERY IMPORTANT*****

asset_id in content must represent the asset_id of the debt asset that you wish to mature.

activity_code

  • 301 – amount = amount of interest income that you wish to apply to asset
  • 304 – amount = amount of increase in asset principal
  • 305 – Sell/mature asset
    • Enter amount = 0 or book value/cost basis – The asset’s book value or amount value will show up as cash in crowd pay account
    • sold_date – if null, we will use transaction date (you should leave as null unless you know what you want valued in this field)
{
"account_id": 1234567,
"asset_id": 987654,
"activity_code": "305",
"sold_date": null,
"reference": "yourtransactionreferencenumber",
"description": "description you would like placed on transaction",
"amount": 100.00,
"created_by_ip_address": "123.456.789.012"
}

 

RESPONSE

Notice the "id" and asset_id attribute returned. This id is GoldStar Trust’s internal unique identifier for the transaction. The asset_id is GoldStar Trust’s internal unique identifier for the asset created. The asset_id can be used with Get Asset and Get Asset with Transactions API functions.

{
"id": 6580369, 
"account_id": 1234567,
"asset_id": 987654,
"activity_code": "305",
"sold_date": 2015-06-01T00:00:00,
"reference": "yourtransactionreferencenumber",
"description": "description you would like placed on transaction",
"amount": 100.00,
"created_by_ip_address": "123.456.789.012",
"status": "Pending"
}


mobo_img.jpg

Equity Pay


Equity Pay


Equity Pay

Initiate a crowd pay transaction to post dividend income to an equity asset.

Submission Current Date Transaction Date Example Transaction Status Account Available Balance
01/05/2015 2:30 PM 01/05/2015 01/05/2015 Before 3:00 PM PENDING changes to PROCESSED when GoldStar posts transactions on 01/05/2015 For 302 Transactions, amount is added to available balance after GoldStar posts transactions on 01/05/2015
01/05/2015 3:30 PM 01/06/2015 01/06/2015 After 3:00 PM PENDING changes to PROCESSED when GoldStar posts transactions on 01/06/2015 For 302 Transactions, amount is added to available balance after GoldStar posts transactions on 01/06/2015
01/05/2015 3:30 PM 01/06/2015 01/06/2015 After 3:00 PM PENDING changes to PROCESSED when GoldStar posts transactions on 01/06/2015 For 305 and 306 Transactions, amount is added to available balance after GoldStar posts transactions on 01/06/2015

 

REQUEST

Content-Type: application/json

QA Environment

POST https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Transaction/EquityPay

*****VERY IMPORTANT*****

asset_id in content must represent the asset_id of the equity asset.

  • 302 – amount = amount of dividend income that you wish to apply to the equity asset
{
"account_id": 12345,
"asset_id": 54321,
"reference":"equitypay",
"amount": 0.10,
"created_by_ip_address":"123.456.789.012"
}

 

RESPONSE

Notice the id. This id is GoldStar Trust’s internal unique identifier for the transaction. The asset_id can be used with Get Asset and Get Asset with Transactions API functions.

{
"id": 6590904,
"account_id": 12345,
"asset_id": 54321,
"date": "2015-07-31T00:00:00",
"reference": "equitypay",
"description": "Dividend Income",
"amount": 0.1,
"status": "Pending",
"created_by_ip_address": "123.456.789.012"
}
mobo_img.jpg

Withdraw Funds Transaction


Withdraw Funds Transaction


Withdraw Funds Transaction

Initiate a transaction to withdraw funds from a CrowdPay account.

Submission Current Date Transaction Date Example Transaction Status Account Available Balance
01/05/2015 2:30 PM 01/05/2015 01/06/2015 Before 3:00 PM PENDING changes to PROCESSED when GoldStar posts transactions on 01/06/2015 Amount is subtracted from available balance after GoldStar posts transactions on 01/05/2015
01/05/2015 3:30 PM 01/06/2015 01/07/2015 After 3:00 PM PENDING changes to PROCESSED when GoldStar posts transactions on 01/07/2015 Amount is subtracted from available balance after GoldStar posts transactions on 01/06/2015

 

REQUEST

Content-Type: application/json

QA Environment

POST https://qaservices.goldstartrust.com/Crowdfunding/api/Account/account_id/Transaction/WithdrawFunds

*****VERY IMPORTANT*****

{
"account_id": 1234567,
"reference": "yourtransactionreferencenumber",
"description": "description you would like placed on transaction",
"amount": 100.00,
"created_by_ip_address": "123.456.789.012"
}

 

RESPONSE

Notice the id. This id is GoldStar Trust’s internal unique identifier for the transaction.

{
"id": 6580369,
"reference": "yourtransactionreferencenumber",
"description": "description you would like placed on transaction",
"amount": 100.00,
"created_by_ip_address": "123.456.789.012",
"status": "Pending"
}