Overview
Net Delivery Obligations (NDO) is a Zero Hash-specific term that we've coined to reference "amount owed". In other words, this is the net amount owed to settle all active and outstanding obligations. It is the summation of:
NDO = Payable + Collateral Payable - Available - Collateral - Receivable
For example, assume a participant has $100,000 USD in their Available account and $60,000 collateral for an open position. They owe $200k to fully close out the position. Their Net Delivery Obligation would equal:
NDO = $200,000 + $0 - $100,000 - $60,000 - $0
NDO = $40,000
Once the participant deposits $40,000, their position will fully settle.
Consuming the NDO over API
There are 2 ways you can do this:
1.GET /accounts/net_delivery_obligations
- This endpoint will provide all NDO's for your participant only
- The client has to make no calculations
Example payload:
"message": [
{
"asset": "USD",
"amount": "40000",
"account_group": "ABC123",
"account_label": "general"
},
]
2. GET /accounts
- A client can derive the NDO's for their participant + their customer
- The client has to make a simple calculation (Payable + Collateral Payable - Available - Collateral - Receivable)
Example payload:
{
"message": [
{
"asset": "ETH",
"account_owner": "ABC123",
"account_type": "payable",
"account_group": "DEF456",
"account_label": "general",
"balance": "3",
"account_id": "a56f5fe4-70e4-4889-858b-3bdbaec73ac4",
"last_update": 1613489832571
},
{
"asset": "ETH",
"account_owner": "ABC123",
"account_type": "available",
"account_group": "DEF456",
"account_label": "general",
"balance": "1.026159757864607609",
"account_id": "558984e8-0d40-4070-9ffa-89abf48911ac",
"last_update": 1616521823146
}
],
"page": 1,
"total_pages": 1
}
Interpretation: Participant ABC123 has a Net Delivery Obligation (NDO) of 3 - 1.026159757864607609 = 1.973840242135392391 on the DEF456 platform