custody/distributions

GET https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/custody/distributions

This endpoint retrieves a list of custody distributions. It supports pagination, filtering, and sorting capabilities.

Response Structure

JSON

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "custody_distributions": [
    {
      "id": "uuid",
      "submissionId": "uuid",
      "brokerageAccountId": "string",
      "amountCents": "integer",
      "status": "string",
      "accountId": "string",
      "bankId": "string",
      "bankAccountId": "string",
      "transactionType": "string",
      "transactionMemo": "string",
      "createdAt": "datetime",
      "updatedAt": "datetime"
    }
  ]
  "pagination": {
    "totalRecords": 100,
    "startIndex": 0,
    "endIndex": 0
  }
}

Response Fields

Field	Type	Description
id	string	Unique identifier for the distribution (UUID format)
submissionId	string	Identifier for the submission batch (UUID format)
brokerageAccountId	string	Brokerage account ID
amountCents	integer	Amount in cents
status	string	Current status of the distribution (e.g., "pending")
accountId	string	External account ID (null if using bank info directly)
bankId	string	Bank routing number or BIC/SWIFT code (null if using accountId)
bankAccountId	string	Bank account number or IBAN (null if using accountId)
transactionType	string	Type of transaction: "ach" or "wire" (may be null initially)
transactionMemo	string	Memo or description for the transaction (may be null)
createdAt	string	Creation timestamp (YYYY-MM-DD HH:MM:SS)
updatedAt	string	Last update timestamp (YYYY-MM-DD HH:MM:SS)

Status Codes

The distribution status can be one of the following:

• pending (default)
• processing
• on_hold
• approved
• rejected
• scheduled
• in_review
• completed
• terminated
• failed
• reopened

Pagination Object

Field	Type	Description
totalRecords	Number	Total number of records available.
startIndex	Number	Starting index of the records in the current response.
endIndex	Number	Ending index of the records in the current response.

Examples

1. Basic query (default behavior):

GET /v3/custody/distributions

2. Limit the number of results:

GET /v3/custody/distributions?limit=1

3. Use limit and offset for pagination:

GET /v3/custody/distributions?limit=1&offset=2

Permissions

This method requires the scopecustody_distribution.read.pii_highto be granted to the calling API key.

This scope can be assigned by system admins through the API or Transact Portal.

Filtering

For more information on filtering see

Working with List Endpoints