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

JavaScriptCurlPythonHTTP

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

Response

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"
    }
  ]
}

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

Example: "The message to be signed."

Response

200400

Successfully retrieved signature

Body

application/json

dataarray of SignedMessage (object)

Request

JavaScriptCurlPythonHTTP

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

200400

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

Endpoint to get the transaction of a user wallet

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

Authorization

default

Path parameters

transactionId*string (uuid)

Id of the transaction

Response

200400

Successfully retrieved User wallet transaction details

Body

application/json

dataarray of UserWalletTransactionDTO (object)

Request

JavaScriptCurlPythonHTTP

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

Response

200400

{
  "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": 0,
      "vat": 0,
      "currency": {
        "shortCode": "CHZ",
        "symbol": "$CHZ",
        "type": "crypto"
      },
      "lockFund": {
        "status": "locked",
        "remainingAmount": "12.5"
      }
    }
  ]
}

Endpoint to get the transaction history of a user wallet

GEThttps://api-public.socios.com/wallet/1.0.0/user/wallet/transaction-history/fan-token

Authorization

default

Query parameters

Response

200400

Successfully retrieved User wallet transaction history

Body

application/json

dataarray of UserWalletTransactionHistoryDTO (object)

metadataone of

PaginationWithDetailedPaginationMode (object)PaginationWithSimplePaginationMode (object)

Request

JavaScriptCurlPythonHTTP

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

Response

200400

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

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

Authorization

default

Body

application/json

amount*string

Amount to transfer

Example: "23.00"

currencyId*string (uuid)

CurrencyId to transfer

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

fromWalletId*string (uuid)

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

toWalletId*string (uuid)

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

uniqueId*string

Generate a unique ID for each transaction

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

Response

200400

Success

Request

JavaScriptCurlPythonHTTP

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();

Response

400

{
  "errors": [
    {
      "title": "Bad Request",
      "status": 400,
      "code": "f4b50cbf-1acb-4964-ab9d-cdca91123d60",
      "meta": {
        "requestId": "dc9cb145-5299-4a1d-af0e-659a6b011106"
      }
    }
  ]
}