Yield-as-a-Service-v2 (2.0.3)

Download OpenAPI specification:

Common

Get the latest products offerings

header Parameters

apikey

required

string

Responses

Response samples

200

Content type

application/json

{"available_products": [{"product_code": "growth_account_btc",
"product_name": "Growth Account BTC",
"portfolio_details_url": "https://www.coinchange.io/portfolios/growth_account_btc",
"offering": [{"asset_id": "BTC",
"historical_performance": [{"period_type": "days",
"period_value": 1,
"period_pnl_percent": "0.001944",
"period_apy_percent": "0.76"
},
{"period_type": "days",
"period_value": 7,
"period_pnl_percent": "-0.001944",
"period_apy_percent": "-0.76"
},
{"period_type": "days",
"period_value": 30,
"period_pnl_percent": "0.586475",
"period_apy_percent": "7.61"
},
{"period_type": "days",
"period_value": 90,
"period_pnl_percent": "1.780027",
"period_apy_percent": "7.61"
}
]
}
]
}
]
}

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

product_code required	string
asset_id required	string

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

{"addresses": [{"product_code": "growth_account_usdc",
"asset_id": "USDT",
"address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3"
}
]
}

Get organization withdrawal addresses

header Parameters

apikey

required

string

Responses

Response samples

200

Content type

application/json

[{"asset_id": "USDT",
"address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3"
}
]

Get organization balances

query Parameters

product_code

string

Filter balances by product code. If not specified, returns balances for all products

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

{"products": [{"product_code": "growth_account_usdc",
"balances": [{"asset_id": "USDC",
"available_for_withdrawal": "1076142.13",
"total_balance": "1076142.13",
"last_pnl_date": "2022-12-10T09:30:00Z",
"total_pnl_amount": "76142.13",
"total_pnl_percent": "7.61",
"historical_performance": [{"period_type": "days",
"period_value": 1,
"period_pnl_amount": "19.44078428",
"period_pnl_percent": "0.001944",
"period_apy_percent": "0.76"
},
{"period_type": "days",
"period_value": 7,
"period_pnl_amount": "-19.44078428",
"period_pnl_percent": "-0.001944",
"period_apy_percent": "-0.76"
},
{"period_type": "days",
"period_value": 30,
"period_pnl_amount": "5865.74629236",
"period_pnl_percent": "0.586475",
"period_apy_percent": "7.61"
},
{"period_type": "days",
"period_value": 90,
"period_pnl_amount": "17800.27348218",
"period_pnl_percent": "1.780027",
"period_apy_percent": "7.61"
}
]
}
]
}
]
}

Create withdrawal request

header Parameters

apikey

required

string

Request Body schema: application/json
required

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
product_code required	string Product code for the withdrawal

Responses

Request samples

Payload

Content type

application/json

{"amount": "100000.0",
"destination_address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3",
"external_tx_id": "string",
"asset_id": "USDT",
"product_code": "growth_account_usdt"
}

Response samples

201
400

Content type

application/json

{"id": "string",
"status": "TRANSFERRED_OUT",
"client_id": "clientid-1234567890",
"destination_address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3",
"note": "string",
"external_tx_id": "string",
"asset_id": "USDC",
"product_code": "growth_account_usdc",
"requested_amount": "100000.0",
"received_amount": "100000.0",
"net_amount": "100000.0",
"fee_amount": "0.0",
"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

product_code	string Filter transactions by product code. If not specified, returns transactions for all products
transaction_id	string
skip	integer Specify how many transactions to skip starting from the first one
take	integer Specify how many transactions to take
asset_id	string

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

{"products": [{"product_code": "growth_account_usdc",
"transactions": [{"id": "string",
"status": "SUCCESS",
"destination_address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3",
"note": "string",
"external_tx_id": "string",
"asset_id": "USDC",
"created_at": "2022-12-10T09:30:00Z",
"modified_at": "2022-12-10T09:30:00Z",
"txhash": "string",
"txhash_url": "string",
"transaction_type": "WITHDRAW",
"fee_amount": "0.0",
"requested_amount": "100000.0",
"received_amount": "100000.0",
"net_amount": "100000.0"
}
]
},
{"product_code": "growth_account_btc",
"transactions": [{"id": "string",
"status": "SUCCESS",
"destination_address": "bc1qu3qwchkeq4fsycufq3gzua6w2kffyx5lux7kuf",
"note": "string",
"external_tx_id": "string",
"asset_id": "BTC",
"created_at": "2022-12-10T09:30:00Z",
"modified_at": "2022-12-10T09:30:00Z",
"txhash": "string",
"txhash_url": "string",
"transaction_type": "DEPOSIT",
"fee_amount": "0.0",
"requested_amount": "1.0",
"received_amount": "1.0",
"net_amount": "1.0"
}
]
}
]
}

Notify about a new deposit transaction

Request Body schema: application/json
required

asset_id required	string Id of the asset, refer to response from /asset endpoint
product_code required	string
txhash required	string
amount required	string
tx_timestamp required	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"asset_id": "USDC",
"product_code": "growth_account_usdc",
"txhash": "string",
"amount": "150000.0",
"tx_timestamp": "2018-02-10T09:30:00Z"
}

Response samples

400

Content type

application/json

Example

asset_not_found

[{"field_name": "asset_id",
"error_details": [{"message": "Currency with code <invalid_asset_id> does not exist.",
"code": "not_found"
}
]
}
]

Perform pre-submission withdrawal request validation

Request Body schema: application/json
required

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
product_code required	string Product code for the withdrawal

Responses

Request samples

Payload

Content type

application/json

{"amount": "100000.0",
"destination_address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3",
"external_tx_id": "string",
"asset_id": "USDT",
"product_code": "growth_account_usdt"
}

Response samples

200
400

Content type

application/json

{"requested_amount": "string",
"received_amount": "string",
"net_amount": "string",
"fee_amount": "string",
"withdrawal_status": "Success",
"message": "string"
}

Allocate reserve funds

Reserve account can be used only in conjunction with sub-accounts. Reserve account cannot be used for organization-level deposits.

Request Body schema: application/json
required

required

Array of objects (Root Type for Allocation)

Responses

Request samples

Payload

Content type

application/json

{"allocations": [{"client_id": "clientid-1234567890",
"allocation_type": "EARN_ACCOUNT",
"asset_id": "USDT",
"amount": "1450.0"
},
{"client_id": "clientid-1234567890",
"allocation_type": "EARN_ACCOUNT",
"asset_id": "USDC",
"amount": "1450.0"
}
]
}

Response samples

200
400

Content type

application/json

Example

Successful allocation

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

Get organization reserve account deposit addresses

Reserve account can be used only in conjunction with sub-accounts. Reserve account cannot be used for organization-level deposits.

query Parameters

asset_id

required

string

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

[{"product_code": "growth_account_usdc",
"asset_id": "USDT",
"address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3"
}
]

Get organization reserve account balances

Reserve account can be used only in conjunction with sub-accounts. Reserve account cannot be used for organization-level deposits.

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

[{"asset_id": "USDT",
"balance": "1500.0"
},
{"asset_id": "USDC",
"balance": "1000.0"
}
]

Sub-Account

Get list of sub-clients

header Parameters

apikey

required

string

Responses

Response samples

200

Content type

application/json

[{"client_id": "clientid-1234567890",
"first_name": "John",
"last_name": "Smith"
}
]

Create new sub-client

header Parameters

apikey

required

any

Request Body schema: application/json
required

client_id required	string Unique client ID from the system requesting to create the earn client
required	Array of objects (Root Type for WithdrawalWallet)
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": "clientid-1234567890",
"first_name": "John",
"last_name": "Smith",
"withdrawal_wallets": [{"address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3",
"asset_id": "USDT"
},
{"address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3",
"asset_id": "USDC"
}
]
}

Response samples

201
400

Content type

application/json

{"withdraw_address_change_authorization_key": "#&AgY92a^Z$39d"
}

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
product_code	string Filter transactions by product code. If not specified, returns transactions for all products
take	integer Specify how many transactions to take
skip	integer Specify how many transactions to skip starting from the first one
asset_id	string

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

{"products": [{"product_code": "growth_account_usdc",
"transactions": [{"id": "string",
"status": "SUCCESS",
"client_id": "clientid-1234567890",
"destination_address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3",
"note": "string",
"external_tx_id": "string",
"asset_id": "USDC",
"created_at": "2022-12-10T09:30:00Z",
"modified_at": "2022-12-10T09:30:00Z",
"txhash": "string",
"txhash_url": "string",
"transaction_type": "WITHDRAW",
"fee_amount": "0.0",
"requested_amount": "100000.0",
"received_amount": "100000.0",
"net_amount": "100000.0"
}
]
},
{"product_code": "growth_account_usdt",
"transactions": [{"id": "string",
"status": "SUCCESS",
"client_id": "clientid-1234567890",
"destination_address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3",
"note": "string",
"external_tx_id": "string",
"asset_id": "USDT",
"created_at": "2022-12-10T09:30:00Z",
"modified_at": "2022-12-10T09:30:00Z",
"txhash": "string",
"txhash_url": "string",
"transaction_type": "DEPOSIT",
"fee_amount": "0.0",
"requested_amount": "100000.0",
"received_amount": "100000.0",
"net_amount": "100000.0"
}
]
}
]
}

Create withdrawal request

header Parameters

apikey

required

string

Request Body schema: application/json
required

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
product_code required	string Product code for the withdrawal

Responses

Request samples

Payload

Content type

application/json

{"amount": "100000.0",
"destination_address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3",
"external_tx_id": "string",
"asset_id": "USDT",
"client_id": "clientid-1234567890",
"product_code": "growth_account_usdt"
}

Response samples

201
400

Content type

application/json

{"id": "string",
"status": "TRANSFERRED_OUT",
"client_id": "clientid-1234567890",
"destination_address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3",
"note": "string",
"external_tx_id": "string",
"asset_id": "USDC",
"product_code": "growth_account_usdc",
"requested_amount": "100000.0",
"received_amount": "100000.0",
"net_amount": "100000.0",
"fee_amount": "0.0",
"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
product_code required	string
asset_id required	string

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

{"addresses": [{"product_code": "growth_account_usdc",
"asset_id": "USDT",
"address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3"
}
]
}

Get withdrawal addresses

query Parameters

client_id

required

string

header Parameters

apikey

required

any

Responses

Response samples

200
400

Content type

application/json

[{"asset_id": "USDT",
"address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3"
}
]

Update withdrawal wallets

This operation completely replaces all previous wallets with the provided ones.

header Parameters

apikey

required

any

Request Body schema: application/json
required

authorization_key required	string
required	Array of objects (Root Type for WithdrawalWalletsWithCurrency)
client_id required	string

Responses

Request samples

Payload

Content type

application/json

{"authorization_key": "KSIiw3!ioj@4adsmDOIJ3",
"client_id": "clientid-1234567890",
"currencies": [{"currency": "USDC",
"withdrawal_wallets": ["0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3"
]
},
{"currency": "BTC",
"withdrawal_wallets": ["bc1qu3qwchkeq4fsycufq3gzua6w2kffyx5lux7kuf"
]
}
]
}

Response samples

400

Content type

application/json

[{"field_name": "client_id",
"error_details": [{"message": "Client with ID 'invalid-client' does not exist.",
"code": "not_found"
}
]
}
]

Get sub-client balances

query Parameters

client_id required	string
product_code	string Filter balances by product code. If not specified, returns balances for all products

header Parameters

apikey

required

string

Responses

Response samples

200
400

Content type

application/json

{"products": [{"product_code": "growth_account_usdc",
"balances": [{"asset_id": "USDC",
"available_for_withdrawal": "1076142.13",
"total_balance": "1076142.13",
"last_pnl_date": "2022-12-10T09:30:00Z",
"total_pnl_amount": "76142.13",
"total_pnl_percent": "7.61",
"historical_performance": [{"period_type": "days",
"period_value": 1,
"period_pnl_amount": "19.44078428",
"period_pnl_percent": "0.001944",
"period_apy_percent": "0.76"
},
{"period_type": "days",
"period_value": 7,
"period_pnl_amount": "-19.44078428",
"period_pnl_percent": "-0.001944",
"period_apy_percent": "-0.76"
},
{"period_type": "days",
"period_value": 30,
"period_pnl_amount": "5865.74629236",
"period_pnl_percent": "0.586475",
"period_apy_percent": "7.61"
},
{"period_type": "days",
"period_value": 90,
"period_pnl_amount": "17800.27348218",
"period_pnl_percent": "1.780027",
"period_apy_percent": "7.61"
}
]
}
]
}
]
}

Notify about a new deposit transaction

Request Body schema: application/json
required

asset_id required	string Id of the asset, refer to response from /asset endpoint
product_code required	string
txhash required	string
amount required	string
tx_timestamp required	string <date-time>
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

{"asset_id": "USDC",
"product_code": "growth_account_usdc",
"txhash": "string",
"amount": "150000.0",
"tx_timestamp": "2022-02-10T09:30:00Z",
"client_id": "clientid-1234567890"
}

Response samples

400

Content type

application/json

Example

client_not_found

[{"field_name": "client_id",
"error_details": [{"message": "Client with ID 'invalid-client' does not exist.",
"code": "not_found"
}
]
}
]

Perform pre-submission withdrawal request validation

Request Body schema: application/json
required

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
product_code required	string Product code for the withdrawal

Responses

Request samples

Payload

Content type

application/json

{"amount": "100000.0",
"destination_address": "0xD2c6ADc7E90f29442e458F90958ed8731AC1f2A3",
"external_tx_id": "string",
"asset_id": "USDT",
"client_id": "clientid-1234567890",
"product_code": "growth_account_usdt"
}

Response samples

200
400

Content type

application/json

{"requested_amount": "string",
"received_amount": "string",
"net_amount": "string",
"fee_amount": "string",
"withdrawal_status": "Success",
"message": "string"
}

Yield-as-a-Service-v2 (2.0.3)

Common

Get the latest products offerings

header Parameters

Responses

Response samples

Get list of assets

header Parameters

Responses

Response samples

Organization

Get organization deposit addresses

query Parameters

header Parameters

Responses

Response samples

Get organization withdrawal addresses

header Parameters

Responses

Response samples

Get organization balances

query Parameters

header Parameters

Responses

Response samples

Create withdrawal request

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get organization transaction history

query Parameters

header Parameters

Responses

Response samples

Notify about a new deposit transaction

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Perform pre-submission withdrawal request validation

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Allocate reserve funds

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get organization reserve account deposit addresses

query Parameters

header Parameters

Responses

Response samples

Get organization reserve account balances

header Parameters

Responses

Response samples

Sub-Account

Get list of sub-clients

header Parameters

Responses

Response samples

Create new sub-client

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get sub-client transaction history

query Parameters

header Parameters

Responses

Response samples

Create withdrawal request

header Parameters

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required