/collateral/v1/settlement

Notify Sinohope of the settlement details list after the exchange initiates a settlement

application/json

Request Body required

settlementId_ex string required

Exchange-side settlement batch identifier

collateralId CollateralId required

Unique identifier for the CVA account

to_exchange object[] required
Array [
assetId string
Sinohope asset identifier (for multi-chain scenarios, the exchange needs to split the details based on the balance of the user's CVA address)
amount string
Settlement amount
toAddress string
Exchange receiving address
toTag string nullable
Exchange receiving address tag
]
to_collateral object[] required
Array [
assetId string
Sinohope asset identifier (for multi-chain scenarios, the exchange needs to merge the settlement assets based on the user's preferedNetwork field when binding the address)
amount string
Settlement amount
toAddress string
CVA address
toTag string nullable
CVA address tag
]

Responses

• 200

---

Successful response

application/json

Schema

Example (from schema)

---

Schema

settlementId string required

Unique identifier for a settlement batch

{
  "settlementId": "string"
}

POST /collateral/v1/settlement

Authorization

name: BIZ-API-KEYtype: apiKeyin: headerdescription: This API key is given to you by Sinohope when onboarding your exchange.

name: BIZ-API-NONCEtype: apiKeyin: headerdescription: A nonce value (timestamp) that is included in the data to be signed.

name: BIZ-API-SIGNATUREtype: apiKeyin: headerdescription: signature of the request information(nonce,path,body) using the secret_key which is provided by Sinohope when onboarding your exchange.

Request

ApiKeyAuth

ApiNonce

ApiSig

Body required

{
  "settlementId_ex": "string",
  "collateralId": "411136872665588",
  "to_exchange": [
    {
      "assetId": "string",
      "amount": "string",
      "toAddress": "string",
      "toTag": "string"
    }
  ],
  "to_collateral": [
    {
      "assetId": "string",
      "amount": "string",
      "toAddress": "string",
      "toTag": "string"
    }
  ]
}

go / requests

nodejs / axios

java / unirest

python / requests

ruby / RestSharp

csharp / httpclient

php / OkHttp