1. Counterparties management
On this page you can see how you should work with counterparties.
Working with counterparties you have the following features:
Update counterparty attributes
Create counterparty
A counterparty is created together with 2 accounts: emission account and processing account.
Create counterparty
AssetCode first emission account
AssetIssuer first emission account
optional
GUID if guid is zero, generate new random guid if guid exist return error
optional
Name unique counterparty name
UserAuthURL url where we can request user authorization on counterparty side
UserIDURL url where we can request user id on counterparty side
UserKeyURL url where we can request user key on counterparty side
POST /api/v1/counterparties HTTP/1.1
Host: dev-dcm-api.armenotech.dev
Content-Type: application/json
Accept: */*
Content-Length: 180
{
"asset_code": "text",
"asset_issuer": "text",
"description": "text",
"guid": "text",
"holding_name": "text",
"name": "text",
"user_auth_url": "text",
"user_id_url": "text",
"user_key_url": "text"
}{
"emission_account_guid": "text",
"guid": "text",
"processing_account_guid": "text"
}Update counterparty attributes
Update counterparty fields by guid
Counterparty's description
Counterparty's holding name
Counterparty's unique name
URL where DCM can request user authorization on the counterparty's side
URL where DCM can request a user ID on the counterparty's side
URL where DCM can request a user key on the counterparty's side
PUT /api/v1/counterparties/{counterparty_guid} HTTP/1.1
Host: dev-dcm-api.armenotech.dev
Content-Type: application/json
Accept: */*
Content-Length: 124
{
"description": "text",
"holding_name": "text",
"name": "text",
"user_auth_url": "text",
"user_id_url": "text",
"user_key_url": "text"
}{}Get the list of counterparties
Get counterparties list
Counterparty's GUIDs
Counterparty's names
Counterparty's holding names
Offset
Limit
Ordering by created_at
GET /api/v1/counterparties HTTP/1.1
Host: dev-dcm-api.armenotech.dev
Accept: */*
{
"counterparties": [
{
"created_at": "text",
"description": "text",
"guid": "text",
"holding_name": "text",
"name": "text",
"updated_at": "text",
"user_auth_url": "text",
"user_id_url": "text",
"user_key_url": "text"
}
],
"total": 1
}Show counterparty attributes
To show a counterparty attributes you should do the previuos request and to find the counterparty you need with an appropriate guid.
Last updated