Wallet API endpoints

Last updated 10 days ago

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

ALTERNATIVE: Retrieve User Token Balance

import { createPublicClient, http } from 'viem';
import { abi as erc20ABI } from './ERC20ABI.json';

const client = createPublicClient({
  transport: http('https://rpc.ankr.com/chiliz'),
});

const tokenAddress = '0xYourTokenAddress'; // Replace with the actual ERC-20 contract address
const userAddress = '0xUserWalletAddress'; // Replace with the user's wallet address
async function getTokenBalance() {
  const balance = await client.readContract({
    address: tokenAddress, // Contract address of the token
    abi: erc20ABI, // ERC-20 ABI
    functionName: 'balanceOf', // Standard ERC-20 function to get balance
    args: [userAddress], // User's address whose balance you want to check
  });
  return balance.toString();
}
// Example usage
getTokenBalance().then(console.log);

REMOVED WITH NO ALTERNATIVE AVAILABLE

async function getTransaction(txHash) {
  const transaction = await client.getTransaction({
    hash: txHash, // Replace with the actual transaction hash
  });
  return transaction;
}

// Example usage
getTransaction('0xTransactionHash').then(console.log);

import { createWalletClient, privateKeyToAccount } from 'viem';

const privateKey = '0xSenderPrivateKey'; // Replace with the sender's private key
const account = privateKeyToAccount(privateKey);
const walletClient = createWalletClient({
  account,
  transport: http('https://rpc.ankr.com/chiliz'),
});
async function sendTokens(to, amount) {
  const txHash = await walletClient.writeContract({
    address: '0xYourTokenAddress', // Replace with the ERC-20 token contract address
    abi: erc20ABI, // ERC-20 ABI
    functionName: 'transfer', // Standard ERC-20 function to transfer tokens
    args: [to, BigInt(amount * 1e18)], // Replace 'to' with recipient address and 'amount' with the amount to send
  });
  return txHash;
}
// Example usage
sendTokens('0xRecipientAddress', 10).then(console.log);

PreviousWallet API NextOverview

Last updated 10 days ago

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

ALTERNATIVE: Retrieve User Token Balance

import { createPublicClient, http } from 'viem';
import { abi as erc20ABI } from './ERC20ABI.json';

const client = createPublicClient({
  transport: http('https://rpc.ankr.com/chiliz'),
});

const tokenAddress = '0xYourTokenAddress'; // Replace with the actual ERC-20 contract address
const userAddress = '0xUserWalletAddress'; // Replace with the user's wallet address
async function getTokenBalance() {
  const balance = await client.readContract({
    address: tokenAddress, // Contract address of the token
    abi: erc20ABI, // ERC-20 ABI
    functionName: 'balanceOf', // Standard ERC-20 function to get balance
    args: [userAddress], // User's address whose balance you want to check
  });
  return balance.toString();
}
// Example usage
getTokenBalance().then(console.log);

REMOVED WITH NO ALTERNATIVE AVAILABLE

ALTERNATIVE: Retrieve a User's Transaction

async function getTransaction(txHash) {
  const transaction = await client.getTransaction({
    hash: txHash, // Replace with the actual transaction hash
  });
  return transaction;
}

// Example usage
getTransaction('0xTransactionHash').then(console.log);

ALTERNATIVE: Send ERC-20 Tokens to a User Wallet

import { createWalletClient, privateKeyToAccount } from 'viem';

const privateKey = '0xSenderPrivateKey'; // Replace with the sender's private key
const account = privateKeyToAccount(privateKey);
const walletClient = createWalletClient({
  account,
  transport: http('https://rpc.ankr.com/chiliz'),
});
async function sendTokens(to, amount) {
  const txHash = await walletClient.writeContract({
    address: '0xYourTokenAddress', // Replace with the ERC-20 token contract address
    abi: erc20ABI, // ERC-20 ABI
    functionName: 'transfer', // Standard ERC-20 function to transfer tokens
    args: [to, BigInt(amount * 1e18)], // Replace 'to' with recipient address and 'amount' with the amount to send
  });
  return txHash;
}
// Example usage
sendTokens('0xRecipientAddress', 10).then(console.log);

DEPRECATED - Endpoint to get wallet data for currently logged-in user

Deprecated

get

/user/wallet

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api-public.socios.com/wallet/1.0.0/user/wallet'

200

{
  "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",
        "images": [
          {
            "url": "https://url.com/partner/d66eb9d2-56c6-4b1b-8f56-31f8aa319abe/partner_logo/38aca876-86a8-4a10-a0e8-b0859614c8b3.png?version=1653577420",
            "type": "png",
            "format": "desktop",
            "width": "500",
            "height": "500"
          }
        ]
      },
      "blockchainAddress": "0x11225D5D1230B07e814BE63C5e2FF6EaE43b45A0"
    }
  ]
}

Successfully retrieved User's wallet

DEPRECATED - Endpoint to sign a transaction via ETH Sign method

Deprecated

post

/user/wallet/sign-message

Authorizations

Body

messagestringrequired

Example: The message to be signed.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api-public.socios.com/wallet/1.0.0/user/wallet/sign-message' \
  --header 'Content-Type: application/json' \
  --data '{
    "message": "The message to be signed."
  }'

200

400

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

Successfully retrieved signature

DEPRECATED - Endpoint to get the transaction of a user wallet

Deprecated

get

/user/wallet/{transactionId}

Authorizations

Path parameters

transactionIdstring · uuidrequired

Id of the transaction

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api-public.socios.com/wallet/1.0.0/user/wallet/{transactionId}'

200

400

{
  "data": [
    {
      "transactionId": "a2567e3a-9c00-4094-8196-9ec92b98f3a5",
      "amount": "3.5",
      "totalAmount": "3.5",
      "paidCHZAmount": "11.95",
      "status": "text",
      "createdAt": "2020-11-02T07:26:40+00:00",
      "referenceNumber": "text",
      "consumerName": "marketplace",
      "fee": 1,
      "vat": 1,
      "currency": {
        "shortCode": "CHZ",
        "symbol": "$CHZ",
        "type": "crypto"
      },
      "lockFund": {
        "remainingAmount": "12.5",
        "status": "locked"
      }
    }
  ]
}

Successfully retrieved User wallet transaction details

DEPRECATED - Endpoint to get the transaction history of a user wallet

Deprecated

get

/user/wallet/transaction-history/fan-token

Authorizations

Query parameters

pageinteger · integer

limitinteger · integer

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api-public.socios.com/wallet/1.0.0/user/wallet/transaction-history/fan-token'

200

400

{
  "data": [
    {
      "transactionId": "text",
      "status": "text",
      "transactionTypeName": "Redeem CHZ from Voucher",
      "amount": "10.90",
      "date": "2020-11-02T07:26:40Z",
      "isNegativeBalance": true,
      "currencySymbol": "$CHZ",
      "currencyShortCode": "CHZ",
      "partnerId": "text",
      "isPending": true,
      "currencyId": "text",
      "transactionBatchType": "text",
      "transactionType": "text"
    }
  ],
  "metadata": {
    "total_items": 588,
    "current_page": 2,
    "last_page": 4,
    "cursor": "text"
  }
}

Successfully retrieved User wallet transaction history

DEPRECATED - Endpoint to transfer a token from your wallet to your user's wallet

Deprecated

post

/admin/wallet/transfer/fan-token

Authorizations

Body

amountstringrequired

Amount to transfer

Example: 23.00

currencyIdstring · uuidrequired

CurrencyId to transfer

Example: f9d5eaae-230d-4bec-9d8e-51732ad6b664

fromWalletIdstring · uuidrequired

Example: b1168a48-22c3-4e26-ac0c-0150e89d050d

toWalletIdstring · uuidrequired

Example: 6a56ffda-62a6-4205-8c01-7fff01a500b7

uniqueIdstringrequired

Generate a unique ID for each transaction

Example: 3a56ffda-62a6-4205-8c01-7fff01a500b7

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api-public.socios.com/wallet/1.0.0/admin/wallet/transfer/fan-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

200

400

No body

Success