😄Users

API's to manage Users.

Production URL: https://users-v1-api-rdqehkur6a-ey.a.run.app

Create User

Supported Date formats includes: "2015-03-25" (The International Standard) "03/25/2015" "Mar 25 2015" or "25 Mar 2015" 1726726779171 (Epoch milliseconds)

Create a new user.

POST/user

Header parameters

Body

application/json

thirdPartyUserIdstring

Third party user id of the user. This is the unique identifier of the user in the third party system.

firstNamestring

First name of the user.

lastNamestring

Last name of the user.

languageCodestring

Language code of the user. e.g. en, fr, es etc.

emailstring (email)

Email of the user.

countrystring

Country of the user. e.g. EU, NG, US etc.

dateOfBirthstring (date)

Date of birth of the user.

phoneNumberstring

Phone number of the user. e.g. [phone]

Response

200409500

User successfully created.

Body

application/json

userIdstring

TygaPay user id of the user. This is the unique identifier of the user in the TygaPay system.

thirdPartyUserIdstring

Third party user id of the user. This is the unique identifier of the user in the third party system.

Request

JavaScriptCurlPython

const response = await fetch('/user', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "x-api-hash": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "userId": "text",
  "thirdPartyUserId": "text"
}

Get User

Fetch the user by userId, thirdPartyUserId or email.

GET/user

Query parameters

Header parameters

Response

200404

The User Information.

Body

application/json

userIdstring

TygaPay user id of the user. This is the unique identifier of the user in the TygaPay system.

thirdPartyUserId*string

Third party user id of the user. This is the unique identifier of the user in the third party system.

firstName*string

First name of the user.

lastName*string

Last name of the user.

languageCode*string

Language code of the user. e.g. en, fr, es etc.

email*string (email)

Email of the user.

country*string

Country of the user. e.g. EU, NG, US etc.

dateOfBirth*string (date)

Date of birth of the user.

phoneNumberstring

Phone number of the user. e.g. [phone]

Request

JavaScriptCurlPython

const response = await fetch('/user', {
    method: 'GET',
    headers: {
      "x-api-key": "text",
      "x-api-hash": "text"
    },
});
const data = await response.json();

Response

200404

{
  "userId": "text",
  "thirdPartyUserId": "text",
  "firstName": "text",
  "lastName": "text",
  "languageCode": "text",
  "email": "[e-mail]",
  "country": "text",
  "dateOfBirth": "2024-10-18",
  "phoneNumber": "text"
}

Get User Balances

Fetch the balances of the user by id.

GET/user/balances

Query parameters

Header parameters

Response

200

Returns a mysterious string.

Body

application/json

totalBalancenumber

The users total balance.

mainBalancenumber

The users main balance.

pendingBalancenumber

The users pending balance.

Request

JavaScriptCurlPython

const response = await fetch('/user/balances?userId=text', {
    method: 'GET',
    headers: {
      "x-api-key": "text",
      "x-api-hash": "text"
    },
});
const data = await response.json();

Response

200

{
  "totalBalance": 0,
  "mainBalance": 0,
  "pendingBalance": 0
}

Get User Crypto Deposit Addresses

Fetches the deposit addresses for a user.

GET/user/deposit-addresses

Query parameters

Header parameters

Response

200409500

OK

Body

application/json

addressstring

The deposit address for the tenant.

networkstring

The network for the deposit address.

supportedTokensarray of string

The supported tokens for the deposit address.

Request

JavaScriptCurlPython

const response = await fetch('/user/deposit-addresses?userId=text', {
    method: 'GET',
    headers: {
      "x-api-key": "text",
      "x-api-hash": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "address": "text",
    "network": "text",
    "supportedTokens": [
      "text"
    ]
  }
]