Wallet API endpoints

The latest documentation for endpoints is always on the DevPortal: https://partner.socios.com/devportal/apis/1464738d-213b-4073-8599-46b63390a6ea/test

Endpoint to get wallet data for currently logged-in user

GEThttps://api-public.socios.com/wallet/1.0.0/user/wallet

Authorization

default

Response

200

Successfully retrieved User's wallet

Body

application/json

dataarray of Ledger (object)

Request

JavaScriptCurl

const response = await fetch('https://api-public.socios.com/wallet/1.0.0/user/wallet', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": "a2567e3a-9c00-4094-8196-9ec92b98f3a5",
      "totalBalance": "100.123",
      "currencyNetwork": {
        "id": "a2567e3a-9c00-4094-8196-9ec92b98f3a5",
        "shortCode": "CHZ",
        "type": "crypto",
        "symbol": "$CHZ",
        "precision": 18,
        "networkType": "ethereum"
      }
    }
  ]
}

POSThttps://api-public.socios.com/wallet/1.0.0/user/wallet/sign-message

Authorization

default

Body

application/json

The message to be signed.

message*string

Response

200400

Successfully retrieved signature

Body

application/json

dataarray of SignedMessage (object)

Request

JavaScriptCurl

const response = await fetch('https://api-public.socios.com/wallet/1.0.0/user/wallet/sign-message', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "message": "The message to be signed."
    }),
});
const data = await response.json();

Response

{
  "data": [
    {
      "signedMessage": "1.6843624793958161E+156"
    }
  ]
}

Endpoint to redeem voucher by its code.

Validation errors

• 508e8fdf-265e-459b-88d6-18e6dc534150: the Voucher is not redeemable
• 4569623f-852e-46a4-89d3-a4f860178ccc: the User's holding limit is exceeded
• d4968b7d-3f7e-4c2c-ace6-d743f6d6b578: the User's minimal limits are exceeded
• 58c75c17-f7e7-4929-8c6a-bb093acd4594: the User's cumulative limits are exceeded
• 3d727162-d0b5-4ba0-a691-cdcbbc3bdcdf: the User is subject to regulatory restrictions
• a9aaebc8-0616-4019-b46a-687a56a87326: another User's limits are exceeded
• 8a3cf073-642d-4622-a067-8b188cd5ae0d: the transaction related to the Voucher redeeming failed, the Voucher redeeming may still be processed later once the issue is solved
• 00ad9646-643a-41db-b97a-970dec679f53: the transaction related to the Voucher redeeming failed, the Voucher is still available to be redeemed

POSThttps://api-public.socios.com/wallet/1.0.0/user/wallet/redeem/{voucherCode}

Authorization

default

Path parameters

voucherCode*string

The value of the voucher to redeem

Response

200400

Success. The redeem process will call wallet to check ledger limits

Request

JavaScriptCurl

const response = await fetch('https://api-public.socios.com/wallet/1.0.0/user/wallet/redeem/{voucherCode}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

POSThttps://api-public.socios.com/wallet/1.0.0/admin/wallet/transfer/fan-token

Authorization

default

Body

application/json

amount*string

Amount to transfer

currencyId*string (uuid)

CurrencyId to transfer

fromWalletId*string (uuid)

toWalletId*string (uuid)

uniqueId*string

Generate a unique ID for each transaction

Response

200400

Success

Request

JavaScriptCurl

const response = await fetch('https://api-public.socios.com/wallet/1.0.0/admin/wallet/transfer/fan-token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": "23.00",
      "currencyId": "f9d5eaae-230d-4bec-9d8e-51732ad6b664",
      "fromWalletId": "b1168a48-22c3-4e26-ac0c-0150e89d050d",
      "toWalletId": "6a56ffda-62a6-4205-8c01-7fff01a500b7",
      "uniqueId": "3a56ffda-62a6-4205-8c01-7fff01a500b7"
    }),
});
const data = await response.json();