๐Users
API's to manage Users.
Create User
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
409
User with the same third party user id already exists.
500
Internal error.
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
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
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
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
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
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