Member Authentication
Merchant
Credit
Promo Credit
Discount
User Discount
Email Template
Gateway
- POSTPayment Gateway Archive
- GETPayment Gateway
- POSTPayment Gateway
- POSTPayment Gateway Edit
- POSTPayment Gateway Country Config Edit
- POSTEdit Payment Gateway Sort
- GETGet Payment Gateway List
- POSTPayment Gateway Setup
- POSTExchange Rate Api Setup
- GETGet Payment Gateway Setup List
- POSTPayment Gateway Webhook Setup
- POSTWire Transfer Edit
- POSTWire Transfer Setup
- POSTSegment Setup
Invoice
- POSTAdmin Cancel Invoice
- POSTDelete Pending Invoice
- GETInvoice Detail
- POSTInvoice Detail
- POSTInvoice Edit
- POSTFinish Invoice
- GETGet Invoice List
- POSTGet Invoice List
- POSTMark Invoice Refund
- POSTMark Invoice Refund As Success
- POSTMark Wire Transfer Invoice As Success
- POSTNew Invoice
- POSTGenerate Invoice PDF
- POSTUpdate Invoice PDF
- POSTAdmin Reconvert Crypto Data and Send Invoice Email
- POSTCreate InvoiceRefund
- POSTSend Invoice Email
Admin Member
Metric
Metric Event
Payment
- POSTCancel Payment
- POSTCapture Payment
- GETPayment Detail
- GETGet OneTime Payment Item List
- GETGet Payment List
- POSTDelete Payment Method
- GETPayment Method
- GETPayment Method List
- POSTCreate New Payment Method
- POSTNew Payment
- POSTCancel Payment Refund
- GETPayment Refund Detail
- GETGet Payment Refund List
- POSTNew Payment Refund
- GETGet Payment TimeLine List
- POSTGet Payment TimeLine List
Plan
Product
Search
Session
Subscription Update
Subscription
- POSTAppend Subscription TrialEnd
- POSTCancel Subscription Immediately
- POSTCancel Subscription At Period End
- POSTCancel Last Cancel Subscription At Period End
- POSTChange Subscription Gateway
- POSTCreate Subscription Preview
- POSTCreate Subscription
- GETSubscription Detail
- POSTSubscription Detail
- GETGet Subscription List
- POSTGet Subscription List
- GETSubscription Next Invoice Preview
- GETUser Pending Crypto Subscription Detail
- POSTUser Pending Crypto Subscription Detail
- GETUser Subscription Detail
- POSTUser Subscription Detail
Subscription Note
Subscription Config
Subscription Payment
Subscription Timeline
User
- GETGet User Admin Note List
- POSTGet User Admin Note List
- POSTChange User Email
- POSTChange User Default Gateway
- POSTClear AutoCharge Method
- GETUser Count
- GETGet User Profile
- GETUser List
- POSTUser List
- POSTNew User
- POSTNew Admin Note
- POSTResume User
- GETUser Search
- POSTUser Search
- POSTSuspend User
- POSTUpdate User Profile
Vat Gateway
Get User Profile
curl --request GET \
--url https://api.unibee.top/merchant/user/get \
--header 'Authorization: Bearer <token>'
{
"code": 123,
"data": {
"user": {
"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>",
"bic": "<string>",
"iban": "<string>"
},
"countryConfig": {},
"createTime": 123,
"currency": "<string>",
"currencyExchange": [
{
"exchange_rate": 123,
"from_currency": "<string>",
"to_currency": "<string>"
}
],
"currencyExchangeEnabled": true,
"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>"
}
],
"gatewaySecret": "<string>",
"gatewayType": 123,
"gatewayWebhookIntegrationLink": "<string>",
"gatewayWebsiteLink": "<string>",
"minimumAmount": 123,
"name": "<string>",
"privateSecretName": "<string>",
"publicKeyName": "<string>",
"setupGatewayPaymentTypes": [
{
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<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,
"profession": "<string>",
"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>",
"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>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
UserId
Response
address
avator url
1-recurring,2-one-time
brithday
city
company name
country_code
country_name
create utc time
creditAccounts
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
Whether the gateway finished setup process
create utc time
The currency of wire transfer
The currency exchange for gateway payment, effect at start of payment creation when currency matched
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
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
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
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
profession
promoCreditAccounts
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
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-organization
user name
vat number
version
whats app
zip_code
curl --request GET \
--url https://api.unibee.top/merchant/user/get \
--header 'Authorization: Bearer <token>'
{
"code": 123,
"data": {
"user": {
"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>",
"bic": "<string>",
"iban": "<string>"
},
"countryConfig": {},
"createTime": 123,
"currency": "<string>",
"currencyExchange": [
{
"exchange_rate": 123,
"from_currency": "<string>",
"to_currency": "<string>"
}
],
"currencyExchangeEnabled": true,
"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>"
}
],
"gatewaySecret": "<string>",
"gatewayType": 123,
"gatewayWebhookIntegrationLink": "<string>",
"gatewayWebsiteLink": "<string>",
"minimumAmount": 123,
"name": "<string>",
"privateSecretName": "<string>",
"publicKeyName": "<string>",
"setupGatewayPaymentTypes": [
{
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<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,
"profession": "<string>",
"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>",
"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>"
}