Segments

Get entity types by segments

Segments define the account types available for customers within a counterparty.

Get account types by segment

get

Get account types by segment

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Query parameters

segment_namesstring[]Optional

segment names (string)

Responses

200

OK

application/json

400

json with error msg

application/json

get

/counterparty/{counterparty_guid}/segments

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/segments HTTP/1.1
Accept: */*

[
  {
    "counterparty": {
      "guid": "text",
      "name": "text"
    },
    "segments": {
      "ANY_ADDITIONAL_PROPERTY": [
        {
          "account_type_guid": "text",
          "asset_code": "text",
          "asset_issuer": "text",
          "counterparty_guid": "text",
          "kind": "processing",
          "segment_name": "text"
        }
      ]
    }
  }
]

Update segment

A user is capable to change the name of the segment.

Update account types segment

patch

Update account types segment

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

application/json

account_type_guidstringOptional

segment_namestringOptional

Responses

200

OK

application/json

objectOptional

400

json with error msg

application/json

patch

/counterparty/{counterparty_guid}/segments

HTTPcURLJavaScriptPython

PATCH /api/v1/counterparty/{counterparty_guid}/segments HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "account_type_guid": "text",
  "segment_name": "text"
}

{}