๐Ÿ˜„Users

API's to manage Users.

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. +2348123456789

Responses
200
User successfully created.
application/json
post
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": "[email protected]",
  "country": "text",
  "dateOfBirth": "2025-06-23",
  "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
get
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": "[email protected]",
  "country": "text",
  "dateOfBirth": "2025-06-23",
  "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
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
get
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"
    ]
  }
]

Last updated