Jump to Content
Guides
API Reference
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Guides
API Reference
Create note for entity by type and ID
Search
All
Pages
Start typing to search…
JUMP TO
Preview Api
/api/file-aws
Generate URL for file upload
post
Generate URL for file download
post
Check file readiness
post
Delete files list by id array
post
/api/v1/client/alert-validator-configs
Create Alert-Validator-Config in Company
post
Update Alert-Validator-Config by alertValidatorConfigId in Company
post
Remove Alert-Validator-Config by alertValidatorConfigId in Company
post
/api/v1/client/alert-validators
Get Alert-Validator types (templates)
get
Get Alert-Validator list in Company
post
Get Alert-Validator by alertValidatorId in Company
post
Create Alert-Validator in Company
post
Update Alert-Validator by alertValidatorId in Company
post
Update Alert-Validator active status by alertValidatorId in Company (isActive = true/false)
post
Remove Alert-Validator by alertValidatorId in Company
post
/api/v1/client/alerts
Get Alert list in Company
post
Get Alert by alertId in Company
post
Get Alert-Count by filters in Company
post
Get Alert aggregate list by entityType and entityId in Company
post
Mark Alerts as Read by alerIdList or all Alerts (readAll=true) in Company
post
Mark Alerts as Resolved by alerIdList in Company
post
Mark Alerts as NeedToDelete by alerIdList in Company
post
Remove Alert list by alertIdList in Company
post
/api/v1/client/api-keys
Get User API Keys
post
Get API Key by ID
post
Create API Key
post
Update API Key
post
Reset API Key
post
Delete API Key
post
/api/v1/client/auth
Auth is system by login and password (Client)
post
Logout from system (Client)
post
Check is API key valid
post
Check is TOKEN valid
post
/api/v1/client/banks
Get Banks list in Company
post
Get Bank by ID in Company
post
Get Bank bin list by bankId in Company
post
Create Bank in Company
post
Update Bank in Company
post
Restore Bank by ID (isDelete = false)
post
Delete Bank by ID (isDelete = true)
post
/api/v1/client/bins
Get Bin list in Company
post
/api/v1/client/bw-items-bw-lists
Add items to Black/White List in Company
post
Remove items from Black/White List in Company
post
/api/v1/client/bw-lists
Get Black/White Lists in Company
post
Get Black/White List by ID in Company
post
Get Black/White items by bwListId in Company
post
Create Black/White List in Company
post
Get Black/White List targets (links) in Company
post
Update Black/White List targets (links) in Company
post
Update Black/White List in Company
post
Delete Black/White List in Company
post
/api/v1/client/cascades
Get Cascade list in Company
post
Get Cascade by ID in Company
post
Create Cascade in Company
post
Update Cascade in Company
post
Restore Cascade (isDelete = false)
post
Delete Cascade (isDelete = true)
post
/api/v1/client/chargeback
Get Chargeback list by filters in Company
post
Create Chargeback for transaction
post
Update Chargeback for transaction
post
Delete Chargeback by ID
post
/api/v1/client/commission-rules
Create CommissionRule in Company
post
Update CommissionRule in Company
post
Delete CommissionRule by ID
post
/api/v1/client/commission-tariffs
Get CommissionTariff list in Company
post
Get CommissionTariff by ID in Company
post
Create CommissionTariff in Company
post
Update CommissionTariff in Company
post
Delete CommissionTariff by ID
post
/api/v1/client/company-settings
Get CompanySettings by companyId
post
Update CompanySettings by companyId
post
/api/v1/client/company
Get CompanyInfo by companyId
get
/api/v1/client/countries
Get Country list in Company
post
Get Country one by countryCode in Company
post
/api/v1/client/customers
Get Customer list in Company
post
Get Customer one by customerId in Company
post
Get total customer info
post
Get Customer chargeback list by customerId in Company
post
Get customer phone attributes with cursor pagination
post
Get customer email attributes with cursor pagination
post
Get customer fingerprint attributes with cursor pagination
post
Get customer card token attributes with cursor pagination
post
Get customer card BIN attributes with cursor pagination
post
Get customer card country attributes with cursor pagination
post
Get customer card attributes with cursor pagination
post
Get customer IP address attributes with cursor pagination
post
Get customer IP address country attributes with cursor pagination
post
Get customer address attributes with cursor pagination
post
Get customer external ID attributes with cursor pagination
post
Get total count of customer phone attributes
post
Get total count of customer email attributes
post
Get total count of customer fingerprint attributes
post
Get total count of customer card token attributes
post
Get total count of customer card BIN attributes
post
Get total count of customer card country attributes
post
Get total count of customer card attributes
post
Get total count of customer IP address attributes
post
Get total count of customer IP country attributes
post
Get total count of customer address attributes
post
Get total count of customer external ID attributes
post
/api/v1/client/external-notifies
Get External-Notify types list
get
Get External-Notify list in company
post
Get one External-Notify by externalNotifyId
post
Create External-Notify
post
Update External-Notify
post
Toggle ExternalNotify active status by externalNotifyId (isActive = true / false)
post
Delete External-Notify by externalNotifyId
post
/api/v1/client/filters
Get Banks list for filtering
post
Get Gates list for filtering
post
Get Cascades list for filtering
post
Get MerchantAccounts list for filtering
post
Get Merchants list for filtering
post
Get AlertValidators list for filtering
post
Get BlackWhiteLists list for filtering
post
Get ExternalNotifies list for filtering
post
Get ScoreGenerators list for filtering
post
Get PermGroups list for filtering
post
Get Countries list for filtering
post
[ @deprecated ] Get Banks list for filtering
get
[ @deprecated ] Get Gates list for filtering
get
[ @deprecated ] Get Cascades list for filtering
get
[ @deprecated ] Get MerchantAccounts list for filtering
get
[ @deprecated ] Get Merchants list for filtering
get
[ @deprecated ] Get AlertValidators list for filtering
get
[ @deprecated ] Get BlackWhiteLists list for filtering
get
[ @deprecated ] Get ExternalNotifies list for filtering
get
[ @deprecated ] Get ScoreGenerators list for filtering
get
[ @deprecated ] Get PermGroups list for filtering
get
[ @deprecated ] Get Countries list for filtering
get
/api/v1/client/frauds
Create Fraud by transactionId in Company
post
Update Fraud by fraudId in Company
post
Remove Fraud by fraudId in Company (full remove)
post
/api/v1/client/gates
Get Gate list in company
post
Get Gate one by gateId in Company
post
Create Gate in Company
post
Update Gate by gateId in Company
post
Restore Gate by gateId in Company(isDelete = false)
post
Remove Gate by gateId in Company(isDelete = true)
post
/api/v1/client/link-detect
Get merchantList for link-detect function
post
Get merchant totals for link-detect function
post
Get domain whiteList for this merchant
post
Add items to whiteList (allowDomain)
post
Remove items from whiteList (allowDomain)
post
Get domainList for link-detect function
post
Get domainMerchantsList for link-detect function
post
Get link-detect history
post
/api/v1/client/merchant-accounts
Get Merchantaccounts list by merchantId in company
post
Get Merchantaccount one by merchantAccountId in company
post
Create MerchantAccount one in company
post
Update MerchantAccount one by merchantAccountId in company
post
/api/v1/client/merchants-settings
Get MerchantsSettings by merchantSettingsId in company
post
Update MerchantsSettings by merchantSettingsId in company
post
/api/v1/client/merchants
Get Merchant list in compamy
post
Get one Merchant by ID in Company
post
Create Merchant in company
post
Update Merchant in company
post
/api/v1/client/note
Get notes entity list by type and ID
post
Create note for entity by type and ID
post
Update note by ID
post
Delete Note by ID
post
/api/v1/client/perm-groups
Get PermgGoups templates
get
Get PermGroups list in company
post
Get one Permgroup by ID in Company
post
Get userList in perGroup, by permGroupId in company
post
Create Permgroup in company
post
Update Permgroup in company
post
Remove Permgroup in company (Full delete, from DB)
post
/api/v1/client/profile
Get my profile info
get
/api/v1/client/refunds
Get refundList by filters in Company
post
Create one refund for transaction
post
Create refund by refundId in Company
post
Remove refund by refundId in Company
post
/api/v1/client/score-generators
Get ScoregeneratorType list
get
Get ScoreGenerator list in Company
post
Get ScoreGenerator by scoreGeneratorId in Company
post
Create new Score-Generator in Company
post
Update Score-Generator by scoreGeneratorId in Company
post
Toggle ScoreGenerator priority by scoreGeneratorId in Company (isPriority = true/false)
post
Toggle ScoreGenerator active by scoreGeneratorId in Company (isActive = true/false)
post
Remove ScoreGenerator by scoreGeneratorId in Company (Full remove)
post
/api/v1/client/system-search
Global system search
post
/api/v1/client/transaction-process
Transaction processing (Risk-score). Single item
post
/api/v1/client/transactions
Get all transactionList in Company
post
Get one transaction by transactionId
post
/api/v1/client/users-perm-groups
Add UserList In PermgroupList In Company
post
Delete UserList from PermgroupList In Company
post
/api/v1/client/users
Get user list in Company
post
Get one user by userid in Company
post
Create new user in Company
post
Update user by userid in Company
post
Restore user by userid in Company
post
Delete user by userId (isDelete=true) in Company
post
/api/v1/client/webhooks
Get List Webhook In Company
post
Get one Webhook by webhookId
post
Create Webhook
post
Update Webhook
post
Restore Webhook by webhookId (isDelete = false)
post
Delete Webhook by webhookId
post
Powered by
Create note for entity by type and ID
post
https://api.embermind.ch/api/v1/client/note/create
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!
