Cart

Get carts (Trade.status = CART)

get

Authorizations

api_key

X-API-KEYstringRequired

Query parameters

userIdstringRequired

Responses

200

200

application/json

idstringRequiredExample: entityprefix_01j1xgme5qeqq97gpdztd7e4a6

__entitystringOptionalExample: Entity

createdAtone ofRequiredExample: 2026-03-27T15:47:09.539Z

string · date-timeOptional

or

string · date-timeOptional

updatedAtone ofRequiredExample: 2026-03-27T15:47:09.539Z

string · date-timeOptional

or

string · date-timeOptional

deletedAtone of · nullableRequiredExample: 2026-03-27T15:47:09.540Z

string · date-timeOptional

or

string · date-timeOptional

investorAccountIdany · nullableRequired

investorAccountany · nullableOptional

offeringany · nullableOptional

accountIdstring · nullableRequiredExample: account_01j1xgme5qeqq97gpdztd7e4a6

accountany · nullableRequired

offeringIdany · nullableRequired

paymentMethodIdany · nullableRequired

paymentMethodany · nullableOptional

userIdany · nullableRequired

tradeNumberstringRequired

ipstring · nullableRequired

tidstring · nullableRequired

investmentTypestring · enumRequiredPossible values:

purchasedSharesintegerRequired

bonusSharesinteger · nullableRequired

totalNumberOfSharesintegerRequired

pricePerSharenumberRequired

totalAmountnumber · nullableRequired

tradeStatusstring · enumRequiredPossible values:

tradeStatusUnmappedstring · nullableRequired

tradeDatestring · date-time · nullableRequired

saStatusstring · enumRequiredPossible values:

saStatusUnmappedstring · nullableRequired

saUrlstring · nullableRequired

saSignedAtstring · date-time · nullableRequired

saExtractedNumberOfSharesstring · nullableRequired

saExtractedTotalAmountstring · nullableRequired

saExtractedPricePerSharestring · nullableRequired

saExtractedInvestorTypestring · nullableRequired

saExtractedSignerstring · nullableRequired

saExtractedSignatureDatestring · date-time · nullableRequired

saExtractedSigner2string · nullableRequired

saExtractedSignatureDate2string · date-time · nullableRequired

saCheckstring · enumRequiredPossible values:

saCheckedAtstring · date-time · nullableRequired

txnTidstring · nullableRequired

txnResponsestring · nullableRequired

txnPaymentMethodstring · enum · nullableRequiredPossible values:

txnCurrencyCodestring · min: 3 · max: 3 · nullableRequired

txnChargedAmountnumber · nullableRequired

txnDatestring · date-time · nullableRequired

txnSettledDatestring · date-time · nullableRequired

fundingStatusstring · enum · nullableRequiredPossible values:

fundingStatusUnmappedstring · nullableRequired

txnCheckstring · enum · nullableRequiredPossible values:

txnCheckedAtstring · date-time · nullableRequired

txnLogstring · nullableRequired

systemReviewCheckstring · enum · nullableRequiredPossible values:

systemReviewCheckedAtstring · date-time · nullableRequired

systemReviewLogstring · nullableRequired

complianceReviewstring · enum · nullableRequiredPossible values:

complianceReviewNotesstring · nullableRequired

complianceReviewerIdstring · nullableRequired

issuerIdany · nullableRequired

complianceReviewNamestring · nullableRequired

complianceReviewAtstring · date-time · nullableRequired

tradeTypestring · enum · nullableRequiredPossible values:

placedAtstring · date-time · nullableRequired

platformstringRequired

cancelledAtstring · date-time · nullableRequired

cancelledByIdstring · nullableRequired

cancelledReasonstring · nullableRequired

cancellationPeriodnumber · nullableRequired

disbursedbooleanOptional

tradeAdjustmentsnumber · nullableOptional

chargedAmountnumber · nullableOptional

balancenumber · nullableOptional

isUncleared24hbooleanRequired

termnumber · nullableRequired

exercisePricenumber · nullableRequired

warrantPercentagenumber · nullableRequired

calculationMethodstring · enum · nullableRequiredPossible values:

incrementThresholdnumber · nullableRequired

401

401

application/json

403

403

application/json

404

404

application/json

500

500

application/json

get

/clients/api/v1/carts

HTTPcURLJavaScriptPython

GET /clients/api/v1/carts?userId=text HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "entityprefix_01j1xgme5qeqq97gpdztd7e4a6",
  "__entity": "Entity",
  "createdAt": "2026-03-27T15:47:09.539Z",
  "updatedAt": "2026-03-27T15:47:09.539Z",
  "deletedAt": "2026-03-27T15:47:09.540Z",
  "investorAccountId": null,
  "investorAccount": null,
  "offering": null,
  "accountId": "account_01j1xgme5qeqq97gpdztd7e4a6",
  "account": null,
  "offeringId": null,
  "paymentMethodId": null,
  "paymentMethod": null,
  "userId": null,
  "tradeNumber": "text",
  "ip": "text",
  "tid": "text",
  "investmentType": "INDIVIDUAL",
  "purchasedShares": 1,
  "bonusShares": 1,
  "totalNumberOfShares": 1,
  "pricePerShare": 1,
  "lineItems": [],
  "adjustments": [],
  "transactions": [],
  "totalAmount": 1,
  "tradeStatus": "CART",
  "tradeStatusUnmapped": "text",
  "tradeDate": "2026-04-03T19:34:54.540Z",
  "saStatus": "PENDING",
  "saStatusUnmapped": "text",
  "saUrl": "text",
  "saSignedAt": "2026-04-03T19:34:54.540Z",
  "saExtractedNumberOfShares": "text",
  "saExtractedTotalAmount": "text",
  "saExtractedPricePerShare": "text",
  "saExtractedInvestorType": "text",
  "saExtractedSigner": "text",
  "saExtractedSignatureDate": "2026-04-03T19:34:54.540Z",
  "saExtractedSigner2": "text",
  "saExtractedSignatureDate2": "2026-04-03T19:34:54.540Z",
  "saCheck": "PENDING",
  "saCheckedAt": "2026-04-03T19:34:54.540Z",
  "saLog": {
    "finalStatus": "PENDING",
    "matchResults": [
      {
        "tradeLineItemId": "trade_line_item_01kctsycw3fq7sj6hedvy62cja",
        "signerName": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        },
        "totalAmount": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        },
        "investorName": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        },
        "numberOfShares": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        }
      }
    ]
  },
  "txnTid": "text",
  "txnResponse": "text",
  "txnPaymentMethod": "CREDIT_CARD",
  "txnCurrencyCode": "text",
  "txnChargedAmount": 1,
  "txnDate": "2026-04-03T19:34:54.540Z",
  "txnSettledDate": "2026-04-03T19:34:54.540Z",
  "fundingStatus": "PENDING",
  "fundingStatusUnmapped": "text",
  "txnCheck": "PENDING",
  "txnCheckedAt": "2026-04-03T19:34:54.540Z",
  "txnLog": "text",
  "systemReviewCheck": "PENDING",
  "systemReviewCheckedAt": "2026-04-03T19:34:54.540Z",
  "systemReviewLog": "text",
  "complianceReview": "PENDING",
  "complianceReviewNotes": "text",
  "complianceReviewerId": "text",
  "issuerId": null,
  "complianceReviewName": "text",
  "complianceReviewAt": "2026-04-03T19:34:54.540Z",
  "tradeType": "PURCHASE",
  "placedAt": "2026-04-03T19:34:54.540Z",
  "platform": "text",
  "cancelledAt": "2026-04-03T19:34:54.540Z",
  "cancelledById": "text",
  "cancelledReason": "text",
  "cancellationPeriod": 1,
  "disbursed": true,
  "tradeAdjustments": 1,
  "chargedAmount": 1,
  "balance": 1,
  "isUncleared24h": true,
  "term": 1,
  "exercisePrice": 1,
  "warrantPercentage": 1,
  "calculationMethod": "NONE",
  "incrementThreshold": 1
}

Place a trade (checkout button)

post

Authorizations

api_key

X-API-KEYstringRequired

Body

application/json

userIdstringRequired

Responses

200

200

application/json

tradeStatusstring · enumOptionalPossible values:

tradeIdstringOptional

400

400

application/json

401

401

application/json

403

403

application/json

500

500

application/json

post

/clients/api/v1/carts/checkout

HTTPcURLJavaScriptPython

POST /clients/api/v1/carts/checkout HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "userId": "text"
}

{
  "tradeStatus": "CART",
  "tradeId": "text"
}

Patch a cart

patch

Authorizations

api_key

X-API-KEYstringRequired

Path parameters

idstringRequired

Body

application/json

investorAccountIdstringOptional

paymentMethodIdstringOptional

Responses

200

200

application/json

idstringRequiredExample: entityprefix_01j1xgme5qeqq97gpdztd7e4a6

__entitystringOptionalExample: Entity

createdAtone ofRequiredExample: 2026-03-27T15:47:09.539Z

string · date-timeOptional

or

string · date-timeOptional

updatedAtone ofRequiredExample: 2026-03-27T15:47:09.539Z

string · date-timeOptional

or

string · date-timeOptional

deletedAtone of · nullableRequiredExample: 2026-03-27T15:47:09.540Z

string · date-timeOptional

or

string · date-timeOptional

investorAccountIdany · nullableRequired

investorAccountany · nullableOptional

offeringany · nullableOptional

accountIdstring · nullableRequiredExample: account_01j1xgme5qeqq97gpdztd7e4a6

accountany · nullableRequired

offeringIdany · nullableRequired

paymentMethodIdany · nullableRequired

paymentMethodany · nullableOptional

userIdany · nullableRequired

tradeNumberstringRequired

ipstring · nullableRequired

tidstring · nullableRequired

investmentTypestring · enumRequiredPossible values:

purchasedSharesintegerRequired

bonusSharesinteger · nullableRequired

totalNumberOfSharesintegerRequired

pricePerSharenumberRequired

totalAmountnumber · nullableRequired

tradeStatusstring · enumRequiredPossible values:

tradeStatusUnmappedstring · nullableRequired

tradeDatestring · date-time · nullableRequired

saStatusstring · enumRequiredPossible values:

saStatusUnmappedstring · nullableRequired

saUrlstring · nullableRequired

saSignedAtstring · date-time · nullableRequired

saExtractedNumberOfSharesstring · nullableRequired

saExtractedTotalAmountstring · nullableRequired

saExtractedPricePerSharestring · nullableRequired

saExtractedInvestorTypestring · nullableRequired

saExtractedSignerstring · nullableRequired

saExtractedSignatureDatestring · date-time · nullableRequired

saExtractedSigner2string · nullableRequired

saExtractedSignatureDate2string · date-time · nullableRequired

saCheckstring · enumRequiredPossible values:

saCheckedAtstring · date-time · nullableRequired

txnTidstring · nullableRequired

txnResponsestring · nullableRequired

txnPaymentMethodstring · enum · nullableRequiredPossible values:

txnCurrencyCodestring · min: 3 · max: 3 · nullableRequired

txnChargedAmountnumber · nullableRequired

txnDatestring · date-time · nullableRequired

txnSettledDatestring · date-time · nullableRequired

fundingStatusstring · enum · nullableRequiredPossible values:

fundingStatusUnmappedstring · nullableRequired

txnCheckstring · enum · nullableRequiredPossible values:

txnCheckedAtstring · date-time · nullableRequired

txnLogstring · nullableRequired

systemReviewCheckstring · enum · nullableRequiredPossible values:

systemReviewCheckedAtstring · date-time · nullableRequired

systemReviewLogstring · nullableRequired

complianceReviewstring · enum · nullableRequiredPossible values:

complianceReviewNotesstring · nullableRequired

complianceReviewerIdstring · nullableRequired

issuerIdany · nullableRequired

complianceReviewNamestring · nullableRequired

complianceReviewAtstring · date-time · nullableRequired

tradeTypestring · enum · nullableRequiredPossible values:

placedAtstring · date-time · nullableRequired

platformstringRequired

cancelledAtstring · date-time · nullableRequired

cancelledByIdstring · nullableRequired

cancelledReasonstring · nullableRequired

cancellationPeriodnumber · nullableRequired

disbursedbooleanOptional

tradeAdjustmentsnumber · nullableOptional

chargedAmountnumber · nullableOptional

balancenumber · nullableOptional

isUncleared24hbooleanRequired

termnumber · nullableRequired

exercisePricenumber · nullableRequired

warrantPercentagenumber · nullableRequired

calculationMethodstring · enum · nullableRequiredPossible values:

incrementThresholdnumber · nullableRequired

400

400

application/json

401

401

application/json

403

403

application/json

500

500

application/json

patch

/clients/api/v1/carts/{id}

HTTPcURLJavaScriptPython

PATCH /clients/api/v1/carts/{id} HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "investorAccountId": "text",
  "paymentMethodId": "text"
}

{
  "id": "entityprefix_01j1xgme5qeqq97gpdztd7e4a6",
  "__entity": "Entity",
  "createdAt": "2026-03-27T15:47:09.539Z",
  "updatedAt": "2026-03-27T15:47:09.539Z",
  "deletedAt": "2026-03-27T15:47:09.540Z",
  "investorAccountId": null,
  "investorAccount": null,
  "offering": null,
  "accountId": "account_01j1xgme5qeqq97gpdztd7e4a6",
  "account": null,
  "offeringId": null,
  "paymentMethodId": null,
  "paymentMethod": null,
  "userId": null,
  "tradeNumber": "text",
  "ip": "text",
  "tid": "text",
  "investmentType": "INDIVIDUAL",
  "purchasedShares": 1,
  "bonusShares": 1,
  "totalNumberOfShares": 1,
  "pricePerShare": 1,
  "lineItems": [],
  "adjustments": [],
  "transactions": [],
  "totalAmount": 1,
  "tradeStatus": "CART",
  "tradeStatusUnmapped": "text",
  "tradeDate": "2026-04-03T19:34:54.540Z",
  "saStatus": "PENDING",
  "saStatusUnmapped": "text",
  "saUrl": "text",
  "saSignedAt": "2026-04-03T19:34:54.540Z",
  "saExtractedNumberOfShares": "text",
  "saExtractedTotalAmount": "text",
  "saExtractedPricePerShare": "text",
  "saExtractedInvestorType": "text",
  "saExtractedSigner": "text",
  "saExtractedSignatureDate": "2026-04-03T19:34:54.540Z",
  "saExtractedSigner2": "text",
  "saExtractedSignatureDate2": "2026-04-03T19:34:54.540Z",
  "saCheck": "PENDING",
  "saCheckedAt": "2026-04-03T19:34:54.540Z",
  "saLog": {
    "finalStatus": "PENDING",
    "matchResults": [
      {
        "tradeLineItemId": "trade_line_item_01kctsycw3fq7sj6hedvy62cja",
        "signerName": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        },
        "totalAmount": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        },
        "investorName": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        },
        "numberOfShares": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        }
      }
    ]
  },
  "txnTid": "text",
  "txnResponse": "text",
  "txnPaymentMethod": "CREDIT_CARD",
  "txnCurrencyCode": "text",
  "txnChargedAmount": 1,
  "txnDate": "2026-04-03T19:34:54.540Z",
  "txnSettledDate": "2026-04-03T19:34:54.540Z",
  "fundingStatus": "PENDING",
  "fundingStatusUnmapped": "text",
  "txnCheck": "PENDING",
  "txnCheckedAt": "2026-04-03T19:34:54.540Z",
  "txnLog": "text",
  "systemReviewCheck": "PENDING",
  "systemReviewCheckedAt": "2026-04-03T19:34:54.540Z",
  "systemReviewLog": "text",
  "complianceReview": "PENDING",
  "complianceReviewNotes": "text",
  "complianceReviewerId": "text",
  "issuerId": null,
  "complianceReviewName": "text",
  "complianceReviewAt": "2026-04-03T19:34:54.540Z",
  "tradeType": "PURCHASE",
  "placedAt": "2026-04-03T19:34:54.540Z",
  "platform": "text",
  "cancelledAt": "2026-04-03T19:34:54.540Z",
  "cancelledById": "text",
  "cancelledReason": "text",
  "cancellationPeriod": 1,
  "disbursed": true,
  "tradeAdjustments": 1,
  "chargedAmount": 1,
  "balance": 1,
  "isUncleared24h": true,
  "term": 1,
  "exercisePrice": 1,
  "warrantPercentage": 1,
  "calculationMethod": "NONE",
  "incrementThreshold": 1
}