Cash

GET 
/v1.1/statement/ca/cash

This is used to get the cash log of the given customer for the given corporate action.

#	description
CASH_DVD	cash dividend
REV_CASH_DVD	reverse cash dividend
STCK_DVD	stock dividend
REV_STCK_DVD	reverse stock dividend

for fractions - cash can be received along with stock dividend.

Request

Query Parameters

institutionCode stringrequired
customerNumber string

Possible values: >= 1 and <= 12

corporateActionType stringrequired

Possible values: [CASH_DVD, STCK_DVD, REV_CASH_DVD, REV_STCK_DVD]

startDate stringrequired

Possible values: Value must match regular expression yyyy/MM/dd

endDate stringrequired

Possible values: Value must match regular expression yyyy/MM/dd

pageNo integer
pageWidth integer

Responses

200

OK

application/json

Schema

Schema

status stringrequired
rejectCode integer

Find error codes here

isNextPageAvailable boolean
pageNo integer
pageWidth integer
totalNoOfRecords integer
list object[]
Array [
corporateActionType string
exchange string
symbol string
amount number
cashAccountNumber string
date string
transactionCurrency string
amountInTransactionCurrency number
issueSettleRate number
settleCurrency string
eligibleShares number
narration string
]

Example (from schema)

{
  "status": "string",
  "rejectCode": 0,
  "isNextPageAvailable": true,
  "pageNo": 0,
  "pageWidth": 0,
  "totalNoOfRecords": 0,
  "list": [
    {
      "corporateActionType": "string",
      "exchange": "string",
      "symbol": "string",
      "amount": 0,
      "cashAccountNumber": "string",
      "date": "string",
      "transactionCurrency": "string",
      "amountInTransactionCurrency": 0,
      "issueSettleRate": 0,
      "settleCurrency": "string",
      "eligibleShares": 0,
      "narration": "string"
    }
  ]
}

CASH_DVD

{
  "status": "SUCCESS",
  "rejectCode": 0,
  "isNextPageAvailable": false,
  "pageNo": 1,
  "pageWidth": 100,
  "totalNoOfRecords": 2,
  "list": [
    {
      "corporateActionType": "CASH_DVD",
      "exchange": "NSDQ",
      "symbol": "AAPL",
      "amount": -12.06,
      "cashAccountNumber": "C000299630",
      "date": "2023/07/19-18:40:33",
      "transactionCurrency": "USD",
      "amountInTransactionCurrency": -12.06,
      "issueSettleRate": 1,
      "settleCurrency": "USD",
      "eligibleShares": 0,
      "narration": "ADR Fee on Cash Dividends for 603.00000000 shares of AAPL @ 2% rate, On 2023-07-19 00:00:00"
    },
    {
      "corporateActionType": "CASH_DVD",
      "exchange": "NSDQ",
      "symbol": "AAPL",
      "amount": 603,
      "cashAccountNumber": "C000299630",
      "date": "2023/07/19-18:40:33",
      "transactionCurrency": "USD",
      "amountInTransactionCurrency": 603,
      "issueSettleRate": 1,
      "settleCurrency": "USD",
      "eligibleShares": 603,
      "narration": "Cash dividend : AAPL - dividend per share : 1 USD"
    }
  ]
}

REV_CASH_DVD

{
  "status": "SUCCESS",
  "rejectCode": 0,
  "isNextPageAvailable": false,
  "pageNo": 1,
  "pageWidth": 100,
  "totalNoOfRecords": 2,
  "list": [
    {
      "corporateActionType": "REV_CASH_DVD",
      "exchange": "NSDQ",
      "symbol": "AAPL",
      "amount": -603,
      "cashAccountNumber": "C000299630",
      "date": "2023/07/19-18:41:01",
      "transactionCurrency": "USD",
      "amountInTransactionCurrency": -603,
      "issueSettleRate": 1,
      "settleCurrency": "USD",
      "eligibleShares": 603,
      "narration": "Cancellation - Cash dividend : AAPL - dividend per share : 1 USD"
    },
    {
      "corporateActionType": "REV_CASH_DVD",
      "exchange": "NSDQ",
      "symbol": "AAPL",
      "amount": 12.06,
      "cashAccountNumber": "C000299630",
      "date": "2023/07/19-18:41:01",
      "transactionCurrency": "USD",
      "amountInTransactionCurrency": 12.06,
      "issueSettleRate": 1,
      "settleCurrency": "USD",
      "eligibleShares": 0,
      "narration": "ADR Fee on Cash Dividends for 603.00000000 shares of AAPL @ 2% rate, On 2023-07-19 00:00:00"
    }
  ]
}

STCK_DVD

{
  "status": "SUCCESS",
  "rejectCode": 0,
  "isNextPageAvailable": false,
  "pageNo": 1,
  "pageWidth": 100,
  "totalNoOfRecords": 1,
  "list": [
    {
      "corporateActionType": "STCK_DVD",
      "exchange": "NSDQ",
      "symbol": "AAPL",
      "amount": 1,
      "cashAccountNumber": "C000299630",
      "date": "2023/07/19-18:46:39",
      "transactionCurrency": "USD",
      "amountInTransactionCurrency": 1,
      "issueSettleRate": 1,
      "settleCurrency": "USD",
      "eligibleShares": 703,
      "narration": "Stock dividend - AAPL"
    }
  ]
}

REV_STCK_DVD

{
  "status": "SUCCESS",
  "rejectCode": 0,
  "isNextPageAvailable": false,
  "pageNo": 1,
  "pageWidth": 100,
  "totalNoOfRecords": 1,
  "list": [
    {
      "corporateActionType": "REV_STCK_DVD",
      "exchange": "NSDQ",
      "symbol": "AAPL",
      "amount": -1,
      "cashAccountNumber": "C000299630",
      "date": "2023/07/19-30:46:39",
      "transactionCurrency": "USD",
      "amountInTransactionCurrency": -1,
      "issueSettleRate": 1,
      "settleCurrency": "USD",
      "eligibleShares": 703,
      "narration": "Cancellation - Stock dividend - AAPL"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

timestamp string
status string
error string
message string
path string
rejectCode string

Example (from schema)

{
  "timestamp": "string",
  "status": "string",
  "error": "string",
  "message": "string",
  "path": "string",
  "rejectCode": "string"
}

Invalid Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Invalid Token",
  "path": "/api/v1.1/statement/ca/cash",
  "rejectCode": "1008"
}

Expired

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Expired Token",
  "path": "/api/v1.1/statement/ca/cash",
  "rejectCode": "1007"
}

Loading...