😄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

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Body

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]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/user' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "thirdPartyUserId": "text",
    "firstName": "text",
    "lastName": "text",
    "languageCode": "text",
    "email": "[e-mail]",
    "country": "text",
    "dateOfBirth": "2025-03-13",
    "phoneNumber": "text"
  }'

200

409

500

200

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

User successfully created.

Get User

Fetch the user by userId, thirdPartyUserId or email.

get

/user

Query parameters

userIdstring

The TygaPay user id.

thirdPartyUserIdstring

The Tenant user id.

emailstring

The Tenant user email address.

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/user' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text'

200

404

200

{
  "userId": "text",
  "thirdPartyUserId": "text",
  "firstName": "text",
  "lastName": "text",
  "languageCode": "text",
  "email": "[e-mail]",
  "country": "text",
  "dateOfBirth": "2025-03-13",
  "phoneNumber": "text"
}

The User Information.

Get User Balances

Fetch the balances of the user by id.

get

/user/balances

Query parameters

userIdstringrequired

The user id.

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/user/balances?userId=text' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text'

200

200

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

Returns a mysterious string.

Get User Crypto Deposit Addresses

Fetches the deposit addresses for a user.

get

/user/deposit-addresses

Query parameters

userIdstringrequired

The user id.

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/user/deposit-addresses?userId=text' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text'

200

409

500

200

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

OK