Skip to main content

Get Pay Info

Query repayment collateral information for the account before repayment. This data is typically used prior to calling the Repay or Repay Liability endpoints.

HTTP Request

GET/v5/account/pay-info

Request Parameters

ParameterRequiredTypeComments
coinfalsestringCoin name, e.g. USDT, BTC. Must be a coin with outstanding liabilities, otherwise an error will be returned. If not passed, returns the aggregated total across all liabilities.

Response Parameters

ParameterTypeComments
collateralInfoobjectCollateral info
> collateralListarray<object>Collateral list
>> coinstringCoin name
>> availableSizestringAvailable size
>> availableValuestringAvailable value (in USD)
>> coinScaleintegerCoin precision
>> borrowSizestringBorrow size
>> spotHedgeAmountstringSpot hedge amount
>> assetFrozenstringFrozen asset
borrowInfoobjectBorrow info for the queried coin.
> coinstringCoin name. Only returned when coin is passed in the request
> borrowSizestringBorrow size
> borrowValuestringBorrow value (in USD)
> assetFrozenstringFrozen asset
> availableBalancestringAvailable balance

Request Example

GET /v5/account/pay-info?coin=SOL HTTP/1.1
Host: api.bybit.com
X-BAPI-SIGN: XXXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1773230920000
X-BAPI-RECV-WINDOW: 5000

Response Example

{
"retCode": 0,
"retMsg": "Success",
"result": {
"collateralInfo": {
"collateralList": [
{
"availableValue": "13038.369918809215134556464993",
"coinScale": 4,
"borrowSize": "0",
"spotHedgeAmount": "0",
"assetFrozen": "0",
"availableSize": "13041.904274867704282417",
"coin": "USDT"
},
{
"availableValue": "4997.9120975285472554850",
"coinScale": 6,
"borrowSize": "0",
"spotHedgeAmount": "0",
"assetFrozen": "0",
"availableSize": "4997.912097528547255485",
"coin": "USDC"
},
{
"availableValue": "0",
"coinScale": 8,
"borrowSize": "0.10006839",
"spotHedgeAmount": "0",
"assetFrozen": "0",
"availableSize": "0",
"coin": "SOL"
},
{
"availableValue": "0",
"coinScale": 9,
"borrowSize": "0.001000068",
"spotHedgeAmount": "-0.00100006728685180109293673123005419256514869630336761474609375",
"assetFrozen": "0",
"availableSize": "0",
"coin": "BTC"
},
{
"availableValue": "38488.319604591478793130841305",
"coinScale": 8,
"borrowSize": "0",
"spotHedgeAmount": "0",
"assetFrozen": "0",
"availableSize": "17.867158854367695555",
"coin": "ETH"
}
]
},
"borrowInfo": {
"borrowSize": "0.100068384926503532",
"assetFrozen": "0",
"borrowValue": "9.172497619169950215718876",
"coin": "SOL",
"availableBalance": "0"
}
},
"retExtInfo": {},
"time": 1774344990873
}