PayWings.CryptoGateway.Whitelabel API Documentation

GetUserBalance

https://cryptogatewaytest.paywings.io/whitelabel/GetUserBalance

Returns user balance

API Request structure

Parameter name	Type	Max.length	Description
ReferenceID	String	255	Your unique reference ID
PersonID	Guid		Person ID
WalletAddress	String	255	Wallet address (as returned from /ListUserWallets)
DisplayInAssetID	Guid		Display in asset (as returned from /ListAssets) Currently only USD asset is supported

API request sample JSON

{
  "PersonID": "00000000-0000-0000-0000-000000000000",
  "WalletAddress": "",
  "DisplayInAssetID": null,
  "ReferenceID": ""
}

API Response structure

Parameter name	Type	Description
ReferenceID	String	Our response reference ID
CallerReferenceID	String	Your request reference ID
DisplayInAssetSummary	Array	Sum of all assets and their balances in selected asset Only if DisplayInAssetID is specified
Balances	List	List of all assets and their balances
StatusCode	Integer	Status code
StatusDescription	String	Status description

DisplayInAssetSummary array structure

Parameter name	Type	Description
Code	String	Code
Available	Long	Available
Pending	Long	Pending
Total	Long	Total
Decimals	Integer	Decimals

Balances list structure

Parameter name	Type	Description
AssetBalance	Array	Asset balance
DisplayInAssetBalance	Array	Asset balance in selected asset Only if DisplayInAssetID is specified

AssetBalance array structure

Parameter name	Type	Description
Code	String	Code
Available	Long	Available
Pending	Long	Pending
Total	Long	Total
Decimals	Integer	Decimals

DisplayInAssetBalance array structure

Parameter name	Type	Description
Code	String	Code
Available	Long	Available
Pending	Long	Pending
Total	Long	Total
Decimals	Integer	Decimals

API response sample JSON

{
  "StatusCode": 0,
  "StatusDescription": null,
  "DisplayInAssetSummary": {
    "Code": null,
    "Available": 0,
    "Pending": 0,
    "Total": 0,
    "Decimals": 0
  },
  "Balances": [
    {
      "AssetBalance": null,
      "DisplayInAssetBalance": null
    }
  ],
  "ReferenceID": null,
  "CallerReferenceID": null
}

Status codes

Status code	Description
0	OK
-1	Invalid parameters
-8	Person is not onboarded
-9	Asset not found