curl --request GET \
--url https://api.unibee.dev/merchant/user/list \
--header 'Authorization: Bearer <token>'{
"code": 123,
"data": {
"total": 123,
"userAccounts": [
{
"address": "<string>",
"avatarUrl": "<string>",
"billingType": 123,
"birthday": "<string>",
"city": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"createTime": 123,
"creditAccounts": [
{
"amount": 123,
"createTime": 123,
"currency": "<string>",
"currencyAmount": 123,
"exchangeRate": 123,
"id": 123,
"payoutEnable": 123,
"rechargeEnable": 123,
"totalDecrementAmount": 123,
"totalIncrementAmount": 123,
"type": 123,
"userId": 123
}
],
"custom": "<string>",
"email": "<string>",
"externalUserId": "<string>",
"facebook": "<string>",
"firstName": "<string>",
"gateway": {
"IsSetupFinished": true,
"archive": true,
"autoChargeEnabled": true,
"bank": {
"accountHolder": "<string>",
"address": "<string>",
"ABARoutingNumber": "<string>",
"CNAPS": "<string>",
"Remarks": "<string>",
"accountNumber": "<string>",
"bankName": "<string>",
"bic": "<string>",
"bsbCode": "<string>",
"iban": "<string>",
"swiftCode": "<string>"
},
"companyIssuer": {
"issueAddress": "<string>",
"issueCompanyName": "<string>",
"issueLogo": "<string>",
"issueRegNumber": "<string>",
"issueVatNumber": "<string>"
},
"countryConfig": {},
"createTime": 123,
"currency": "<string>",
"currencyExchange": [
{
"exchange_rate": 123,
"from_currency": "<string>",
"to_currency": "<string>"
}
],
"currencyExchangeEnabled": true,
"defaultGatewayPaymentType": {
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<string>",
"supportCurrencies": [
"<string>"
]
},
"description": "<string>",
"displayName": "<string>",
"gatewayIcons": [
"<string>"
],
"gatewayId": 123,
"gatewayKey": "<string>",
"gatewayLogo": "<string>",
"gatewayName": "<string>",
"gatewayPaymentTypes": [
{
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<string>",
"supportCurrencies": [
"<string>"
]
}
],
"gatewaySecret": "<string>",
"gatewayType": 123,
"gatewayWebhookIntegrationLink": "<string>",
"gatewayWebsiteLink": "<string>",
"isDefault": true,
"metadata": {},
"minimumAmount": 123,
"name": "<string>",
"privateSecretName": "<string>",
"publicKeyName": "<string>",
"setupGatewayPaymentTypes": [
{
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<string>",
"supportCurrencies": [
"<string>"
]
}
],
"sort": 123,
"subGateway": "<string>",
"subGatewayName": "<string>",
"webhookEndpointUrl": "<string>",
"webhookSecret": "<string>"
},
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"gender": "<string>",
"id": 123,
"isRisk": 123,
"isSpecial": 123,
"language": "<string>",
"lastLoginAt": 123,
"lastName": "<string>",
"linkedIn": "<string>",
"merchantId": 123,
"metadata": {},
"mobile": "<string>",
"otherSocialInfo": "<string>",
"paymentMethod": "<string>",
"phone": "<string>",
"planId": 123,
"promoCreditAccounts": [
{
"amount": 123,
"createTime": 123,
"currency": "<string>",
"currencyAmount": 123,
"exchangeRate": 123,
"id": 123,
"payoutEnable": 123,
"rechargeEnable": 123,
"totalDecrementAmount": 123,
"totalIncrementAmount": 123,
"type": 123,
"userId": 123
}
],
"recurringAmount": 123,
"registrationNumber": "<string>",
"school": "<string>",
"state": "<string>",
"status": 123,
"subscriptionId": "<string>",
"subscriptionName": "<string>",
"subscriptionStatus": 123,
"taxPercentage": 123,
"telegram": "<string>",
"tikTok": "<string>",
"timeZone": "<string>",
"type": 123,
"userName": "<string>",
"vATNumber": "<string>",
"version": 123,
"weChat": "<string>",
"whatsAPP": "<string>",
"zipCode": "<string>"
}
]
},
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}curl --request GET \
--url https://api.unibee.dev/merchant/user/list \
--header 'Authorization: Bearer <token>'{
"code": 123,
"data": {
"total": 123,
"userAccounts": [
{
"address": "<string>",
"avatarUrl": "<string>",
"billingType": 123,
"birthday": "<string>",
"city": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"createTime": 123,
"creditAccounts": [
{
"amount": 123,
"createTime": 123,
"currency": "<string>",
"currencyAmount": 123,
"exchangeRate": 123,
"id": 123,
"payoutEnable": 123,
"rechargeEnable": 123,
"totalDecrementAmount": 123,
"totalIncrementAmount": 123,
"type": 123,
"userId": 123
}
],
"custom": "<string>",
"email": "<string>",
"externalUserId": "<string>",
"facebook": "<string>",
"firstName": "<string>",
"gateway": {
"IsSetupFinished": true,
"archive": true,
"autoChargeEnabled": true,
"bank": {
"accountHolder": "<string>",
"address": "<string>",
"ABARoutingNumber": "<string>",
"CNAPS": "<string>",
"Remarks": "<string>",
"accountNumber": "<string>",
"bankName": "<string>",
"bic": "<string>",
"bsbCode": "<string>",
"iban": "<string>",
"swiftCode": "<string>"
},
"companyIssuer": {
"issueAddress": "<string>",
"issueCompanyName": "<string>",
"issueLogo": "<string>",
"issueRegNumber": "<string>",
"issueVatNumber": "<string>"
},
"countryConfig": {},
"createTime": 123,
"currency": "<string>",
"currencyExchange": [
{
"exchange_rate": 123,
"from_currency": "<string>",
"to_currency": "<string>"
}
],
"currencyExchangeEnabled": true,
"defaultGatewayPaymentType": {
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<string>",
"supportCurrencies": [
"<string>"
]
},
"description": "<string>",
"displayName": "<string>",
"gatewayIcons": [
"<string>"
],
"gatewayId": 123,
"gatewayKey": "<string>",
"gatewayLogo": "<string>",
"gatewayName": "<string>",
"gatewayPaymentTypes": [
{
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<string>",
"supportCurrencies": [
"<string>"
]
}
],
"gatewaySecret": "<string>",
"gatewayType": 123,
"gatewayWebhookIntegrationLink": "<string>",
"gatewayWebsiteLink": "<string>",
"isDefault": true,
"metadata": {},
"minimumAmount": 123,
"name": "<string>",
"privateSecretName": "<string>",
"publicKeyName": "<string>",
"setupGatewayPaymentTypes": [
{
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<string>",
"supportCurrencies": [
"<string>"
]
}
],
"sort": 123,
"subGateway": "<string>",
"subGatewayName": "<string>",
"webhookEndpointUrl": "<string>",
"webhookSecret": "<string>"
},
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"gender": "<string>",
"id": 123,
"isRisk": 123,
"isSpecial": 123,
"language": "<string>",
"lastLoginAt": 123,
"lastName": "<string>",
"linkedIn": "<string>",
"merchantId": 123,
"metadata": {},
"mobile": "<string>",
"otherSocialInfo": "<string>",
"paymentMethod": "<string>",
"phone": "<string>",
"planId": 123,
"promoCreditAccounts": [
{
"amount": 123,
"createTime": 123,
"currency": "<string>",
"currencyAmount": 123,
"exchangeRate": 123,
"id": 123,
"payoutEnable": 123,
"rechargeEnable": 123,
"totalDecrementAmount": 123,
"totalIncrementAmount": 123,
"type": 123,
"userId": 123
}
],
"recurringAmount": 123,
"registrationNumber": "<string>",
"school": "<string>",
"state": "<string>",
"status": 123,
"subscriptionId": "<string>",
"subscriptionName": "<string>",
"subscriptionStatus": 123,
"taxPercentage": 123,
"telegram": "<string>",
"tikTok": "<string>",
"timeZone": "<string>",
"type": 123,
"userName": "<string>",
"vATNumber": "<string>",
"version": 123,
"weChat": "<string>",
"whatsAPP": "<string>",
"zipCode": "<string>"
}
]
},
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Filter UserId
ExternalUserId
Search FirstName
Search LastName
Search Filter Email
Search FirstName|LastName|Email|Phone|Address|ExternalUserId
PlanIds, Search Filter PlanIds
GatewayIds, Search Filter GatewayIds
Search Filter SubscriptionId
Filter, Default All,1-Pending|2-Active|3-Suspend | 4-Cancel | 5-Expire | 6- Suspend| 7-Incomplete | 8-Processing | 9-Failed
Status, 0-Active|2-Frozen
Deleted Involved,Need Admin
Sort,user_id|gmt_create|email|user_name|subscription_name|subscription_status|payment_method|recurring_amount|billing_type,Default gmt_create
Sort Type,asc|desc,Default desc
Page,Start 0
Count OF Page
CreateTimeStart,UTC timestamp,seconds
CreateTimeEnd,UTC timestamp,seconds
Show child attributes
Total
User Account Object List
Show child attributes
address
avator url
1-recurring,2-one-time
brithday
city
company name
country_code
country_name
create utc time
creditAccounts
Show child attributes
credit amount, in cent if type is main
create utc time
currency
currency amount, in cent
keep two decimal places,multiply by 100 saved, 1 currency = 1 credit * (exchange_rate/100), main account fixed rate to 100
Id
0-no, 1-yes
0-no, 1-yes
the total decrement amount
the total increment amount
type of credit account, 1-main account, 2-gift account
user_id
custom
external_user_id
first name
Show child attributes
Whether the gateway finished setup process
Show child attributes
The AccountHolder of wire transfer
The address of wire transfer
The ABARoutingNumber of wire transfer
The CNAPS of wire transfer
The Remarks additional content
The Account Number
The Bank Name
The BIC of wire transfer
The BSB Code
The IBAN of wire transfer
The Swift Code
Show child attributes
create utc time
The currency of wire transfer
The currency exchange for gateway payment, effect at start of payment creation when currency matched
Show child attributes
the exchange rate of gateway, set to 0 if using https://app.exchangerate-api.com/ instead of fixed exchange rate
the currency of gateway exchange from
the currency of gateway exchange to
whether to enable currency exchange
Show child attributes
The description of gateway
The gateway display name, used at user portal
The gateway display name, used at user portal
The gateway name, stripe|paypal|changelly|unitpay|payssion|cryptadium
gatewayPaymentTypes
Show child attributes
gateway type,1-Bank Card | 2-Crypto | 3 - Wire Transfer
The gateway webhook integration guide link, gateway webhook need setup if not blank
The gateway website link
The minimum amount of wire transfer
The name of gateway
The total list of gateway payment types, used for setup
Show child attributes
The sort value of payment gateway, The higher the value, the lower the ranking
The endpoint url of gateway webhook
The secret of gateway webhook
gateway_id
gender
userId
is risk account (deperated)
is special account(0.no,1.yes)- deperated
User Language, en|ru|cn|vi|bp
last login time, utc time
last name
merchant_id
mobile
phone
PlanId
promoCreditAccounts
Show child attributes
credit amount, in cent if type is main
create utc time
currency
currency amount, in cent
keep two decimal places,multiply by 100 saved, 1 currency = 1 credit * (exchange_rate/100), main account fixed rate to 100
Id
0-no, 1-yes
0-no, 1-yes
the total decrement amount
the total increment amount
type of credit account, 1-main account, 2-gift account
user_id
total recurring amount, cent
RegistrationNumber
school
state
0-Active, 2-Suspend
subscription id
subscription name
sub status, 1-Pending|2-Active|3-PendingInActive | 4-Cancel | 5-Expire | 6- Suspend| 7-Incomplete | 8-Processing | 9-Failed
taxPercentage,1000 = 10%
telegram
tictok
User type, 1-Individual|2-Business
user name
vat number
version
whats app
zip_code