😄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

Header parameters

x-api-keystringRequired

Your unique API Key.

x-api-hashstringRequired

Your API Hash.

Body

thirdPartyUserIdstringOptional

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

firstNamestringOptional

First name of the user.

lastNamestringOptional

Last name of the user.

languageCodestringOptional

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

emailstring · emailOptional

Email of the user.

countrystringOptional

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

dateOfBirthstring · dateOptional

Date of birth of the user.

phoneNumberstringOptional

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

Responses

200

User successfully created.

application/json

409

User with the same third party user id already exists.

500

Internal error.

post

HTTPcURLJavaScriptPython

POST /user HTTP/1.1
Host: 
x-api-key: text
x-api-hash: text
Content-Type: application/json
Accept: */*
Content-Length: 176

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

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

Get User

Fetch the user by userId, thirdPartyUserId or email.

get

Query parameters

userIdstringOptional

The TygaPay user id.

thirdPartyUserIdstringOptional

The Tenant user id.

emailstringOptional

The Tenant user email address.

Header parameters

x-api-keystringRequired

Your unique API Key.

x-api-hashstringRequired

Your API Hash.

Responses

200

The User Information.

application/json

404

User not found.

application/json

get

HTTPcURLJavaScriptPython

GET /user HTTP/1.1
Host: 
x-api-key: text
x-api-hash: text
Accept: */*

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

Get User Balances

Fetch the balances of the user by id.

get

Query parameters

userIdstringRequired

The user id.

Header parameters

x-api-keystringRequired

Your unique API Key.

x-api-hashstringRequired

Your API Hash.

Responses

200

Returns a mysterious string.

application/json

get

HTTPcURLJavaScriptPython

GET /user/balances?userId=text HTTP/1.1
Host: 
x-api-key: text
x-api-hash: text
Accept: */*

200

Returns a mysterious string.

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

Get User Crypto Deposit Addresses

Fetches the deposit addresses for a user.

get

Query parameters

userIdstringRequired

The user id.

Header parameters

x-api-keystringRequired

Your unique API Key.

x-api-hashstringRequired

Your API Hash.

Responses

200

OK

application/json

409

Permission denied.

500

Internal error.

get

HTTPcURLJavaScriptPython

GET /user/deposit-addresses?userId=text HTTP/1.1
Host: 
x-api-key: text
x-api-hash: text
Accept: */*

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