Yield-as-a-Service (1.0.0)

Download OpenAPI specification:Download

Common

Get the latest products offerings

header Parameters

apikey

required

string

Responses

Response samples

200

Content type

application/json

[{"product": "highyield",
"offering": [{"asset_id": "USDC",
"apy_30d": "6.0"
},
{"asset_id": "USDT",
"apy_30d": "6.5"
}
]
}
]

Get list of assets

header Parameters

apikey

required

any

Responses

Response samples

200

Content type

application/json

[{"id": "USDC",
"name": "USD Сoin",
"precision": 4
},
{"id": "DAI",
"name": "Dai",
"precision": 4
},
{"id": "BTC",
"name": "Bitcoin",
"precision": 8
},
{"id": "ETH",
"name": "Ethereum",
"precision": 8
},
{"id": "USDT",
"name": "Tether",
"precision": 4
}
]

Organization

Get organization deposit addresses

query Parameters

asset_id

required

string

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

[{"asset_id": "USDT",
"address": "string",
"nickname": "string"
}
]

Get organization withdrawal addresses

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

[{"asset_id": "USDT",
"address": "string",
"nickname": "string"
}
]

Get organization balances

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

[{"asset_id": "USDC",
"available_for_withdrawal": "string",
"earn_total": "string",
"earn_90d": "string",
"earn_30d": "string",
"earn_7d": "string",
"earn_1d": "string",
"total": "string",
"last_payout_date": "2022-12-10T09:30Z",
"last_payout_amount": "string"
}
]

Create withdrawal request

header Parameters

apikey

required

any

Request Body schema: application/json

amount required	string
destination_address required	string
external_tx_id	string
asset_id required	string Id of the asset, refer to response from /asset endpoint

Responses

Request samples

Payload

Content type

application/json

{"amount": "string",
"destination_address": "string",
"external_tx_id": "string",
"asset_id": "USDT"
}

Response samples

201
400

Content type

application/json

{"id": "string",
"status": "TRANSFERRED_OUT",
"client_id": "string",
"destination_address": "string",
"note": "string",
"external_tx_id": "string",
"asset_id": "USDC",
"gross_amount": "string",
"net_amount": "string",
"fee_amount": "string",
"created_at": "2022-06-12T19:27:12.895815Z",
"modified_at": "2022-06-16T09:45:43.896465Z",
"txhash": "string",
"txhash_url": "string",
"transaction_type": "WITHDRAW"
}

Get organization transaction history

Transaction list on ogranization level does not include transactions for individual sub-clients. Use this operation to check status of in-progress withdrawal requests.

query Parameters

transaction_id

string

header Parameters

apikey

required

string

Responses

Response samples

200

Content type

application/json

{"next": "string (N/A)",
"previous": "string (N/A)",
"count": 21,
"results": [{"id": "string",
"status": "REQUESTED",
"destination_address": "string",
"note": "string",
"external_tx_id": "string",
"asset_id": "string",
"created_at": "2022-12-10T09:30Z",
"modified_at": "2022-12-10T09:30Z",
"txhash": "string",
"txhash_url": "string",
"transaction_type": "WITHDRAW",
"fee_amount": "string",
"gross_amount": "string",
"net_amount": "string"
},
{"id": "string",
"status": "REQUESTED",
"destination_address": "string",
"note": "string",
"external_tx_id": "string",
"asset_id": "string",
"created_at": "2022-12-10T09:30Z",
"modified_at": "2022-12-10T09:30Z",
"txhash": "string",
"txhash_url": "string",
"transaction_type": "EARN",
"fee_amount": "string",
"gross_amount": "string",
"net_amount": "string"
}
]
}

Notify about a new deposit transaction

Request Body schema: application/json

txhash_url required	string
amount required	string
asset_id required	string Id of the asset, refer to response from /asset endpoint
product required	string Value: "highyield"
tx_timestamp required	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"txhash": "string",
"amount": 1.2,
"asset_id": "USDC",
"product": "highyield",
"tx_timestamp": "2018-02-10T09:30Z"
}

Perform pre-submission withdrawal request validation

Request Body schema: application/json

amount required	string
destination_address required	string
external_tx_id	string
asset_id required	string Id of the asset, refer to response from /asset endpoint

Responses

Request samples

Payload

Content type

application/json

{"amount": "string",
"destination_address": "string",
"external_tx_id": "string",
"asset_id": "USDT"
}

Response samples

200

Content type

application/json

{"gross_amount": "string",
"net_amount": "string",
"fee_amount": "string",
"withdrawal_status": "Success",
"message": "string"
}

Allocate reserve funds

Request Body schema: application/json

required

Array of objects (Root Type for Allocation) [ items ]

Responses

Request samples

Payload

Content type

application/json

{"allocations": [{"client_id": "1",
"allocation_type": "EARN_ACCOUNT",
"asset_id": "USDT",
"amount": "100"
},
{"client_id": "2",
"allocation_type": "EARN_ACCOUNT",
"asset_id": "USDC",
"amount": "100"
}
]
}

Response samples

200

Content type

application/json

Example

{"error": { },
"status": "success",
"remaining_reserve_balances": [{"asset_id": "USDT",
"balance": "1450.92"
},
{"asset_id": "BTC",
"balance": "2.02"
}
]
}

Get organization reserve account deposit addresses

query Parameters

asset_id

required

string

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

[{"asset_id": "USDT",
"address": "string",
"nickname": "string"
}
]

Get organization reserve account balances

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

[{"asset_id": "USDT",
"balance": "1500"
},
{"asset_id": "USDC",
"balance": "1000"
}
]

Sub-Account

Get list of sub-clients

header Parameters

apikey

required

any

Responses

Response samples

200

Content type

application/json

[{"client_id": "string",
"first_name": "string",
"last_name": "sting"
}
]

Create new sub-client

header Parameters

apikey

required

any

Request Body schema: application/json

client_id required	string Unique client ID from the system requesting to create the earn client
required	Array of objects (Root Type for WithdrawalWallet) [ items ]
first_name	string First name of the client. Used in client searches.
last_name	string Last name of the client. Used in client searches.

Responses

Request samples

Payload

Content type

application/json

{"client_id": "string",
"first_name": "string",
"last_name": "string",
"withdrawal_wallets": [{"address": "string",
"asset_id": "USDT",
"nickname": "string"
},
{"address": "string",
"asset_id": "USDC"
}
]
}

Response samples

400

Content type

application/json

[{"field_name": "string",
"error_details": [{"message": "string",
"code": "string"
},
{"message": "string",
"code": "string"
}
]
}
]

Get sub-client transaction history

Use this operation to check on the status of the in-progress withdrawal requests.

query Parameters

client_id

required

string

header Parameters

apikey

required

string

Responses

Response samples

200

Content type

application/json

{"next": "string (N/A)",
"previous": "string (N/A)",
"count": 21,
"results": [{"id": "string",
"status": "REQUESTED",
"client_id": "string",
"destination_address": "string",
"note": "string",
"external_tx_id": "string",
"asset_id": "string",
"created_at": "2012-12-10T09:30Z",
"modified_at": "2012-12-10T09:30Z",
"txhash": "string",
"txhash_url": "string",
"transaction_type": "WITHDRAW",
"fee_amount": "string",
"gross_amount": "string",
"net_amount": "string"
},
{"id": "string",
"status": "REQUESTED",
"client_id": "string",
"destination_address": "string",
"note": "string",
"external_tx_id": "string",
"asset_id": "string",
"created_at": "2022-12-10T09:30Z",
"modified_at": "2022-12-10T09:30Z",
"txhash": "string",
"txhash_url": "string",
"transaction_type": "EARN",
"fee_amount": "string",
"gross_amount": "string",
"net_amount": "string"
}
]
}

Create withdrawal request

header Parameters

apikey

required

any

Request Body schema: application/json

amount required	string
destination_address required	string
external_tx_id	string Transaction id passed to Coinchange by an external system in the original withdrawal request.
asset_id required	string Id of the asset, refer to response from /asset endpoint
client_id required	string Client id provided to Coinchange when client was initially created by external system

Responses

Request samples

Payload

Content type

application/json

{"amount": "string",
"destination_address": "string",
"external_tx_id": "string",
"asset_id": "USDT",
"client_id": "string"
}

Response samples

201
400

Content type

application/json

{"id": "string",
"status": "TRANSFERRED_OUT",
"client_id": "string",
"destination_address": "string",
"note": "string",
"external_tx_id": "string",
"asset_id": "USDC",
"gross_amount": "string",
"net_amount": "string",
"fee_amount": "string",
"created_at": "2022-06-12T19:27:12.895815Z",
"modified_at": "2022-06-16T09:45:43.896465Z",
"txhash": "string",
"txhash_url": "string",
"transaction_type": "WITHDRAW"
}

Get deposit addresses

query Parameters

client_id required	string
asset_id required	string

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

[{"asset_id": "USDT",
"address": "string",
"nickname": "string"
}
]

Get withdrawal addresses

query Parameters

client_id

required

any

header Parameters

apikey

required

any

Responses

Response samples

200

Content type

application/json

[{"asset_id": "USDT",
"address": "string",
"nickname": "string"
}
]

Get sub-client balances

query Parameters

client_id

required

string

header Parameters

apikey

required

string

Responses

Response samples

200

Content type

application/json

[{"asset_id": "USDC",
"available_for_withdrawal": "string",
"earn_total": "string",
"earn_90d": "string",
"earn_30d": "string",
"earn_7d": "string",
"earn_1d": "string",
"total": "string",
"last_payout_date": "2022-12-10T09:30Z",
"last_payout_amount": "string"
}
]

Notify about a new deposit transaction

Request Body schema: application/json

amount required	string
asset_id required	string Id of the asset, refer to response from /asset endpoint
client_id required	string Client id provided to Coinchange when client was initially created by external system
product required	string Value: "highyield"
txhash required	string
tx_timestamp required	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"txhash": "string",
"amount": 1.2,
"asset_id": "USDC",
"client_id": "string",
"product": "highyield",
"tx_timestamp": "2022-02-10T09:30Z"
}

Perform pre-submission withdrawal request validation

Request Body schema: application/json

amount required	string
destination_address required	string
external_tx_id	string Transaction id passed to Coinchange by an external system in the original withdrawal request.
asset_id required	string Id of the asset, refer to response from /asset endpoint
client_id required	string Client id provided to Coinchange when client was initially created by external system

Responses

Request samples

Payload

Content type

application/json

{"amount": "string",
"destination_address": "string",
"external_tx_id": "string",
"asset_id": "USDT",
"client_id": "string"
}

Response samples

200

Content type

application/json

{"gross_amount": "string",
"net_amount": "string",
"fee_amount": "string",
"withdrawal_status": "Success",
"message": "string"
}