GetCoins API - API for the Ewallet project

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.!

View GraphiQL playground

Contact

GetCoins API Support

[email protected]

API Endpoints
https://app.acclivity.digital/gql

Queries

generateWebApiToken

Description

API token generation

Response

Returns a String!

Arguments
Name Description
newLevel - String newLevel

Example

Query
query generateWebApiToken($newLevel: String) {
  generateWebApiToken(newLevel: $newLevel)
}
Variables
{"newLevel": "abc123"}
Response
{"data": {"generateWebApiToken": "abc123"}}
Queries

getApiKeys

Description

Get API keys

Response

Returns an ApiKeyListResult

Arguments
Name Description
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getApiKeys(
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getApiKeys(
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...ApiKeyFragment
    }
  }
}
Variables
{
  "filter": "xyz789",
  "skip": 123,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{"data": {"getApiKeys": {"count": 987, "list": [ApiKey]}}}
Queries

getAppropriatePaymentProviders

Description

Get payment providers for relevant options

Response

Returns [PaymentProviderByInstrument!]

Arguments
Name Description
fiatCurrency - String Fiat currency
widgetId - String Widget id
source - TransactionSource TransactionSource

Example

Query
query getAppropriatePaymentProviders(
  $fiatCurrency: String,
  $widgetId: String,
  $source: TransactionSource
) {
  getAppropriatePaymentProviders(
    fiatCurrency: $fiatCurrency,
    widgetId: $widgetId,
    source: $source
  ) {
    id
    instrument
    provider {
      ...PaymentProviderFragment
    }
  }
}
Variables
{
  "fiatCurrency": "xyz789",
  "widgetId": "abc123",
  "source": "QuickCheckout"
}
Response
{
  "data": {
    "getAppropriatePaymentProviders": [
      {
        "id": 4,
        "instrument": "CreditCard",
        "provider": PaymentProvider
      }
    ]
  }
}
Queries

getAppropriateSettingsCostFull

Description

Get cost settings for the relevant parameters

Response

Returns a SettingsCost

Arguments
Name Description
transactionType - TransactionType! Transaction type
instrument - PaymentInstrument! PaymentInstrument
paymentProvider - String Payment provider
currency - String Currency
filterType - SettingsCostTargetFilterType SettingsCostTargetFilterType
filterValue - String Value

Example

Query
query getAppropriateSettingsCostFull(
  $transactionType: TransactionType!,
  $instrument: PaymentInstrument!,
  $paymentProvider: String,
  $currency: String,
  $filterType: SettingsCostTargetFilterType,
  $filterValue: String
) {
  getAppropriateSettingsCostFull(
    transactionType: $transactionType,
    instrument: $instrument,
    paymentProvider: $paymentProvider,
    currency: $currency,
    filterType: $filterType,
    filterValue: $filterValue
  ) {
    settingsCostId
    name
    description
    targetFilterType
    targetFilterValues
    targetInstruments
    targetTransactionTypes
    targetPaymentProviders
    terms
    created
    createdBy
    bankAccounts {
      ...WireTransferBankAccountFragment
    }
    default
    deleted
  }
}
Variables
{
  "transactionType": "Buy",
  "instrument": "CreditCard",
  "paymentProvider": "abc123",
  "currency": "abc123",
  "filterType": "None",
  "filterValue": "xyz789"
}
Response
{
  "data": {
    "getAppropriateSettingsCostFull": {
      "settingsCostId": "4",
      "name": "xyz789",
      "description": "abc123",
      "targetFilterType": "None",
      "targetFilterValues": ["abc123"],
      "targetInstruments": ["abc123"],
      "targetTransactionTypes": ["xyz789"],
      "targetPaymentProviders": ["abc123"],
      "terms": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "bankAccounts": [WireTransferBankAccount],
      "default": false,
      "deleted": "2007-12-03T10:15:30Z"
    }
  }
}
Queries

getAppropriateSettingsFee

Description

Get fee settings for the relevant parameters

Response

Returns a SettingsFee

Arguments
Name Description
transactionType - TransactionType! Transaction type
targetUserType - UserType! User type
targetUserMode - UserMode! User mode
instrument - PaymentInstrument! Instrument
paymentProvider - String Payment provider
currency - String Currency
filterType - SettingsFeeTargetFilterType Filter type
filterValue - String Value

Example

Query
query getAppropriateSettingsFee(
  $transactionType: TransactionType!,
  $targetUserType: UserType!,
  $targetUserMode: UserMode!,
  $instrument: PaymentInstrument!,
  $paymentProvider: String,
  $currency: String,
  $filterType: SettingsFeeTargetFilterType,
  $filterValue: String
) {
  getAppropriateSettingsFee(
    transactionType: $transactionType,
    targetUserType: $targetUserType,
    targetUserMode: $targetUserMode,
    instrument: $instrument,
    paymentProvider: $paymentProvider,
    currency: $currency,
    filterType: $filterType,
    filterValue: $filterValue
  ) {
    settingsFeeId
    name
    description
    targetFilterType
    targetFilterValues
    targetInstruments
    targetUserTypes
    targetUserModes
    targetTransactionTypes
    targetPaymentProviders
    terms
    wireDetails
    created
    createdBy
    default
    deleted
    currency
    rateToEur
    costs {
      ...SettingsCostFragment
    }
  }
}
Variables
{
  "transactionType": "Buy",
  "targetUserType": "Merchant",
  "targetUserMode": "InternalWallet",
  "instrument": "CreditCard",
  "paymentProvider": "abc123",
  "currency": "xyz789",
  "filterType": "None",
  "filterValue": "xyz789"
}
Response
{
  "data": {
    "getAppropriateSettingsFee": {
      "settingsFeeId": "4",
      "name": "abc123",
      "description": "abc123",
      "targetFilterType": "None",
      "targetFilterValues": ["abc123"],
      "targetInstruments": ["xyz789"],
      "targetUserTypes": ["Merchant"],
      "targetUserModes": ["InternalWallet"],
      "targetTransactionTypes": ["xyz789"],
      "targetPaymentProviders": ["abc123"],
      "terms": "xyz789",
      "wireDetails": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "xyz789",
      "default": false,
      "deleted": "2007-12-03T10:15:30Z",
      "currency": "abc123",
      "rateToEur": 123.45,
      "costs": [SettingsCost]
    }
  }
}
Queries

getAppropriateSettingsKyc

Description

Get KYC settings for relevant options

Response

Returns a SettingsKyc

Arguments
Name Description
targetKycProvider - KycProvider! KYC provider
targetUserType - UserType! User type
targetUserMode - UserMode! User mode
filterType - SettingsKycTargetFilterType SettingsKycTargetFilterType
filterValue - String Value

Example

Query
query getAppropriateSettingsKyc(
  $targetKycProvider: KycProvider!,
  $targetUserType: UserType!,
  $targetUserMode: UserMode!,
  $filterType: SettingsKycTargetFilterType,
  $filterValue: String
) {
  getAppropriateSettingsKyc(
    targetKycProvider: $targetKycProvider,
    targetUserType: $targetUserType,
    targetUserMode: $targetUserMode,
    filterType: $filterType,
    filterValue: $filterValue
  ) {
    settingsKycId
    name
    description
    targetKycProviders
    targetUserType
    targetUserModes
    targetFilterType
    targetFilterValues
    levels {
      ...SettingsKycLevelFragment
    }
    requireUserFullName
    requireUserPhone
    requireUserBirthday
    requireUserAddress
    requireUserFlatNumber
    created
    createdBy
    default
    deleted
  }
}
Variables
{
  "targetKycProvider": "Local",
  "targetUserType": "Merchant",
  "targetUserMode": "InternalWallet",
  "filterType": "None",
  "filterValue": "xyz789"
}
Response
{
  "data": {
    "getAppropriateSettingsKyc": {
      "settingsKycId": "4",
      "name": "xyz789",
      "description": "abc123",
      "targetKycProviders": ["Local"],
      "targetUserType": "Merchant",
      "targetUserModes": ["InternalWallet"],
      "targetFilterType": "None",
      "targetFilterValues": ["abc123"],
      "levels": [SettingsKycLevel],
      "requireUserFullName": true,
      "requireUserPhone": false,
      "requireUserBirthday": false,
      "requireUserAddress": false,
      "requireUserFlatNumber": true,
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "default": false,
      "deleted": "2007-12-03T10:15:30Z"
    }
  }
}
Queries

getAppropriateSettingsKycTiers

Description

Get KYC levels settings for relevant options

Response

Returns a SettingsKycTierShortExListResult

Arguments
Name Description
amount - Float Amount
currency - String Currency
targetKycProvider - KycProvider! Kyc Provider
source - TransactionSource Source
widgetId - String Widget id

Example

Query
query getAppropriateSettingsKycTiers(
  $amount: Float,
  $currency: String,
  $targetKycProvider: KycProvider!,
  $source: TransactionSource,
  $widgetId: String
) {
  getAppropriateSettingsKycTiers(
    amount: $amount,
    currency: $currency,
    targetKycProvider: $targetKycProvider,
    source: $source,
    widgetId: $widgetId
  ) {
    count
    list {
      ...SettingsKycTierShortExFragment
    }
  }
}
Variables
{
  "amount": 123.45,
  "currency": "xyz789",
  "targetKycProvider": "Local",
  "source": "QuickCheckout",
  "widgetId": "xyz789"
}
Response
{
  "data": {
    "getAppropriateSettingsKycTiers": {
      "count": 987,
      "list": [SettingsKycTierShortEx]
    }
  }
}
Queries

getCountryBlackList

Description

Get a black list of countries

Response

Returns a BlackCountryListResult

Example

Query
query getCountryBlackList {
  getCountryBlackList {
    count
    list {
      ...BlackCountryFragment
    }
  }
}
Response
{
  "data": {
    "getCountryBlackList": {
      "count": 123,
      "list": [BlackCountry]
    }
  }
}
Queries

getDashboardStats

Description

Get toolbar statistics

Response

Returns a DashboardStats

Arguments
Name Description
updateDateInterval - DateTimeInterval transaction update date interval
transactionDateOnly - DateTime DateTime
createdDateInterval - DateTimeInterval transactionCreated interval
userIdOnly - [String!] User ids
widgetIdOnly - [String!] Widget ids
sourcesOnly - [TransactionSource!] Sources
countriesOnly - [String!] Counties
countryCodeType - CountryCodeType CountryCodeType
completedDateInterval - DateTimeInterval Transaction completion date
accountTypesOnly - [UserType!] Account types

Example

Query
query getDashboardStats(
  $updateDateInterval: DateTimeInterval,
  $transactionDateOnly: DateTime,
  $createdDateInterval: DateTimeInterval,
  $userIdOnly: [String!],
  $widgetIdOnly: [String!],
  $sourcesOnly: [TransactionSource!],
  $countriesOnly: [String!],
  $countryCodeType: CountryCodeType,
  $completedDateInterval: DateTimeInterval,
  $accountTypesOnly: [UserType!]
) {
  getDashboardStats(
    updateDateInterval: $updateDateInterval,
    transactionDateOnly: $transactionDateOnly,
    createdDateInterval: $createdDateInterval,
    userIdOnly: $userIdOnly,
    widgetIdOnly: $widgetIdOnly,
    sourcesOnly: $sourcesOnly,
    countriesOnly: $countriesOnly,
    countryCodeType: $countryCodeType,
    completedDateInterval: $completedDateInterval,
    accountTypesOnly: $accountTypesOnly
  ) {
    buys {
      ...BuyOrSellStatsFragment
    }
    sells {
      ...BuyOrSellStatsFragment
    }
    deposits {
      ...DepositOrWithdrawalStatsFragment
    }
    withdrawals {
      ...DepositOrWithdrawalStatsFragment
    }
    transfers {
      ...TransferStatsFragment
    }
    receives {
      ...TransferStatsFragment
    }
    exchanges {
      ...ExchangeStatsFragment
    }
    balances {
      ...BalanceStatsFragment
    }
    openpaydBalances {
      ...OpenpaydProviderBalanceFragment
    }
    liquidityProviderBalances {
      ...liquidityProviderBalanceFragment
    }
  }
}
Variables
{
  "updateDateInterval": DateTimeInterval,
  "transactionDateOnly": "2007-12-03T10:15:30Z",
  "createdDateInterval": DateTimeInterval,
  "userIdOnly": ["abc123"],
  "widgetIdOnly": ["abc123"],
  "sourcesOnly": ["QuickCheckout"],
  "countriesOnly": ["xyz789"],
  "countryCodeType": "code2",
  "completedDateInterval": DateTimeInterval,
  "accountTypesOnly": ["Merchant"]
}
Response
{
  "data": {
    "getDashboardStats": {
      "buys": BuyOrSellStats,
      "sells": BuyOrSellStats,
      "deposits": DepositOrWithdrawalStats,
      "withdrawals": DepositOrWithdrawalStats,
      "transfers": TransferStats,
      "receives": TransferStats,
      "exchanges": ExchangeStats,
      "balances": [BalanceStats],
      "openpaydBalances": [OpenpaydProviderBalance],
      "liquidityProviderBalances": [
        liquidityProviderBalance
      ]
    }
  }
}
Queries

getDevices

Response

Returns a UserDeviceListResult

Example

Query
query getDevices {
  getDevices {
    count
    list {
      ...UserDeviceFragment
    }
  }
}
Response
{
  "data": {
    "getDevices": {"count": 123, "list": [UserDevice]}
  }
}
Queries

getFakeError

Description

Get fake error

Response

Returns a Void

Example

Query
query getFakeError {
  getFakeError
}
Response
{"data": {"getFakeError": null}}
Queries

getFeedbacks

Description

get feedbacks

Response

Returns a FeedbackListResult

Arguments
Name Description
recaptcha - String
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getFeedbacks(
  $recaptcha: String,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getFeedbacks(
    recaptcha: $recaptcha,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...FeedbackFragment
    }
  }
}
Variables
{
  "recaptcha": "xyz789",
  "filter": "xyz789",
  "skip": 987,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getFeedbacks": {"count": 987, "list": [Feedback]}
  }
}
Queries

getFiatVaults

Description

This endpoint can be used to get all fiat wallets with their description

Response

Returns a FiatVaultUserListResult

Arguments
Name Description
userIdsOnly - [String] User ids
assetsOnly - [String] Assets
vaultIdsOnly - [String] Wallet ids
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getFiatVaults(
  $userIdsOnly: [String],
  $assetsOnly: [String],
  $vaultIdsOnly: [String],
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getFiatVaults(
    userIdsOnly: $userIdsOnly,
    assetsOnly: $assetsOnly,
    vaultIdsOnly: $vaultIdsOnly,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...FiatVaultUserFragment
    }
  }
}
Variables
{
  "userIdsOnly": ["xyz789"],
  "assetsOnly": ["xyz789"],
  "vaultIdsOnly": ["abc123"],
  "skip": 123,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getFiatVaults": {
      "count": 987,
      "list": [FiatVaultUser]
    }
  }
}
Queries

getNotifications

Description

Get notifications

Response

Returns a UserNotificationListResult

Arguments
Name Description
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getNotifications(
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getNotifications(
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...UserNotificationFragment
    }
  }
}
Variables
{
  "filter": "abc123",
  "skip": 987,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getNotifications": {
      "count": 987,
      "list": [UserNotification]
    }
  }
}
Queries

getNotificationsByUser

Description

Get user notifications

Response

Returns a UserNotificationListResult

Arguments
Name Description
userId - String User id
unreadOnly - Boolean
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getNotificationsByUser(
  $userId: String,
  $unreadOnly: Boolean,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getNotificationsByUser(
    userId: $userId,
    unreadOnly: $unreadOnly,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...UserNotificationFragment
    }
  }
}
Variables
{
  "userId": "xyz789",
  "unreadOnly": false,
  "filter": "abc123",
  "skip": 987,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getNotificationsByUser": {
      "count": 987,
      "list": [UserNotification]
    }
  }
}
Queries

getOneToManyRates

Description

Get the rate of one currency to many

Response

Returns [Rate!]

Arguments
Name Description
currencyFrom - String! Currency from
currenciesTo - [String!]! Currencies to
reverse - Boolean

Example

Query
query getOneToManyRates(
  $currencyFrom: String!,
  $currenciesTo: [String!]!,
  $reverse: Boolean
) {
  getOneToManyRates(
    currencyFrom: $currencyFrom,
    currenciesTo: $currenciesTo,
    reverse: $reverse
  ) {
    currencyFrom
    currencyTo
    originalRate
    depositRate
    withdrawRate
  }
}
Variables
{
  "currencyFrom": "abc123",
  "currenciesTo": ["xyz789"],
  "reverse": true
}
Response
{
  "data": {
    "getOneToManyRates": [
      {
        "currencyFrom": "xyz789",
        "currencyTo": "xyz789",
        "originalRate": 123.45,
        "depositRate": 987.65,
        "withdrawRate": 987.65
      }
    ]
  }
}
Queries

getOneToManyRatesMerchant

Description

Get the rate of one currency to many (using for liquidity provider functionality)

Response

Returns [Rate]

Arguments
Name Description
currencyFrom - String
currenciesTo - [String]
withFactor - Boolean

Example

Query
query getOneToManyRatesMerchant(
  $currencyFrom: String,
  $currenciesTo: [String],
  $withFactor: Boolean
) {
  getOneToManyRatesMerchant(
    currencyFrom: $currencyFrom,
    currenciesTo: $currenciesTo,
    withFactor: $withFactor
  ) {
    currencyFrom
    currencyTo
    originalRate
    depositRate
    withdrawRate
  }
}
Variables
{
  "currencyFrom": "xyz789",
  "currenciesTo": ["xyz789"],
  "withFactor": false
}
Response
{
  "data": {
    "getOneToManyRatesMerchant": [
      {
        "currencyFrom": "xyz789",
        "currencyTo": "abc123",
        "originalRate": 123.45,
        "depositRate": 123.45,
        "withdrawRate": 987.65
      }
    ]
  }
}
Queries

getPaymentProviders

Description

Get payment providers

Response

Returns [PaymentProvider!]

Example

Query
query getPaymentProviders {
  getPaymentProviders {
    paymentProviderId
    name
    currencies
    countriesCode2
    instruments
    default
    disabled
    displayName
    logo
  }
}
Response
{
  "data": {
    "getPaymentProviders": [
      {
        "paymentProviderId": "4",
        "name": "abc123",
        "currencies": ["abc123"],
        "countriesCode2": ["xyz789"],
        "instruments": ["xyz789"],
        "default": true,
        "disabled": "2007-12-03T10:15:30Z",
        "displayName": "xyz789",
        "logo": "xyz789"
      }
    ]
  }
}
Queries

getRates

Description

Get the exchange rate of several currencies to one

Response

Returns [Rate!]

Arguments
Name Description
currenciesFrom - [String!]! Currencies from
currencyTo - String! Currency to
recaptcha - String

Example

Query
query getRates(
  $currenciesFrom: [String!]!,
  $currencyTo: String!,
  $recaptcha: String
) {
  getRates(
    currenciesFrom: $currenciesFrom,
    currencyTo: $currencyTo,
    recaptcha: $recaptcha
  ) {
    currencyFrom
    currencyTo
    originalRate
    depositRate
    withdrawRate
  }
}
Variables
{
  "currenciesFrom": ["abc123"],
  "currencyTo": "abc123",
  "recaptcha": "abc123"
}
Response
{
  "data": {
    "getRates": [
      {
        "currencyFrom": "xyz789",
        "currencyTo": "xyz789",
        "originalRate": 987.65,
        "depositRate": 987.65,
        "withdrawRate": 123.45
      }
    ]
  }
}
Queries

getRiskAlerts

Response

Returns a RiskAlertResultList

Arguments
Name Description
userId - String
code - RiskAlertCodes
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getRiskAlerts(
  $userId: String,
  $code: RiskAlertCodes,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getRiskAlerts(
    userId: $userId,
    code: $code,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...RiskAlertFragment
    }
  }
}
Variables
{
  "userId": "abc123",
  "code": "USER_AGE",
  "filter": "xyz789",
  "skip": 123,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getRiskAlerts": {"count": 123, "list": [RiskAlert]}
  }
}
Queries

getRoles

Description

Get Roles

Response

Returns [UserRole!]

Example

Query
query getRoles {
  getRoles {
    userRoleId
    name
    code
    immutable
  }
}
Response
{
  "data": {
    "getRoles": [
      {
        "userRoleId": "abc123",
        "name": "abc123",
        "code": "abc123",
        "immutable": false
      }
    ]
  }
}
Queries

getSellAddress

Description

Get wallet address

Response

Returns a String

Arguments
Name Description
currency - String
amount - Float

Example

Query
query getSellAddress(
  $currency: String,
  $amount: Float
) {
  getSellAddress(
    currency: $currency,
    amount: $amount
  )
}
Variables
{"currency": "xyz789", "amount": 987.65}
Response
{"data": {"getSellAddress": "abc123"}}
Queries

getSettingsCommon

Description

Get common settings

Response

Returns a SettingsCommon

Example

Query
query getSettingsCommon {
  getSettingsCommon {
    settingsCommonId
    liquidityProvider
    mailProvider
    custodyProvider
    kycProvider
    kycBaseAddress
    adminEmails
    stoppedForServicing
    additionalSettings
    proxyLiquidityProviderUrl
    proxyLiquidityProviderApiSecret
    proxyLiquidityProviderApiKey
    proxyLiquidityProvider
    proxyLiquidityProviderTransactionChangedCallback
    textPages {
      ...TextPageFragment
    }
  }
}
Response
{
  "data": {
    "getSettingsCommon": {
      "settingsCommonId": "abc123",
      "liquidityProvider": "abc123",
      "mailProvider": "abc123",
      "custodyProvider": "abc123",
      "kycProvider": "abc123",
      "kycBaseAddress": "abc123",
      "adminEmails": ["xyz789"],
      "stoppedForServicing": false,
      "additionalSettings": "abc123",
      "proxyLiquidityProviderUrl": "abc123",
      "proxyLiquidityProviderApiSecret": "abc123",
      "proxyLiquidityProviderApiKey": "xyz789",
      "proxyLiquidityProvider": "abc123",
      "proxyLiquidityProviderTransactionChangedCallback": "abc123",
      "textPages": [TextPage]
    }
  }
}
Queries

getSettingsCost

Description

Get cost settings

Response

Returns a SettingsCostListResult

Arguments
Name Description
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getSettingsCost(
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getSettingsCost(
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...SettingsCostFragment
    }
  }
}
Variables
{
  "filter": "xyz789",
  "skip": 987,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getSettingsCost": {
      "count": 123,
      "list": [SettingsCost]
    }
  }
}
Queries

getSettingsCurrency

Description

Get currency settings

Response

Returns a SettingsCurrencyWithDefaults

Arguments
Name Description
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]
recaptcha - String!

Example

Query
query getSettingsCurrency(
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!],
  $recaptcha: String!
) {
  getSettingsCurrency(
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy,
    recaptcha: $recaptcha
  ) {
    settingsCurrency {
      ...SettingsCurrencyListResultFragment
    }
    defaultFiat
    defaultCrypto
  }
}
Variables
{
  "filter": "abc123",
  "skip": 987,
  "first": 987,
  "orderBy": [OrderBy],
  "recaptcha": "xyz789"
}
Response
{
  "data": {
    "getSettingsCurrency": {
      "settingsCurrency": SettingsCurrencyListResult,
      "defaultFiat": "xyz789",
      "defaultCrypto": "abc123"
    }
  }
}
Queries

getSettingsFee

Description

Get fee settings

Response

Returns a SettingsFeeListResult

Arguments
Name Description
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getSettingsFee(
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getSettingsFee(
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...SettingsFeeFragment
    }
  }
}
Variables
{
  "filter": "xyz789",
  "skip": 987,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getSettingsFee": {
      "count": 123,
      "list": [SettingsFee]
    }
  }
}
Queries

getSettingsKyc

Description

Get KYC settings

Response

Returns a SettingsKycListResult

Arguments
Name Description
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getSettingsKyc(
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getSettingsKyc(
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...SettingsKycFragment
    }
  }
}
Variables
{
  "filter": "abc123",
  "skip": 987,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getSettingsKyc": {
      "count": 123,
      "list": [SettingsKyc]
    }
  }
}
Queries

getSettingsKycLevels

Response

Returns a SettingsKycLevelListResult

Arguments
Name Description
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getSettingsKycLevels(
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getSettingsKycLevels(
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...SettingsKycLevelFragment
    }
  }
}
Variables
{
  "filter": "xyz789",
  "skip": 987,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getSettingsKycLevels": {
      "count": 123,
      "list": [SettingsKycLevel]
    }
  }
}
Queries

getSettingsKycTiers

Description

Get KYC levels settings

Response

Returns a SettingsKycTierListResult

Arguments
Name Description
userId - String User id
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getSettingsKycTiers(
  $userId: String,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getSettingsKycTiers(
    userId: $userId,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...SettingsKycTierFragment
    }
  }
}
Variables
{
  "userId": "xyz789",
  "filter": "abc123",
  "skip": 987,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getSettingsKycTiers": {
      "count": 987,
      "list": [SettingsKycTier]
    }
  }
}
Queries

getSupportTickets

Description

Get support tickets

Response

Returns a SupportTicketListResult

Arguments
Name Description
userId - String User id
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getSupportTickets(
  $userId: String,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getSupportTickets(
    userId: $userId,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...SupportTicketFragment
    }
  }
}
Variables
{
  "userId": "xyz789",
  "filter": "xyz789",
  "skip": 987,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getSupportTickets": {
      "count": 987,
      "list": [SupportTicket]
    }
  }
}
Queries

getSystemBalanceMany

Description

Get system balance

Response

Returns a String

Example

Query
query getSystemBalanceMany {
  getSystemBalanceMany
}
Response
{"data": {"getSystemBalanceMany": "xyz789"}}
Queries

getTextPages

Description

Get common settings

Response

Returns [TextPage]

Example

Query
query getTextPages {
  getTextPages {
    page
    text
  }
}
Response
{
  "data": {
    "getTextPages": [
      {"page": 987, "text": "xyz789"}
    ]
  }
}
Queries

getTransactionStatusHistory

Description

Get transaction history with filters

Response

Returns a TransactionStatusHistoryListResult!

Arguments
Name Description
transactionId - String Transaction id
userId - String User id
statusesOnly - [String!] Statuses only
createdDateInterval - DateTimeInterval Created within the interval only
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getTransactionStatusHistory(
  $transactionId: String,
  $userId: String,
  $statusesOnly: [String!],
  $createdDateInterval: DateTimeInterval,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getTransactionStatusHistory(
    transactionId: $transactionId,
    userId: $userId,
    statusesOnly: $statusesOnly,
    createdDateInterval: $createdDateInterval,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...TransactionStatusHistoryFragment
    }
  }
}
Variables
{
  "transactionId": "xyz789",
  "userId": "abc123",
  "statusesOnly": ["abc123"],
  "createdDateInterval": DateTimeInterval,
  "filter": "xyz789",
  "skip": 123,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getTransactionStatusHistory": {
      "count": 123,
      "list": [TransactionStatusHistory]
    }
  }
}
Queries

getTransactionStatuses

Description

This endpoint can be used to get all transaction statuses with their description

Response

Returns [TransactionStatusDescriptorMap!]

Example

Query
query getTransactionStatuses {
  getTransactionStatuses {
    key
    value {
      ...TransactionStatusDescriptorFragment
    }
  }
}
Response
{
  "data": {
    "getTransactionStatuses": [
      {"key": "New", "value": TransactionStatusDescriptor}
    ]
  }
}
Queries

getTransactions

Description

This endpoint can be used to get all transactions with their description.

Response

Returns a TransactionListResult

Arguments
Name Description
transactionIdsOnly - [String!] Transaction ids
transactionStatusesOnly - [String!] Transaction Statuses
userIdsOnly - [String!] User ids
widgetIdsOnly - [String!] Widget ids
sourcesOnly - [TransactionSource!] transaction sources
countriesOnly - [String!] transaction countries
countryCodeType - CountryCodeType country code
accountTypesOnly - [UserType!] Account types
kycStatusesOnly - [TransactionKycStatus!] KYC statuses
transactionDateOnly - DateTime Transaction dates
transactionTypesOnly - [TransactionType!] Transaction types
sendersOrReceiversOnly - [String!] Transactions senders or receivers
paymentProvidersOnly - [String!] Transaction payment providers
accountStatusesOnly - [String!] Account statuses
userTierLevelsOnly - [String!] User tier levels for the filter
riskLevelsOnly - [String!] Risk levels for the filter
paymentInstrumentsOnly - [PaymentInstrument!] Transactions payment instruments
createdDateInterval - DateTimeInterval transaction creation date
updateDateInterval - DateTimeInterval transaction update date interval
completedDateInterval - DateTimeInterval transaction completed date
walletAddressOnly - String Wallet address
verifyWhenPaid - Boolean Verify when paid
accountModesOnly - [UserMode] User's mode
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getTransactions(
  $transactionIdsOnly: [String!],
  $transactionStatusesOnly: [String!],
  $userIdsOnly: [String!],
  $widgetIdsOnly: [String!],
  $sourcesOnly: [TransactionSource!],
  $countriesOnly: [String!],
  $countryCodeType: CountryCodeType,
  $accountTypesOnly: [UserType!],
  $kycStatusesOnly: [TransactionKycStatus!],
  $transactionDateOnly: DateTime,
  $transactionTypesOnly: [TransactionType!],
  $sendersOrReceiversOnly: [String!],
  $paymentProvidersOnly: [String!],
  $accountStatusesOnly: [String!],
  $userTierLevelsOnly: [String!],
  $riskLevelsOnly: [String!],
  $paymentInstrumentsOnly: [PaymentInstrument!],
  $createdDateInterval: DateTimeInterval,
  $updateDateInterval: DateTimeInterval,
  $completedDateInterval: DateTimeInterval,
  $walletAddressOnly: String,
  $verifyWhenPaid: Boolean,
  $accountModesOnly: [UserMode],
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getTransactions(
    transactionIdsOnly: $transactionIdsOnly,
    transactionStatusesOnly: $transactionStatusesOnly,
    userIdsOnly: $userIdsOnly,
    widgetIdsOnly: $widgetIdsOnly,
    sourcesOnly: $sourcesOnly,
    countriesOnly: $countriesOnly,
    countryCodeType: $countryCodeType,
    accountTypesOnly: $accountTypesOnly,
    kycStatusesOnly: $kycStatusesOnly,
    transactionDateOnly: $transactionDateOnly,
    transactionTypesOnly: $transactionTypesOnly,
    sendersOrReceiversOnly: $sendersOrReceiversOnly,
    paymentProvidersOnly: $paymentProvidersOnly,
    accountStatusesOnly: $accountStatusesOnly,
    userTierLevelsOnly: $userTierLevelsOnly,
    riskLevelsOnly: $riskLevelsOnly,
    paymentInstrumentsOnly: $paymentInstrumentsOnly,
    createdDateInterval: $createdDateInterval,
    updateDateInterval: $updateDateInterval,
    completedDateInterval: $completedDateInterval,
    walletAddressOnly: $walletAddressOnly,
    verifyWhenPaid: $verifyWhenPaid,
    accountModesOnly: $accountModesOnly,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...TransactionFragment
    }
  }
}
Variables
{
  "transactionIdsOnly": ["xyz789"],
  "transactionStatusesOnly": ["abc123"],
  "userIdsOnly": ["abc123"],
  "widgetIdsOnly": ["xyz789"],
  "sourcesOnly": ["QuickCheckout"],
  "countriesOnly": ["xyz789"],
  "countryCodeType": "code2",
  "accountTypesOnly": ["Merchant"],
  "kycStatusesOnly": ["KycWaiting"],
  "transactionDateOnly": "2007-12-03T10:15:30Z",
  "transactionTypesOnly": ["Buy"],
  "sendersOrReceiversOnly": ["abc123"],
  "paymentProvidersOnly": ["abc123"],
  "accountStatusesOnly": ["xyz789"],
  "userTierLevelsOnly": ["xyz789"],
  "riskLevelsOnly": ["abc123"],
  "paymentInstrumentsOnly": ["CreditCard"],
  "createdDateInterval": DateTimeInterval,
  "updateDateInterval": DateTimeInterval,
  "completedDateInterval": DateTimeInterval,
  "walletAddressOnly": "abc123",
  "verifyWhenPaid": true,
  "accountModesOnly": ["InternalWallet"],
  "filter": "abc123",
  "skip": 123,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getTransactions": {
      "count": 987,
      "list": [Transaction]
    }
  }
}
Queries

getUserActions

Description

Get user actions with filters

Response

Returns a UserActionListResult!

Arguments
Name Description
userId - String User id
resultsOnly - [UserActionResult!] User action result only
statusesOnly - [String!] Statuses only
actionTypesOnly - [UserActionType!] User action types only
createdDateInterval - DateTimeInterval Created within the interval only
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getUserActions(
  $userId: String,
  $resultsOnly: [UserActionResult!],
  $statusesOnly: [String!],
  $actionTypesOnly: [UserActionType!],
  $createdDateInterval: DateTimeInterval,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getUserActions(
    userId: $userId,
    resultsOnly: $resultsOnly,
    statusesOnly: $statusesOnly,
    actionTypesOnly: $actionTypesOnly,
    createdDateInterval: $createdDateInterval,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...UserActionFragment
    }
  }
}
Variables
{
  "userId": "abc123",
  "resultsOnly": ["unknown"],
  "statusesOnly": ["abc123"],
  "actionTypesOnly": ["signup"],
  "createdDateInterval": DateTimeInterval,
  "filter": "abc123",
  "skip": 987,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getUserActions": {"count": 123, "list": [UserAction]}
  }
}
Queries

getUserBalanceHistory

Description

Get balance history with filters

Response

Returns a UserBalanceHistoryRecordListResult!

Arguments
Name Description
userId - String User id
asset - String Asset
period - UserBalanceHistoryPeriod Balance history period
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getUserBalanceHistory(
  $userId: String,
  $asset: String,
  $period: UserBalanceHistoryPeriod,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getUserBalanceHistory(
    userId: $userId,
    asset: $asset,
    period: $period,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...UserBalanceHistoryRecordFragment
    }
  }
}
Variables
{
  "userId": "xyz789",
  "asset": "xyz789",
  "period": "LastWeek",
  "filter": "xyz789",
  "skip": 987,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getUserBalanceHistory": {
      "count": 987,
      "list": [UserBalanceHistoryRecord]
    }
  }
}
Queries

getUserBankAccounts

Description

Get bank accounts for selected user

Response

Returns a UserContactListResult!

Arguments
Name Description
userId - String User id
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getUserBankAccounts(
  $userId: String,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getUserBankAccounts(
    userId: $userId,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...UserContactFragment
    }
  }
}
Variables
{
  "userId": "abc123",
  "filter": "abc123",
  "skip": 987,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getUserBankAccounts": {
      "count": 123,
      "list": [UserContact]
    }
  }
}
Queries

getUserContacts

Description

Get contacts for selected user

Response

Returns a UserContactListResult!

Arguments
Name Description
userId - String User id
assetIds - [String!] Asset ids
contactEmails - [String!] Contact email addresses
contactDisplayNames - [String!] contact display names
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getUserContacts(
  $userId: String,
  $assetIds: [String!],
  $contactEmails: [String!],
  $contactDisplayNames: [String!],
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getUserContacts(
    userId: $userId,
    assetIds: $assetIds,
    contactEmails: $contactEmails,
    contactDisplayNames: $contactDisplayNames,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...UserContactFragment
    }
  }
}
Variables
{
  "userId": "xyz789",
  "assetIds": ["abc123"],
  "contactEmails": ["xyz789"],
  "contactDisplayNames": ["xyz789"],
  "filter": "abc123",
  "skip": 123,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getUserContacts": {
      "count": 123,
      "list": [UserContact]
    }
  }
}
Queries

getUserKycInfo

Description

Get KYC information for selected user

Response

Returns a KycInfo

Arguments
Name Description
userId - String User id

Example

Query
query getUserKycInfo($userId: String) {
  getUserKycInfo(userId: $userId) {
    applicant {
      ...KycApplicantFragment
    }
    levelName
    appliedDocuments {
      ...KycAppliedDocumentFragment
    }
    requiredInfo {
      ...KycRequiredInfoFragment
    }
  }
}
Variables
{"userId": "xyz789"}
Response
{
  "data": {
    "getUserKycInfo": {
      "applicant": KycApplicant,
      "levelName": "abc123",
      "appliedDocuments": [KycAppliedDocument],
      "requiredInfo": KycRequiredInfo
    }
  }
}
Queries

getUserState

Description

Get state for the selected user

Response

Returns a UserState!

Arguments
Name Description
userId - String User id
options - UserStateInput UserStateInput

Example

Query
query getUserState(
  $userId: String,
  $options: UserStateInput
) {
  getUserState(
    userId: $userId,
    options: $options
  ) {
    date
    kycProviderLink
    totalAmountEur
    transactionSummary {
      ...UserTransactionSummaryFragment
    }
    vaults {
      ...VaultAccountExFragment
    }
    fiatVaults {
      ...FiatVaultFragment
    }
    externalWallets {
      ...ExternalWalletFragment
    }
    notifications {
      ...UserNotificationListResultFragment
    }
  }
}
Variables
{
  "userId": "abc123",
  "options": UserStateInput
}
Response
{
  "data": {
    "getUserState": {
      "date": "2007-12-03T10:15:30Z",
      "kycProviderLink": "xyz789",
      "totalAmountEur": 987.65,
      "transactionSummary": [UserTransactionSummary],
      "vaults": [VaultAccountEx],
      "fiatVaults": [FiatVault],
      "externalWallets": [ExternalWallet],
      "notifications": UserNotificationListResult
    }
  }
}
Queries

getUsers

Description

Get users by parameters

Response

Returns a UserListResult!

Arguments
Name Description
userIdsOnly - [String!] User ids
roleIdsOnly - [String!] Role ids
accountTypesOnly - [UserType!] Account types
accountModesOnly - [UserMode!] Account modes
accountStatusesOnly - [AccountStatus!] Account statuses
userTierLevelsOnly - [String!] User tier levels
riskLevelsOnly - [RiskLevel!] Rist levels
countriesOnly - [String!] Countries
countryCodeType - CountryCodeType Country code
kycStatusesOnly - [KycStatus!] KYC statuses
registrationDateInterval - DateTimeInterval registration date interval
widgetIdsOnly - [String!] Widget ids
totalBuyVolumeOver - Int total purchase over
transactionCountOver - Int Transaction count
verifyWhenPaid - Boolean Verify when paid
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getUsers(
  $userIdsOnly: [String!],
  $roleIdsOnly: [String!],
  $accountTypesOnly: [UserType!],
  $accountModesOnly: [UserMode!],
  $accountStatusesOnly: [AccountStatus!],
  $userTierLevelsOnly: [String!],
  $riskLevelsOnly: [RiskLevel!],
  $countriesOnly: [String!],
  $countryCodeType: CountryCodeType,
  $kycStatusesOnly: [KycStatus!],
  $registrationDateInterval: DateTimeInterval,
  $widgetIdsOnly: [String!],
  $totalBuyVolumeOver: Int,
  $transactionCountOver: Int,
  $verifyWhenPaid: Boolean,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getUsers(
    userIdsOnly: $userIdsOnly,
    roleIdsOnly: $roleIdsOnly,
    accountTypesOnly: $accountTypesOnly,
    accountModesOnly: $accountModesOnly,
    accountStatusesOnly: $accountStatusesOnly,
    userTierLevelsOnly: $userTierLevelsOnly,
    riskLevelsOnly: $riskLevelsOnly,
    countriesOnly: $countriesOnly,
    countryCodeType: $countryCodeType,
    kycStatusesOnly: $kycStatusesOnly,
    registrationDateInterval: $registrationDateInterval,
    widgetIdsOnly: $widgetIdsOnly,
    totalBuyVolumeOver: $totalBuyVolumeOver,
    transactionCountOver: $transactionCountOver,
    verifyWhenPaid: $verifyWhenPaid,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...UserFragment
    }
  }
}
Variables
{
  "userIdsOnly": ["abc123"],
  "roleIdsOnly": ["xyz789"],
  "accountTypesOnly": ["Merchant"],
  "accountModesOnly": ["InternalWallet"],
  "accountStatusesOnly": ["Live"],
  "userTierLevelsOnly": ["xyz789"],
  "riskLevelsOnly": ["Low"],
  "countriesOnly": ["xyz789"],
  "countryCodeType": "code2",
  "kycStatusesOnly": ["unknown"],
  "registrationDateInterval": DateTimeInterval,
  "widgetIdsOnly": ["abc123"],
  "totalBuyVolumeOver": 987,
  "transactionCountOver": 123,
  "verifyWhenPaid": false,
  "filter": "abc123",
  "skip": 123,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{"data": {"getUsers": {"count": 123, "list": [User]}}}
Queries

getWallets

Description

This endpoint can be used to get all wallets with their description.

Response

Returns an AssetAddressListResult

Arguments
Name Description
walletIdsOnly - [String!] Wallet ids
userIdsOnly - [String!] User ids
assetIdsOnly - [String!] Asset ids
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getWallets(
  $walletIdsOnly: [String!],
  $userIdsOnly: [String!],
  $assetIdsOnly: [String!],
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getWallets(
    walletIdsOnly: $walletIdsOnly,
    userIdsOnly: $userIdsOnly,
    assetIdsOnly: $assetIdsOnly,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...AssetAddressFragment
    }
  }
}
Variables
{
  "walletIdsOnly": ["abc123"],
  "userIdsOnly": ["abc123"],
  "assetIdsOnly": ["xyz789"],
  "filter": "xyz789",
  "skip": 987,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getWallets": {"count": 987, "list": [AssetAddress]}
  }
}
Queries

getWidget

Description

This endpoint can be used to get a widget by id

Response

Returns a Widget

Arguments
Name Description
id - String! Widget id
recaptcha - String!

Example

Query
query getWidget(
  $id: String!,
  $recaptcha: String!
) {
  getWidget(
    id: $id,
    recaptcha: $recaptcha
  ) {
    widgetId
    code
    userId
    userCode
    name
    description
    created
    createdBy
    createdByUser {
      ...UserFragment
    }
    transactionTypes
    currenciesCrypto
    currenciesFiat
    destinationAddress
    countriesCode2
    instruments
    paymentProviders
    liquidityProvider
    additionalSettings
    currentUserEmail
    currentUserParams
    hasFixedAddress
    secret
  }
}
Variables
{
  "id": "abc123",
  "recaptcha": "abc123"
}
Response
{
  "data": {
    "getWidget": {
      "widgetId": "4",
      "code": "xyz789",
      "userId": "xyz789",
      "userCode": "abc123",
      "name": "xyz789",
      "description": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "xyz789",
      "createdByUser": User,
      "transactionTypes": ["Buy"],
      "currenciesCrypto": ["abc123"],
      "currenciesFiat": ["abc123"],
      "destinationAddress": "abc123",
      "countriesCode2": ["xyz789"],
      "instruments": ["CreditCard"],
      "paymentProviders": ["xyz789"],
      "liquidityProvider": "Bitstamp",
      "additionalSettings": "xyz789",
      "currentUserEmail": "xyz789",
      "currentUserParams": "xyz789",
      "hasFixedAddress": false,
      "secret": "xyz789"
    }
  }
}
Queries

getWidgets

Description

This endpoint can be used to get all widgets.

Response

Returns a WidgetListResult

Arguments
Name Description
widgetIdsOnly - [String!] Widget ids
userIdsOnly - [String!] User ids
name - String name
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getWidgets(
  $widgetIdsOnly: [String!],
  $userIdsOnly: [String!],
  $name: String,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getWidgets(
    widgetIdsOnly: $widgetIdsOnly,
    userIdsOnly: $userIdsOnly,
    name: $name,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...WidgetFragment
    }
  }
}
Variables
{
  "widgetIdsOnly": ["xyz789"],
  "userIdsOnly": ["xyz789"],
  "name": "xyz789",
  "filter": "xyz789",
  "skip": 123,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{"data": {"getWidgets": {"count": 123, "list": [Widget]}}}
Queries

getWidgetsByUser

Description

This endpoint can be used to get all widgets for the selected user.

Response

Returns a WidgetListResult

Arguments
Name Description
userId - String User id
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getWidgetsByUser(
  $userId: String,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getWidgetsByUser(
    userId: $userId,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...WidgetFragment
    }
  }
}
Variables
{
  "userId": "xyz789",
  "filter": "xyz789",
  "skip": 123,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getWidgetsByUser": {"count": 123, "list": [Widget]}
  }
}
Queries

getWireTransferBankAccounts

Description

API token generation

Response

Returns a WireTransferBankAccountListResult

Arguments
Name Description
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query getWireTransferBankAccounts(
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  getWireTransferBankAccounts(
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...WireTransferBankAccountFragment
    }
  }
}
Variables
{
  "filter": "xyz789",
  "skip": 123,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "getWireTransferBankAccounts": {
      "count": 987,
      "list": [WireTransferBankAccount]
    }
  }
}
Queries

me

Response

Returns a User!

Example

Query
query me {
  me {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Response
{
  "data": {
    "me": {
      "userId": "4",
      "email": "xyz789",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["abc123"],
      "firstName": "xyz789",
      "lastName": "abc123",
      "avatar": "xyz789",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "xyz789",
      "countryCode3": "abc123",
      "postCode": "abc123",
      "town": "abc123",
      "street": "xyz789",
      "subStreet": "xyz789",
      "stateName": "abc123",
      "buildingName": "abc123",
      "buildingNumber": "xyz789",
      "flatNumber": "abc123",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "xyz789",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 987,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": false,
      "changePasswordRequired": true,
      "referralCode": 123,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "abc123",
      "kycTierId": "abc123",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "abc123",
      "kycValid": true,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "abc123",
      "kycPrivateComment": "abc123",
      "kycReviewRejectedType": "xyz789",
      "kycReviewRejectedLabels": ["abc123"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": true,
      "kycDocs": ["xyz789"],
      "custodyProvider": "xyz789",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "xyz789",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "riskAlertCount": 123,
      "widgetId": "xyz789",
      "widgetCode": "xyz789",
      "affiliateId": "xyz789",
      "affiliateCode": "xyz789",
      "totalDepositCompleted": 123.45,
      "totalDepositCompletedCount": 123,
      "totalDepositInProcess": 123.45,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 123.45,
      "totalWithdrawalCompletedCount": 987,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 987,
      "totalBoughtCompleted": 123.45,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 123.45,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 123.45,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 987.65,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 123.45,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 123.45,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 987.65,
      "totalReceivedCompletedCount": 123,
      "totalReceivedInProcess": 123.45,
      "totalReceivedInProcessCount": 123,
      "totalTransactionCount": 987,
      "avarageTransaction": 123.45,
      "manuallyEditedRisk": true,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "xyz789",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "xyz789",
      "openpaydAccountHolderId": "xyz789"
    }
  }
}
Queries

myActions

Description

Get my actions with filters

Response

Returns a UserActionListResult!

Arguments
Name Description
withResult - UserActionResult
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query myActions(
  $withResult: UserActionResult,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  myActions(
    withResult: $withResult,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...UserActionFragment
    }
  }
}
Variables
{
  "withResult": "unknown",
  "filter": "abc123",
  "skip": 987,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "myActions": {"count": 123, "list": [UserAction]}
  }
}
Queries

myApiKeys

Description

Get API keys for current user

Response

Returns an ApiKeyListResult

Arguments
Name Description
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query myApiKeys(
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  myApiKeys(
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...ApiKeyFragment
    }
  }
}
Variables
{
  "filter": "abc123",
  "skip": 987,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{"data": {"myApiKeys": {"count": 987, "list": [ApiKey]}}}
Queries

myBalanceHistory

Description

Get my balance history with filters

Response

Returns a UserBalanceHistoryRecordListResult!

Arguments
Name Description
asset - String Asset
period - UserBalanceHistoryPeriod Balance history period
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query myBalanceHistory(
  $asset: String,
  $period: UserBalanceHistoryPeriod,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  myBalanceHistory(
    asset: $asset,
    period: $period,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...UserBalanceHistoryRecordFragment
    }
  }
}
Variables
{
  "asset": "abc123",
  "period": "LastWeek",
  "filter": "xyz789",
  "skip": 987,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "myBalanceHistory": {
      "count": 123,
      "list": [UserBalanceHistoryRecord]
    }
  }
}
Queries

myBankAccounts

Description

Get bank accounts for current user

Response

Returns a UserContactListResult!

Arguments
Name Description
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query myBankAccounts(
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  myBankAccounts(
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...UserContactFragment
    }
  }
}
Variables
{
  "filter": "xyz789",
  "skip": 987,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "myBankAccounts": {
      "count": 987,
      "list": [UserContact]
    }
  }
}
Queries

myContacts

Description

Get contacts for current user

Response

Returns a UserContactListResult!

Arguments
Name Description
assetIds - [String!] Asset ids
contactEmails - [String!] Contact email addresses
contactDisplayNames - [String!] contact display names
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query myContacts(
  $assetIds: [String!],
  $contactEmails: [String!],
  $contactDisplayNames: [String!],
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  myContacts(
    assetIds: $assetIds,
    contactEmails: $contactEmails,
    contactDisplayNames: $contactDisplayNames,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...UserContactFragment
    }
  }
}
Variables
{
  "assetIds": ["abc123"],
  "contactEmails": ["abc123"],
  "contactDisplayNames": ["abc123"],
  "filter": "xyz789",
  "skip": 987,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "myContacts": {"count": 123, "list": [UserContact]}
  }
}
Queries

myDevices

Response

Returns a UserDeviceListResult

Example

Query
query myDevices {
  myDevices {
    count
    list {
      ...UserDeviceFragment
    }
  }
}
Response
{
  "data": {
    "myDevices": {"count": 123, "list": [UserDevice]}
  }
}
Queries

myFiatVaults

Description

This endpoint can be used to get all fiat wallets for the current user

Response

Returns a FiatVaultListResult

Arguments
Name Description
assetsOnly - [String] Assets
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query myFiatVaults(
  $assetsOnly: [String],
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  myFiatVaults(
    assetsOnly: $assetsOnly,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...FiatVaultFragment
    }
  }
}
Variables
{
  "assetsOnly": ["xyz789"],
  "skip": 123,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "myFiatVaults": {"count": 987, "list": [FiatVault]}
  }
}
Queries

myKycInfo

Description

Get KYC information for current user

Response

Returns a KycInfo

Example

Query
query myKycInfo {
  myKycInfo {
    applicant {
      ...KycApplicantFragment
    }
    levelName
    appliedDocuments {
      ...KycAppliedDocumentFragment
    }
    requiredInfo {
      ...KycRequiredInfoFragment
    }
  }
}
Response
{
  "data": {
    "myKycInfo": {
      "applicant": KycApplicant,
      "levelName": "abc123",
      "appliedDocuments": [KycAppliedDocument],
      "requiredInfo": KycRequiredInfo
    }
  }
}
Queries

myKycStatus

Response

Returns a String!

Example

Query
query myKycStatus {
  myKycStatus
}
Response
{"data": {"myKycStatus": "xyz789"}}
Queries

myNotifications

Description

Get notifications for current user

Response

Returns a UserNotificationListResult

Arguments
Name Description
unreadOnly - Boolean
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query myNotifications(
  $unreadOnly: Boolean,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  myNotifications(
    unreadOnly: $unreadOnly,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...UserNotificationFragment
    }
  }
}
Variables
{
  "unreadOnly": true,
  "filter": "abc123",
  "skip": 987,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "myNotifications": {
      "count": 987,
      "list": [UserNotification]
    }
  }
}
Queries

myProfit

Description

Transaction history for the current user

Response

Returns a UserProfit!

Arguments
Name Description
options - UserProfitInput UserProfitInput

Example

Query
query myProfit($options: UserProfitInput) {
  myProfit(options: $options) {
    userId
    currencyTo
    period
    profits {
      ...UserCurrencyProfitFragment
    }
  }
}
Variables
{"options": UserProfitInput}
Response
{
  "data": {
    "myProfit": {
      "userId": "xyz789",
      "currencyTo": "xyz789",
      "period": "LastWeek",
      "profits": [UserCurrencyProfit]
    }
  }
}
Queries

mySettingsCost

Description

Get cost settings for the current user

Response

Returns a SettingsCostShort

Arguments
Name Description
transactionType - TransactionType! Transaction type
instrument - PaymentInstrument! PaymentInstrument
paymentProvider - String Payment provider
currency - String Currency

Example

Query
query mySettingsCost(
  $transactionType: TransactionType!,
  $instrument: PaymentInstrument!,
  $paymentProvider: String,
  $currency: String
) {
  mySettingsCost(
    transactionType: $transactionType,
    instrument: $instrument,
    paymentProvider: $paymentProvider,
    currency: $currency
  ) {
    terms
    bankAccounts {
      ...WireTransferBankAccountShortFragment
    }
  }
}
Variables
{
  "transactionType": "Buy",
  "instrument": "CreditCard",
  "paymentProvider": "xyz789",
  "currency": "abc123"
}
Response
{
  "data": {
    "mySettingsCost": {
      "terms": "xyz789",
      "bankAccounts": [WireTransferBankAccountShort]
    }
  }
}
Queries

mySettingsFee

Description

Get fee settings for the current user(SettingsFeeShort)

Response

Returns a SettingsFeeShort

Arguments
Name Description
transactionType - TransactionType! Transaction type
transactionSource - TransactionSource! Transaction source
instrument - PaymentInstrument! Instrument
paymentProvider - String Payment provider
currencyTo - String CurrencyTo
currencyFrom - String CurrencyFrom
widgetId - String Widget id

Example

Query
query mySettingsFee(
  $transactionType: TransactionType!,
  $transactionSource: TransactionSource!,
  $instrument: PaymentInstrument!,
  $paymentProvider: String,
  $currencyTo: String,
  $currencyFrom: String,
  $widgetId: String
) {
  mySettingsFee(
    transactionType: $transactionType,
    transactionSource: $transactionSource,
    instrument: $instrument,
    paymentProvider: $paymentProvider,
    currencyTo: $currencyTo,
    currencyFrom: $currencyFrom,
    widgetId: $widgetId
  ) {
    terms
    wireDetails
    currency
    rateToEur
    costs {
      ...SettingsCostShortFragment
    }
    requiredFields
  }
}
Variables
{
  "transactionType": "Buy",
  "transactionSource": "QuickCheckout",
  "instrument": "CreditCard",
  "paymentProvider": "abc123",
  "currencyTo": "xyz789",
  "currencyFrom": "xyz789",
  "widgetId": "abc123"
}
Response
{
  "data": {
    "mySettingsFee": {
      "terms": "xyz789",
      "wireDetails": "xyz789",
      "currency": "xyz789",
      "rateToEur": 987.65,
      "costs": [SettingsCostShort],
      "requiredFields": ["abc123"]
    }
  }
}
Queries

mySettingsFeeFull

Description

Get fee settings for the current user

Response

Returns a SettingsFee

Arguments
Name Description
transactionType - TransactionType! Transaction type
transactionSource - TransactionSource! Transaction source
instrument - PaymentInstrument! Instrument
paymentProvider - String Payment provider
currency - String Currency
widgetId - String Widget id

Example

Query
query mySettingsFeeFull(
  $transactionType: TransactionType!,
  $transactionSource: TransactionSource!,
  $instrument: PaymentInstrument!,
  $paymentProvider: String,
  $currency: String,
  $widgetId: String
) {
  mySettingsFeeFull(
    transactionType: $transactionType,
    transactionSource: $transactionSource,
    instrument: $instrument,
    paymentProvider: $paymentProvider,
    currency: $currency,
    widgetId: $widgetId
  ) {
    settingsFeeId
    name
    description
    targetFilterType
    targetFilterValues
    targetInstruments
    targetUserTypes
    targetUserModes
    targetTransactionTypes
    targetPaymentProviders
    terms
    wireDetails
    created
    createdBy
    default
    deleted
    currency
    rateToEur
    costs {
      ...SettingsCostFragment
    }
  }
}
Variables
{
  "transactionType": "Buy",
  "transactionSource": "QuickCheckout",
  "instrument": "CreditCard",
  "paymentProvider": "abc123",
  "currency": "xyz789",
  "widgetId": "abc123"
}
Response
{
  "data": {
    "mySettingsFeeFull": {
      "settingsFeeId": 4,
      "name": "xyz789",
      "description": "abc123",
      "targetFilterType": "None",
      "targetFilterValues": ["abc123"],
      "targetInstruments": ["xyz789"],
      "targetUserTypes": ["Merchant"],
      "targetUserModes": ["InternalWallet"],
      "targetTransactionTypes": ["xyz789"],
      "targetPaymentProviders": ["xyz789"],
      "terms": "abc123",
      "wireDetails": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "xyz789",
      "default": true,
      "deleted": "2007-12-03T10:15:30Z",
      "currency": "xyz789",
      "rateToEur": 987.65,
      "costs": [SettingsCost]
    }
  }
}
Queries

mySettingsKyc

Description

Get KYC settings for the current user(SettingsKycTierShort)

Response

Returns a SettingsKycShort

Example

Query
query mySettingsKyc {
  mySettingsKyc {
    requireUserFullName
    requireUserPhone
    requireUserBirthday
    requireUserAddress
    requireUserFlatNumber
    levels {
      ...SettingsKycLevelShortFragment
    }
  }
}
Response
{
  "data": {
    "mySettingsKyc": {
      "requireUserFullName": true,
      "requireUserPhone": false,
      "requireUserBirthday": true,
      "requireUserAddress": false,
      "requireUserFlatNumber": true,
      "levels": [SettingsKycLevelShort]
    }
  }
}
Queries

mySettingsKycFull

Description

Get KYC settings for the current user

Response

Returns a SettingsKyc

Example

Query
query mySettingsKycFull {
  mySettingsKycFull {
    settingsKycId
    name
    description
    targetKycProviders
    targetUserType
    targetUserModes
    targetFilterType
    targetFilterValues
    levels {
      ...SettingsKycLevelFragment
    }
    requireUserFullName
    requireUserPhone
    requireUserBirthday
    requireUserAddress
    requireUserFlatNumber
    created
    createdBy
    default
    deleted
  }
}
Response
{
  "data": {
    "mySettingsKycFull": {
      "settingsKycId": "4",
      "name": "abc123",
      "description": "abc123",
      "targetKycProviders": ["Local"],
      "targetUserType": "Merchant",
      "targetUserModes": ["InternalWallet"],
      "targetFilterType": "None",
      "targetFilterValues": ["abc123"],
      "levels": [SettingsKycLevel],
      "requireUserFullName": false,
      "requireUserPhone": false,
      "requireUserBirthday": false,
      "requireUserAddress": false,
      "requireUserFlatNumber": true,
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "default": true,
      "deleted": "2007-12-03T10:15:30Z"
    }
  }
}
Queries

mySettingsKycTier

Description

Get KYC levels settings for the current user(SettingsKycTierShort)

Response

Returns a SettingsKycTierShort

Example

Query
query mySettingsKycTier {
  mySettingsKycTier {
    name
    description
    amount
    requireUserFullName
    requireUserPhone
    requireUserBirthday
    requireUserAddress
    requireUserFlatNumber
  }
}
Response
{
  "data": {
    "mySettingsKycTier": {
      "name": "xyz789",
      "description": "xyz789",
      "amount": 987.65,
      "requireUserFullName": true,
      "requireUserPhone": true,
      "requireUserBirthday": false,
      "requireUserAddress": true,
      "requireUserFlatNumber": false
    }
  }
}
Queries

mySettingsKycTiers

Description

Get KYC levels settings for the current user

Response

Returns a SettingsKycTierShortExListResult

Arguments
Name Description
source - TransactionSource Source
widgetId - String Widget id

Example

Query
query mySettingsKycTiers(
  $source: TransactionSource,
  $widgetId: String
) {
  mySettingsKycTiers(
    source: $source,
    widgetId: $widgetId
  ) {
    count
    list {
      ...SettingsKycTierShortExFragment
    }
  }
}
Variables
{
  "source": "QuickCheckout",
  "widgetId": "xyz789"
}
Response
{
  "data": {
    "mySettingsKycTiers": {
      "count": 123,
      "list": [SettingsKycTierShortEx]
    }
  }
}
Queries

myState

Description

Get state for the current user

Response

Returns a UserState!

Arguments
Name Description
options - UserStateInput UserStateInput

Example

Query
query myState($options: UserStateInput) {
  myState(options: $options) {
    date
    kycProviderLink
    totalAmountEur
    transactionSummary {
      ...UserTransactionSummaryFragment
    }
    vaults {
      ...VaultAccountExFragment
    }
    fiatVaults {
      ...FiatVaultFragment
    }
    externalWallets {
      ...ExternalWalletFragment
    }
    notifications {
      ...UserNotificationListResultFragment
    }
  }
}
Variables
{"options": UserStateInput}
Response
{
  "data": {
    "myState": {
      "date": "2007-12-03T10:15:30Z",
      "kycProviderLink": "xyz789",
      "totalAmountEur": 987.65,
      "transactionSummary": [UserTransactionSummary],
      "vaults": [VaultAccountEx],
      "fiatVaults": [FiatVault],
      "externalWallets": [ExternalWallet],
      "notifications": UserNotificationListResult
    }
  }
}
Queries

mySupportTickets

Description

Get support tickets for current user

Response

Returns a SupportTicketListResult

Arguments
Name Description
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query mySupportTickets(
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  mySupportTickets(
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...SupportTicketFragment
    }
  }
}
Variables
{
  "filter": "xyz789",
  "skip": 987,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "mySupportTickets": {
      "count": 123,
      "list": [SupportTicket]
    }
  }
}
Queries

myTransactions

Description

This endpoint can be used to get all transactions for current user.

Response

Returns a TransactionShortListResult

Arguments
Name Description
transactionIdsOnly - [String!] Transaction ids
sourcesOnly - [TransactionSource!] transaction sources
transactionDateOnly - DateTime Transaction dates
transactionTypesOnly - [TransactionType!] Transaction types
sendersOrReceiversOnly - [String!] Transactions senders or receivers
paymentProvidersOnly - [String!] Payment providers
walletAddressOnly - String Wallet addresses
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query myTransactions(
  $transactionIdsOnly: [String!],
  $sourcesOnly: [TransactionSource!],
  $transactionDateOnly: DateTime,
  $transactionTypesOnly: [TransactionType!],
  $sendersOrReceiversOnly: [String!],
  $paymentProvidersOnly: [String!],
  $walletAddressOnly: String,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  myTransactions(
    transactionIdsOnly: $transactionIdsOnly,
    sourcesOnly: $sourcesOnly,
    transactionDateOnly: $transactionDateOnly,
    transactionTypesOnly: $transactionTypesOnly,
    sendersOrReceiversOnly: $sendersOrReceiversOnly,
    paymentProvidersOnly: $paymentProvidersOnly,
    walletAddressOnly: $walletAddressOnly,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...TransactionShortFragment
    }
  }
}
Variables
{
  "transactionIdsOnly": ["abc123"],
  "sourcesOnly": ["QuickCheckout"],
  "transactionDateOnly": "2007-12-03T10:15:30Z",
  "transactionTypesOnly": ["Buy"],
  "sendersOrReceiversOnly": ["abc123"],
  "paymentProvidersOnly": ["xyz789"],
  "walletAddressOnly": "xyz789",
  "filter": "xyz789",
  "skip": 987,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "myTransactions": {
      "count": 987,
      "list": [TransactionShort]
    }
  }
}
Queries

myWallets

Description

This endpoint can be used to get all wallets of the current user with their description.

Response

Returns an AssetAddressShortListResult

Arguments
Name Description
assetIdsOnly - [String!] Asset ids
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query myWallets(
  $assetIdsOnly: [String!],
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  myWallets(
    assetIdsOnly: $assetIdsOnly,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...AssetAddressShortFragment
    }
  }
}
Variables
{
  "assetIdsOnly": ["abc123"],
  "filter": "xyz789",
  "skip": 987,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{
  "data": {
    "myWallets": {
      "count": 987,
      "list": [AssetAddressShort]
    }
  }
}
Queries

myWidgets

Description

This endpoint can be used to get all widgets for the current user.

Response

Returns a WidgetListResult

Arguments
Name Description
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
query myWidgets(
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  myWidgets(
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  ) {
    count
    list {
      ...WidgetFragment
    }
  }
}
Variables
{
  "filter": "xyz789",
  "skip": 123,
  "first": 123,
  "orderBy": [OrderBy]
}
Response
{"data": {"myWidgets": {"count": 123, "list": [Widget]}}}
Queries

serverTime

Response

Returns a String!

Example

Query
query serverTime {
  serverTime
}
Response
{"data": {"serverTime": "xyz789"}}
Queries

userByEmail

Description

Get user by email

Response

Returns a User!

Arguments
Name Description
email - String Email

Example

Query
query userByEmail($email: String) {
  userByEmail(email: $email) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"email": "abc123"}
Response
{
  "data": {
    "userByEmail": {
      "userId": 4,
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["abc123"],
      "firstName": "abc123",
      "lastName": "abc123",
      "avatar": "xyz789",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "xyz789",
      "countryCode3": "xyz789",
      "postCode": "xyz789",
      "town": "abc123",
      "street": "xyz789",
      "subStreet": "abc123",
      "stateName": "xyz789",
      "buildingName": "abc123",
      "buildingNumber": "xyz789",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": true,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 987,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": false,
      "changePasswordRequired": true,
      "referralCode": 123,
      "systemUser": true,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "abc123",
      "kycTierId": "abc123",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": false,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "xyz789",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": false,
      "kycDocs": ["abc123"],
      "custodyProvider": "xyz789",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "xyz789",
      "defaultCryptoCurrency": "abc123",
      "risk": "Low",
      "riskCodes": ["xyz789"],
      "riskAlertCount": 987,
      "widgetId": "abc123",
      "widgetCode": "xyz789",
      "affiliateId": "abc123",
      "affiliateCode": "xyz789",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 123,
      "totalDepositInProcess": 987.65,
      "totalDepositInProcessCount": 987,
      "totalWithdrawalCompleted": 123.45,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 987.65,
      "totalWithdrawalInProcessCount": 123,
      "totalBoughtCompleted": 123.45,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 987.65,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 123.45,
      "totalSoldCompletedCount": 123,
      "totalSoldInProcess": 987.65,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 987.65,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 987.65,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 123.45,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 123,
      "totalTransactionCount": 123,
      "avarageTransaction": 987.65,
      "manuallyEditedRisk": false,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "abc123",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "xyz789",
      "openpaydIds": "abc123",
      "openpaydAccountHolderId": "xyz789"
    }
  }
}
Queries

userById

Description

Get user by email

Response

Returns a User!

Arguments
Name Description
userId - String User id

Example

Query
query userById($userId: String) {
  userById(userId: $userId) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"userId": "abc123"}
Response
{
  "data": {
    "userById": {
      "userId": "4",
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["xyz789"],
      "firstName": "abc123",
      "lastName": "xyz789",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "abc123",
      "countryCode3": "abc123",
      "postCode": "xyz789",
      "town": "abc123",
      "street": "xyz789",
      "subStreet": "abc123",
      "stateName": "xyz789",
      "buildingName": "xyz789",
      "buildingNumber": "abc123",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "xyz789",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 123,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": true,
      "changePasswordRequired": true,
      "referralCode": 123,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "abc123",
      "kycTierId": "xyz789",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": false,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "abc123",
      "kycReviewRejectedLabels": ["abc123"],
      "kycReviewResult": "xyz789",
      "kycStatusUpdateRequired": true,
      "kycDocs": ["xyz789"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "abc123",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "riskAlertCount": 987,
      "widgetId": "abc123",
      "widgetCode": "xyz789",
      "affiliateId": "abc123",
      "affiliateCode": "xyz789",
      "totalDepositCompleted": 123.45,
      "totalDepositCompletedCount": 987,
      "totalDepositInProcess": 987.65,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 987,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 123,
      "totalBoughtCompleted": 123.45,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 987.65,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 123,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 123.45,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 987.65,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 123.45,
      "totalReceivedCompletedCount": 123,
      "totalReceivedInProcess": 123.45,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 987,
      "avarageTransaction": 987.65,
      "manuallyEditedRisk": true,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "xyz789",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "xyz789",
      "openpaydIds": "xyz789",
      "openpaydAccountHolderId": "abc123"
    }
  }
}
Queries

userByName

Description

Get user by name

Response

Returns a User!

Arguments
Name Description
name - String Name

Example

Query
query userByName($name: String) {
  userByName(name: $name) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"name": "xyz789"}
Response
{
  "data": {
    "userByName": {
      "userId": 4,
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["xyz789"],
      "firstName": "abc123",
      "lastName": "xyz789",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "abc123",
      "countryCode3": "abc123",
      "postCode": "xyz789",
      "town": "xyz789",
      "street": "xyz789",
      "subStreet": "abc123",
      "stateName": "abc123",
      "buildingName": "xyz789",
      "buildingNumber": "xyz789",
      "flatNumber": "abc123",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 123,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": false,
      "changePasswordRequired": false,
      "referralCode": 987,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "abc123",
      "kycTierId": "xyz789",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": true,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "abc123",
      "kycPrivateComment": "abc123",
      "kycReviewRejectedType": "xyz789",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "xyz789",
      "kycStatusUpdateRequired": false,
      "kycDocs": ["abc123"],
      "custodyProvider": "xyz789",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "abc123",
      "risk": "Low",
      "riskCodes": ["xyz789"],
      "riskAlertCount": 123,
      "widgetId": "xyz789",
      "widgetCode": "abc123",
      "affiliateId": "abc123",
      "affiliateCode": "xyz789",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 123,
      "totalDepositInProcess": 123.45,
      "totalDepositInProcessCount": 987,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 987,
      "totalBoughtCompleted": 123.45,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 987.65,
      "totalBoughtInProcessCount": 123,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 987.65,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 123.45,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 123.45,
      "totalReceivedCompletedCount": 123,
      "totalReceivedInProcess": 123.45,
      "totalReceivedInProcessCount": 123,
      "totalTransactionCount": 123,
      "avarageTransaction": 987.65,
      "manuallyEditedRisk": false,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "xyz789",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "xyz789",
      "openpaydAccountHolderId": "xyz789"
    }
  }
}
Queries

userByOAuthAppId

Description

Get user by OAuthAppId

Response

Returns a User!

Arguments
Name Description
oAuthProvider - OAuthProvider OAuthProvider
oAuthAppId - String oAuthAppId

Example

Query
query userByOAuthAppId(
  $oAuthProvider: OAuthProvider,
  $oAuthAppId: String
) {
  userByOAuthAppId(
    oAuthProvider: $oAuthProvider,
    oAuthAppId: $oAuthAppId
  ) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{
  "oAuthProvider": "google",
  "oAuthAppId": "xyz789"
}
Response
{
  "data": {
    "userByOAuthAppId": {
      "userId": 4,
      "email": "xyz789",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["abc123"],
      "firstName": "xyz789",
      "lastName": "xyz789",
      "avatar": "xyz789",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "xyz789",
      "countryCode3": "abc123",
      "postCode": "xyz789",
      "town": "xyz789",
      "street": "abc123",
      "subStreet": "abc123",
      "stateName": "abc123",
      "buildingName": "abc123",
      "buildingNumber": "abc123",
      "flatNumber": "abc123",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 987,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": false,
      "hasEmailAuth": false,
      "changePasswordRequired": false,
      "referralCode": 987,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "xyz789",
      "kycTierId": "abc123",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": true,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "abc123",
      "kycReviewRejectedType": "abc123",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": false,
      "kycDocs": ["xyz789"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "xyz789",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "riskAlertCount": 987,
      "widgetId": "abc123",
      "widgetCode": "abc123",
      "affiliateId": "abc123",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 123,
      "totalDepositInProcess": 987.65,
      "totalDepositInProcessCount": 987,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 987.65,
      "totalWithdrawalInProcessCount": 123,
      "totalBoughtCompleted": 987.65,
      "totalBoughtCompletedCount": 123,
      "totalBoughtInProcess": 987.65,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 123,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 123.45,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 123.45,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 123.45,
      "totalReceivedCompletedCount": 123,
      "totalReceivedInProcess": 123.45,
      "totalReceivedInProcessCount": 123,
      "totalTransactionCount": 987,
      "avarageTransaction": 123.45,
      "manuallyEditedRisk": false,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "abc123",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "xyz789",
      "openpaydIds": "xyz789",
      "openpaydAccountHolderId": "abc123"
    }
  }
}
Queries

userByReferralCode

Description

Get user by referral code

Response

Returns a User!

Arguments
Name Description
referralCode - Int Referral code

Example

Query
query userByReferralCode($referralCode: Int) {
  userByReferralCode(referralCode: $referralCode) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"referralCode": 987}
Response
{
  "data": {
    "userByReferralCode": {
      "userId": 4,
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["xyz789"],
      "firstName": "xyz789",
      "lastName": "abc123",
      "avatar": "xyz789",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "xyz789",
      "countryCode3": "abc123",
      "postCode": "xyz789",
      "town": "abc123",
      "street": "abc123",
      "subStreet": "xyz789",
      "stateName": "abc123",
      "buildingName": "abc123",
      "buildingNumber": "abc123",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "xyz789",
      "termsOfUse": true,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 987,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": false,
      "hasEmailAuth": false,
      "changePasswordRequired": false,
      "referralCode": 987,
      "systemUser": true,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "abc123",
      "kycTierId": "xyz789",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "abc123",
      "kycValid": false,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "xyz789",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "abc123",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "xyz789",
      "kycStatusUpdateRequired": false,
      "kycDocs": ["abc123"],
      "custodyProvider": "xyz789",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "xyz789",
      "defaultCryptoCurrency": "xyz789",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "riskAlertCount": 987,
      "widgetId": "xyz789",
      "widgetCode": "xyz789",
      "affiliateId": "xyz789",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 123.45,
      "totalDepositCompletedCount": 123,
      "totalDepositInProcess": 123.45,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 987.65,
      "totalWithdrawalInProcessCount": 123,
      "totalBoughtCompleted": 123.45,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 123.45,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 123.45,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 123,
      "totalSentCompleted": 987.65,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 123.45,
      "totalSentInProcessCount": 123,
      "totalReceivedCompleted": 987.65,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 987,
      "avarageTransaction": 987.65,
      "manuallyEditedRisk": false,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "abc123",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "abc123",
      "openpaydAccountHolderId": "abc123"
    }
  }
}
Queries

userCount

Description

User count

Response

Returns an Int

Example

Query
query userCount {
  userCount
}
Response
{"data": {"userCount": 123}}
Queries

userKycInfo

Response

Returns a KycInfo!

Arguments
Name Description
userId - String!

Example

Query
query userKycInfo($userId: String!) {
  userKycInfo(userId: $userId) {
    applicant {
      ...KycApplicantFragment
    }
    levelName
    appliedDocuments {
      ...KycAppliedDocumentFragment
    }
    requiredInfo {
      ...KycRequiredInfoFragment
    }
  }
}
Variables
{"userId": "xyz789"}
Response
{
  "data": {
    "userKycInfo": {
      "applicant": KycApplicant,
      "levelName": "xyz789",
      "appliedDocuments": [KycAppliedDocument],
      "requiredInfo": KycRequiredInfo
    }
  }
}
Queries

userProfit

Description

Transaction history for the selected user

Response

Returns a UserProfit!

Arguments
Name Description
userId - String! User id
options - UserProfitInput UserProfitInput

Example

Query
query userProfit(
  $userId: String!,
  $options: UserProfitInput
) {
  userProfit(
    userId: $userId,
    options: $options
  ) {
    userId
    currencyTo
    period
    profits {
      ...UserCurrencyProfitFragment
    }
  }
}
Variables
{
  "userId": "xyz789",
  "options": UserProfitInput
}
Response
{
  "data": {
    "userProfit": {
      "userId": "xyz789",
      "currencyTo": "abc123",
      "period": "LastWeek",
      "profits": [UserCurrencyProfit]
    }
  }
}

Mutations

abandonCryptoInvoice

Description

This endpoint can be used to abandon a crypto invoice

Response

Returns a CryptoInvoice

Arguments
Name Description
cryptoInvoiceId - String Crypto invoice id

Example

Query
mutation abandonCryptoInvoice($cryptoInvoiceId: String) {
  abandonCryptoInvoice(cryptoInvoiceId: $cryptoInvoiceId) {
    cryptoInvoiceId
    name
    destination
    vaultId
    userId
    created
    widgetId
    currencyToSend
    amountToSend
    currencyToReceive
    amountToReceive
    rate
    widgetUserParamsId
  }
}
Variables
{"cryptoInvoiceId": "xyz789"}
Response
{
  "data": {
    "abandonCryptoInvoice": {
      "cryptoInvoiceId": 4,
      "name": "xyz789",
      "destination": "xyz789",
      "vaultId": "abc123",
      "userId": "abc123",
      "created": "abc123",
      "widgetId": "xyz789",
      "currencyToSend": "xyz789",
      "amountToSend": 987.65,
      "currencyToReceive": "abc123",
      "amountToReceive": 123.45,
      "rate": 123.45,
      "widgetUserParamsId": "xyz789"
    }
  }
}
Mutations

abandonTransaction

Description

This endpoint can be used to abandon a transaction

Response

Returns a TransactionShort

Arguments
Name Description
transactionId - String Transaction id

Example

Query
mutation abandonTransaction($transactionId: String) {
  abandonTransaction(transactionId: $transactionId) {
    transactionId
    code
    userId
    userReferralCode
    sourceVaultId
    sourceVault
    userIp
    userTierId
    userTier {
      ...SettingsKycTierShortExFragment
    }
    requiredUserTierId
    requiredUserTier {
      ...SettingsKycTierShortExFragment
    }
    created
    updated
    executed
    type
    status
    subStatus
    kycStatus
    accountStatus
    feeFiat
    feePercent
    feeMinFiat
    feeDetails
    approxNetworkFee
    approxNetworkFeeFiat
    currencyToSpend
    amountToSpend
    amountToSpendWithoutFee
    currencyToReceive
    initialAmountToReceive
    initialAmountToReceiveWithoutFee
    amountToReceive
    amountToReceiveWithoutFee
    amountInEur
    initialRate
    rate
    rateFiatToEur
    destVaultId
    destVault
    destination
    countryCode2
    countryCode3
    accountType
    source
    instrument
    instrumentDetails
    custodyProvider
    custodyDetails
    paymentProvider
    liquidityProvider
    paymentOrder {
      ...PaymentOrderFragment
    }
    liquidityOrder {
      ...LiquidityOrderFragment
    }
    transferOrder {
      ...TransferOrderFragment
    }
    widgetId
    widgetCode
    widgetUserParamsId
    widgetUserParams
    widget
    destinationUserId
    risk
    riskCodes
    cryptoInvoiceName
    data
    sourceAddress
  }
}
Variables
{"transactionId": "abc123"}
Response
{
  "data": {
    "abandonTransaction": {
      "transactionId": 4,
      "code": "xyz789",
      "userId": "abc123",
      "userReferralCode": 987,
      "sourceVaultId": "abc123",
      "sourceVault": "xyz789",
      "userIp": "xyz789",
      "userTierId": "abc123",
      "userTier": SettingsKycTierShortEx,
      "requiredUserTierId": "xyz789",
      "requiredUserTier": SettingsKycTierShortEx,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "executed": "2007-12-03T10:15:30Z",
      "type": "Buy",
      "status": "New",
      "subStatus": "abc123",
      "kycStatus": "KycWaiting",
      "accountStatus": "Live",
      "feeFiat": 123.45,
      "feePercent": 123.45,
      "feeMinFiat": 987.65,
      "feeDetails": "xyz789",
      "approxNetworkFee": 123.45,
      "approxNetworkFeeFiat": 123.45,
      "currencyToSpend": "xyz789",
      "amountToSpend": 123.45,
      "amountToSpendWithoutFee": 987.65,
      "currencyToReceive": "xyz789",
      "initialAmountToReceive": 987.65,
      "initialAmountToReceiveWithoutFee": 987.65,
      "amountToReceive": 987.65,
      "amountToReceiveWithoutFee": 987.65,
      "amountInEur": 123.45,
      "initialRate": 987.65,
      "rate": 123.45,
      "rateFiatToEur": 987.65,
      "destVaultId": "abc123",
      "destVault": "abc123",
      "destination": "abc123",
      "countryCode2": "abc123",
      "countryCode3": "xyz789",
      "accountType": "xyz789",
      "source": "QuickCheckout",
      "instrument": "CreditCard",
      "instrumentDetails": "abc123",
      "custodyProvider": "Fireblocks",
      "custodyDetails": "xyz789",
      "paymentProvider": "xyz789",
      "liquidityProvider": "Bitstamp",
      "paymentOrder": PaymentOrder,
      "liquidityOrder": LiquidityOrder,
      "transferOrder": TransferOrder,
      "widgetId": "xyz789",
      "widgetCode": "xyz789",
      "widgetUserParamsId": "abc123",
      "widgetUserParams": "xyz789",
      "widget": "xyz789",
      "destinationUserId": "abc123",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "cryptoInvoiceName": "abc123",
      "data": "xyz789",
      "sourceAddress": "xyz789"
    }
  }
}
Mutations

addBankAccount

Response

Returns a User

Arguments
Name Description
userId - String!
bankAccount - UserBankAccountInput

Example

Query
mutation addBankAccount(
  $userId: String!,
  $bankAccount: UserBankAccountInput
) {
  addBankAccount(
    userId: $userId,
    bankAccount: $bankAccount
  ) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{
  "userId": "xyz789",
  "bankAccount": UserBankAccountInput
}
Response
{
  "data": {
    "addBankAccount": {
      "userId": 4,
      "email": "xyz789",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["xyz789"],
      "firstName": "xyz789",
      "lastName": "xyz789",
      "avatar": "xyz789",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "xyz789",
      "countryCode3": "xyz789",
      "postCode": "abc123",
      "town": "abc123",
      "street": "abc123",
      "subStreet": "xyz789",
      "stateName": "abc123",
      "buildingName": "abc123",
      "buildingNumber": "abc123",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 987,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": false,
      "hasEmailAuth": false,
      "changePasswordRequired": false,
      "referralCode": 987,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "abc123",
      "kycTierId": "abc123",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "abc123",
      "kycValid": false,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "abc123",
      "kycReviewRejectedType": "abc123",
      "kycReviewRejectedLabels": ["abc123"],
      "kycReviewResult": "xyz789",
      "kycStatusUpdateRequired": true,
      "kycDocs": ["abc123"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "xyz789",
      "defaultCryptoCurrency": "xyz789",
      "risk": "Low",
      "riskCodes": ["xyz789"],
      "riskAlertCount": 987,
      "widgetId": "xyz789",
      "widgetCode": "abc123",
      "affiliateId": "xyz789",
      "affiliateCode": "xyz789",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 987,
      "totalDepositInProcess": 987.65,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 987.65,
      "totalWithdrawalInProcessCount": 987,
      "totalBoughtCompleted": 123.45,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 987.65,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 123.45,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 987.65,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 987.65,
      "totalSentCompletedCount": 987,
      "totalSentInProcess": 987.65,
      "totalSentInProcessCount": 123,
      "totalReceivedCompleted": 987.65,
      "totalReceivedCompletedCount": 123,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 123,
      "totalTransactionCount": 123,
      "avarageTransaction": 123.45,
      "manuallyEditedRisk": true,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "abc123",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "abc123",
      "openpaydAccountHolderId": "xyz789"
    }
  }
}
Mutations

addBlackCountry

Response

Returns a BlackCountry

Arguments
Name Description
countryCode2 - String!

Example

Query
mutation addBlackCountry($countryCode2: String!) {
  addBlackCountry(countryCode2: $countryCode2) {
    countryCode2
    created
  }
}
Variables
{"countryCode2": "xyz789"}
Response
{
  "data": {
    "addBlackCountry": {
      "countryCode2": 4,
      "created": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

addFeedback

Response

Returns a Feedback!

Arguments
Name Description
recaptcha - String
feedback - FeedbackInput!

Example

Query
mutation addFeedback(
  $recaptcha: String,
  $feedback: FeedbackInput!
) {
  addFeedback(
    recaptcha: $recaptcha,
    feedback: $feedback
  ) {
    feedbackId
    name
    email
    title
    description
    created
  }
}
Variables
{
  "recaptcha": "xyz789",
  "feedback": FeedbackInput
}
Response
{
  "data": {
    "addFeedback": {
      "feedbackId": 4,
      "name": "abc123",
      "email": "xyz789",
      "title": "abc123",
      "description": "xyz789",
      "created": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

addFiatVault

Description

Not used

Response

Returns a FiatVault

Arguments
Name Description
userId - String! User id
currency - String Currency

Example

Query
mutation addFiatVault(
  $userId: String!,
  $currency: String
) {
  addFiatVault(
    userId: $userId,
    currency: $currency
  ) {
    fiatVaultId
    userId
    balance
    created
    currency
    generalBalance
  }
}
Variables
{
  "userId": "xyz789",
  "currency": "xyz789"
}
Response
{
  "data": {
    "addFiatVault": {
      "fiatVaultId": "4",
      "userId": "xyz789",
      "balance": 987.65,
      "created": "2007-12-03T10:15:30Z",
      "currency": "abc123",
      "generalBalance": 987.65
    }
  }
}
Mutations

addMyBankAccount

Response

Returns a User

Arguments
Name Description
bankAccount - UserBankAccountInput

Example

Query
mutation addMyBankAccount($bankAccount: UserBankAccountInput) {
  addMyBankAccount(bankAccount: $bankAccount) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"bankAccount": UserBankAccountInput}
Response
{
  "data": {
    "addMyBankAccount": {
      "userId": 4,
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["xyz789"],
      "firstName": "xyz789",
      "lastName": "xyz789",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "xyz789",
      "countryCode3": "abc123",
      "postCode": "abc123",
      "town": "abc123",
      "street": "xyz789",
      "subStreet": "xyz789",
      "stateName": "abc123",
      "buildingName": "abc123",
      "buildingNumber": "xyz789",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "xyz789",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 987,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": false,
      "hasEmailAuth": true,
      "changePasswordRequired": false,
      "referralCode": 987,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "xyz789",
      "kycTierId": "xyz789",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": false,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "xyz789",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "abc123",
      "kycPrivateComment": "abc123",
      "kycReviewRejectedType": "xyz789",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": true,
      "kycDocs": ["xyz789"],
      "custodyProvider": "xyz789",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "xyz789",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "riskAlertCount": 987,
      "widgetId": "xyz789",
      "widgetCode": "abc123",
      "affiliateId": "xyz789",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 987,
      "totalDepositInProcess": 123.45,
      "totalDepositInProcessCount": 987,
      "totalWithdrawalCompleted": 123.45,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 987,
      "totalBoughtCompleted": 987.65,
      "totalBoughtCompletedCount": 123,
      "totalBoughtInProcess": 123.45,
      "totalBoughtInProcessCount": 123,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 987.65,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 123.45,
      "totalSentCompletedCount": 987,
      "totalSentInProcess": 987.65,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 123.45,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 123,
      "avarageTransaction": 123.45,
      "manuallyEditedRisk": false,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "abc123",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "xyz789",
      "openpaydAccountHolderId": "xyz789"
    }
  }
}
Mutations

addMyContact

Response

Returns a User

Arguments
Name Description
contact - UserContactInput

Example

Query
mutation addMyContact($contact: UserContactInput) {
  addMyContact(contact: $contact) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"contact": UserContactInput}
Response
{
  "data": {
    "addMyContact": {
      "userId": 4,
      "email": "xyz789",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["abc123"],
      "firstName": "abc123",
      "lastName": "abc123",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "abc123",
      "countryCode3": "xyz789",
      "postCode": "abc123",
      "town": "xyz789",
      "street": "xyz789",
      "subStreet": "abc123",
      "stateName": "abc123",
      "buildingName": "abc123",
      "buildingNumber": "abc123",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "xyz789",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 123,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": true,
      "changePasswordRequired": true,
      "referralCode": 987,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "xyz789",
      "kycTierId": "xyz789",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": true,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "abc123",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": false,
      "kycDocs": ["xyz789"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "xyz789",
      "risk": "Low",
      "riskCodes": ["xyz789"],
      "riskAlertCount": 987,
      "widgetId": "xyz789",
      "widgetCode": "xyz789",
      "affiliateId": "abc123",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 123,
      "totalDepositInProcess": 987.65,
      "totalDepositInProcessCount": 987,
      "totalWithdrawalCompleted": 123.45,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 123,
      "totalBoughtCompleted": 987.65,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 987.65,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 123.45,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 123,
      "totalSentCompleted": 123.45,
      "totalSentCompletedCount": 987,
      "totalSentInProcess": 987.65,
      "totalSentInProcessCount": 123,
      "totalReceivedCompleted": 987.65,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 987,
      "avarageTransaction": 123.45,
      "manuallyEditedRisk": false,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "abc123",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "xyz789",
      "openpaydIds": "xyz789",
      "openpaydAccountHolderId": "xyz789"
    }
  }
}
Mutations

addMyVault

Description

This endpoint can be used to add a current user's wallet.

Response

Returns a VaultAccount

Arguments
Name Description
vaultName - String Wallet name
assetId - String! Asset id
originalId - String Original id

Example

Query
mutation addMyVault(
  $vaultName: String,
  $assetId: String!,
  $originalId: String
) {
  addMyVault(
    vaultName: $vaultName,
    assetId: $assetId,
    originalId: $originalId
  ) {
    id
    userId
    name
    custodyProviderLink
    rawData
    assets {
      ...VaultAccountAssetFragment
    }
  }
}
Variables
{
  "vaultName": "abc123",
  "assetId": "abc123",
  "originalId": "xyz789"
}
Response
{
  "data": {
    "addMyVault": {
      "id": 4,
      "userId": "xyz789",
      "name": "abc123",
      "custodyProviderLink": "xyz789",
      "rawData": "abc123",
      "assets": [VaultAccountAsset]
    }
  }
}
Mutations

addMyWidgetUserParams

Description

This endpoint can be used to add user params.

Response

Returns a WidgetUserParams

Arguments
Name Description
widgetUserParams - WidgetUserParamsInput WidgetUserParamsInput

Example

Query
mutation addMyWidgetUserParams($widgetUserParams: WidgetUserParamsInput) {
  addMyWidgetUserParams(widgetUserParams: $widgetUserParams) {
    widgetUserParamsId
    widgetId
    userId
    created
    params
  }
}
Variables
{"widgetUserParams": WidgetUserParamsInput}
Response
{
  "data": {
    "addMyWidgetUserParams": {
      "widgetUserParamsId": 4,
      "widgetId": "abc123",
      "userId": "abc123",
      "created": "2007-12-03T10:15:30Z",
      "params": "xyz789"
    }
  }
}
Mutations

addSettingsCost

Response

Returns a SettingsCost!

Arguments
Name Description
settings - SettingsCostInput!

Example

Query
mutation addSettingsCost($settings: SettingsCostInput!) {
  addSettingsCost(settings: $settings) {
    settingsCostId
    name
    description
    targetFilterType
    targetFilterValues
    targetInstruments
    targetTransactionTypes
    targetPaymentProviders
    terms
    created
    createdBy
    bankAccounts {
      ...WireTransferBankAccountFragment
    }
    default
    deleted
  }
}
Variables
{"settings": SettingsCostInput}
Response
{
  "data": {
    "addSettingsCost": {
      "settingsCostId": "4",
      "name": "xyz789",
      "description": "xyz789",
      "targetFilterType": "None",
      "targetFilterValues": ["xyz789"],
      "targetInstruments": ["xyz789"],
      "targetTransactionTypes": ["abc123"],
      "targetPaymentProviders": ["abc123"],
      "terms": "abc123",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "bankAccounts": [WireTransferBankAccount],
      "default": false,
      "deleted": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

addSettingsFee

Response

Returns a SettingsFee!

Arguments
Name Description
settings - SettingsFeeInput!

Example

Query
mutation addSettingsFee($settings: SettingsFeeInput!) {
  addSettingsFee(settings: $settings) {
    settingsFeeId
    name
    description
    targetFilterType
    targetFilterValues
    targetInstruments
    targetUserTypes
    targetUserModes
    targetTransactionTypes
    targetPaymentProviders
    terms
    wireDetails
    created
    createdBy
    default
    deleted
    currency
    rateToEur
    costs {
      ...SettingsCostFragment
    }
  }
}
Variables
{"settings": SettingsFeeInput}
Response
{
  "data": {
    "addSettingsFee": {
      "settingsFeeId": 4,
      "name": "abc123",
      "description": "abc123",
      "targetFilterType": "None",
      "targetFilterValues": ["xyz789"],
      "targetInstruments": ["xyz789"],
      "targetUserTypes": ["Merchant"],
      "targetUserModes": ["InternalWallet"],
      "targetTransactionTypes": ["abc123"],
      "targetPaymentProviders": ["xyz789"],
      "terms": "xyz789",
      "wireDetails": "abc123",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "xyz789",
      "default": true,
      "deleted": "2007-12-03T10:15:30Z",
      "currency": "xyz789",
      "rateToEur": 123.45,
      "costs": [SettingsCost]
    }
  }
}
Mutations

addSettingsKyc

Response

Returns a SettingsKyc!

Arguments
Name Description
settings - SettingsKycInput!

Example

Query
mutation addSettingsKyc($settings: SettingsKycInput!) {
  addSettingsKyc(settings: $settings) {
    settingsKycId
    name
    description
    targetKycProviders
    targetUserType
    targetUserModes
    targetFilterType
    targetFilterValues
    levels {
      ...SettingsKycLevelFragment
    }
    requireUserFullName
    requireUserPhone
    requireUserBirthday
    requireUserAddress
    requireUserFlatNumber
    created
    createdBy
    default
    deleted
  }
}
Variables
{"settings": SettingsKycInput}
Response
{
  "data": {
    "addSettingsKyc": {
      "settingsKycId": "4",
      "name": "xyz789",
      "description": "abc123",
      "targetKycProviders": ["Local"],
      "targetUserType": "Merchant",
      "targetUserModes": ["InternalWallet"],
      "targetFilterType": "None",
      "targetFilterValues": ["abc123"],
      "levels": [SettingsKycLevel],
      "requireUserFullName": false,
      "requireUserPhone": false,
      "requireUserBirthday": false,
      "requireUserAddress": true,
      "requireUserFlatNumber": false,
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "default": true,
      "deleted": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

addSettingsKycLevel

Response

Returns a SettingsKycLevel!

Arguments
Name Description
settingsLevel - SettingsKycLevelInput!

Example

Query
mutation addSettingsKycLevel($settingsLevel: SettingsKycLevelInput!) {
  addSettingsKycLevel(settingsLevel: $settingsLevel) {
    settingsKycLevelId
    name
    originalLevelName
    originalFlowName
    description
    userType
    order
    data
    created
    createdBy
  }
}
Variables
{"settingsLevel": SettingsKycLevelInput}
Response
{
  "data": {
    "addSettingsKycLevel": {
      "settingsKycLevelId": 4,
      "name": "abc123",
      "originalLevelName": "xyz789",
      "originalFlowName": "xyz789",
      "description": "xyz789",
      "userType": "Merchant",
      "order": 987,
      "data": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123"
    }
  }
}
Mutations

addSettingsKycTier

Response

Returns a Boolean!

Arguments
Name Description
settings - SettingsKycTierInput!

Example

Query
mutation addSettingsKycTier($settings: SettingsKycTierInput!) {
  addSettingsKycTier(settings: $settings)
}
Variables
{"settings": SettingsKycTierInput}
Response
{"data": {"addSettingsKycTier": true}}
Mutations

addUserVault

Description

This endpoint can be used to add a user's wallet.

Response

Returns a VaultAccount

Arguments
Name Description
userId - ID! User id
vaultName - String! Wallet name
assetId - String! Asset id
originalId - String Original id

Example

Query
mutation addUserVault(
  $userId: ID!,
  $vaultName: String!,
  $assetId: String!,
  $originalId: String
) {
  addUserVault(
    userId: $userId,
    vaultName: $vaultName,
    assetId: $assetId,
    originalId: $originalId
  ) {
    id
    userId
    name
    custodyProviderLink
    rawData
    assets {
      ...VaultAccountAssetFragment
    }
  }
}
Variables
{
  "userId": 4,
  "vaultName": "abc123",
  "assetId": "abc123",
  "originalId": "abc123"
}
Response
{
  "data": {
    "addUserVault": {
      "id": 4,
      "userId": "abc123",
      "name": "xyz789",
      "custodyProviderLink": "xyz789",
      "rawData": "xyz789",
      "assets": [VaultAccountAsset]
    }
  }
}
Mutations

addWireTransferBankAccount

Response

Returns a WireTransferBankAccount!

Arguments
Name Description
bankAccount - WireTransferBankAccountInput!

Example

Query
mutation addWireTransferBankAccount($bankAccount: WireTransferBankAccountInput!) {
  addWireTransferBankAccount(bankAccount: $bankAccount) {
    bankAccountId
    name
    description
    created
    createdBy
    au
    uk
    eu
    openpayd
    openpaydObject
    deleted
  }
}
Variables
{"bankAccount": WireTransferBankAccountInput}
Response
{
  "data": {
    "addWireTransferBankAccount": {
      "bankAccountId": 4,
      "name": "xyz789",
      "description": "abc123",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "xyz789",
      "au": "abc123",
      "uk": "xyz789",
      "eu": "abc123",
      "openpayd": false,
      "openpaydObject": "abc123",
      "deleted": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

assignRole

Response

Returns a User

Arguments
Name Description
userId - ID!
roleCodes - [String!]

Example

Query
mutation assignRole(
  $userId: ID!,
  $roleCodes: [String!]
) {
  assignRole(
    userId: $userId,
    roleCodes: $roleCodes
  ) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{
  "userId": "4",
  "roleCodes": ["xyz789"]
}
Response
{
  "data": {
    "assignRole": {
      "userId": "4",
      "email": "xyz789",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["xyz789"],
      "firstName": "xyz789",
      "lastName": "abc123",
      "avatar": "xyz789",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "xyz789",
      "countryCode3": "abc123",
      "postCode": "abc123",
      "town": "xyz789",
      "street": "abc123",
      "subStreet": "xyz789",
      "stateName": "abc123",
      "buildingName": "abc123",
      "buildingNumber": "xyz789",
      "flatNumber": "abc123",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 987,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": true,
      "changePasswordRequired": false,
      "referralCode": 987,
      "systemUser": true,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "xyz789",
      "kycTierId": "xyz789",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": false,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "abc123",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "xyz789",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": false,
      "kycDocs": ["xyz789"],
      "custodyProvider": "xyz789",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "xyz789",
      "risk": "Low",
      "riskCodes": ["xyz789"],
      "riskAlertCount": 987,
      "widgetId": "abc123",
      "widgetCode": "xyz789",
      "affiliateId": "xyz789",
      "affiliateCode": "xyz789",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 987,
      "totalDepositInProcess": 987.65,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 123.45,
      "totalWithdrawalCompletedCount": 987,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 123,
      "totalBoughtCompleted": 123.45,
      "totalBoughtCompletedCount": 123,
      "totalBoughtInProcess": 987.65,
      "totalBoughtInProcessCount": 123,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 123,
      "totalSoldInProcess": 987.65,
      "totalSoldInProcessCount": 123,
      "totalSentCompleted": 987.65,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 123.45,
      "totalSentInProcessCount": 123,
      "totalReceivedCompleted": 987.65,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 123,
      "avarageTransaction": 987.65,
      "manuallyEditedRisk": true,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "abc123",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "xyz789",
      "openpaydIds": "abc123",
      "openpaydAccountHolderId": "xyz789"
    }
  }
}
Mutations

calculateInvoice

Description

This endpoint to recalculate the invoice (with current rate)

Response

Returns a CryptoInvoiceCreationResult

Arguments
Name Description
invoiceId - String

Example

Query
mutation calculateInvoice($invoiceId: String) {
  calculateInvoice(invoiceId: $invoiceId) {
    invoice {
      ...CryptoInvoiceFragment
    }
    rate
    convertedAmount
    convertedCurrency
  }
}
Variables
{"invoiceId": "xyz789"}
Response
{
  "data": {
    "calculateInvoice": {
      "invoice": CryptoInvoice,
      "rate": 123.45,
      "convertedAmount": 123.45,
      "convertedCurrency": "xyz789"
    }
  }
}
Mutations

cancelMyTransaction

Description

This endpoint can be used to cancel a transaction for the current user

Response

Returns a TransactionShort

Arguments
Name Description
transactionId - String Transaction id

Example

Query
mutation cancelMyTransaction($transactionId: String) {
  cancelMyTransaction(transactionId: $transactionId) {
    transactionId
    code
    userId
    userReferralCode
    sourceVaultId
    sourceVault
    userIp
    userTierId
    userTier {
      ...SettingsKycTierShortExFragment
    }
    requiredUserTierId
    requiredUserTier {
      ...SettingsKycTierShortExFragment
    }
    created
    updated
    executed
    type
    status
    subStatus
    kycStatus
    accountStatus
    feeFiat
    feePercent
    feeMinFiat
    feeDetails
    approxNetworkFee
    approxNetworkFeeFiat
    currencyToSpend
    amountToSpend
    amountToSpendWithoutFee
    currencyToReceive
    initialAmountToReceive
    initialAmountToReceiveWithoutFee
    amountToReceive
    amountToReceiveWithoutFee
    amountInEur
    initialRate
    rate
    rateFiatToEur
    destVaultId
    destVault
    destination
    countryCode2
    countryCode3
    accountType
    source
    instrument
    instrumentDetails
    custodyProvider
    custodyDetails
    paymentProvider
    liquidityProvider
    paymentOrder {
      ...PaymentOrderFragment
    }
    liquidityOrder {
      ...LiquidityOrderFragment
    }
    transferOrder {
      ...TransferOrderFragment
    }
    widgetId
    widgetCode
    widgetUserParamsId
    widgetUserParams
    widget
    destinationUserId
    risk
    riskCodes
    cryptoInvoiceName
    data
    sourceAddress
  }
}
Variables
{"transactionId": "abc123"}
Response
{
  "data": {
    "cancelMyTransaction": {
      "transactionId": 4,
      "code": "abc123",
      "userId": "xyz789",
      "userReferralCode": 987,
      "sourceVaultId": "xyz789",
      "sourceVault": "xyz789",
      "userIp": "abc123",
      "userTierId": "abc123",
      "userTier": SettingsKycTierShortEx,
      "requiredUserTierId": "xyz789",
      "requiredUserTier": SettingsKycTierShortEx,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "executed": "2007-12-03T10:15:30Z",
      "type": "Buy",
      "status": "New",
      "subStatus": "xyz789",
      "kycStatus": "KycWaiting",
      "accountStatus": "Live",
      "feeFiat": 987.65,
      "feePercent": 123.45,
      "feeMinFiat": 987.65,
      "feeDetails": "abc123",
      "approxNetworkFee": 987.65,
      "approxNetworkFeeFiat": 123.45,
      "currencyToSpend": "xyz789",
      "amountToSpend": 123.45,
      "amountToSpendWithoutFee": 123.45,
      "currencyToReceive": "xyz789",
      "initialAmountToReceive": 987.65,
      "initialAmountToReceiveWithoutFee": 123.45,
      "amountToReceive": 987.65,
      "amountToReceiveWithoutFee": 123.45,
      "amountInEur": 123.45,
      "initialRate": 123.45,
      "rate": 987.65,
      "rateFiatToEur": 987.65,
      "destVaultId": "xyz789",
      "destVault": "abc123",
      "destination": "xyz789",
      "countryCode2": "abc123",
      "countryCode3": "abc123",
      "accountType": "xyz789",
      "source": "QuickCheckout",
      "instrument": "CreditCard",
      "instrumentDetails": "xyz789",
      "custodyProvider": "Fireblocks",
      "custodyDetails": "xyz789",
      "paymentProvider": "xyz789",
      "liquidityProvider": "Bitstamp",
      "paymentOrder": PaymentOrder,
      "liquidityOrder": LiquidityOrder,
      "transferOrder": TransferOrder,
      "widgetId": "xyz789",
      "widgetCode": "xyz789",
      "widgetUserParamsId": "abc123",
      "widgetUserParams": "xyz789",
      "widget": "xyz789",
      "destinationUserId": "xyz789",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "cryptoInvoiceName": "xyz789",
      "data": "abc123",
      "sourceAddress": "xyz789"
    }
  }
}
Mutations

cancelTransaction

Description

This endpoint can be used to cancel a transaction

Response

Returns a Transaction

Arguments
Name Description
transactionId - String Transaction id

Example

Query
mutation cancelTransaction($transactionId: String) {
  cancelTransaction(transactionId: $transactionId) {
    transactionId
    code
    userId
    userReferralCode
    userIp
    userTierId
    userTier {
      ...SettingsKycTierShortExFragment
    }
    requiredUserTierId
    requiredUserTier {
      ...SettingsKycTierShortExFragment
    }
    sourceVaultId
    sourceVault
    user {
      ...UserFragment
    }
    created
    updated
    executed
    type
    status
    subStatus
    kycStatus
    accountStatus
    feeFiat
    feePercent
    feeMinFiat
    feeDetails
    approxNetworkFee
    approxNetworkFeeFiat
    userDefaultFiatCurrency
    userDefaultCryptoCurrency
    currencyToSpend
    amountToSpend
    amountToSpendWithoutFee
    currencyToReceive
    initialAmountToReceive
    initialAmountToReceiveWithoutFee
    amountToReceive
    amountToReceiveWithoutFee
    amountInEur
    initialRate
    rate
    rateFiatToEur
    destVaultId
    destVault
    destination
    countryCode2
    countryCode3
    accountType
    source
    instrument
    instrumentDetails
    custodyProvider
    custodyDetails
    paymentProvider
    paymentOrderId
    paymentOrder {
      ...PaymentOrderFragment
    }
    liquidityProvider
    liquidityOrderId
    liquidityOrder {
      ...LiquidityOrderFragment
    }
    transferOrderId
    transferOrder {
      ...TransferOrderFragment
    }
    transferOrderBlockchainLink
    benchmarkTransferOrderId
    benchmarkTransferOrder {
      ...TransferOrderFragment
    }
    benchmarkTransferOrderBlockchainLink
    userBalanceTotalBefore
    userBalanceAvailableBefore
    userBalanceTotalAfter
    userBalanceAvailableAfter
    totalUserAmountBeforeTransactionInEur
    hasBeenBenchmarked
    widgetId
    widgetCode
    widgetUserParamsId
    widgetUserParams
    widget
    destinationUserId
    manuallyEditedAmounts
    manuallyEditedFee
    manuallyEditedStatus
    manuallyEditedKycStatus
    manuallyEditedAccountStatus
    risk
    riskCodes
    backups
    comment
    data
    verifyWhenPaid
    requestParams
    cryptoInvoiceName
    sourceAddress
  }
}
Variables
{"transactionId": "xyz789"}
Response
{
  "data": {
    "cancelTransaction": {
      "transactionId": 4,
      "code": "xyz789",
      "userId": "xyz789",
      "userReferralCode": 123,
      "userIp": "abc123",
      "userTierId": "abc123",
      "userTier": SettingsKycTierShortEx,
      "requiredUserTierId": "xyz789",
      "requiredUserTier": SettingsKycTierShortEx,
      "sourceVaultId": "xyz789",
      "sourceVault": "xyz789",
      "user": User,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "executed": "2007-12-03T10:15:30Z",
      "type": "Buy",
      "status": "New",
      "subStatus": "xyz789",
      "kycStatus": "KycWaiting",
      "accountStatus": "Live",
      "feeFiat": 987.65,
      "feePercent": 123.45,
      "feeMinFiat": 123.45,
      "feeDetails": "abc123",
      "approxNetworkFee": 123.45,
      "approxNetworkFeeFiat": 987.65,
      "userDefaultFiatCurrency": "abc123",
      "userDefaultCryptoCurrency": "xyz789",
      "currencyToSpend": "xyz789",
      "amountToSpend": 987.65,
      "amountToSpendWithoutFee": 987.65,
      "currencyToReceive": "abc123",
      "initialAmountToReceive": 123.45,
      "initialAmountToReceiveWithoutFee": 987.65,
      "amountToReceive": 123.45,
      "amountToReceiveWithoutFee": 123.45,
      "amountInEur": 987.65,
      "initialRate": 123.45,
      "rate": 123.45,
      "rateFiatToEur": 123.45,
      "destVaultId": "xyz789",
      "destVault": "xyz789",
      "destination": "xyz789",
      "countryCode2": "abc123",
      "countryCode3": "xyz789",
      "accountType": "xyz789",
      "source": "QuickCheckout",
      "instrument": "CreditCard",
      "instrumentDetails": "xyz789",
      "custodyProvider": "Fireblocks",
      "custodyDetails": "abc123",
      "paymentProvider": "xyz789",
      "paymentOrderId": "abc123",
      "paymentOrder": PaymentOrder,
      "liquidityProvider": "Bitstamp",
      "liquidityOrderId": "xyz789",
      "liquidityOrder": LiquidityOrder,
      "transferOrderId": "abc123",
      "transferOrder": TransferOrder,
      "transferOrderBlockchainLink": "abc123",
      "benchmarkTransferOrderId": "xyz789",
      "benchmarkTransferOrder": TransferOrder,
      "benchmarkTransferOrderBlockchainLink": "abc123",
      "userBalanceTotalBefore": 123.45,
      "userBalanceAvailableBefore": 123.45,
      "userBalanceTotalAfter": 987.65,
      "userBalanceAvailableAfter": 987.65,
      "totalUserAmountBeforeTransactionInEur": 987.65,
      "hasBeenBenchmarked": true,
      "widgetId": "abc123",
      "widgetCode": "abc123",
      "widgetUserParamsId": "abc123",
      "widgetUserParams": "abc123",
      "widget": "abc123",
      "destinationUserId": "abc123",
      "manuallyEditedAmounts": false,
      "manuallyEditedFee": true,
      "manuallyEditedStatus": true,
      "manuallyEditedKycStatus": false,
      "manuallyEditedAccountStatus": true,
      "risk": "Low",
      "riskCodes": ["abc123"],
      "backups": ["abc123"],
      "comment": "xyz789",
      "data": "abc123",
      "verifyWhenPaid": true,
      "requestParams": "abc123",
      "cryptoInvoiceName": "abc123",
      "sourceAddress": "abc123"
    }
  }
}
Mutations

captureFull

Response

Returns a PaymentOrder!

Arguments
Name Description
orderId - String!

Example

Query
mutation captureFull($orderId: String!) {
  captureFull(orderId: $orderId) {
    orderId
    userId
    transactionId
    provider
    created
    amount
    currency
    operations {
      ...PaymentOperationFragment
    }
    status
    statusReason
    originalOrderId
    preauthOperationSn
    captureOperationSn
    refundOperationSn
    paymentInfo
    paymentBankName
    paymentCardHolderName
    paymentCardType
    paymentCardLastFourDigits
    paymentProcessorName
    paymentBin
    providerSpecificStates {
      ...DateMapFragment
    }
    providerSpecificParams {
      ...StringMapFragment
    }
  }
}
Variables
{"orderId": "abc123"}
Response
{
  "data": {
    "captureFull": {
      "orderId": "abc123",
      "userId": "abc123",
      "transactionId": "xyz789",
      "provider": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "amount": 987.65,
      "currency": "xyz789",
      "operations": [PaymentOperation],
      "status": "abc123",
      "statusReason": "xyz789",
      "originalOrderId": "xyz789",
      "preauthOperationSn": "xyz789",
      "captureOperationSn": "abc123",
      "refundOperationSn": "xyz789",
      "paymentInfo": "xyz789",
      "paymentBankName": "abc123",
      "paymentCardHolderName": "xyz789",
      "paymentCardType": "xyz789",
      "paymentCardLastFourDigits": "xyz789",
      "paymentProcessorName": "abc123",
      "paymentBin": "abc123",
      "providerSpecificStates": [DateMap],
      "providerSpecificParams": [StringMap]
    }
  }
}
Mutations

changeMyKycTier

Response

Returns a User

Arguments
Name Description
userTierId - String!

Example

Query
mutation changeMyKycTier($userTierId: String!) {
  changeMyKycTier(userTierId: $userTierId) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"userTierId": "abc123"}
Response
{
  "data": {
    "changeMyKycTier": {
      "userId": "4",
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["abc123"],
      "firstName": "abc123",
      "lastName": "abc123",
      "avatar": "xyz789",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "abc123",
      "countryCode3": "xyz789",
      "postCode": "xyz789",
      "town": "abc123",
      "street": "abc123",
      "subStreet": "xyz789",
      "stateName": "xyz789",
      "buildingName": "xyz789",
      "buildingNumber": "abc123",
      "flatNumber": "abc123",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": true,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 123,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": false,
      "hasEmailAuth": true,
      "changePasswordRequired": true,
      "referralCode": 123,
      "systemUser": true,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "xyz789",
      "kycTierId": "abc123",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": true,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "xyz789",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "abc123",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "abc123",
      "kycReviewRejectedLabels": ["abc123"],
      "kycReviewResult": "xyz789",
      "kycStatusUpdateRequired": false,
      "kycDocs": ["xyz789"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "xyz789",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "riskAlertCount": 987,
      "widgetId": "xyz789",
      "widgetCode": "abc123",
      "affiliateId": "xyz789",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 123.45,
      "totalDepositCompletedCount": 987,
      "totalDepositInProcess": 123.45,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 123.45,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 987.65,
      "totalWithdrawalInProcessCount": 123,
      "totalBoughtCompleted": 123.45,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 987.65,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 123,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 987.65,
      "totalSentCompletedCount": 987,
      "totalSentInProcess": 987.65,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 987.65,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 123,
      "totalTransactionCount": 987,
      "avarageTransaction": 987.65,
      "manuallyEditedRisk": true,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "abc123",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "xyz789",
      "openpaydAccountHolderId": "abc123"
    }
  }
}
Mutations

changePassword

Response

Returns a Boolean!

Arguments
Name Description
code2fa - String
oldPassword - String!
newPassword - String!

Example

Query
mutation changePassword(
  $code2fa: String,
  $oldPassword: String!,
  $newPassword: String!
) {
  changePassword(
    code2fa: $code2fa,
    oldPassword: $oldPassword,
    newPassword: $newPassword
  )
}
Variables
{
  "code2fa": "xyz789",
  "oldPassword": "xyz789",
  "newPassword": "abc123"
}
Response
{"data": {"changePassword": false}}
Mutations

changeUserKycTier

Response

Returns a User

Arguments
Name Description
userId - String
userTierId - String!

Example

Query
mutation changeUserKycTier(
  $userId: String,
  $userTierId: String!
) {
  changeUserKycTier(
    userId: $userId,
    userTierId: $userTierId
  ) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{
  "userId": "abc123",
  "userTierId": "abc123"
}
Response
{
  "data": {
    "changeUserKycTier": {
      "userId": "4",
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["abc123"],
      "firstName": "xyz789",
      "lastName": "abc123",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "abc123",
      "countryCode3": "abc123",
      "postCode": "abc123",
      "town": "xyz789",
      "street": "abc123",
      "subStreet": "xyz789",
      "stateName": "xyz789",
      "buildingName": "abc123",
      "buildingNumber": "abc123",
      "flatNumber": "abc123",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "xyz789",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 987,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": false,
      "hasEmailAuth": false,
      "changePasswordRequired": false,
      "referralCode": 987,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "abc123",
      "kycTierId": "abc123",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": true,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "abc123",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "abc123",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "xyz789",
      "kycStatusUpdateRequired": true,
      "kycDocs": ["abc123"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "abc123",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "riskAlertCount": 123,
      "widgetId": "xyz789",
      "widgetCode": "abc123",
      "affiliateId": "abc123",
      "affiliateCode": "xyz789",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 123,
      "totalDepositInProcess": 987.65,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 123.45,
      "totalWithdrawalCompletedCount": 987,
      "totalWithdrawalInProcess": 987.65,
      "totalWithdrawalInProcessCount": 123,
      "totalBoughtCompleted": 987.65,
      "totalBoughtCompletedCount": 123,
      "totalBoughtInProcess": 123.45,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 123,
      "totalSentCompleted": 123.45,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 987.65,
      "totalSentInProcessCount": 123,
      "totalReceivedCompleted": 987.65,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 123,
      "avarageTransaction": 987.65,
      "manuallyEditedRisk": false,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "xyz789",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "abc123",
      "openpaydAccountHolderId": "abc123"
    }
  }
}
Mutations

confirmDevice

Response

Returns a Boolean!

Arguments
Name Description
token - String!
recaptcha - String!

Example

Query
mutation confirmDevice(
  $token: String!,
  $recaptcha: String!
) {
  confirmDevice(
    token: $token,
    recaptcha: $recaptcha
  )
}
Variables
{
  "token": "xyz789",
  "recaptcha": "xyz789"
}
Response
{"data": {"confirmDevice": false}}
Mutations

confirmEmail

Response

Returns a Boolean!

Arguments
Name Description
token - String
code - Int
email - String
recaptcha - String!

Example

Query
mutation confirmEmail(
  $token: String,
  $code: Int,
  $email: String,
  $recaptcha: String!
) {
  confirmEmail(
    token: $token,
    code: $code,
    email: $email,
    recaptcha: $recaptcha
  )
}
Variables
{
  "token": "xyz789",
  "code": 987,
  "email": "abc123",
  "recaptcha": "abc123"
}
Response
{"data": {"confirmEmail": true}}
Mutations

confirmUserDevice

Response

Returns a Boolean!

Arguments
Name Description
device_id - String!

Example

Query
mutation confirmUserDevice($device_id: String!) {
  confirmUserDevice(device_id: $device_id)
}
Variables
{"device_id": "xyz789"}
Response
{"data": {"confirmUserDevice": false}}
Mutations

confirmUserEmail

Response

Returns a Boolean!

Arguments
Name Description
user_id - String!

Example

Query
mutation confirmUserEmail($user_id: String!) {
  confirmUserEmail(user_id: $user_id)
}
Variables
{"user_id": "abc123"}
Response
{"data": {"confirmUserEmail": true}}
Mutations

createInvoice

Description

This endpoint can be used to create a transaction

Response

Returns a CryptoInvoiceCreationResult

Arguments
Name Description
widgetId - String
currencyToSend - String
amountToSend - Float

Example

Query
mutation createInvoice(
  $widgetId: String,
  $currencyToSend: String,
  $amountToSend: Float
) {
  createInvoice(
    widgetId: $widgetId,
    currencyToSend: $currencyToSend,
    amountToSend: $amountToSend
  ) {
    invoice {
      ...CryptoInvoiceFragment
    }
    rate
    convertedAmount
    convertedCurrency
  }
}
Variables
{
  "widgetId": "xyz789",
  "currencyToSend": "xyz789",
  "amountToSend": 987.65
}
Response
{
  "data": {
    "createInvoice": {
      "invoice": CryptoInvoice,
      "rate": 987.65,
      "convertedAmount": 123.45,
      "convertedCurrency": "xyz789"
    }
  }
}
Mutations

createMerchantTransaction

Description

This endpoint can be used to create a merchant transaction

Response

Returns a TransactionShort

Arguments
Name Description
transaction - TransactionMerchantInput TransactionMerchantInput
params - String Parameters for creating a transaction

Example

Query
mutation createMerchantTransaction(
  $transaction: TransactionMerchantInput,
  $params: String
) {
  createMerchantTransaction(
    transaction: $transaction,
    params: $params
  ) {
    transactionId
    code
    userId
    userReferralCode
    sourceVaultId
    sourceVault
    userIp
    userTierId
    userTier {
      ...SettingsKycTierShortExFragment
    }
    requiredUserTierId
    requiredUserTier {
      ...SettingsKycTierShortExFragment
    }
    created
    updated
    executed
    type
    status
    subStatus
    kycStatus
    accountStatus
    feeFiat
    feePercent
    feeMinFiat
    feeDetails
    approxNetworkFee
    approxNetworkFeeFiat
    currencyToSpend
    amountToSpend
    amountToSpendWithoutFee
    currencyToReceive
    initialAmountToReceive
    initialAmountToReceiveWithoutFee
    amountToReceive
    amountToReceiveWithoutFee
    amountInEur
    initialRate
    rate
    rateFiatToEur
    destVaultId
    destVault
    destination
    countryCode2
    countryCode3
    accountType
    source
    instrument
    instrumentDetails
    custodyProvider
    custodyDetails
    paymentProvider
    liquidityProvider
    paymentOrder {
      ...PaymentOrderFragment
    }
    liquidityOrder {
      ...LiquidityOrderFragment
    }
    transferOrder {
      ...TransferOrderFragment
    }
    widgetId
    widgetCode
    widgetUserParamsId
    widgetUserParams
    widget
    destinationUserId
    risk
    riskCodes
    cryptoInvoiceName
    data
    sourceAddress
  }
}
Variables
{
  "transaction": TransactionMerchantInput,
  "params": "abc123"
}
Response
{
  "data": {
    "createMerchantTransaction": {
      "transactionId": 4,
      "code": "abc123",
      "userId": "xyz789",
      "userReferralCode": 987,
      "sourceVaultId": "xyz789",
      "sourceVault": "abc123",
      "userIp": "abc123",
      "userTierId": "xyz789",
      "userTier": SettingsKycTierShortEx,
      "requiredUserTierId": "abc123",
      "requiredUserTier": SettingsKycTierShortEx,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "executed": "2007-12-03T10:15:30Z",
      "type": "Buy",
      "status": "New",
      "subStatus": "xyz789",
      "kycStatus": "KycWaiting",
      "accountStatus": "Live",
      "feeFiat": 123.45,
      "feePercent": 123.45,
      "feeMinFiat": 123.45,
      "feeDetails": "abc123",
      "approxNetworkFee": 987.65,
      "approxNetworkFeeFiat": 987.65,
      "currencyToSpend": "abc123",
      "amountToSpend": 987.65,
      "amountToSpendWithoutFee": 123.45,
      "currencyToReceive": "abc123",
      "initialAmountToReceive": 987.65,
      "initialAmountToReceiveWithoutFee": 987.65,
      "amountToReceive": 123.45,
      "amountToReceiveWithoutFee": 987.65,
      "amountInEur": 987.65,
      "initialRate": 123.45,
      "rate": 123.45,
      "rateFiatToEur": 123.45,
      "destVaultId": "abc123",
      "destVault": "abc123",
      "destination": "abc123",
      "countryCode2": "xyz789",
      "countryCode3": "abc123",
      "accountType": "abc123",
      "source": "QuickCheckout",
      "instrument": "CreditCard",
      "instrumentDetails": "xyz789",
      "custodyProvider": "Fireblocks",
      "custodyDetails": "xyz789",
      "paymentProvider": "abc123",
      "liquidityProvider": "Bitstamp",
      "paymentOrder": PaymentOrder,
      "liquidityOrder": LiquidityOrder,
      "transferOrder": TransferOrder,
      "widgetId": "xyz789",
      "widgetCode": "abc123",
      "widgetUserParamsId": "xyz789",
      "widgetUserParams": "abc123",
      "widget": "abc123",
      "destinationUserId": "abc123",
      "risk": "Low",
      "riskCodes": ["xyz789"],
      "cryptoInvoiceName": "abc123",
      "data": "abc123",
      "sourceAddress": "xyz789"
    }
  }
}
Mutations

createMyApiKey

Response

Returns an ApiKeySecret

Example

Query
mutation createMyApiKey {
  createMyApiKey {
    apiKeyId
    userId
    user {
      ...UserFragment
    }
    secret
    created
    disabled
  }
}
Response
{
  "data": {
    "createMyApiKey": {
      "apiKeyId": 4,
      "userId": "xyz789",
      "user": User,
      "secret": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "disabled": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

createMyWidget

Description

This endpoint can be used to create a widget for the current user.

Response

Returns a Widget

Arguments
Name Description
widget - WidgetInput WidgetInput

Example

Query
mutation createMyWidget($widget: WidgetInput) {
  createMyWidget(widget: $widget) {
    widgetId
    code
    userId
    userCode
    name
    description
    created
    createdBy
    createdByUser {
      ...UserFragment
    }
    transactionTypes
    currenciesCrypto
    currenciesFiat
    destinationAddress
    countriesCode2
    instruments
    paymentProviders
    liquidityProvider
    additionalSettings
    currentUserEmail
    currentUserParams
    hasFixedAddress
    secret
  }
}
Variables
{"widget": WidgetInput}
Response
{
  "data": {
    "createMyWidget": {
      "widgetId": "4",
      "code": "xyz789",
      "userId": "xyz789",
      "userCode": "xyz789",
      "name": "xyz789",
      "description": "abc123",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "createdByUser": User,
      "transactionTypes": ["Buy"],
      "currenciesCrypto": ["xyz789"],
      "currenciesFiat": ["xyz789"],
      "destinationAddress": "xyz789",
      "countriesCode2": ["xyz789"],
      "instruments": ["CreditCard"],
      "paymentProviders": ["xyz789"],
      "liquidityProvider": "Bitstamp",
      "additionalSettings": "abc123",
      "currentUserEmail": "xyz789",
      "currentUserParams": "abc123",
      "hasFixedAddress": false,
      "secret": "xyz789"
    }
  }
}
Mutations

createTransaction

Description

This endpoint can be used to create a transaction

Response

Returns a TransactionShort

Arguments
Name Description
transaction - TransactionInput TransactionInput

Example

Query
mutation createTransaction($transaction: TransactionInput) {
  createTransaction(transaction: $transaction) {
    transactionId
    code
    userId
    userReferralCode
    sourceVaultId
    sourceVault
    userIp
    userTierId
    userTier {
      ...SettingsKycTierShortExFragment
    }
    requiredUserTierId
    requiredUserTier {
      ...SettingsKycTierShortExFragment
    }
    created
    updated
    executed
    type
    status
    subStatus
    kycStatus
    accountStatus
    feeFiat
    feePercent
    feeMinFiat
    feeDetails
    approxNetworkFee
    approxNetworkFeeFiat
    currencyToSpend
    amountToSpend
    amountToSpendWithoutFee
    currencyToReceive
    initialAmountToReceive
    initialAmountToReceiveWithoutFee
    amountToReceive
    amountToReceiveWithoutFee
    amountInEur
    initialRate
    rate
    rateFiatToEur
    destVaultId
    destVault
    destination
    countryCode2
    countryCode3
    accountType
    source
    instrument
    instrumentDetails
    custodyProvider
    custodyDetails
    paymentProvider
    liquidityProvider
    paymentOrder {
      ...PaymentOrderFragment
    }
    liquidityOrder {
      ...LiquidityOrderFragment
    }
    transferOrder {
      ...TransferOrderFragment
    }
    widgetId
    widgetCode
    widgetUserParamsId
    widgetUserParams
    widget
    destinationUserId
    risk
    riskCodes
    cryptoInvoiceName
    data
    sourceAddress
  }
}
Variables
{"transaction": TransactionInput}
Response
{
  "data": {
    "createTransaction": {
      "transactionId": 4,
      "code": "xyz789",
      "userId": "xyz789",
      "userReferralCode": 987,
      "sourceVaultId": "abc123",
      "sourceVault": "abc123",
      "userIp": "abc123",
      "userTierId": "abc123",
      "userTier": SettingsKycTierShortEx,
      "requiredUserTierId": "abc123",
      "requiredUserTier": SettingsKycTierShortEx,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "executed": "2007-12-03T10:15:30Z",
      "type": "Buy",
      "status": "New",
      "subStatus": "abc123",
      "kycStatus": "KycWaiting",
      "accountStatus": "Live",
      "feeFiat": 123.45,
      "feePercent": 987.65,
      "feeMinFiat": 987.65,
      "feeDetails": "abc123",
      "approxNetworkFee": 123.45,
      "approxNetworkFeeFiat": 123.45,
      "currencyToSpend": "xyz789",
      "amountToSpend": 987.65,
      "amountToSpendWithoutFee": 123.45,
      "currencyToReceive": "abc123",
      "initialAmountToReceive": 987.65,
      "initialAmountToReceiveWithoutFee": 123.45,
      "amountToReceive": 123.45,
      "amountToReceiveWithoutFee": 987.65,
      "amountInEur": 123.45,
      "initialRate": 123.45,
      "rate": 987.65,
      "rateFiatToEur": 987.65,
      "destVaultId": "abc123",
      "destVault": "xyz789",
      "destination": "xyz789",
      "countryCode2": "xyz789",
      "countryCode3": "abc123",
      "accountType": "abc123",
      "source": "QuickCheckout",
      "instrument": "CreditCard",
      "instrumentDetails": "xyz789",
      "custodyProvider": "Fireblocks",
      "custodyDetails": "xyz789",
      "paymentProvider": "abc123",
      "liquidityProvider": "Bitstamp",
      "paymentOrder": PaymentOrder,
      "liquidityOrder": LiquidityOrder,
      "transferOrder": TransferOrder,
      "widgetId": "xyz789",
      "widgetCode": "xyz789",
      "widgetUserParamsId": "abc123",
      "widgetUserParams": "xyz789",
      "widget": "xyz789",
      "destinationUserId": "xyz789",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "cryptoInvoiceName": "xyz789",
      "data": "xyz789",
      "sourceAddress": "abc123"
    }
  }
}
Mutations

createUser

Response

Returns a User

Arguments
Name Description
user - UserInput!
roles - [String!]

Example

Query
mutation createUser(
  $user: UserInput!,
  $roles: [String!]
) {
  createUser(
    user: $user,
    roles: $roles
  ) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{
  "user": UserInput,
  "roles": ["xyz789"]
}
Response
{
  "data": {
    "createUser": {
      "userId": "4",
      "email": "xyz789",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["xyz789"],
      "firstName": "xyz789",
      "lastName": "abc123",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "xyz789",
      "countryCode3": "abc123",
      "postCode": "xyz789",
      "town": "xyz789",
      "street": "xyz789",
      "subStreet": "abc123",
      "stateName": "xyz789",
      "buildingName": "xyz789",
      "buildingNumber": "xyz789",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": true,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 123,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": false,
      "changePasswordRequired": false,
      "referralCode": 987,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "abc123",
      "kycTierId": "xyz789",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": true,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "xyz789",
      "kycReviewRejectedLabels": ["abc123"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": false,
      "kycDocs": ["abc123"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "abc123",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "riskAlertCount": 987,
      "widgetId": "abc123",
      "widgetCode": "xyz789",
      "affiliateId": "xyz789",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 987,
      "totalDepositInProcess": 987.65,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 987,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 987,
      "totalBoughtCompleted": 123.45,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 123.45,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 123,
      "totalSentCompleted": 987.65,
      "totalSentCompletedCount": 987,
      "totalSentInProcess": 987.65,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 987.65,
      "totalReceivedCompletedCount": 123,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 123,
      "avarageTransaction": 987.65,
      "manuallyEditedRisk": true,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "xyz789",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "abc123",
      "openpaydAccountHolderId": "xyz789"
    }
  }
}
Mutations

createUserApiKey

Response

Returns an ApiKeySecret

Arguments
Name Description
userId - String

Example

Query
mutation createUserApiKey($userId: String) {
  createUserApiKey(userId: $userId) {
    apiKeyId
    userId
    user {
      ...UserFragment
    }
    secret
    created
    disabled
  }
}
Variables
{"userId": "xyz789"}
Response
{
  "data": {
    "createUserApiKey": {
      "apiKeyId": 4,
      "userId": "abc123",
      "user": User,
      "secret": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "disabled": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

createWidget

Description

This endpoint can be used to create a widget.

Response

Returns a Widget

Arguments
Name Description
userId - String User id
widget - WidgetInput WidgetInput

Example

Query
mutation createWidget(
  $userId: String,
  $widget: WidgetInput
) {
  createWidget(
    userId: $userId,
    widget: $widget
  ) {
    widgetId
    code
    userId
    userCode
    name
    description
    created
    createdBy
    createdByUser {
      ...UserFragment
    }
    transactionTypes
    currenciesCrypto
    currenciesFiat
    destinationAddress
    countriesCode2
    instruments
    paymentProviders
    liquidityProvider
    additionalSettings
    currentUserEmail
    currentUserParams
    hasFixedAddress
    secret
  }
}
Variables
{
  "userId": "abc123",
  "widget": WidgetInput
}
Response
{
  "data": {
    "createWidget": {
      "widgetId": "4",
      "code": "xyz789",
      "userId": "xyz789",
      "userCode": "abc123",
      "name": "abc123",
      "description": "abc123",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "xyz789",
      "createdByUser": User,
      "transactionTypes": ["Buy"],
      "currenciesCrypto": ["xyz789"],
      "currenciesFiat": ["xyz789"],
      "destinationAddress": "xyz789",
      "countriesCode2": ["abc123"],
      "instruments": ["CreditCard"],
      "paymentProviders": ["abc123"],
      "liquidityProvider": "Bitstamp",
      "additionalSettings": "abc123",
      "currentUserEmail": "xyz789",
      "currentUserParams": "abc123",
      "hasFixedAddress": false,
      "secret": "xyz789"
    }
  }
}
Mutations

deleteBankAccount

Response

Returns a User

Arguments
Name Description
bankAccountId - ID!

Example

Query
mutation deleteBankAccount($bankAccountId: ID!) {
  deleteBankAccount(bankAccountId: $bankAccountId) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"bankAccountId": 4}
Response
{
  "data": {
    "deleteBankAccount": {
      "userId": "4",
      "email": "xyz789",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["xyz789"],
      "firstName": "abc123",
      "lastName": "xyz789",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "abc123",
      "countryCode3": "abc123",
      "postCode": "xyz789",
      "town": "abc123",
      "street": "xyz789",
      "subStreet": "abc123",
      "stateName": "abc123",
      "buildingName": "xyz789",
      "buildingNumber": "abc123",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": true,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 987,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": false,
      "changePasswordRequired": true,
      "referralCode": 123,
      "systemUser": true,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "xyz789",
      "kycTierId": "abc123",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": true,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "abc123",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "abc123",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": true,
      "kycDocs": ["abc123"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "xyz789",
      "risk": "Low",
      "riskCodes": ["xyz789"],
      "riskAlertCount": 123,
      "widgetId": "xyz789",
      "widgetCode": "abc123",
      "affiliateId": "abc123",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 123.45,
      "totalDepositCompletedCount": 987,
      "totalDepositInProcess": 123.45,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 987,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 123,
      "totalBoughtCompleted": 123.45,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 123.45,
      "totalBoughtInProcessCount": 123,
      "totalSoldCompleted": 123.45,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 123.45,
      "totalSentCompletedCount": 987,
      "totalSentInProcess": 987.65,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 123.45,
      "totalReceivedCompletedCount": 123,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 123,
      "totalTransactionCount": 987,
      "avarageTransaction": 123.45,
      "manuallyEditedRisk": true,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "abc123",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "xyz789",
      "openpaydIds": "xyz789",
      "openpaydAccountHolderId": "abc123"
    }
  }
}
Mutations

deleteBlackCountry

Response

Returns a BlackCountry

Arguments
Name Description
countryCode2 - String!

Example

Query
mutation deleteBlackCountry($countryCode2: String!) {
  deleteBlackCountry(countryCode2: $countryCode2) {
    countryCode2
    created
  }
}
Variables
{"countryCode2": "xyz789"}
Response
{
  "data": {
    "deleteBlackCountry": {
      "countryCode2": 4,
      "created": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

deleteDevice

Response

Returns a UserDeviceListResult

Arguments
Name Description
deviceIds - [String]

Example

Query
mutation deleteDevice($deviceIds: [String]) {
  deleteDevice(deviceIds: $deviceIds) {
    count
    list {
      ...UserDeviceFragment
    }
  }
}
Variables
{"deviceIds": ["xyz789"]}
Response
{
  "data": {
    "deleteDevice": {"count": 987, "list": [UserDevice]}
  }
}
Mutations

deleteFiatVault

Response

Returns a FiatVault

Arguments
Name Description
fiatVaultId - String

Example

Query
mutation deleteFiatVault($fiatVaultId: String) {
  deleteFiatVault(fiatVaultId: $fiatVaultId) {
    fiatVaultId
    userId
    balance
    created
    currency
    generalBalance
  }
}
Variables
{"fiatVaultId": "xyz789"}
Response
{
  "data": {
    "deleteFiatVault": {
      "fiatVaultId": "4",
      "userId": "xyz789",
      "balance": 987.65,
      "created": "2007-12-03T10:15:30Z",
      "currency": "abc123",
      "generalBalance": 987.65
    }
  }
}
Mutations

deleteMyApiKey

Response

Returns an ApiKey

Arguments
Name Description
apiKeyId - String

Example

Query
mutation deleteMyApiKey($apiKeyId: String) {
  deleteMyApiKey(apiKeyId: $apiKeyId) {
    apiKeyId
    userId
    user {
      ...UserFragment
    }
    created
    disabled
  }
}
Variables
{"apiKeyId": "abc123"}
Response
{
  "data": {
    "deleteMyApiKey": {
      "apiKeyId": "4",
      "userId": "xyz789",
      "user": User,
      "created": "2007-12-03T10:15:30Z",
      "disabled": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

deleteMyBankAccount

Response

Returns a User

Arguments
Name Description
bankAccountId - ID!

Example

Query
mutation deleteMyBankAccount($bankAccountId: ID!) {
  deleteMyBankAccount(bankAccountId: $bankAccountId) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"bankAccountId": 4}
Response
{
  "data": {
    "deleteMyBankAccount": {
      "userId": "4",
      "email": "xyz789",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["abc123"],
      "firstName": "abc123",
      "lastName": "abc123",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "abc123",
      "countryCode3": "xyz789",
      "postCode": "xyz789",
      "town": "abc123",
      "street": "abc123",
      "subStreet": "abc123",
      "stateName": "abc123",
      "buildingName": "abc123",
      "buildingNumber": "abc123",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "xyz789",
      "termsOfUse": true,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 987,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": true,
      "changePasswordRequired": false,
      "referralCode": 987,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "abc123",
      "kycTierId": "xyz789",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "abc123",
      "kycValid": false,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "xyz789",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "xyz789",
      "kycReviewRejectedLabels": ["abc123"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": false,
      "kycDocs": ["xyz789"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "xyz789",
      "defaultCryptoCurrency": "xyz789",
      "risk": "Low",
      "riskCodes": ["xyz789"],
      "riskAlertCount": 987,
      "widgetId": "xyz789",
      "widgetCode": "abc123",
      "affiliateId": "xyz789",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 123.45,
      "totalDepositCompletedCount": 123,
      "totalDepositInProcess": 123.45,
      "totalDepositInProcessCount": 987,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 987,
      "totalBoughtCompleted": 987.65,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 987.65,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 123.45,
      "totalSoldCompletedCount": 123,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 987.65,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 123.45,
      "totalSentInProcessCount": 123,
      "totalReceivedCompleted": 987.65,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 987,
      "avarageTransaction": 987.65,
      "manuallyEditedRisk": true,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "xyz789",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "xyz789",
      "openpaydIds": "xyz789",
      "openpaydAccountHolderId": "xyz789"
    }
  }
}
Mutations

deleteMyContact

Response

Returns a User

Arguments
Name Description
contactId - ID!

Example

Query
mutation deleteMyContact($contactId: ID!) {
  deleteMyContact(contactId: $contactId) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"contactId": "4"}
Response
{
  "data": {
    "deleteMyContact": {
      "userId": 4,
      "email": "xyz789",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["abc123"],
      "firstName": "abc123",
      "lastName": "xyz789",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "xyz789",
      "countryCode3": "abc123",
      "postCode": "abc123",
      "town": "xyz789",
      "street": "abc123",
      "subStreet": "abc123",
      "stateName": "xyz789",
      "buildingName": "xyz789",
      "buildingNumber": "xyz789",
      "flatNumber": "abc123",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 987,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": false,
      "hasEmailAuth": false,
      "changePasswordRequired": true,
      "referralCode": 987,
      "systemUser": true,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "xyz789",
      "kycTierId": "xyz789",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": true,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "xyz789",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "abc123",
      "kycReviewRejectedType": "xyz789",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "xyz789",
      "kycStatusUpdateRequired": true,
      "kycDocs": ["abc123"],
      "custodyProvider": "xyz789",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "xyz789",
      "defaultCryptoCurrency": "abc123",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "riskAlertCount": 123,
      "widgetId": "xyz789",
      "widgetCode": "xyz789",
      "affiliateId": "abc123",
      "affiliateCode": "xyz789",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 123,
      "totalDepositInProcess": 123.45,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 123,
      "totalBoughtCompleted": 987.65,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 123.45,
      "totalBoughtInProcessCount": 123,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 123,
      "totalSentCompleted": 123.45,
      "totalSentCompletedCount": 987,
      "totalSentInProcess": 123.45,
      "totalSentInProcessCount": 123,
      "totalReceivedCompleted": 123.45,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 123.45,
      "totalReceivedInProcessCount": 123,
      "totalTransactionCount": 123,
      "avarageTransaction": 987.65,
      "manuallyEditedRisk": true,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "xyz789",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "abc123",
      "openpaydAccountHolderId": "abc123"
    }
  }
}
Mutations

deleteMyDevice

Response

Returns a UserDeviceListResult

Arguments
Name Description
deviceIds - [String]

Example

Query
mutation deleteMyDevice($deviceIds: [String]) {
  deleteMyDevice(deviceIds: $deviceIds) {
    count
    list {
      ...UserDeviceFragment
    }
  }
}
Variables
{"deviceIds": ["xyz789"]}
Response
{
  "data": {
    "deleteMyDevice": {"count": 987, "list": [UserDevice]}
  }
}
Mutations

deleteMyNotifications

Response

Returns [UserNotification!]

Arguments
Name Description
notificationIds - [ID!]

Example

Query
mutation deleteMyNotifications($notificationIds: [ID!]) {
  deleteMyNotifications(notificationIds: $notificationIds) {
    userNotificationId
    userId
    user {
      ...UserFragment
    }
    userNotificationTypeCode
    userNotificationLevel
    created
    viewed
    title
    text
    linkedId
    linkedTable
    params
  }
}
Variables
{"notificationIds": ["4"]}
Response
{
  "data": {
    "deleteMyNotifications": [
      {
        "userNotificationId": "4",
        "userId": "xyz789",
        "user": User,
        "userNotificationTypeCode": "xyz789",
        "userNotificationLevel": "Request",
        "created": "2007-12-03T10:15:30Z",
        "viewed": "2007-12-03T10:15:30Z",
        "title": "xyz789",
        "text": "xyz789",
        "linkedId": "abc123",
        "linkedTable": "xyz789",
        "params": "xyz789"
      }
    ]
  }
}
Mutations

deleteMyVault

Description

This endpoint can be used to delete the current user's wallet.

Response

Returns a UserVaultIdObj

Arguments
Name Description
vaultId - String Wallet id

Example

Query
mutation deleteMyVault($vaultId: String) {
  deleteMyVault(vaultId: $vaultId) {
    userVaultId
    userId
    custodyProvider
    originalId
    name
    default
    created
    disabled
    subWallets
    additionalSettings
  }
}
Variables
{"vaultId": "xyz789"}
Response
{
  "data": {
    "deleteMyVault": {
      "userVaultId": "4",
      "userId": "abc123",
      "custodyProvider": "xyz789",
      "originalId": "abc123",
      "name": "xyz789",
      "default": true,
      "created": "2007-12-03T10:15:30Z",
      "disabled": "2007-12-03T10:15:30Z",
      "subWallets": ["abc123"],
      "additionalSettings": "abc123"
    }
  }
}
Mutations

deleteMyWidget

Description

This endpoint can be used to delete a widget for the current user.

Response

Returns a Widget

Arguments
Name Description
widgetId - String Widget id

Example

Query
mutation deleteMyWidget($widgetId: String) {
  deleteMyWidget(widgetId: $widgetId) {
    widgetId
    code
    userId
    userCode
    name
    description
    created
    createdBy
    createdByUser {
      ...UserFragment
    }
    transactionTypes
    currenciesCrypto
    currenciesFiat
    destinationAddress
    countriesCode2
    instruments
    paymentProviders
    liquidityProvider
    additionalSettings
    currentUserEmail
    currentUserParams
    hasFixedAddress
    secret
  }
}
Variables
{"widgetId": "abc123"}
Response
{
  "data": {
    "deleteMyWidget": {
      "widgetId": 4,
      "code": "xyz789",
      "userId": "abc123",
      "userCode": "xyz789",
      "name": "xyz789",
      "description": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "createdByUser": User,
      "transactionTypes": ["Buy"],
      "currenciesCrypto": ["abc123"],
      "currenciesFiat": ["xyz789"],
      "destinationAddress": "xyz789",
      "countriesCode2": ["abc123"],
      "instruments": ["CreditCard"],
      "paymentProviders": ["xyz789"],
      "liquidityProvider": "Bitstamp",
      "additionalSettings": "xyz789",
      "currentUserEmail": "xyz789",
      "currentUserParams": "xyz789",
      "hasFixedAddress": false,
      "secret": "abc123"
    }
  }
}
Mutations

deleteSettingsCost

Response

Returns a SettingsCost!

Arguments
Name Description
settingsId - ID!

Example

Query
mutation deleteSettingsCost($settingsId: ID!) {
  deleteSettingsCost(settingsId: $settingsId) {
    settingsCostId
    name
    description
    targetFilterType
    targetFilterValues
    targetInstruments
    targetTransactionTypes
    targetPaymentProviders
    terms
    created
    createdBy
    bankAccounts {
      ...WireTransferBankAccountFragment
    }
    default
    deleted
  }
}
Variables
{"settingsId": 4}
Response
{
  "data": {
    "deleteSettingsCost": {
      "settingsCostId": 4,
      "name": "abc123",
      "description": "xyz789",
      "targetFilterType": "None",
      "targetFilterValues": ["xyz789"],
      "targetInstruments": ["xyz789"],
      "targetTransactionTypes": ["abc123"],
      "targetPaymentProviders": ["xyz789"],
      "terms": "abc123",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "xyz789",
      "bankAccounts": [WireTransferBankAccount],
      "default": false,
      "deleted": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

deleteSettingsFee

Response

Returns a SettingsFee!

Arguments
Name Description
settingsId - ID!

Example

Query
mutation deleteSettingsFee($settingsId: ID!) {
  deleteSettingsFee(settingsId: $settingsId) {
    settingsFeeId
    name
    description
    targetFilterType
    targetFilterValues
    targetInstruments
    targetUserTypes
    targetUserModes
    targetTransactionTypes
    targetPaymentProviders
    terms
    wireDetails
    created
    createdBy
    default
    deleted
    currency
    rateToEur
    costs {
      ...SettingsCostFragment
    }
  }
}
Variables
{"settingsId": "4"}
Response
{
  "data": {
    "deleteSettingsFee": {
      "settingsFeeId": 4,
      "name": "xyz789",
      "description": "abc123",
      "targetFilterType": "None",
      "targetFilterValues": ["abc123"],
      "targetInstruments": ["xyz789"],
      "targetUserTypes": ["Merchant"],
      "targetUserModes": ["InternalWallet"],
      "targetTransactionTypes": ["xyz789"],
      "targetPaymentProviders": ["abc123"],
      "terms": "xyz789",
      "wireDetails": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "default": true,
      "deleted": "2007-12-03T10:15:30Z",
      "currency": "abc123",
      "rateToEur": 123.45,
      "costs": [SettingsCost]
    }
  }
}
Mutations

deleteSettingsKyc

Response

Returns a SettingsKyc!

Arguments
Name Description
settingsId - ID!

Example

Query
mutation deleteSettingsKyc($settingsId: ID!) {
  deleteSettingsKyc(settingsId: $settingsId) {
    settingsKycId
    name
    description
    targetKycProviders
    targetUserType
    targetUserModes
    targetFilterType
    targetFilterValues
    levels {
      ...SettingsKycLevelFragment
    }
    requireUserFullName
    requireUserPhone
    requireUserBirthday
    requireUserAddress
    requireUserFlatNumber
    created
    createdBy
    default
    deleted
  }
}
Variables
{"settingsId": 4}
Response
{
  "data": {
    "deleteSettingsKyc": {
      "settingsKycId": 4,
      "name": "xyz789",
      "description": "abc123",
      "targetKycProviders": ["Local"],
      "targetUserType": "Merchant",
      "targetUserModes": ["InternalWallet"],
      "targetFilterType": "None",
      "targetFilterValues": ["xyz789"],
      "levels": [SettingsKycLevel],
      "requireUserFullName": true,
      "requireUserPhone": true,
      "requireUserBirthday": true,
      "requireUserAddress": true,
      "requireUserFlatNumber": false,
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "default": false,
      "deleted": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

deleteSettingsKycLevel

Response

Returns a SettingsKycLevel!

Arguments
Name Description
settingsId - ID!

Example

Query
mutation deleteSettingsKycLevel($settingsId: ID!) {
  deleteSettingsKycLevel(settingsId: $settingsId) {
    settingsKycLevelId
    name
    originalLevelName
    originalFlowName
    description
    userType
    order
    data
    created
    createdBy
  }
}
Variables
{"settingsId": "4"}
Response
{
  "data": {
    "deleteSettingsKycLevel": {
      "settingsKycLevelId": 4,
      "name": "xyz789",
      "originalLevelName": "abc123",
      "originalFlowName": "abc123",
      "description": "xyz789",
      "userType": "Merchant",
      "order": 987,
      "data": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "xyz789"
    }
  }
}
Mutations

deleteSettingsKycTier

Response

Returns a SettingsKycTier!

Arguments
Name Description
settingsId - ID!

Example

Query
mutation deleteSettingsKycTier($settingsId: ID!) {
  deleteSettingsKycTier(settingsId: $settingsId) {
    settingsKycTierId
    name
    description
    amount
    targetKycProviders
    targetUserType
    targetUserModes
    targetFilterType
    targetFilterValues
    levelId
    level {
      ...SettingsKycLevelFragment
    }
    requireUserFullName
    requireUserPhone
    requireUserBirthday
    requireUserAddress
    requireUserFlatNumber
    created
    createdBy
    default
    deleted
  }
}
Variables
{"settingsId": 4}
Response
{
  "data": {
    "deleteSettingsKycTier": {
      "settingsKycTierId": "4",
      "name": "xyz789",
      "description": "abc123",
      "amount": 987.65,
      "targetKycProviders": ["Local"],
      "targetUserType": "Merchant",
      "targetUserModes": ["InternalWallet"],
      "targetFilterType": "None",
      "targetFilterValues": ["abc123"],
      "levelId": "abc123",
      "level": SettingsKycLevel,
      "requireUserFullName": false,
      "requireUserPhone": false,
      "requireUserBirthday": true,
      "requireUserAddress": false,
      "requireUserFlatNumber": false,
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "xyz789",
      "default": true,
      "deleted": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

deleteUser

Response

Returns a User

Arguments
Name Description
userId - ID!

Example

Query
mutation deleteUser($userId: ID!) {
  deleteUser(userId: $userId) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"userId": 4}
Response
{
  "data": {
    "deleteUser": {
      "userId": 4,
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["xyz789"],
      "firstName": "xyz789",
      "lastName": "xyz789",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "abc123",
      "countryCode3": "xyz789",
      "postCode": "abc123",
      "town": "abc123",
      "street": "abc123",
      "subStreet": "xyz789",
      "stateName": "xyz789",
      "buildingName": "xyz789",
      "buildingNumber": "abc123",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 123,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": false,
      "hasEmailAuth": false,
      "changePasswordRequired": true,
      "referralCode": 123,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "abc123",
      "kycTierId": "xyz789",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "abc123",
      "kycValid": false,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "xyz789",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": true,
      "kycDocs": ["abc123"],
      "custodyProvider": "xyz789",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "abc123",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "riskAlertCount": 987,
      "widgetId": "xyz789",
      "widgetCode": "abc123",
      "affiliateId": "xyz789",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 123.45,
      "totalDepositCompletedCount": 987,
      "totalDepositInProcess": 987.65,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 987.65,
      "totalWithdrawalInProcessCount": 123,
      "totalBoughtCompleted": 987.65,
      "totalBoughtCompletedCount": 123,
      "totalBoughtInProcess": 123.45,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 123.45,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 123.45,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 987.65,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 123,
      "totalTransactionCount": 987,
      "avarageTransaction": 123.45,
      "manuallyEditedRisk": true,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "abc123",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "abc123",
      "openpaydAccountHolderId": "abc123"
    }
  }
}
Mutations

deleteUserApiKey

Response

Returns an ApiKey

Arguments
Name Description
apiKeyId - String

Example

Query
mutation deleteUserApiKey($apiKeyId: String) {
  deleteUserApiKey(apiKeyId: $apiKeyId) {
    apiKeyId
    userId
    user {
      ...UserFragment
    }
    created
    disabled
  }
}
Variables
{"apiKeyId": "abc123"}
Response
{
  "data": {
    "deleteUserApiKey": {
      "apiKeyId": 4,
      "userId": "xyz789",
      "user": User,
      "created": "2007-12-03T10:15:30Z",
      "disabled": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

deleteUserNotifications

Response

Returns [UserNotification!]

Arguments
Name Description
notificationIds - [ID!]

Example

Query
mutation deleteUserNotifications($notificationIds: [ID!]) {
  deleteUserNotifications(notificationIds: $notificationIds) {
    userNotificationId
    userId
    user {
      ...UserFragment
    }
    userNotificationTypeCode
    userNotificationLevel
    created
    viewed
    title
    text
    linkedId
    linkedTable
    params
  }
}
Variables
{"notificationIds": [4]}
Response
{
  "data": {
    "deleteUserNotifications": [
      {
        "userNotificationId": 4,
        "userId": "abc123",
        "user": User,
        "userNotificationTypeCode": "xyz789",
        "userNotificationLevel": "Request",
        "created": "2007-12-03T10:15:30Z",
        "viewed": "2007-12-03T10:15:30Z",
        "title": "abc123",
        "text": "xyz789",
        "linkedId": "abc123",
        "linkedTable": "abc123",
        "params": "abc123"
      }
    ]
  }
}
Mutations

deleteUserVault

Description

This endpoint can be used to delete the user's wallet.

Response

Returns a UserVaultIdObj

Arguments
Name Description
userId - ID! User id
vaultId - String Wallet id

Example

Query
mutation deleteUserVault(
  $userId: ID!,
  $vaultId: String
) {
  deleteUserVault(
    userId: $userId,
    vaultId: $vaultId
  ) {
    userVaultId
    userId
    custodyProvider
    originalId
    name
    default
    created
    disabled
    subWallets
    additionalSettings
  }
}
Variables
{"userId": 4, "vaultId": "xyz789"}
Response
{
  "data": {
    "deleteUserVault": {
      "userVaultId": "4",
      "userId": "abc123",
      "custodyProvider": "xyz789",
      "originalId": "xyz789",
      "name": "abc123",
      "default": true,
      "created": "2007-12-03T10:15:30Z",
      "disabled": "2007-12-03T10:15:30Z",
      "subWallets": ["abc123"],
      "additionalSettings": "abc123"
    }
  }
}
Mutations

deleteWidget

Description

This endpoint can be used to delete a widget.

Response

Returns a Widget

Arguments
Name Description
widgetId - String Widget id

Example

Query
mutation deleteWidget($widgetId: String) {
  deleteWidget(widgetId: $widgetId) {
    widgetId
    code
    userId
    userCode
    name
    description
    created
    createdBy
    createdByUser {
      ...UserFragment
    }
    transactionTypes
    currenciesCrypto
    currenciesFiat
    destinationAddress
    countriesCode2
    instruments
    paymentProviders
    liquidityProvider
    additionalSettings
    currentUserEmail
    currentUserParams
    hasFixedAddress
    secret
  }
}
Variables
{"widgetId": "xyz789"}
Response
{
  "data": {
    "deleteWidget": {
      "widgetId": 4,
      "code": "xyz789",
      "userId": "abc123",
      "userCode": "abc123",
      "name": "xyz789",
      "description": "abc123",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "xyz789",
      "createdByUser": User,
      "transactionTypes": ["Buy"],
      "currenciesCrypto": ["abc123"],
      "currenciesFiat": ["abc123"],
      "destinationAddress": "abc123",
      "countriesCode2": ["xyz789"],
      "instruments": ["CreditCard"],
      "paymentProviders": ["abc123"],
      "liquidityProvider": "Bitstamp",
      "additionalSettings": "abc123",
      "currentUserEmail": "xyz789",
      "currentUserParams": "abc123",
      "hasFixedAddress": true,
      "secret": "xyz789"
    }
  }
}
Mutations

deleteWireTransferBankAccount

Response

Returns a WireTransferBankAccount!

Arguments
Name Description
bankAccountId - ID!

Example

Query
mutation deleteWireTransferBankAccount($bankAccountId: ID!) {
  deleteWireTransferBankAccount(bankAccountId: $bankAccountId) {
    bankAccountId
    name
    description
    created
    createdBy
    au
    uk
    eu
    openpayd
    openpaydObject
    deleted
  }
}
Variables
{"bankAccountId": "4"}
Response
{
  "data": {
    "deleteWireTransferBankAccount": {
      "bankAccountId": 4,
      "name": "abc123",
      "description": "abc123",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "au": "abc123",
      "uk": "abc123",
      "eu": "xyz789",
      "openpayd": false,
      "openpaydObject": "xyz789",
      "deleted": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

disable2fa

Response

Returns a LoginResult!

Arguments
Name Description
password - String!
code - String!

Example

Query
mutation disable2fa(
  $password: String!,
  $code: String!
) {
  disable2fa(
    password: $password,
    code: $code
  ) {
    authToken
    user {
      ...UserFragment
    }
    authTokenAction
    authTokenActionParam
  }
}
Variables
{
  "password": "abc123",
  "code": "xyz789"
}
Response
{
  "data": {
    "disable2fa": {
      "authToken": "abc123",
      "user": User,
      "authTokenAction": "xyz789",
      "authTokenActionParam": "xyz789"
    }
  }
}
Mutations

enable2fa

Response

Returns a LoginResult!

Arguments
Name Description
password - String!
code - String!

Example

Query
mutation enable2fa(
  $password: String!,
  $code: String!
) {
  enable2fa(
    password: $password,
    code: $code
  ) {
    authToken
    user {
      ...UserFragment
    }
    authTokenAction
    authTokenActionParam
  }
}
Variables
{
  "password": "xyz789",
  "code": "abc123"
}
Response
{
  "data": {
    "enable2fa": {
      "authToken": "abc123",
      "user": User,
      "authTokenAction": "xyz789",
      "authTokenActionParam": "abc123"
    }
  }
}
Mutations

executeTransaction

Description

This endpoint can be used to execute a transaction

Response

Returns a TransactionShort

Arguments
Name Description
transactionId - String Transaction id
code - Int Code

Example

Query
mutation executeTransaction(
  $transactionId: String,
  $code: Int
) {
  executeTransaction(
    transactionId: $transactionId,
    code: $code
  ) {
    transactionId
    code
    userId
    userReferralCode
    sourceVaultId
    sourceVault
    userIp
    userTierId
    userTier {
      ...SettingsKycTierShortExFragment
    }
    requiredUserTierId
    requiredUserTier {
      ...SettingsKycTierShortExFragment
    }
    created
    updated
    executed
    type
    status
    subStatus
    kycStatus
    accountStatus
    feeFiat
    feePercent
    feeMinFiat
    feeDetails
    approxNetworkFee
    approxNetworkFeeFiat
    currencyToSpend
    amountToSpend
    amountToSpendWithoutFee
    currencyToReceive
    initialAmountToReceive
    initialAmountToReceiveWithoutFee
    amountToReceive
    amountToReceiveWithoutFee
    amountInEur
    initialRate
    rate
    rateFiatToEur
    destVaultId
    destVault
    destination
    countryCode2
    countryCode3
    accountType
    source
    instrument
    instrumentDetails
    custodyProvider
    custodyDetails
    paymentProvider
    liquidityProvider
    paymentOrder {
      ...PaymentOrderFragment
    }
    liquidityOrder {
      ...LiquidityOrderFragment
    }
    transferOrder {
      ...TransferOrderFragment
    }
    widgetId
    widgetCode
    widgetUserParamsId
    widgetUserParams
    widget
    destinationUserId
    risk
    riskCodes
    cryptoInvoiceName
    data
    sourceAddress
  }
}
Variables
{"transactionId": "abc123", "code": 123}
Response
{
  "data": {
    "executeTransaction": {
      "transactionId": "4",
      "code": "xyz789",
      "userId": "xyz789",
      "userReferralCode": 123,
      "sourceVaultId": "xyz789",
      "sourceVault": "xyz789",
      "userIp": "xyz789",
      "userTierId": "abc123",
      "userTier": SettingsKycTierShortEx,
      "requiredUserTierId": "xyz789",
      "requiredUserTier": SettingsKycTierShortEx,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "executed": "2007-12-03T10:15:30Z",
      "type": "Buy",
      "status": "New",
      "subStatus": "abc123",
      "kycStatus": "KycWaiting",
      "accountStatus": "Live",
      "feeFiat": 123.45,
      "feePercent": 123.45,
      "feeMinFiat": 987.65,
      "feeDetails": "abc123",
      "approxNetworkFee": 123.45,
      "approxNetworkFeeFiat": 987.65,
      "currencyToSpend": "xyz789",
      "amountToSpend": 123.45,
      "amountToSpendWithoutFee": 123.45,
      "currencyToReceive": "xyz789",
      "initialAmountToReceive": 987.65,
      "initialAmountToReceiveWithoutFee": 987.65,
      "amountToReceive": 987.65,
      "amountToReceiveWithoutFee": 123.45,
      "amountInEur": 123.45,
      "initialRate": 987.65,
      "rate": 123.45,
      "rateFiatToEur": 987.65,
      "destVaultId": "xyz789",
      "destVault": "abc123",
      "destination": "abc123",
      "countryCode2": "abc123",
      "countryCode3": "abc123",
      "accountType": "xyz789",
      "source": "QuickCheckout",
      "instrument": "CreditCard",
      "instrumentDetails": "abc123",
      "custodyProvider": "Fireblocks",
      "custodyDetails": "xyz789",
      "paymentProvider": "xyz789",
      "liquidityProvider": "Bitstamp",
      "paymentOrder": PaymentOrder,
      "liquidityOrder": LiquidityOrder,
      "transferOrder": TransferOrder,
      "widgetId": "xyz789",
      "widgetCode": "abc123",
      "widgetUserParamsId": "xyz789",
      "widgetUserParams": "abc123",
      "widget": "abc123",
      "destinationUserId": "abc123",
      "risk": "Low",
      "riskCodes": ["xyz789"],
      "cryptoInvoiceName": "xyz789",
      "data": "abc123",
      "sourceAddress": "abc123"
    }
  }
}
Mutations

exportTransactionsToCsv

Response

Returns a Boolean

Arguments
Name Description
transactionIdsOnly - [String!]
transactionStatusesOnly - [String!]
userIdsOnly - [String!]
widgetIdsOnly - [String!]
sourcesOnly - [TransactionSource!]
countriesOnly - [String!]
countryCodeType - CountryCodeType
accountTypesOnly - [UserType!]
transactionDateOnly - DateTime
transactionTypesOnly - [TransactionType!]
sendersOrReceiversOnly - [String!]
paymentProvidersOnly - [String!]
accountStatusesOnly - [String!]
userTierLevelsOnly - [String!]
riskLevelsOnly - [String!]
paymentInstrumentsOnly - [PaymentInstrument!]
createdDateInterval - DateTimeInterval
completedDateInterval - DateTimeInterval
walletAddressOnly - String
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
mutation exportTransactionsToCsv(
  $transactionIdsOnly: [String!],
  $transactionStatusesOnly: [String!],
  $userIdsOnly: [String!],
  $widgetIdsOnly: [String!],
  $sourcesOnly: [TransactionSource!],
  $countriesOnly: [String!],
  $countryCodeType: CountryCodeType,
  $accountTypesOnly: [UserType!],
  $transactionDateOnly: DateTime,
  $transactionTypesOnly: [TransactionType!],
  $sendersOrReceiversOnly: [String!],
  $paymentProvidersOnly: [String!],
  $accountStatusesOnly: [String!],
  $userTierLevelsOnly: [String!],
  $riskLevelsOnly: [String!],
  $paymentInstrumentsOnly: [PaymentInstrument!],
  $createdDateInterval: DateTimeInterval,
  $completedDateInterval: DateTimeInterval,
  $walletAddressOnly: String,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  exportTransactionsToCsv(
    transactionIdsOnly: $transactionIdsOnly,
    transactionStatusesOnly: $transactionStatusesOnly,
    userIdsOnly: $userIdsOnly,
    widgetIdsOnly: $widgetIdsOnly,
    sourcesOnly: $sourcesOnly,
    countriesOnly: $countriesOnly,
    countryCodeType: $countryCodeType,
    accountTypesOnly: $accountTypesOnly,
    transactionDateOnly: $transactionDateOnly,
    transactionTypesOnly: $transactionTypesOnly,
    sendersOrReceiversOnly: $sendersOrReceiversOnly,
    paymentProvidersOnly: $paymentProvidersOnly,
    accountStatusesOnly: $accountStatusesOnly,
    userTierLevelsOnly: $userTierLevelsOnly,
    riskLevelsOnly: $riskLevelsOnly,
    paymentInstrumentsOnly: $paymentInstrumentsOnly,
    createdDateInterval: $createdDateInterval,
    completedDateInterval: $completedDateInterval,
    walletAddressOnly: $walletAddressOnly,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  )
}
Variables
{
  "transactionIdsOnly": ["abc123"],
  "transactionStatusesOnly": ["xyz789"],
  "userIdsOnly": ["abc123"],
  "widgetIdsOnly": ["xyz789"],
  "sourcesOnly": ["QuickCheckout"],
  "countriesOnly": ["xyz789"],
  "countryCodeType": "code2",
  "accountTypesOnly": ["Merchant"],
  "transactionDateOnly": "2007-12-03T10:15:30Z",
  "transactionTypesOnly": ["Buy"],
  "sendersOrReceiversOnly": ["abc123"],
  "paymentProvidersOnly": ["abc123"],
  "accountStatusesOnly": ["xyz789"],
  "userTierLevelsOnly": ["abc123"],
  "riskLevelsOnly": ["xyz789"],
  "paymentInstrumentsOnly": ["CreditCard"],
  "createdDateInterval": DateTimeInterval,
  "completedDateInterval": DateTimeInterval,
  "walletAddressOnly": "xyz789",
  "filter": "xyz789",
  "skip": 987,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{"data": {"exportTransactionsToCsv": true}}
Mutations

exportUsersToCsv

Response

Returns a Boolean

Arguments
Name Description
userIdsOnly - [String!]
roleIdsOnly - [String!]
accountTypesOnly - [UserType!]
accountModesOnly - [UserMode!]
accountStatusesOnly - [AccountStatus!]
userTierLevelsOnly - [String!]
riskLevelsOnly - [RiskLevel!]
countriesOnly - [String!]
countryCodeType - CountryCodeType
kycStatusesOnly - [KycStatus!]
registrationDateInterval - DateTimeInterval
widgetIdsOnly - [String!]
totalBuyVolumeOver - Int
transactionCountOver - Int
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
mutation exportUsersToCsv(
  $userIdsOnly: [String!],
  $roleIdsOnly: [String!],
  $accountTypesOnly: [UserType!],
  $accountModesOnly: [UserMode!],
  $accountStatusesOnly: [AccountStatus!],
  $userTierLevelsOnly: [String!],
  $riskLevelsOnly: [RiskLevel!],
  $countriesOnly: [String!],
  $countryCodeType: CountryCodeType,
  $kycStatusesOnly: [KycStatus!],
  $registrationDateInterval: DateTimeInterval,
  $widgetIdsOnly: [String!],
  $totalBuyVolumeOver: Int,
  $transactionCountOver: Int,
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  exportUsersToCsv(
    userIdsOnly: $userIdsOnly,
    roleIdsOnly: $roleIdsOnly,
    accountTypesOnly: $accountTypesOnly,
    accountModesOnly: $accountModesOnly,
    accountStatusesOnly: $accountStatusesOnly,
    userTierLevelsOnly: $userTierLevelsOnly,
    riskLevelsOnly: $riskLevelsOnly,
    countriesOnly: $countriesOnly,
    countryCodeType: $countryCodeType,
    kycStatusesOnly: $kycStatusesOnly,
    registrationDateInterval: $registrationDateInterval,
    widgetIdsOnly: $widgetIdsOnly,
    totalBuyVolumeOver: $totalBuyVolumeOver,
    transactionCountOver: $transactionCountOver,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  )
}
Variables
{
  "userIdsOnly": ["abc123"],
  "roleIdsOnly": ["xyz789"],
  "accountTypesOnly": ["Merchant"],
  "accountModesOnly": ["InternalWallet"],
  "accountStatusesOnly": ["Live"],
  "userTierLevelsOnly": ["abc123"],
  "riskLevelsOnly": ["Low"],
  "countriesOnly": ["abc123"],
  "countryCodeType": "code2",
  "kycStatusesOnly": ["unknown"],
  "registrationDateInterval": DateTimeInterval,
  "widgetIdsOnly": ["xyz789"],
  "totalBuyVolumeOver": 123,
  "transactionCountOver": 987,
  "filter": "xyz789",
  "skip": 987,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{"data": {"exportUsersToCsv": false}}
Mutations

exportWidgetsToCsv

Response

Returns a Boolean

Arguments
Name Description
widgetIdsOnly - [String!]
userIdsOnly - [String!]
filter - String
skip - Int
first - Int
orderBy - [OrderBy!]

Example

Query
mutation exportWidgetsToCsv(
  $widgetIdsOnly: [String!],
  $userIdsOnly: [String!],
  $filter: String,
  $skip: Int,
  $first: Int,
  $orderBy: [OrderBy!]
) {
  exportWidgetsToCsv(
    widgetIdsOnly: $widgetIdsOnly,
    userIdsOnly: $userIdsOnly,
    filter: $filter,
    skip: $skip,
    first: $first,
    orderBy: $orderBy
  )
}
Variables
{
  "widgetIdsOnly": ["xyz789"],
  "userIdsOnly": ["xyz789"],
  "filter": "abc123",
  "skip": 123,
  "first": 987,
  "orderBy": [OrderBy]
}
Response
{"data": {"exportWidgetsToCsv": true}}
Mutations

foo

Response

Returns a String!

Example

Query
mutation foo {
  foo
}
Response
{"data": {"foo": "abc123"}}
Mutations

forgotPassword

Response

Returns a Boolean!

Arguments
Name Description
email - String!
recaptcha - String!

Example

Query
mutation forgotPassword(
  $email: String!,
  $recaptcha: String!
) {
  forgotPassword(
    email: $email,
    recaptcha: $recaptcha
  )
}
Variables
{
  "email": "xyz789",
  "recaptcha": "abc123"
}
Response
{"data": {"forgotPassword": true}}
Mutations

generate2faCode

Response

Returns a TwoFactorAuthenticationResult!

Example

Query
mutation generate2faCode {
  generate2faCode {
    otpauthUrl
    code
    qr
  }
}
Response
{
  "data": {
    "generate2faCode": {
      "otpauthUrl": "xyz789",
      "code": "abc123",
      "qr": "xyz789"
    }
  }
}
Mutations

generateDefaultTokenWhenKycSent

Response

Returns a LoginResult!

Arguments
Name Description
recaptcha - String!

Example

Query
mutation generateDefaultTokenWhenKycSent($recaptcha: String!) {
  generateDefaultTokenWhenKycSent(recaptcha: $recaptcha) {
    authToken
    user {
      ...UserFragment
    }
    authTokenAction
    authTokenActionParam
  }
}
Variables
{"recaptcha": "abc123"}
Response
{
  "data": {
    "generateDefaultTokenWhenKycSent": {
      "authToken": "abc123",
      "user": User,
      "authTokenAction": "xyz789",
      "authTokenActionParam": "abc123"
    }
  }
}
Mutations

get2faQRCode

Response

Returns a String!

Arguments
Name Description
data - String!

Example

Query
mutation get2faQRCode($data: String!) {
  get2faQRCode(data: $data)
}
Variables
{"data": "xyz789"}
Response
{"data": {"get2faQRCode": "abc123"}}
Mutations

login

Response

Returns a LoginResult!

Arguments
Name Description
email - String
password - String
oAuthProvider - OAuthProvider
oAuthToken - String
recaptcha - String!
widgetId - String

Example

Query
mutation login(
  $email: String,
  $password: String,
  $oAuthProvider: OAuthProvider,
  $oAuthToken: String,
  $recaptcha: String!,
  $widgetId: String
) {
  login(
    email: $email,
    password: $password,
    oAuthProvider: $oAuthProvider,
    oAuthToken: $oAuthToken,
    recaptcha: $recaptcha,
    widgetId: $widgetId
  ) {
    authToken
    user {
      ...UserFragment
    }
    authTokenAction
    authTokenActionParam
  }
}
Variables
{
  "email": "abc123",
  "password": "xyz789",
  "oAuthProvider": "google",
  "oAuthToken": "abc123",
  "recaptcha": "abc123",
  "widgetId": "xyz789"
}
Response
{
  "data": {
    "login": {
      "authToken": "abc123",
      "user": User,
      "authTokenAction": "abc123",
      "authTokenActionParam": "abc123"
    }
  }
}
Mutations

logout

Response

Returns a Boolean!

Example

Query
mutation logout {
  logout
}
Response
{"data": {"logout": true}}
Mutations

makeNotificationsViewed

Response

Returns [UserNotification!]

Arguments
Name Description
notificationIds - [ID!]

Example

Query
mutation makeNotificationsViewed($notificationIds: [ID!]) {
  makeNotificationsViewed(notificationIds: $notificationIds) {
    userNotificationId
    userId
    user {
      ...UserFragment
    }
    userNotificationTypeCode
    userNotificationLevel
    created
    viewed
    title
    text
    linkedId
    linkedTable
    params
  }
}
Variables
{"notificationIds": ["4"]}
Response
{
  "data": {
    "makeNotificationsViewed": [
      {
        "userNotificationId": 4,
        "userId": "xyz789",
        "user": User,
        "userNotificationTypeCode": "xyz789",
        "userNotificationLevel": "Request",
        "created": "2007-12-03T10:15:30Z",
        "viewed": "2007-12-03T10:15:30Z",
        "title": "xyz789",
        "text": "xyz789",
        "linkedId": "xyz789",
        "linkedTable": "xyz789",
        "params": "abc123"
      }
    ]
  }
}
Mutations

preauth

Response

Returns a PaymentPreauthResultShort!

Arguments
Name Description
orderParams - PaymentPreauthInput!

Example

Query
mutation preauth($orderParams: PaymentPreauthInput!) {
  preauth(orderParams: $orderParams) {
    order {
      ...PaymentOrderShortFragment
    }
    html
    details
  }
}
Variables
{"orderParams": PaymentPreauthInput}
Response
{
  "data": {
    "preauth": {
      "order": PaymentOrderShort,
      "html": "xyz789",
      "details": "xyz789"
    }
  }
}
Mutations

preauthFull

Response

Returns a PaymentPreauthResult!

Arguments
Name Description
orderParams - PaymentPreauthInput!

Example

Query
mutation preauthFull($orderParams: PaymentPreauthInput!) {
  preauthFull(orderParams: $orderParams) {
    order {
      ...PaymentOrderFragment
    }
    html
    details
  }
}
Variables
{"orderParams": PaymentPreauthInput}
Response
{
  "data": {
    "preauthFull": {
      "order": PaymentOrder,
      "html": "xyz789",
      "details": "xyz789"
    }
  }
}
Mutations

refreshToken

Response

Returns a String!

Example

Query
mutation refreshToken {
  refreshToken
}
Response
{"data": {"refreshToken": "abc123"}}
Mutations

removeRole

Response

Returns a User

Arguments
Name Description
userId - ID!
roleCodes - [String!]

Example

Query
mutation removeRole(
  $userId: ID!,
  $roleCodes: [String!]
) {
  removeRole(
    userId: $userId,
    roleCodes: $roleCodes
  ) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"userId": 4, "roleCodes": ["xyz789"]}
Response
{
  "data": {
    "removeRole": {
      "userId": 4,
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["abc123"],
      "firstName": "abc123",
      "lastName": "abc123",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "abc123",
      "countryCode3": "abc123",
      "postCode": "abc123",
      "town": "xyz789",
      "street": "abc123",
      "subStreet": "xyz789",
      "stateName": "abc123",
      "buildingName": "abc123",
      "buildingNumber": "xyz789",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "xyz789",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 123,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": false,
      "changePasswordRequired": false,
      "referralCode": 123,
      "systemUser": true,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "xyz789",
      "kycTierId": "abc123",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "abc123",
      "kycValid": false,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "xyz789",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "abc123",
      "kycReviewRejectedType": "abc123",
      "kycReviewRejectedLabels": ["abc123"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": true,
      "kycDocs": ["abc123"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "abc123",
      "risk": "Low",
      "riskCodes": ["xyz789"],
      "riskAlertCount": 123,
      "widgetId": "xyz789",
      "widgetCode": "xyz789",
      "affiliateId": "xyz789",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 123,
      "totalDepositInProcess": 987.65,
      "totalDepositInProcessCount": 987,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 987,
      "totalWithdrawalInProcess": 987.65,
      "totalWithdrawalInProcessCount": 987,
      "totalBoughtCompleted": 123.45,
      "totalBoughtCompletedCount": 123,
      "totalBoughtInProcess": 123.45,
      "totalBoughtInProcessCount": 123,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 123,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 123,
      "totalSentCompleted": 987.65,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 123.45,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 123.45,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 987,
      "avarageTransaction": 987.65,
      "manuallyEditedRisk": false,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "abc123",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "xyz789",
      "openpaydAccountHolderId": "xyz789"
    }
  }
}
Mutations

repeatDeclinedTransactions

Response

Returns [Transaction!]

Arguments
Name Description
transactionIds - [String!]

Example

Query
mutation repeatDeclinedTransactions($transactionIds: [String!]) {
  repeatDeclinedTransactions(transactionIds: $transactionIds) {
    transactionId
    code
    userId
    userReferralCode
    userIp
    userTierId
    userTier {
      ...SettingsKycTierShortExFragment
    }
    requiredUserTierId
    requiredUserTier {
      ...SettingsKycTierShortExFragment
    }
    sourceVaultId
    sourceVault
    user {
      ...UserFragment
    }
    created
    updated
    executed
    type
    status
    subStatus
    kycStatus
    accountStatus
    feeFiat
    feePercent
    feeMinFiat
    feeDetails
    approxNetworkFee
    approxNetworkFeeFiat
    userDefaultFiatCurrency
    userDefaultCryptoCurrency
    currencyToSpend
    amountToSpend
    amountToSpendWithoutFee
    currencyToReceive
    initialAmountToReceive
    initialAmountToReceiveWithoutFee
    amountToReceive
    amountToReceiveWithoutFee
    amountInEur
    initialRate
    rate
    rateFiatToEur
    destVaultId
    destVault
    destination
    countryCode2
    countryCode3
    accountType
    source
    instrument
    instrumentDetails
    custodyProvider
    custodyDetails
    paymentProvider
    paymentOrderId
    paymentOrder {
      ...PaymentOrderFragment
    }
    liquidityProvider
    liquidityOrderId
    liquidityOrder {
      ...LiquidityOrderFragment
    }
    transferOrderId
    transferOrder {
      ...TransferOrderFragment
    }
    transferOrderBlockchainLink
    benchmarkTransferOrderId
    benchmarkTransferOrder {
      ...TransferOrderFragment
    }
    benchmarkTransferOrderBlockchainLink
    userBalanceTotalBefore
    userBalanceAvailableBefore
    userBalanceTotalAfter
    userBalanceAvailableAfter
    totalUserAmountBeforeTransactionInEur
    hasBeenBenchmarked
    widgetId
    widgetCode
    widgetUserParamsId
    widgetUserParams
    widget
    destinationUserId
    manuallyEditedAmounts
    manuallyEditedFee
    manuallyEditedStatus
    manuallyEditedKycStatus
    manuallyEditedAccountStatus
    risk
    riskCodes
    backups
    comment
    data
    verifyWhenPaid
    requestParams
    cryptoInvoiceName
    sourceAddress
  }
}
Variables
{"transactionIds": ["abc123"]}
Response
{
  "data": {
    "repeatDeclinedTransactions": [
      {
        "transactionId": "4",
        "code": "abc123",
        "userId": "xyz789",
        "userReferralCode": 987,
        "userIp": "xyz789",
        "userTierId": "abc123",
        "userTier": SettingsKycTierShortEx,
        "requiredUserTierId": "abc123",
        "requiredUserTier": SettingsKycTierShortEx,
        "sourceVaultId": "xyz789",
        "sourceVault": "xyz789",
        "user": User,
        "created": "2007-12-03T10:15:30Z",
        "updated": "2007-12-03T10:15:30Z",
        "executed": "2007-12-03T10:15:30Z",
        "type": "Buy",
        "status": "New",
        "subStatus": "xyz789",
        "kycStatus": "KycWaiting",
        "accountStatus": "Live",
        "feeFiat": 123.45,
        "feePercent": 123.45,
        "feeMinFiat": 123.45,
        "feeDetails": "abc123",
        "approxNetworkFee": 123.45,
        "approxNetworkFeeFiat": 123.45,
        "userDefaultFiatCurrency": "xyz789",
        "userDefaultCryptoCurrency": "abc123",
        "currencyToSpend": "xyz789",
        "amountToSpend": 123.45,
        "amountToSpendWithoutFee": 987.65,
        "currencyToReceive": "xyz789",
        "initialAmountToReceive": 123.45,
        "initialAmountToReceiveWithoutFee": 987.65,
        "amountToReceive": 987.65,
        "amountToReceiveWithoutFee": 123.45,
        "amountInEur": 123.45,
        "initialRate": 123.45,
        "rate": 123.45,
        "rateFiatToEur": 123.45,
        "destVaultId": "abc123",
        "destVault": "abc123",
        "destination": "abc123",
        "countryCode2": "abc123",
        "countryCode3": "xyz789",
        "accountType": "xyz789",
        "source": "QuickCheckout",
        "instrument": "CreditCard",
        "instrumentDetails": "abc123",
        "custodyProvider": "Fireblocks",
        "custodyDetails": "abc123",
        "paymentProvider": "abc123",
        "paymentOrderId": "xyz789",
        "paymentOrder": PaymentOrder,
        "liquidityProvider": "Bitstamp",
        "liquidityOrderId": "xyz789",
        "liquidityOrder": LiquidityOrder,
        "transferOrderId": "abc123",
        "transferOrder": TransferOrder,
        "transferOrderBlockchainLink": "abc123",
        "benchmarkTransferOrderId": "abc123",
        "benchmarkTransferOrder": TransferOrder,
        "benchmarkTransferOrderBlockchainLink": "abc123",
        "userBalanceTotalBefore": 987.65,
        "userBalanceAvailableBefore": 987.65,
        "userBalanceTotalAfter": 987.65,
        "userBalanceAvailableAfter": 123.45,
        "totalUserAmountBeforeTransactionInEur": 987.65,
        "hasBeenBenchmarked": true,
        "widgetId": "xyz789",
        "widgetCode": "abc123",
        "widgetUserParamsId": "abc123",
        "widgetUserParams": "xyz789",
        "widget": "xyz789",
        "destinationUserId": "xyz789",
        "manuallyEditedAmounts": true,
        "manuallyEditedFee": true,
        "manuallyEditedStatus": true,
        "manuallyEditedKycStatus": false,
        "manuallyEditedAccountStatus": true,
        "risk": "Low",
        "riskCodes": ["abc123"],
        "backups": ["xyz789"],
        "comment": "abc123",
        "data": "abc123",
        "verifyWhenPaid": true,
        "requestParams": "abc123",
        "cryptoInvoiceName": "xyz789",
        "sourceAddress": "xyz789"
      }
    ]
  }
}
Mutations

resendNotification

Response

Returns a UserNotification

Arguments
Name Description
notificationId - String

Example

Query
mutation resendNotification($notificationId: String) {
  resendNotification(notificationId: $notificationId) {
    userNotificationId
    userId
    user {
      ...UserFragment
    }
    userNotificationTypeCode
    userNotificationLevel
    created
    viewed
    title
    text
    linkedId
    linkedTable
    params
  }
}
Variables
{"notificationId": "abc123"}
Response
{
  "data": {
    "resendNotification": {
      "userNotificationId": 4,
      "userId": "xyz789",
      "user": User,
      "userNotificationTypeCode": "xyz789",
      "userNotificationLevel": "Request",
      "created": "2007-12-03T10:15:30Z",
      "viewed": "2007-12-03T10:15:30Z",
      "title": "abc123",
      "text": "abc123",
      "linkedId": "abc123",
      "linkedTable": "abc123",
      "params": "abc123"
    }
  }
}
Mutations

restoreUser

Response

Returns a User

Arguments
Name Description
userId - ID!

Example

Query
mutation restoreUser($userId: ID!) {
  restoreUser(userId: $userId) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"userId": 4}
Response
{
  "data": {
    "restoreUser": {
      "userId": 4,
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["xyz789"],
      "firstName": "xyz789",
      "lastName": "abc123",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "xyz789",
      "countryCode3": "xyz789",
      "postCode": "abc123",
      "town": "abc123",
      "street": "xyz789",
      "subStreet": "abc123",
      "stateName": "abc123",
      "buildingName": "xyz789",
      "buildingNumber": "xyz789",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "xyz789",
      "termsOfUse": true,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 123,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": true,
      "changePasswordRequired": false,
      "referralCode": 123,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "xyz789",
      "kycTierId": "xyz789",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "abc123",
      "kycValid": false,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "abc123",
      "kycReviewRejectedLabels": ["abc123"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": false,
      "kycDocs": ["abc123"],
      "custodyProvider": "xyz789",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "xyz789",
      "defaultCryptoCurrency": "abc123",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "riskAlertCount": 123,
      "widgetId": "abc123",
      "widgetCode": "abc123",
      "affiliateId": "abc123",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 123,
      "totalDepositInProcess": 123.45,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 987,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 987,
      "totalBoughtCompleted": 987.65,
      "totalBoughtCompletedCount": 123,
      "totalBoughtInProcess": 123.45,
      "totalBoughtInProcessCount": 123,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 123.45,
      "totalSentCompletedCount": 987,
      "totalSentInProcess": 987.65,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 987.65,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 123.45,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 987,
      "avarageTransaction": 123.45,
      "manuallyEditedRisk": true,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "xyz789",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "xyz789",
      "openpaydAccountHolderId": "abc123"
    }
  }
}
Mutations

sendAdminNotification

Response

Returns [UserNotification!]

Arguments
Name Description
notifiedUserIds - [String!]
title - String
text - String
level - UserNotificationLevel

Example

Query
mutation sendAdminNotification(
  $notifiedUserIds: [String!],
  $title: String,
  $text: String,
  $level: UserNotificationLevel
) {
  sendAdminNotification(
    notifiedUserIds: $notifiedUserIds,
    title: $title,
    text: $text,
    level: $level
  ) {
    userNotificationId
    userId
    user {
      ...UserFragment
    }
    userNotificationTypeCode
    userNotificationLevel
    created
    viewed
    title
    text
    linkedId
    linkedTable
    params
  }
}
Variables
{
  "notifiedUserIds": ["xyz789"],
  "title": "xyz789",
  "text": "abc123",
  "level": "Request"
}
Response
{
  "data": {
    "sendAdminNotification": [
      {
        "userNotificationId": 4,
        "userId": "xyz789",
        "user": User,
        "userNotificationTypeCode": "abc123",
        "userNotificationLevel": "Request",
        "created": "2007-12-03T10:15:30Z",
        "viewed": "2007-12-03T10:15:30Z",
        "title": "abc123",
        "text": "xyz789",
        "linkedId": "abc123",
        "linkedTable": "xyz789",
        "params": "abc123"
      }
    ]
  }
}
Mutations

sendEmailCodePasswordChange

Response

Returns a Boolean!

Example

Query
mutation sendEmailCodePasswordChange {
  sendEmailCodePasswordChange
}
Response
{"data": {"sendEmailCodePasswordChange": true}}
Mutations

sendFakeLiquidityProviderTransactionChangedCallback

Response

Returns a Boolean

Example

Query
mutation sendFakeLiquidityProviderTransactionChangedCallback {
  sendFakeLiquidityProviderTransactionChangedCallback
}
Response
{"data": {"sendFakeLiquidityProviderTransactionChangedCallback": true}}
Mutations

sendInvoice

Response

Returns a Boolean

Arguments
Name Description
transactionId - String

Example

Query
mutation sendInvoice($transactionId: String) {
  sendInvoice(transactionId: $transactionId)
}
Variables
{"transactionId": "abc123"}
Response
{"data": {"sendInvoice": true}}
Mutations

sendTestKycServiceNotification

Response

Returns a Void

Arguments
Name Description
type - KycServiceNotificationType

Example

Query
mutation sendTestKycServiceNotification($type: KycServiceNotificationType) {
  sendTestKycServiceNotification(type: $type)
}
Variables
{"type": "KycStatusChanged"}
Response
{"data": {"sendTestKycServiceNotification": null}}
Mutations

sendTestNotification

Response

Returns a Void

Example

Query
mutation sendTestNotification {
  sendTestNotification
}
Response
{"data": {"sendTestNotification": null}}
Mutations

sendTestTransactionServiceNotification

Response

Returns a Void

Arguments
Name Description
type - TransactionServiceNotificationType

Example

Query
mutation sendTestTransactionServiceNotification($type: TransactionServiceNotificationType) {
  sendTestTransactionServiceNotification(type: $type)
}
Variables
{"type": "PaymentStatusChanged"}
Response
{"data": {"sendTestTransactionServiceNotification": null}}
Mutations

setMyInfo

Response

Returns a LoginResult!

Arguments
Name Description
firstName - String
lastName - String
birthday - DateTime
address - PostAddress
phone - String
recaptcha - String!

Example

Query
mutation setMyInfo(
  $firstName: String,
  $lastName: String,
  $birthday: DateTime,
  $address: PostAddress,
  $phone: String,
  $recaptcha: String!
) {
  setMyInfo(
    firstName: $firstName,
    lastName: $lastName,
    birthday: $birthday,
    address: $address,
    phone: $phone,
    recaptcha: $recaptcha
  ) {
    authToken
    user {
      ...UserFragment
    }
    authTokenAction
    authTokenActionParam
  }
}
Variables
{
  "firstName": "abc123",
  "lastName": "abc123",
  "birthday": "2007-12-03T10:15:30Z",
  "address": PostAddress,
  "phone": "xyz789",
  "recaptcha": "xyz789"
}
Response
{
  "data": {
    "setMyInfo": {
      "authToken": "abc123",
      "user": User,
      "authTokenAction": "xyz789",
      "authTokenActionParam": "abc123"
    }
  }
}
Mutations

setPassword

Response

Returns a Boolean!

Arguments
Name Description
token - String!
password - String!
recaptcha - String!

Example

Query
mutation setPassword(
  $token: String!,
  $password: String!,
  $recaptcha: String!
) {
  setPassword(
    token: $token,
    password: $password,
    recaptcha: $recaptcha
  )
}
Variables
{
  "token": "xyz789",
  "password": "xyz789",
  "recaptcha": "abc123"
}
Response
{"data": {"setPassword": false}}
Mutations

setUserInfo

Response

Returns a LoginResult!

Arguments
Name Description
userId - String!
firstName - String
lastName - String
birthday - DateTime
address - PostAddress
phone - String

Example

Query
mutation setUserInfo(
  $userId: String!,
  $firstName: String,
  $lastName: String,
  $birthday: DateTime,
  $address: PostAddress,
  $phone: String
) {
  setUserInfo(
    userId: $userId,
    firstName: $firstName,
    lastName: $lastName,
    birthday: $birthday,
    address: $address,
    phone: $phone
  ) {
    authToken
    user {
      ...UserFragment
    }
    authTokenAction
    authTokenActionParam
  }
}
Variables
{
  "userId": "abc123",
  "firstName": "xyz789",
  "lastName": "abc123",
  "birthday": "2007-12-03T10:15:30Z",
  "address": PostAddress,
  "phone": "xyz789"
}
Response
{
  "data": {
    "setUserInfo": {
      "authToken": "xyz789",
      "user": User,
      "authTokenAction": "abc123",
      "authTokenActionParam": "abc123"
    }
  }
}
Mutations

signup

Response

Returns a LoginResult!

Arguments
Name Description
email - String!
type - UserType!
mode - UserMode!
merchantId - String
firstName - String
lastName - String
birthday - DateTime
countryCode2 - String
countryCode3 - String
address - PostAddress
phone - String
password - String
recaptcha - String!
termsOfUse - Boolean!
pep - Boolean!

Example

Query
mutation signup(
  $email: String!,
  $type: UserType!,
  $mode: UserMode!,
  $merchantId: String,
  $firstName: String,
  $lastName: String,
  $birthday: DateTime,
  $countryCode2: String,
  $countryCode3: String,
  $address: PostAddress,
  $phone: String,
  $password: String,
  $recaptcha: String!,
  $termsOfUse: Boolean!,
  $pep: Boolean!
) {
  signup(
    email: $email,
    type: $type,
    mode: $mode,
    merchantId: $merchantId,
    firstName: $firstName,
    lastName: $lastName,
    birthday: $birthday,
    countryCode2: $countryCode2,
    countryCode3: $countryCode3,
    address: $address,
    phone: $phone,
    password: $password,
    recaptcha: $recaptcha,
    termsOfUse: $termsOfUse,
    pep: $pep
  ) {
    authToken
    user {
      ...UserFragment
    }
    authTokenAction
    authTokenActionParam
  }
}
Variables
{
  "email": "xyz789",
  "type": "Merchant",
  "mode": "InternalWallet",
  "merchantId": "xyz789",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "birthday": "2007-12-03T10:15:30Z",
  "countryCode2": "xyz789",
  "countryCode3": "abc123",
  "address": PostAddress,
  "phone": "abc123",
  "password": "xyz789",
  "recaptcha": "abc123",
  "termsOfUse": true,
  "pep": false
}
Response
{
  "data": {
    "signup": {
      "authToken": "xyz789",
      "user": User,
      "authTokenAction": "xyz789",
      "authTokenActionParam": "abc123"
    }
  }
}
Mutations

status

Response

Returns a String!

Arguments
Name Description
orderId - String!
amount - Float

Example

Query
mutation status(
  $orderId: String!,
  $amount: Float
) {
  status(
    orderId: $orderId,
    amount: $amount
  )
}
Variables
{"orderId": "xyz789", "amount": 123.45}
Response
{"data": {"status": "abc123"}}
Mutations

unbenchmarkTransactions

Description

Unbenchmarking Transactions

Response

Returns [Transaction!]

Arguments
Name Description
transactionIds - [String!] Transaction ids

Example

Query
mutation unbenchmarkTransactions($transactionIds: [String!]) {
  unbenchmarkTransactions(transactionIds: $transactionIds) {
    transactionId
    code
    userId
    userReferralCode
    userIp
    userTierId
    userTier {
      ...SettingsKycTierShortExFragment
    }
    requiredUserTierId
    requiredUserTier {
      ...SettingsKycTierShortExFragment
    }
    sourceVaultId
    sourceVault
    user {
      ...UserFragment
    }
    created
    updated
    executed
    type
    status
    subStatus
    kycStatus
    accountStatus
    feeFiat
    feePercent
    feeMinFiat
    feeDetails
    approxNetworkFee
    approxNetworkFeeFiat
    userDefaultFiatCurrency
    userDefaultCryptoCurrency
    currencyToSpend
    amountToSpend
    amountToSpendWithoutFee
    currencyToReceive
    initialAmountToReceive
    initialAmountToReceiveWithoutFee
    amountToReceive
    amountToReceiveWithoutFee
    amountInEur
    initialRate
    rate
    rateFiatToEur
    destVaultId
    destVault
    destination
    countryCode2
    countryCode3
    accountType
    source
    instrument
    instrumentDetails
    custodyProvider
    custodyDetails
    paymentProvider
    paymentOrderId
    paymentOrder {
      ...PaymentOrderFragment
    }
    liquidityProvider
    liquidityOrderId
    liquidityOrder {
      ...LiquidityOrderFragment
    }
    transferOrderId
    transferOrder {
      ...TransferOrderFragment
    }
    transferOrderBlockchainLink
    benchmarkTransferOrderId
    benchmarkTransferOrder {
      ...TransferOrderFragment
    }
    benchmarkTransferOrderBlockchainLink
    userBalanceTotalBefore
    userBalanceAvailableBefore
    userBalanceTotalAfter
    userBalanceAvailableAfter
    totalUserAmountBeforeTransactionInEur
    hasBeenBenchmarked
    widgetId
    widgetCode
    widgetUserParamsId
    widgetUserParams
    widget
    destinationUserId
    manuallyEditedAmounts
    manuallyEditedFee
    manuallyEditedStatus
    manuallyEditedKycStatus
    manuallyEditedAccountStatus
    risk
    riskCodes
    backups
    comment
    data
    verifyWhenPaid
    requestParams
    cryptoInvoiceName
    sourceAddress
  }
}
Variables
{"transactionIds": ["abc123"]}
Response
{
  "data": {
    "unbenchmarkTransactions": [
      {
        "transactionId": "4",
        "code": "xyz789",
        "userId": "abc123",
        "userReferralCode": 123,
        "userIp": "xyz789",
        "userTierId": "xyz789",
        "userTier": SettingsKycTierShortEx,
        "requiredUserTierId": "xyz789",
        "requiredUserTier": SettingsKycTierShortEx,
        "sourceVaultId": "abc123",
        "sourceVault": "abc123",
        "user": User,
        "created": "2007-12-03T10:15:30Z",
        "updated": "2007-12-03T10:15:30Z",
        "executed": "2007-12-03T10:15:30Z",
        "type": "Buy",
        "status": "New",
        "subStatus": "abc123",
        "kycStatus": "KycWaiting",
        "accountStatus": "Live",
        "feeFiat": 123.45,
        "feePercent": 123.45,
        "feeMinFiat": 123.45,
        "feeDetails": "abc123",
        "approxNetworkFee": 123.45,
        "approxNetworkFeeFiat": 987.65,
        "userDefaultFiatCurrency": "xyz789",
        "userDefaultCryptoCurrency": "xyz789",
        "currencyToSpend": "xyz789",
        "amountToSpend": 987.65,
        "amountToSpendWithoutFee": 123.45,
        "currencyToReceive": "xyz789",
        "initialAmountToReceive": 123.45,
        "initialAmountToReceiveWithoutFee": 987.65,
        "amountToReceive": 987.65,
        "amountToReceiveWithoutFee": 123.45,
        "amountInEur": 987.65,
        "initialRate": 987.65,
        "rate": 123.45,
        "rateFiatToEur": 123.45,
        "destVaultId": "xyz789",
        "destVault": "xyz789",
        "destination": "abc123",
        "countryCode2": "xyz789",
        "countryCode3": "abc123",
        "accountType": "abc123",
        "source": "QuickCheckout",
        "instrument": "CreditCard",
        "instrumentDetails": "abc123",
        "custodyProvider": "Fireblocks",
        "custodyDetails": "xyz789",
        "paymentProvider": "xyz789",
        "paymentOrderId": "abc123",
        "paymentOrder": PaymentOrder,
        "liquidityProvider": "Bitstamp",
        "liquidityOrderId": "abc123",
        "liquidityOrder": LiquidityOrder,
        "transferOrderId": "xyz789",
        "transferOrder": TransferOrder,
        "transferOrderBlockchainLink": "xyz789",
        "benchmarkTransferOrderId": "abc123",
        "benchmarkTransferOrder": TransferOrder,
        "benchmarkTransferOrderBlockchainLink": "abc123",
        "userBalanceTotalBefore": 987.65,
        "userBalanceAvailableBefore": 123.45,
        "userBalanceTotalAfter": 987.65,
        "userBalanceAvailableAfter": 123.45,
        "totalUserAmountBeforeTransactionInEur": 987.65,
        "hasBeenBenchmarked": true,
        "widgetId": "xyz789",
        "widgetCode": "abc123",
        "widgetUserParamsId": "xyz789",
        "widgetUserParams": "xyz789",
        "widget": "xyz789",
        "destinationUserId": "xyz789",
        "manuallyEditedAmounts": true,
        "manuallyEditedFee": false,
        "manuallyEditedStatus": false,
        "manuallyEditedKycStatus": false,
        "manuallyEditedAccountStatus": true,
        "risk": "Low",
        "riskCodes": ["abc123"],
        "backups": ["abc123"],
        "comment": "xyz789",
        "data": "abc123",
        "verifyWhenPaid": false,
        "requestParams": "xyz789",
        "cryptoInvoiceName": "xyz789",
        "sourceAddress": "abc123"
      }
    ]
  }
}
Mutations

updateBankAccount

Response

Returns a User

Arguments
Name Description
userId - String!
bankAccountId - String!
bankAccount - UserBankAccountInput

Example

Query
mutation updateBankAccount(
  $userId: String!,
  $bankAccountId: String!,
  $bankAccount: UserBankAccountInput
) {
  updateBankAccount(
    userId: $userId,
    bankAccountId: $bankAccountId,
    bankAccount: $bankAccount
  ) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{
  "userId": "xyz789",
  "bankAccountId": "abc123",
  "bankAccount": UserBankAccountInput
}
Response
{
  "data": {
    "updateBankAccount": {
      "userId": "4",
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["xyz789"],
      "firstName": "abc123",
      "lastName": "xyz789",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "abc123",
      "countryCode3": "xyz789",
      "postCode": "xyz789",
      "town": "abc123",
      "street": "xyz789",
      "subStreet": "abc123",
      "stateName": "abc123",
      "buildingName": "xyz789",
      "buildingNumber": "xyz789",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": true,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 987,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": false,
      "changePasswordRequired": false,
      "referralCode": 987,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "abc123",
      "kycTierId": "abc123",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "abc123",
      "kycValid": true,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "abc123",
      "kycReviewRejectedType": "xyz789",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": false,
      "kycDocs": ["abc123"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "abc123",
      "defaultCryptoCurrency": "xyz789",
      "risk": "Low",
      "riskCodes": ["xyz789"],
      "riskAlertCount": 123,
      "widgetId": "xyz789",
      "widgetCode": "xyz789",
      "affiliateId": "xyz789",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 123,
      "totalDepositInProcess": 987.65,
      "totalDepositInProcessCount": 987,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 123,
      "totalBoughtCompleted": 987.65,
      "totalBoughtCompletedCount": 123,
      "totalBoughtInProcess": 987.65,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 123.45,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 123.45,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 987.65,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 123.45,
      "totalReceivedCompletedCount": 123,
      "totalReceivedInProcess": 123.45,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 987,
      "avarageTransaction": 123.45,
      "manuallyEditedRisk": true,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "xyz789",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "abc123",
      "openpaydAccountHolderId": "xyz789"
    }
  }
}
Mutations

updateMe

Response

Returns a User

Arguments
Name Description
user - UserInput

Example

Query
mutation updateMe($user: UserInput) {
  updateMe(user: $user) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"user": UserInput}
Response
{
  "data": {
    "updateMe": {
      "userId": "4",
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["abc123"],
      "firstName": "xyz789",
      "lastName": "abc123",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "abc123",
      "countryCode3": "xyz789",
      "postCode": "xyz789",
      "town": "xyz789",
      "street": "xyz789",
      "subStreet": "abc123",
      "stateName": "abc123",
      "buildingName": "xyz789",
      "buildingNumber": "xyz789",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": true,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 123,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": true,
      "changePasswordRequired": false,
      "referralCode": 123,
      "systemUser": false,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "xyz789",
      "kycTierId": "abc123",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "abc123",
      "kycValid": true,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "xyz789",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "abc123",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "xyz789",
      "kycReviewRejectedLabels": ["abc123"],
      "kycReviewResult": "xyz789",
      "kycStatusUpdateRequired": false,
      "kycDocs": ["abc123"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "xyz789",
      "defaultCryptoCurrency": "xyz789",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "riskAlertCount": 123,
      "widgetId": "xyz789",
      "widgetCode": "abc123",
      "affiliateId": "xyz789",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 123.45,
      "totalDepositCompletedCount": 987,
      "totalDepositInProcess": 123.45,
      "totalDepositInProcessCount": 987,
      "totalWithdrawalCompleted": 987.65,
      "totalWithdrawalCompletedCount": 987,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 123,
      "totalBoughtCompleted": 987.65,
      "totalBoughtCompletedCount": 123,
      "totalBoughtInProcess": 987.65,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 123.45,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 987.65,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 123.45,
      "totalSentCompletedCount": 987,
      "totalSentInProcess": 123.45,
      "totalSentInProcessCount": 123,
      "totalReceivedCompleted": 987.65,
      "totalReceivedCompletedCount": 123,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 123,
      "avarageTransaction": 123.45,
      "manuallyEditedRisk": false,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "xyz789",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "xyz789",
      "openpaydIds": "abc123",
      "openpaydAccountHolderId": "abc123"
    }
  }
}
Mutations

updateMyBankAccount

Response

Returns a User

Arguments
Name Description
bankAccountId - String!
bankAccount - UserBankAccountInput

Example

Query
mutation updateMyBankAccount(
  $bankAccountId: String!,
  $bankAccount: UserBankAccountInput
) {
  updateMyBankAccount(
    bankAccountId: $bankAccountId,
    bankAccount: $bankAccount
  ) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{
  "bankAccountId": "abc123",
  "bankAccount": UserBankAccountInput
}
Response
{
  "data": {
    "updateMyBankAccount": {
      "userId": "4",
      "email": "xyz789",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["xyz789"],
      "firstName": "abc123",
      "lastName": "abc123",
      "avatar": "xyz789",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "abc123",
      "countryCode3": "xyz789",
      "postCode": "xyz789",
      "town": "xyz789",
      "street": "abc123",
      "subStreet": "abc123",
      "stateName": "abc123",
      "buildingName": "xyz789",
      "buildingNumber": "xyz789",
      "flatNumber": "abc123",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 987,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": true,
      "changePasswordRequired": false,
      "referralCode": 123,
      "systemUser": true,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "abc123",
      "kycTierId": "abc123",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": true,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "xyz789",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "abc123",
      "kycPrivateComment": "abc123",
      "kycReviewRejectedType": "abc123",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": true,
      "kycDocs": ["xyz789"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "xyz789",
      "defaultCryptoCurrency": "xyz789",
      "risk": "Low",
      "riskCodes": ["xyz789"],
      "riskAlertCount": 123,
      "widgetId": "abc123",
      "widgetCode": "xyz789",
      "affiliateId": "abc123",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 123.45,
      "totalDepositCompletedCount": 987,
      "totalDepositInProcess": 123.45,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 123.45,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 987,
      "totalBoughtCompleted": 987.65,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 123.45,
      "totalBoughtInProcessCount": 123,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 123,
      "totalSentCompleted": 987.65,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 123.45,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 123.45,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 987,
      "avarageTransaction": 987.65,
      "manuallyEditedRisk": false,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "abc123",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "abc123",
      "openpaydIds": "abc123",
      "openpaydAccountHolderId": "abc123"
    }
  }
}
Mutations

updateMyContact

Response

Returns a User

Arguments
Name Description
contactId - String!
contact - UserContactInput

Example

Query
mutation updateMyContact(
  $contactId: String!,
  $contact: UserContactInput
) {
  updateMyContact(
    contactId: $contactId,
    contact: $contact
  ) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{
  "contactId": "xyz789",
  "contact": UserContactInput
}
Response
{
  "data": {
    "updateMyContact": {
      "userId": "4",
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["xyz789"],
      "firstName": "xyz789",
      "lastName": "abc123",
      "avatar": "xyz789",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "abc123",
      "countryCode3": "abc123",
      "postCode": "abc123",
      "town": "xyz789",
      "street": "xyz789",
      "subStreet": "abc123",
      "stateName": "xyz789",
      "buildingName": "xyz789",
      "buildingNumber": "abc123",
      "flatNumber": "abc123",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "xyz789",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 123,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": true,
      "hasEmailAuth": true,
      "changePasswordRequired": false,
      "referralCode": 987,
      "systemUser": true,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "abc123",
      "kycTierId": "xyz789",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": false,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "abc123",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "abc123",
      "kycPrivateComment": "xyz789",
      "kycReviewRejectedType": "xyz789",
      "kycReviewRejectedLabels": ["xyz789"],
      "kycReviewResult": "xyz789",
      "kycStatusUpdateRequired": false,
      "kycDocs": ["xyz789"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "xyz789",
      "defaultCryptoCurrency": "abc123",
      "risk": "Low",
      "riskCodes": ["abc123"],
      "riskAlertCount": 123,
      "widgetId": "abc123",
      "widgetCode": "abc123",
      "affiliateId": "abc123",
      "affiliateCode": "abc123",
      "totalDepositCompleted": 987.65,
      "totalDepositCompletedCount": 987,
      "totalDepositInProcess": 987.65,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 123.45,
      "totalWithdrawalCompletedCount": 123,
      "totalWithdrawalInProcess": 123.45,
      "totalWithdrawalInProcessCount": 987,
      "totalBoughtCompleted": 123.45,
      "totalBoughtCompletedCount": 987,
      "totalBoughtInProcess": 987.65,
      "totalBoughtInProcessCount": 987,
      "totalSoldCompleted": 987.65,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 987,
      "totalSentCompleted": 987.65,
      "totalSentCompletedCount": 987,
      "totalSentInProcess": 987.65,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 123.45,
      "totalReceivedCompletedCount": 123,
      "totalReceivedInProcess": 987.65,
      "totalReceivedInProcessCount": 123,
      "totalTransactionCount": 123,
      "avarageTransaction": 123.45,
      "manuallyEditedRisk": false,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "xyz789",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "xyz789",
      "openpaydIds": "abc123",
      "openpaydAccountHolderId": "abc123"
    }
  }
}
Mutations

updateMyVault

Description

This endpoint can be used to update the current user's wallet.

Response

Returns a VaultAccount

Arguments
Name Description
vaultId - String Wallet id
vaultName - String! Wallet name

Example

Query
mutation updateMyVault(
  $vaultId: String,
  $vaultName: String!
) {
  updateMyVault(
    vaultId: $vaultId,
    vaultName: $vaultName
  ) {
    id
    userId
    name
    custodyProviderLink
    rawData
    assets {
      ...VaultAccountAssetFragment
    }
  }
}
Variables
{
  "vaultId": "abc123",
  "vaultName": "xyz789"
}
Response
{
  "data": {
    "updateMyVault": {
      "id": "4",
      "userId": "xyz789",
      "name": "abc123",
      "custodyProviderLink": "xyz789",
      "rawData": "xyz789",
      "assets": [VaultAccountAsset]
    }
  }
}
Mutations

updateMyWidget

Description

This endpoint can be used to update a widget for the current user.

Response

Returns a Widget

Arguments
Name Description
widgetId - String Widget id
widget - WidgetUpdateInput WidgetUpdateInput

Example

Query
mutation updateMyWidget(
  $widgetId: String,
  $widget: WidgetUpdateInput
) {
  updateMyWidget(
    widgetId: $widgetId,
    widget: $widget
  ) {
    widgetId
    code
    userId
    userCode
    name
    description
    created
    createdBy
    createdByUser {
      ...UserFragment
    }
    transactionTypes
    currenciesCrypto
    currenciesFiat
    destinationAddress
    countriesCode2
    instruments
    paymentProviders
    liquidityProvider
    additionalSettings
    currentUserEmail
    currentUserParams
    hasFixedAddress
    secret
  }
}
Variables
{
  "widgetId": "xyz789",
  "widget": WidgetUpdateInput
}
Response
{
  "data": {
    "updateMyWidget": {
      "widgetId": "4",
      "code": "xyz789",
      "userId": "xyz789",
      "userCode": "xyz789",
      "name": "abc123",
      "description": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "createdByUser": User,
      "transactionTypes": ["Buy"],
      "currenciesCrypto": ["xyz789"],
      "currenciesFiat": ["xyz789"],
      "destinationAddress": "xyz789",
      "countriesCode2": ["xyz789"],
      "instruments": ["CreditCard"],
      "paymentProviders": ["xyz789"],
      "liquidityProvider": "Bitstamp",
      "additionalSettings": "xyz789",
      "currentUserEmail": "xyz789",
      "currentUserParams": "xyz789",
      "hasFixedAddress": false,
      "secret": "abc123"
    }
  }
}
Mutations

updateRiskAlertType

Response

Returns a RiskAlertType

Arguments
Name Description
riskAlertTypeId - String
riskAlertTypeInput - RiskAlertTypeInput

Example

Query
mutation updateRiskAlertType(
  $riskAlertTypeId: String,
  $riskAlertTypeInput: RiskAlertTypeInput
) {
  updateRiskAlertType(
    riskAlertTypeId: $riskAlertTypeId,
    riskAlertTypeInput: $riskAlertTypeInput
  ) {
    riskAlertTypeCode
    description
    created
    disabled
  }
}
Variables
{
  "riskAlertTypeId": "xyz789",
  "riskAlertTypeInput": RiskAlertTypeInput
}
Response
{
  "data": {
    "updateRiskAlertType": {
      "riskAlertTypeCode": "USER_AGE",
      "description": "abc123",
      "created": "2007-12-03T10:15:30Z",
      "disabled": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

updateSettingsCommon

Response

Returns a SettingsCommon!

Arguments
Name Description
settingsId - ID!
settings - SettingsCommonInput!

Example

Query
mutation updateSettingsCommon(
  $settingsId: ID!,
  $settings: SettingsCommonInput!
) {
  updateSettingsCommon(
    settingsId: $settingsId,
    settings: $settings
  ) {
    settingsCommonId
    liquidityProvider
    mailProvider
    custodyProvider
    kycProvider
    kycBaseAddress
    adminEmails
    stoppedForServicing
    additionalSettings
    proxyLiquidityProviderUrl
    proxyLiquidityProviderApiSecret
    proxyLiquidityProviderApiKey
    proxyLiquidityProvider
    proxyLiquidityProviderTransactionChangedCallback
    textPages {
      ...TextPageFragment
    }
  }
}
Variables
{
  "settingsId": "4",
  "settings": SettingsCommonInput
}
Response
{
  "data": {
    "updateSettingsCommon": {
      "settingsCommonId": "xyz789",
      "liquidityProvider": "abc123",
      "mailProvider": "abc123",
      "custodyProvider": "xyz789",
      "kycProvider": "xyz789",
      "kycBaseAddress": "abc123",
      "adminEmails": ["xyz789"],
      "stoppedForServicing": false,
      "additionalSettings": "xyz789",
      "proxyLiquidityProviderUrl": "xyz789",
      "proxyLiquidityProviderApiSecret": "xyz789",
      "proxyLiquidityProviderApiKey": "xyz789",
      "proxyLiquidityProvider": "abc123",
      "proxyLiquidityProviderTransactionChangedCallback": "xyz789",
      "textPages": [TextPage]
    }
  }
}
Mutations

updateSettingsCost

Response

Returns a SettingsCost!

Arguments
Name Description
settingsId - ID!
settings - SettingsCostInput!

Example

Query
mutation updateSettingsCost(
  $settingsId: ID!,
  $settings: SettingsCostInput!
) {
  updateSettingsCost(
    settingsId: $settingsId,
    settings: $settings
  ) {
    settingsCostId
    name
    description
    targetFilterType
    targetFilterValues
    targetInstruments
    targetTransactionTypes
    targetPaymentProviders
    terms
    created
    createdBy
    bankAccounts {
      ...WireTransferBankAccountFragment
    }
    default
    deleted
  }
}
Variables
{
  "settingsId": "4",
  "settings": SettingsCostInput
}
Response
{
  "data": {
    "updateSettingsCost": {
      "settingsCostId": "4",
      "name": "xyz789",
      "description": "xyz789",
      "targetFilterType": "None",
      "targetFilterValues": ["xyz789"],
      "targetInstruments": ["abc123"],
      "targetTransactionTypes": ["abc123"],
      "targetPaymentProviders": ["xyz789"],
      "terms": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "xyz789",
      "bankAccounts": [WireTransferBankAccount],
      "default": false,
      "deleted": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

updateSettingsFee

Response

Returns a SettingsFee!

Arguments
Name Description
settingsId - ID!
settings - SettingsFeeInput!

Example

Query
mutation updateSettingsFee(
  $settingsId: ID!,
  $settings: SettingsFeeInput!
) {
  updateSettingsFee(
    settingsId: $settingsId,
    settings: $settings
  ) {
    settingsFeeId
    name
    description
    targetFilterType
    targetFilterValues
    targetInstruments
    targetUserTypes
    targetUserModes
    targetTransactionTypes
    targetPaymentProviders
    terms
    wireDetails
    created
    createdBy
    default
    deleted
    currency
    rateToEur
    costs {
      ...SettingsCostFragment
    }
  }
}
Variables
{"settingsId": 4, "settings": SettingsFeeInput}
Response
{
  "data": {
    "updateSettingsFee": {
      "settingsFeeId": "4",
      "name": "abc123",
      "description": "xyz789",
      "targetFilterType": "None",
      "targetFilterValues": ["abc123"],
      "targetInstruments": ["xyz789"],
      "targetUserTypes": ["Merchant"],
      "targetUserModes": ["InternalWallet"],
      "targetTransactionTypes": ["abc123"],
      "targetPaymentProviders": ["abc123"],
      "terms": "abc123",
      "wireDetails": "abc123",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "default": true,
      "deleted": "2007-12-03T10:15:30Z",
      "currency": "xyz789",
      "rateToEur": 987.65,
      "costs": [SettingsCost]
    }
  }
}
Mutations

updateSettingsKyc

Response

Returns a SettingsKyc!

Arguments
Name Description
settingsId - ID!
settings - SettingsKycInput!

Example

Query
mutation updateSettingsKyc(
  $settingsId: ID!,
  $settings: SettingsKycInput!
) {
  updateSettingsKyc(
    settingsId: $settingsId,
    settings: $settings
  ) {
    settingsKycId
    name
    description
    targetKycProviders
    targetUserType
    targetUserModes
    targetFilterType
    targetFilterValues
    levels {
      ...SettingsKycLevelFragment
    }
    requireUserFullName
    requireUserPhone
    requireUserBirthday
    requireUserAddress
    requireUserFlatNumber
    created
    createdBy
    default
    deleted
  }
}
Variables
{"settingsId": 4, "settings": SettingsKycInput}
Response
{
  "data": {
    "updateSettingsKyc": {
      "settingsKycId": "4",
      "name": "xyz789",
      "description": "abc123",
      "targetKycProviders": ["Local"],
      "targetUserType": "Merchant",
      "targetUserModes": ["InternalWallet"],
      "targetFilterType": "None",
      "targetFilterValues": ["xyz789"],
      "levels": [SettingsKycLevel],
      "requireUserFullName": true,
      "requireUserPhone": true,
      "requireUserBirthday": true,
      "requireUserAddress": true,
      "requireUserFlatNumber": false,
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "default": false,
      "deleted": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

updateSettingsKycLevel

Response

Returns a SettingsKycLevel!

Arguments
Name Description
settingsLevelId - ID!
settingsLevel - SettingsKycLevelInput!

Example

Query
mutation updateSettingsKycLevel(
  $settingsLevelId: ID!,
  $settingsLevel: SettingsKycLevelInput!
) {
  updateSettingsKycLevel(
    settingsLevelId: $settingsLevelId,
    settingsLevel: $settingsLevel
  ) {
    settingsKycLevelId
    name
    originalLevelName
    originalFlowName
    description
    userType
    order
    data
    created
    createdBy
  }
}
Variables
{
  "settingsLevelId": 4,
  "settingsLevel": SettingsKycLevelInput
}
Response
{
  "data": {
    "updateSettingsKycLevel": {
      "settingsKycLevelId": "4",
      "name": "abc123",
      "originalLevelName": "abc123",
      "originalFlowName": "xyz789",
      "description": "abc123",
      "userType": "Merchant",
      "order": 123,
      "data": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123"
    }
  }
}
Mutations

updateSettingsKycTier

Response

Returns a Boolean!

Arguments
Name Description
settingsId - ID!
settings - SettingsKycTierInput!

Example

Query
mutation updateSettingsKycTier(
  $settingsId: ID!,
  $settings: SettingsKycTierInput!
) {
  updateSettingsKycTier(
    settingsId: $settingsId,
    settings: $settings
  )
}
Variables
{
  "settingsId": "4",
  "settings": SettingsKycTierInput
}
Response
{"data": {"updateSettingsKycTier": true}}
Mutations

updateTransaction

Description

This endpoint can be used to update a transaction

Response

Returns a Transaction

Arguments
Name Description
transactionId - String Transaction id
transaction - TransactionUpdateInput TransactionUpdateInput
recalculate - Boolean Parameter for transaction recalculation

Example

Query
mutation updateTransaction(
  $transactionId: String,
  $transaction: TransactionUpdateInput,
  $recalculate: Boolean
) {
  updateTransaction(
    transactionId: $transactionId,
    transaction: $transaction,
    recalculate: $recalculate
  ) {
    transactionId
    code
    userId
    userReferralCode
    userIp
    userTierId
    userTier {
      ...SettingsKycTierShortExFragment
    }
    requiredUserTierId
    requiredUserTier {
      ...SettingsKycTierShortExFragment
    }
    sourceVaultId
    sourceVault
    user {
      ...UserFragment
    }
    created
    updated
    executed
    type
    status
    subStatus
    kycStatus
    accountStatus
    feeFiat
    feePercent
    feeMinFiat
    feeDetails
    approxNetworkFee
    approxNetworkFeeFiat
    userDefaultFiatCurrency
    userDefaultCryptoCurrency
    currencyToSpend
    amountToSpend
    amountToSpendWithoutFee
    currencyToReceive
    initialAmountToReceive
    initialAmountToReceiveWithoutFee
    amountToReceive
    amountToReceiveWithoutFee
    amountInEur
    initialRate
    rate
    rateFiatToEur
    destVaultId
    destVault
    destination
    countryCode2
    countryCode3
    accountType
    source
    instrument
    instrumentDetails
    custodyProvider
    custodyDetails
    paymentProvider
    paymentOrderId
    paymentOrder {
      ...PaymentOrderFragment
    }
    liquidityProvider
    liquidityOrderId
    liquidityOrder {
      ...LiquidityOrderFragment
    }
    transferOrderId
    transferOrder {
      ...TransferOrderFragment
    }
    transferOrderBlockchainLink
    benchmarkTransferOrderId
    benchmarkTransferOrder {
      ...TransferOrderFragment
    }
    benchmarkTransferOrderBlockchainLink
    userBalanceTotalBefore
    userBalanceAvailableBefore
    userBalanceTotalAfter
    userBalanceAvailableAfter
    totalUserAmountBeforeTransactionInEur
    hasBeenBenchmarked
    widgetId
    widgetCode
    widgetUserParamsId
    widgetUserParams
    widget
    destinationUserId
    manuallyEditedAmounts
    manuallyEditedFee
    manuallyEditedStatus
    manuallyEditedKycStatus
    manuallyEditedAccountStatus
    risk
    riskCodes
    backups
    comment
    data
    verifyWhenPaid
    requestParams
    cryptoInvoiceName
    sourceAddress
  }
}
Variables
{
  "transactionId": "xyz789",
  "transaction": TransactionUpdateInput,
  "recalculate": false
}
Response
{
  "data": {
    "updateTransaction": {
      "transactionId": 4,
      "code": "abc123",
      "userId": "xyz789",
      "userReferralCode": 987,
      "userIp": "xyz789",
      "userTierId": "abc123",
      "userTier": SettingsKycTierShortEx,
      "requiredUserTierId": "abc123",
      "requiredUserTier": SettingsKycTierShortEx,
      "sourceVaultId": "xyz789",
      "sourceVault": "abc123",
      "user": User,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "executed": "2007-12-03T10:15:30Z",
      "type": "Buy",
      "status": "New",
      "subStatus": "xyz789",
      "kycStatus": "KycWaiting",
      "accountStatus": "Live",
      "feeFiat": 987.65,
      "feePercent": 123.45,
      "feeMinFiat": 123.45,
      "feeDetails": "abc123",
      "approxNetworkFee": 123.45,
      "approxNetworkFeeFiat": 123.45,
      "userDefaultFiatCurrency": "xyz789",
      "userDefaultCryptoCurrency": "xyz789",
      "currencyToSpend": "xyz789",
      "amountToSpend": 987.65,
      "amountToSpendWithoutFee": 123.45,
      "currencyToReceive": "abc123",
      "initialAmountToReceive": 123.45,
      "initialAmountToReceiveWithoutFee": 987.65,
      "amountToReceive": 987.65,
      "amountToReceiveWithoutFee": 123.45,
      "amountInEur": 987.65,
      "initialRate": 987.65,
      "rate": 123.45,
      "rateFiatToEur": 123.45,
      "destVaultId": "xyz789",
      "destVault": "abc123",
      "destination": "xyz789",
      "countryCode2": "xyz789",
      "countryCode3": "abc123",
      "accountType": "abc123",
      "source": "QuickCheckout",
      "instrument": "CreditCard",
      "instrumentDetails": "xyz789",
      "custodyProvider": "Fireblocks",
      "custodyDetails": "xyz789",
      "paymentProvider": "xyz789",
      "paymentOrderId": "abc123",
      "paymentOrder": PaymentOrder,
      "liquidityProvider": "Bitstamp",
      "liquidityOrderId": "abc123",
      "liquidityOrder": LiquidityOrder,
      "transferOrderId": "xyz789",
      "transferOrder": TransferOrder,
      "transferOrderBlockchainLink": "xyz789",
      "benchmarkTransferOrderId": "abc123",
      "benchmarkTransferOrder": TransferOrder,
      "benchmarkTransferOrderBlockchainLink": "xyz789",
      "userBalanceTotalBefore": 123.45,
      "userBalanceAvailableBefore": 123.45,
      "userBalanceTotalAfter": 987.65,
      "userBalanceAvailableAfter": 123.45,
      "totalUserAmountBeforeTransactionInEur": 987.65,
      "hasBeenBenchmarked": true,
      "widgetId": "abc123",
      "widgetCode": "xyz789",
      "widgetUserParamsId": "abc123",
      "widgetUserParams": "abc123",
      "widget": "abc123",
      "destinationUserId": "abc123",
      "manuallyEditedAmounts": false,
      "manuallyEditedFee": true,
      "manuallyEditedStatus": true,
      "manuallyEditedKycStatus": true,
      "manuallyEditedAccountStatus": true,
      "risk": "Low",
      "riskCodes": ["abc123"],
      "backups": ["xyz789"],
      "comment": "xyz789",
      "data": "abc123",
      "verifyWhenPaid": true,
      "requestParams": "abc123",
      "cryptoInvoiceName": "xyz789",
      "sourceAddress": "abc123"
    }
  }
}
Mutations

updateUser

Response

Returns a User

Arguments
Name Description
userId - ID!
user - UserInput

Example

Query
mutation updateUser(
  $userId: ID!,
  $user: UserInput
) {
  updateUser(
    userId: $userId,
    user: $user
  ) {
    userId
    email
    type
    mode
    merchantIds
    firstName
    lastName
    avatar
    birthday
    countryCode2
    countryCode3
    postCode
    town
    street
    subStreet
    stateName
    buildingName
    buildingNumber
    flatNumber
    addressStartDate
    addressEndDate
    phone
    termsOfUse
    created
    updated
    deleted
    accountStatus
    accessFailedCount
    emailConfirmed
    roles {
      ...UserRoleFragment
    }
    contacts {
      ...UserContactFragment
    }
    bankAccounts {
      ...UserBankAccountFragment
    }
    permissions {
      ...UserRolePermissionFragment
    }
    is2faEnabled
    hasEmailAuth
    changePasswordRequired
    referralCode
    systemUser
    notificationSubscriptions {
      ...UserNotificationSubscriptionFragment
    }
    kycProvider
    kycTierId
    kycTier {
      ...SettingsKycTierShortFragment
    }
    kycApplicantId
    kycValid
    kycReviewDate
    kycStatus
    kycStatusDate
    kycReviewComment
    kycPrivateComment
    kycReviewRejectedType
    kycReviewRejectedLabels
    kycReviewResult
    kycStatusUpdateRequired
    kycDocs
    custodyProvider
    vaults {
      ...UserVaultIdObjFragment
    }
    defaultFiatCurrency
    defaultCryptoCurrency
    risk
    riskCodes
    riskAlertCount
    widgetId
    widgetCode
    affiliateId
    affiliateCode
    totalDepositCompleted
    totalDepositCompletedCount
    totalDepositInProcess
    totalDepositInProcessCount
    totalWithdrawalCompleted
    totalWithdrawalCompletedCount
    totalWithdrawalInProcess
    totalWithdrawalInProcessCount
    totalBoughtCompleted
    totalBoughtCompletedCount
    totalBoughtInProcess
    totalBoughtInProcessCount
    totalSoldCompleted
    totalSoldCompletedCount
    totalSoldInProcess
    totalSoldInProcessCount
    totalSentCompleted
    totalSentCompletedCount
    totalSentInProcess
    totalSentInProcessCount
    totalReceivedCompleted
    totalReceivedCompletedCount
    totalReceivedInProcess
    totalReceivedInProcessCount
    totalTransactionCount
    avarageTransaction
    manuallyEditedRisk
    lastLogin
    data
    fiatVaults {
      ...FiatVaultFragment
    }
    gender
    addressLine
    openpaydIds
    openpaydAccountHolderId
  }
}
Variables
{"userId": 4, "user": UserInput}
Response
{
  "data": {
    "updateUser": {
      "userId": 4,
      "email": "abc123",
      "type": "Merchant",
      "mode": "InternalWallet",
      "merchantIds": ["abc123"],
      "firstName": "abc123",
      "lastName": "abc123",
      "avatar": "abc123",
      "birthday": "2007-12-03T10:15:30Z",
      "countryCode2": "xyz789",
      "countryCode3": "abc123",
      "postCode": "xyz789",
      "town": "abc123",
      "street": "xyz789",
      "subStreet": "xyz789",
      "stateName": "xyz789",
      "buildingName": "abc123",
      "buildingNumber": "abc123",
      "flatNumber": "xyz789",
      "addressStartDate": "2007-12-03T10:15:30Z",
      "addressEndDate": "2007-12-03T10:15:30Z",
      "phone": "abc123",
      "termsOfUse": false,
      "created": "2007-12-03T10:15:30Z",
      "updated": "2007-12-03T10:15:30Z",
      "deleted": "2007-12-03T10:15:30Z",
      "accountStatus": "Live",
      "accessFailedCount": 123,
      "emailConfirmed": "2007-12-03T10:15:30Z",
      "roles": [UserRole],
      "contacts": [UserContact],
      "bankAccounts": [UserBankAccount],
      "permissions": [UserRolePermission],
      "is2faEnabled": false,
      "hasEmailAuth": true,
      "changePasswordRequired": false,
      "referralCode": 987,
      "systemUser": true,
      "notificationSubscriptions": [
        UserNotificationSubscription
      ],
      "kycProvider": "xyz789",
      "kycTierId": "xyz789",
      "kycTier": SettingsKycTierShort,
      "kycApplicantId": "xyz789",
      "kycValid": false,
      "kycReviewDate": "2007-12-03T10:15:30Z",
      "kycStatus": "xyz789",
      "kycStatusDate": "2007-12-03T10:15:30Z",
      "kycReviewComment": "xyz789",
      "kycPrivateComment": "abc123",
      "kycReviewRejectedType": "xyz789",
      "kycReviewRejectedLabels": ["abc123"],
      "kycReviewResult": "abc123",
      "kycStatusUpdateRequired": true,
      "kycDocs": ["abc123"],
      "custodyProvider": "abc123",
      "vaults": [UserVaultIdObj],
      "defaultFiatCurrency": "xyz789",
      "defaultCryptoCurrency": "abc123",
      "risk": "Low",
      "riskCodes": ["xyz789"],
      "riskAlertCount": 987,
      "widgetId": "xyz789",
      "widgetCode": "xyz789",
      "affiliateId": "abc123",
      "affiliateCode": "xyz789",
      "totalDepositCompleted": 123.45,
      "totalDepositCompletedCount": 987,
      "totalDepositInProcess": 987.65,
      "totalDepositInProcessCount": 123,
      "totalWithdrawalCompleted": 123.45,
      "totalWithdrawalCompletedCount": 987,
      "totalWithdrawalInProcess": 987.65,
      "totalWithdrawalInProcessCount": 987,
      "totalBoughtCompleted": 987.65,
      "totalBoughtCompletedCount": 123,
      "totalBoughtInProcess": 987.65,
      "totalBoughtInProcessCount": 123,
      "totalSoldCompleted": 123.45,
      "totalSoldCompletedCount": 987,
      "totalSoldInProcess": 123.45,
      "totalSoldInProcessCount": 123,
      "totalSentCompleted": 123.45,
      "totalSentCompletedCount": 123,
      "totalSentInProcess": 987.65,
      "totalSentInProcessCount": 987,
      "totalReceivedCompleted": 123.45,
      "totalReceivedCompletedCount": 987,
      "totalReceivedInProcess": 123.45,
      "totalReceivedInProcessCount": 987,
      "totalTransactionCount": 123,
      "avarageTransaction": 987.65,
      "manuallyEditedRisk": false,
      "lastLogin": "2007-12-03T10:15:30Z",
      "data": "xyz789",
      "fiatVaults": [FiatVault],
      "gender": "O",
      "addressLine": "xyz789",
      "openpaydIds": "abc123",
      "openpaydAccountHolderId": "abc123"
    }
  }
}
Mutations

updateUserVault

Description

This endpoint can be used to update the user's wallet.

Response

Returns a VaultAccount

Arguments
Name Description
userId - ID! User id
vaultId - String Wallet id
vaultName - String! Wallet name

Example

Query
mutation updateUserVault(
  $userId: ID!,
  $vaultId: String,
  $vaultName: String!
) {
  updateUserVault(
    userId: $userId,
    vaultId: $vaultId,
    vaultName: $vaultName
  ) {
    id
    userId
    name
    custodyProviderLink
    rawData
    assets {
      ...VaultAccountAssetFragment
    }
  }
}
Variables
{
  "userId": "4",
  "vaultId": "abc123",
  "vaultName": "abc123"
}
Response
{
  "data": {
    "updateUserVault": {
      "id": 4,
      "userId": "abc123",
      "name": "abc123",
      "custodyProviderLink": "abc123",
      "rawData": "abc123",
      "assets": [VaultAccountAsset]
    }
  }
}
Mutations

updateWidget

Description

This endpoint can be used to update a widget.

Response

Returns a Widget

Arguments
Name Description
widgetId - String Widget id
widget - WidgetUpdateInput WidgetUpdateInput

Example

Query
mutation updateWidget(
  $widgetId: String,
  $widget: WidgetUpdateInput
) {
  updateWidget(
    widgetId: $widgetId,
    widget: $widget
  ) {
    widgetId
    code
    userId
    userCode
    name
    description
    created
    createdBy
    createdByUser {
      ...UserFragment
    }
    transactionTypes
    currenciesCrypto
    currenciesFiat
    destinationAddress
    countriesCode2
    instruments
    paymentProviders
    liquidityProvider
    additionalSettings
    currentUserEmail
    currentUserParams
    hasFixedAddress
    secret
  }
}
Variables
{
  "widgetId": "xyz789",
  "widget": WidgetUpdateInput
}
Response
{
  "data": {
    "updateWidget": {
      "widgetId": 4,
      "code": "abc123",
      "userId": "abc123",
      "userCode": "xyz789",
      "name": "abc123",
      "description": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "xyz789",
      "createdByUser": User,
      "transactionTypes": ["Buy"],
      "currenciesCrypto": ["xyz789"],
      "currenciesFiat": ["abc123"],
      "destinationAddress": "xyz789",
      "countriesCode2": ["abc123"],
      "instruments": ["CreditCard"],
      "paymentProviders": ["xyz789"],
      "liquidityProvider": "Bitstamp",
      "additionalSettings": "abc123",
      "currentUserEmail": "xyz789",
      "currentUserParams": "abc123",
      "hasFixedAddress": false,
      "secret": "abc123"
    }
  }
}
Mutations

updateWireTransferBankAccount

Response

Returns a WireTransferBankAccount!

Arguments
Name Description
bankAccountId - ID!
bankAccount - WireTransferBankAccountInput!

Example

Query
mutation updateWireTransferBankAccount(
  $bankAccountId: ID!,
  $bankAccount: WireTransferBankAccountInput!
) {
  updateWireTransferBankAccount(
    bankAccountId: $bankAccountId,
    bankAccount: $bankAccount
  ) {
    bankAccountId
    name
    description
    created
    createdBy
    au
    uk
    eu
    openpayd
    openpaydObject
    deleted
  }
}
Variables
{
  "bankAccountId": "4",
  "bankAccount": WireTransferBankAccountInput
}
Response
{
  "data": {
    "updateWireTransferBankAccount": {
      "bankAccountId": "4",
      "name": "abc123",
      "description": "xyz789",
      "created": "2007-12-03T10:15:30Z",
      "createdBy": "abc123",
      "au": "abc123",
      "uk": "abc123",
      "eu": "abc123",
      "openpayd": true,
      "openpaydObject": "abc123",
      "deleted": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

verify2faCode

Response

Returns a LoginResult!

Arguments
Name Description
code - String!

Example

Query
mutation verify2faCode($code: String!) {
  verify2faCode(code: $code) {
    authToken
    user {
      ...UserFragment
    }
    authTokenAction
    authTokenActionParam
  }
}
Variables
{"code": "abc123"}
Response
{
  "data": {
    "verify2faCode": {
      "authToken": "abc123",
      "user": User,
      "authTokenAction": "xyz789",
      "authTokenActionParam": "abc123"
    }
  }
}

Types

AccountStatus

Values
Enum Value Description

Live

Suspended

Banned

Closed
Example
"Live"
Types

AdminTransactionStatus

Values
Enum Value Description

New

Pending

Paid

Exchanging

Confirming

Completed

Abandoned

Canceled

Chargeback

PaymentDeclined

AddressDeclined

ExchangeDeclined

TransferDeclined

BenchmarkTransferDeclined

KycDeclined
Example
"New"
Types

ApiKey

Fields
Field Name Description
apiKeyId - ID!
userId - String!
user - User
created - DateTime!
disabled - DateTime
Example
{
  "apiKeyId": "4",
  "userId": "abc123",
  "user": User,
  "created": "2007-12-03T10:15:30Z",
  "disabled": "2007-12-03T10:15:30Z"
}
Types

ApiKeyListResult

Fields
Field Name Description
count - Int
list - [ApiKey!]
Example
{"count": 123, "list": [ApiKey]}
Types

ApiKeySecret

Fields
Field Name Description
apiKeyId - ID!
userId - String!
user - User
secret - String!
created - DateTime!
disabled - DateTime
Example
{
  "apiKeyId": 4,
  "userId": "abc123",
  "user": User,
  "secret": "abc123",
  "created": "2007-12-03T10:15:30Z",
  "disabled": "2007-12-03T10:15:30Z"
}
Types

AssetAddress

Fields
Field Name Description
address - String
legacyAddress - String
description - String
type - String
addressFormat - String
assetId - String
originalId - String
custodyProvider - String
total - Float
totalEur - Float
totalFiat - Float
available - Float
availableEur - Float
availableFiat - Float
pending - Float
lockedAmount - Float
vaultId - String
vaultName - String
vaultOriginalId - String
custodyProviderLink - String
default - Boolean
userId - String
userEmail - String
Example
{
  "address": "xyz789",
  "legacyAddress": "xyz789",
  "description": "abc123",
  "type": "abc123",
  "addressFormat": "xyz789",
  "assetId": "abc123",
  "originalId": "xyz789",
  "custodyProvider": "abc123",
  "total": 123.45,
  "totalEur": 987.65,
  "totalFiat": 987.65,
  "available": 123.45,
  "availableEur": 123.45,
  "availableFiat": 987.65,
  "pending": 987.65,
  "lockedAmount": 123.45,
  "vaultId": "xyz789",
  "vaultName": "abc123",
  "vaultOriginalId": "xyz789",
  "custodyProviderLink": "xyz789",
  "default": true,
  "userId": "xyz789",
  "userEmail": "xyz789"
}
Types

AssetAddressListResult

Fields
Field Name Description
count - Int
list - [AssetAddress!]
Example
{"count": 123, "list": [AssetAddress]}
Types

AssetAddressShort

Fields
Field Name Description
address - String
legacyAddress - String
description - String
type - String
addressFormat - String
assetId - String
originalId - String
custodyProvider - String
total - Float
totalEur - Float
totalFiat - Float
available - Float
availableEur - Float
availableFiat - Float
pending - Float
lockedAmount - Float
vaultId - String
vaultName - String
vaultOriginalId - String
default - Boolean
Example
{
  "address": "abc123",
  "legacyAddress": "xyz789",
  "description": "abc123",
  "type": "abc123",
  "addressFormat": "xyz789",
  "assetId": "xyz789",
  "originalId": "xyz789",
  "custodyProvider": "xyz789",
  "total": 123.45,
  "totalEur": 987.65,
  "totalFiat": 987.65,
  "available": 987.65,
  "availableEur": 123.45,
  "availableFiat": 987.65,
  "pending": 123.45,
  "lockedAmount": 987.65,
  "vaultId": "abc123",
  "vaultName": "xyz789",
  "vaultOriginalId": "xyz789",
  "default": true
}
Types

AssetAddressShortListResult

Fields
Field Name Description
count - Int
list - [AssetAddressShort!]
Example
{"count": 987, "list": [AssetAddressShort]}
Types

BalancePerAsset

Fields
Field Name Description
assetId - String!
totalBalance - Float!
totalBalanceEur - Float!
availableBalance - Float!
availableBalanceEur - Float!
totalBalanceFiat - Float!
availableBalanceFiat - Float!
Example
{
  "assetId": "abc123",
  "totalBalance": 987.65,
  "totalBalanceEur": 987.65,
  "availableBalance": 987.65,
  "availableBalanceEur": 123.45,
  "totalBalanceFiat": 987.65,
  "availableBalanceFiat": 987.65
}
Types

BalanceStats

Fields
Field Name Description
currency - String
volume - TransactionStatsVolume
Example
{
  "currency": "xyz789",
  "volume": TransactionStatsVolume
}
Types

BaseStat

Fields
Field Name Description
ratio - Float
approved - TransactionStatsVolume
declined - TransactionStatsVolume
failed - TransactionStatsVolume
chargedBack - TransactionStatsVolume
abandoned - TransactionStatsVolume
inProcess - TransactionStatsVolume
byStatus - [TransactionStatsByStatus!]
Possible Types
BaseStat Types

BuyOrSellStats

DepositOrWithdrawalStats

TransferStats

ExchangeStats

InstrumentStats

MerchantOrCustomerStats

Example
{
  "ratio": 987.65,
  "approved": TransactionStatsVolume,
  "declined": TransactionStatsVolume,
  "failed": TransactionStatsVolume,
  "chargedBack": TransactionStatsVolume,
  "abandoned": TransactionStatsVolume,
  "inProcess": TransactionStatsVolume,
  "byStatus": [TransactionStatsByStatus]
}
Types

BlackCountry

Fields
Field Name Description
countryCode2 - ID!
created - DateTime!
Example
{
  "countryCode2": 4,
  "created": "2007-12-03T10:15:30Z"
}
Types

BlackCountryListResult

Fields
Field Name Description
count - Int
list - [BlackCountry!]
Example
{"count": 987, "list": [BlackCountry]}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

BuyOrSellStats

Fields
Field Name Description
ratio - Float
approved - TransactionStatsVolume
declined - TransactionStatsVolume
failed - TransactionStatsVolume
chargedBack - TransactionStatsVolume
abandoned - TransactionStatsVolume
inProcess - TransactionStatsVolume
byStatus - [TransactionStatsByStatus!]
fee - TransactionStatsVolume
byInstruments - [InstrumentStats!]
Example
{
  "ratio": 123.45,
  "approved": TransactionStatsVolume,
  "declined": TransactionStatsVolume,
  "failed": TransactionStatsVolume,
  "chargedBack": TransactionStatsVolume,
  "abandoned": TransactionStatsVolume,
  "inProcess": TransactionStatsVolume,
  "byStatus": [TransactionStatsByStatus],
  "fee": TransactionStatsVolume,
  "byInstruments": [InstrumentStats]
}
Types

CountryCodeType

Values
Enum Value Description

code2

code3
Example
"code2"
Types

CryptoInvoice

Fields
Field Name Description
cryptoInvoiceId - ID
name - String
destination - String
vaultId - String
userId - String
created - String
widgetId - String
currencyToSend - String
amountToSend - Float
currencyToReceive - String
amountToReceive - Float
rate - Float
widgetUserParamsId - String
Example
{
  "cryptoInvoiceId": "4",
  "name": "xyz789",
  "destination": "xyz789",
  "vaultId": "xyz789",
  "userId": "abc123",
  "created": "abc123",
  "widgetId": "abc123",
  "currencyToSend": "xyz789",
  "amountToSend": 123.45,
  "currencyToReceive": "xyz789",
  "amountToReceive": 123.45,
  "rate": 123.45,
  "widgetUserParamsId": "abc123"
}
Types

CryptoInvoiceCreationResult

Fields
Field Name Description
invoice - CryptoInvoice
rate - Float
convertedAmount - Float
convertedCurrency - String
Example
{
  "invoice": CryptoInvoice,
  "rate": 987.65,
  "convertedAmount": 123.45,
  "convertedCurrency": "abc123"
}
Types

CustodyProvider

Values
Enum Value Description

Fireblocks
Example
"Fireblocks"
Types

DashboardStats

Fields
Field Name Description
buys - BuyOrSellStats
sells - BuyOrSellStats
deposits - DepositOrWithdrawalStats
withdrawals - DepositOrWithdrawalStats
transfers - TransferStats
receives - TransferStats
exchanges - ExchangeStats
balances - [BalanceStats!]
openpaydBalances - [OpenpaydProviderBalance!]
liquidityProviderBalances - [liquidityProviderBalance]
Example
{
  "buys": BuyOrSellStats,
  "sells": BuyOrSellStats,
  "deposits": DepositOrWithdrawalStats,
  "withdrawals": DepositOrWithdrawalStats,
  "transfers": TransferStats,
  "receives": TransferStats,
  "exchanges": ExchangeStats,
  "balances": [BalanceStats],
  "openpaydBalances": [OpenpaydProviderBalance],
  "liquidityProviderBalances": [liquidityProviderBalance]
}
Types

DateMap

Fields
Field Name Description
date - DateTime!
value - String
Example
{
  "date": "2007-12-03T10:15:30Z",
  "value": "abc123"
}
Types

DateTime

Example
"2007-12-03T10:15:30Z"
Types

DateTimeInterval

Fields
Input Field Description
from - DateTime
to - DateTime
Example
{
  "from": "2007-12-03T10:15:30Z",
  "to": "2007-12-03T10:15:30Z"
}
Types

DepositOrWithdrawalStats

Fields
Field Name Description
ratio - Float
approved - TransactionStatsVolume
declined - TransactionStatsVolume
failed - TransactionStatsVolume
chargedBack - TransactionStatsVolume
abandoned - TransactionStatsVolume
inProcess - TransactionStatsVolume
byStatus - [TransactionStatsByStatus!]
fee - TransactionStatsVolume
byInstruments - [InstrumentStats!]
Example
{
  "ratio": 123.45,
  "approved": TransactionStatsVolume,
  "declined": TransactionStatsVolume,
  "failed": TransactionStatsVolume,
  "chargedBack": TransactionStatsVolume,
  "abandoned": TransactionStatsVolume,
  "inProcess": TransactionStatsVolume,
  "byStatus": [TransactionStatsByStatus],
  "fee": TransactionStatsVolume,
  "byInstruments": [InstrumentStats]
}
Types

ExchangeStats

Fields
Field Name Description
ratio - Float
approved - TransactionStatsVolume
declined - TransactionStatsVolume
failed - TransactionStatsVolume
chargedBack - TransactionStatsVolume
abandoned - TransactionStatsVolume
inProcess - TransactionStatsVolume
byStatus - [TransactionStatsByStatus!]
toMerchant - MerchantOrCustomerStats
toCustomer - MerchantOrCustomerStats
fee - TransactionStatsVolume
Example
{
  "ratio": 123.45,
  "approved": TransactionStatsVolume,
  "declined": TransactionStatsVolume,
  "failed": TransactionStatsVolume,
  "chargedBack": TransactionStatsVolume,
  "abandoned": TransactionStatsVolume,
  "inProcess": TransactionStatsVolume,
  "byStatus": [TransactionStatsByStatus],
  "toMerchant": MerchantOrCustomerStats,
  "toCustomer": MerchantOrCustomerStats,
  "fee": TransactionStatsVolume
}
Types

ExternalWallet

Fields
Field Name Description
id - ID
name - String
customerRefId - String
assets - [ExternalWalletAsset!]
Example
{
  "id": "4",
  "name": "xyz789",
  "customerRefId": "abc123",
  "assets": [ExternalWalletAsset]
}
Types

ExternalWalletAsset

Fields
Field Name Description
id - String
status - WalletAssetStatus
activationTime - String
address - String
tag - String
Example
{
  "id": "xyz789",
  "status": "WAITING_FOR_APPROVAL",
  "activationTime": "abc123",
  "address": "abc123",
  "tag": "abc123"
}
Types

Feedback

Fields
Field Name Description
feedbackId - ID!
name - String
email - String
title - String
description - String
created - DateTime
Example
{
  "feedbackId": "4",
  "name": "abc123",
  "email": "xyz789",
  "title": "abc123",
  "description": "xyz789",
  "created": "2007-12-03T10:15:30Z"
}
Types

FeedbackInput

Fields
Input Field Description
name - String
email - String
title - String
description - String
Example
{
  "name": "abc123",
  "email": "xyz789",
  "title": "xyz789",
  "description": "xyz789"
}
Types

FeedbackListResult

Fields
Field Name Description
count - Int
list - [Feedback!]
Example
{"count": 987, "list": [Feedback]}
Types

FiatVault

Fields
Field Name Description
fiatVaultId - ID
userId - String
balance - Float
created - DateTime
currency - String
generalBalance - Float
Example
{
  "fiatVaultId": 4,
  "userId": "abc123",
  "balance": 123.45,
  "created": "2007-12-03T10:15:30Z",
  "currency": "abc123",
  "generalBalance": 987.65
}
Types

FiatVaultListResult

Fields
Field Name Description
count - Int
list - [FiatVault!]
Example
{"count": 987, "list": [FiatVault]}
Types

FiatVaultUser

Fields
Field Name Description
vault - FiatVault
user - User
Example
{"vault": FiatVault, "user": User}
Types

FiatVaultUserListResult

Fields
Field Name Description
count - Int
list - [FiatVaultUser!]
Example
{"count": 987, "list": [FiatVaultUser]}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45
Types

Gender

Values
Enum Value Description

O

M

F
Example
"O"
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
4
Types

InstrumentStats

Fields
Field Name Description
instrument - PaymentInstrument
ratio - Float
approved - TransactionStatsVolume
declined - TransactionStatsVolume
failed - TransactionStatsVolume
chargedBack - TransactionStatsVolume
abandoned - TransactionStatsVolume
inProcess - TransactionStatsVolume
byStatus - [TransactionStatsByStatus!]
fee - TransactionStatsVolume
Example
{
  "instrument": "CreditCard",
  "ratio": 123.45,
  "approved": TransactionStatsVolume,
  "declined": TransactionStatsVolume,
  "failed": TransactionStatsVolume,
  "chargedBack": TransactionStatsVolume,
  "abandoned": TransactionStatsVolume,
  "inProcess": TransactionStatsVolume,
  "byStatus": [TransactionStatsByStatus],
  "fee": TransactionStatsVolume
}
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Types

KycApplicant

Fields
Field Name Description
firstName - String
lastName - String
email - String
phone - String
birthday - DateTime
countryCode2 - String
countryCode3 - String
status - String
details - [StringMap!]
Example
{
  "firstName": "xyz789",
  "lastName": "abc123",
  "email": "abc123",
  "phone": "abc123",
  "birthday": "2007-12-03T10:15:30Z",
  "countryCode2": "abc123",
  "countryCode3": "abc123",
  "status": "abc123",
  "details": [StringMap]
}
Types

KycAppliedDocument

Fields
Field Name Description
code - String!
firstName - String
lastName - String
issuedDate - String
validUntil - String
number - String
countryCode2 - String
countryCode3 - String
details - [StringMap!]
Example
{
  "code": "xyz789",
  "firstName": "xyz789",
  "lastName": "abc123",
  "issuedDate": "xyz789",
  "validUntil": "abc123",
  "number": "abc123",
  "countryCode2": "abc123",
  "countryCode3": "abc123",
  "details": [StringMap]
}
Types

KycDocumentSubSubType

Fields
Field Name Description
code - String
type - String
name - String
description - String
options - [String!]
Example
{
  "code": "abc123",
  "type": "abc123",
  "name": "abc123",
  "description": "xyz789",
  "options": ["xyz789"]
}
Types

KycDocumentSubType

Fields
Field Name Description
code - String
type - String
name - String
description - String
subTypes - [KycDocumentSubSubType!]
options - [String!]
Example
{
  "code": "abc123",
  "type": "xyz789",
  "name": "xyz789",
  "description": "xyz789",
  "subTypes": [KycDocumentSubSubType],
  "options": ["xyz789"]
}
Types

KycDocumentType

Fields
Field Name Description
code - String
type - String
name - String
description - String
subTypes - [KycDocumentSubType!]
options - [String!]
Example
{
  "code": "abc123",
  "type": "abc123",
  "name": "xyz789",
  "description": "xyz789",
  "subTypes": [KycDocumentSubType],
  "options": ["xyz789"]
}
Types

KycInfo

Fields
Field Name Description
applicant - KycApplicant
levelName - String
appliedDocuments - [KycAppliedDocument!]
requiredInfo - KycRequiredInfo
Example
{
  "applicant": KycApplicant,
  "levelName": "xyz789",
  "appliedDocuments": [KycAppliedDocument],
  "requiredInfo": KycRequiredInfo
}
Types

KycInfoField

Fields
Field Name Description
name - String
required - Boolean
Example
{"name": "abc123", "required": true}
Types

KycProvider

Values
Enum Value Description

Local

SumSub

Shufti
Example
"Local"
Types

KycRequiredInfo

Fields
Field Name Description
documents - [KycDocumentType!]
fields - [KycInfoField!]
Example
{
  "documents": [KycDocumentType],
  "fields": [KycInfoField]
}
Types

KycServiceNotificationType

Values
Enum Value Description

KycStatusChanged

KycCompleted
Example
"KycStatusChanged"
Types

KycStatus

Values
Enum Value Description

unknown

notFound

init

pending

queued

completed

onHold

canceled

timeout

invalid

deleted
Example
"unknown"
Types

LiquidityOrder

Fields
Field Name Description
orderId - String
userId - String
transactionId - String
provider - LiquidityProvider!
created - DateTime!
published - DateTime
publishingResult - String
executed - DateTime
executingResult - String
symbol - String!
type - LiquidityOrderType!
side - LiquidityOrderSide!
price - Float
volume - Float!
state - LiquidityOrderState!
status - String!
statusReason - String
originalOrderId - String
providerSpecificStates - [DateMap!]
providerSpecificParams - [StringMap!]
Example
{
  "orderId": "xyz789",
  "userId": "abc123",
  "transactionId": "abc123",
  "provider": "Bitstamp",
  "created": "2007-12-03T10:15:30Z",
  "published": "2007-12-03T10:15:30Z",
  "publishingResult": "xyz789",
  "executed": "2007-12-03T10:15:30Z",
  "executingResult": "xyz789",
  "symbol": "abc123",
  "type": "Limit",
  "side": "Buy",
  "price": 987.65,
  "volume": 123.45,
  "state": "Created",
  "status": "abc123",
  "statusReason": "xyz789",
  "originalOrderId": "xyz789",
  "providerSpecificStates": [DateMap],
  "providerSpecificParams": [StringMap]
}
Types

LiquidityOrderSide

Values
Enum Value Description

Buy

Sell
Example
"Buy"
Types

LiquidityOrderState

Values
Enum Value Description

Created

Published

Executed

Failed

Canceled
Example
"Created"
Types

LiquidityOrderType

Values
Enum Value Description

Limit

Market

Instant
Example
"Limit"
Types

LiquidityProvider

Values
Enum Value Description

Bitstamp

Binance

Kraken

GetCoins
Example
"Bitstamp"
Types

LoginResult

Fields
Field Name Description
authToken - String
user - User
authTokenAction - String
authTokenActionParam - String
Example
{
  "authToken": "abc123",
  "user": User,
  "authTokenAction": "xyz789",
  "authTokenActionParam": "abc123"
}
Types

MerchantOrCustomerStats

Fields
Field Name Description
instrument - PaymentInstrument
ratio - Float
approved - TransactionStatsVolume
declined - TransactionStatsVolume
failed - TransactionStatsVolume
chargedBack - TransactionStatsVolume
abandoned - TransactionStatsVolume
inProcess - TransactionStatsVolume
byStatus - [TransactionStatsByStatus!]
fee - TransactionStatsVolume
Example
{
  "instrument": "CreditCard",
  "ratio": 123.45,
  "approved": TransactionStatsVolume,
  "declined": TransactionStatsVolume,
  "failed": TransactionStatsVolume,
  "chargedBack": TransactionStatsVolume,
  "abandoned": TransactionStatsVolume,
  "inProcess": TransactionStatsVolume,
  "byStatus": [TransactionStatsByStatus],
  "fee": TransactionStatsVolume
}
Types

OAuthProvider

Values
Enum Value Description

google

facebook

twitter

microsoft
Example
"google"
Types

OpenpaydProviderBalance

Fields
Field Name Description
currency - String
balance - Float
Example
{"currency": "xyz789", "balance": 123.45}
Types

OrderBy

Fields
Input Field Description
orderBy - String!
desc - Boolean!
Example
{"orderBy": "abc123", "desc": false}
Types

PaymentCard

Fields
Input Field Description
number - String
expireMonth - Int
expireYear - Int
cvv2 - Int
holder - String
Example
{
  "number": "abc123",
  "expireMonth": 123,
  "expireYear": 123,
  "cvv2": 123,
  "holder": "xyz789"
}
Types

PaymentInstrument

Values
Enum Value Description

CreditCard

WireTransfer

APM

FiatVault

CryptoVault
Example
"CreditCard"
Types

PaymentOperation

Fields
Field Name Description
operationId - String
transactionId - String
orderId - String
originalOrderId - String
userId - String
created - DateTime
type - PaymentOperationType!
sn - String
status - String
statusReason - String
details - String
callbackDetails - String
errorCode - String
errorMessage - String
providerSpecificStates - [DateMap!]
providerSpecificParams - [StringMap!]
Example
{
  "operationId": "abc123",
  "transactionId": "abc123",
  "orderId": "xyz789",
  "originalOrderId": "abc123",
  "userId": "abc123",
  "created": "2007-12-03T10:15:30Z",
  "type": "preauth",
  "sn": "xyz789",
  "status": "xyz789",
  "statusReason": "xyz789",
  "details": "xyz789",
  "callbackDetails": "abc123",
  "errorCode": "abc123",
  "errorMessage": "xyz789",
  "providerSpecificStates": [DateMap],
  "providerSpecificParams": [StringMap]
}
Types

PaymentOperationShort

Fields
Field Name Description
operationId - String
created - DateTime
type - PaymentOperationType!
status - String
statusReason - String
errorCode - String
errorMessage - String
Example
{
  "operationId": "abc123",
  "created": "2007-12-03T10:15:30Z",
  "type": "preauth",
  "status": "xyz789",
  "statusReason": "abc123",
  "errorCode": "abc123",
  "errorMessage": "abc123"
}
Types

PaymentOperationType

Values
Enum Value Description

preauth

capture

refund
Example
"preauth"
Types

PaymentOrder

Fields
Field Name Description
orderId - String
userId - String
transactionId - String
provider - String!
created - DateTime
amount - Float!
currency - String!
operations - [PaymentOperation!]
status - String
statusReason - String
originalOrderId - String
preauthOperationSn - String
captureOperationSn - String
refundOperationSn - String
paymentInfo - String
paymentBankName - String
paymentCardHolderName - String
paymentCardType - String
paymentCardLastFourDigits - String
paymentProcessorName - String
paymentBin - String
providerSpecificStates - [DateMap!]
providerSpecificParams - [StringMap!]
Example
{
  "orderId": "abc123",
  "userId": "abc123",
  "transactionId": "abc123",
  "provider": "abc123",
  "created": "2007-12-03T10:15:30Z",
  "amount": 123.45,
  "currency": "xyz789",
  "operations": [PaymentOperation],
  "status": "xyz789",
  "statusReason": "abc123",
  "originalOrderId": "abc123",
  "preauthOperationSn": "xyz789",
  "captureOperationSn": "xyz789",
  "refundOperationSn": "xyz789",
  "paymentInfo": "xyz789",
  "paymentBankName": "xyz789",
  "paymentCardHolderName": "abc123",
  "paymentCardType": "abc123",
  "paymentCardLastFourDigits": "abc123",
  "paymentProcessorName": "abc123",
  "paymentBin": "abc123",
  "providerSpecificStates": [DateMap],
  "providerSpecificParams": [StringMap]
}
Types

PaymentOrderShort

Fields
Field Name Description
orderId - String
userId - String
transactionId - String
provider - String!
created - DateTime
amount - Float!
currency - String!
status - String
statusReason - String
operations - [PaymentOperationShort!]
paymentInfo - String
paymentBankName - String
paymentCardHolderName - String
paymentCardType - String
paymentCardLastFourDigits - String
paymentProcessorName - String
paymentBin - String
Example
{
  "orderId": "abc123",
  "userId": "abc123",
  "transactionId": "xyz789",
  "provider": "xyz789",
  "created": "2007-12-03T10:15:30Z",
  "amount": 123.45,
  "currency": "abc123",
  "status": "abc123",
  "statusReason": "xyz789",
  "operations": [PaymentOperationShort],
  "paymentInfo": "abc123",
  "paymentBankName": "abc123",
  "paymentCardHolderName": "abc123",
  "paymentCardType": "abc123",
  "paymentCardLastFourDigits": "xyz789",
  "paymentProcessorName": "xyz789",
  "paymentBin": "abc123"
}
Types

PaymentPreauthInput

Fields
Input Field Description
transactionId - String!
instrument - PaymentInstrument!
provider - String!
card - PaymentCard
Example
{
  "transactionId": "xyz789",
  "instrument": "CreditCard",
  "provider": "abc123",
  "card": PaymentCard
}
Types

PaymentPreauthResult

Fields
Field Name Description
order - PaymentOrder
html - String
details - String
Example
{
  "order": PaymentOrder,
  "html": "xyz789",
  "details": "xyz789"
}
Types

PaymentPreauthResultShort

Fields
Field Name Description
order - PaymentOrderShort
html - String
details - String
Example
{
  "order": PaymentOrderShort,
  "html": "abc123",
  "details": "abc123"
}
Types

PaymentProvider

Fields
Field Name Description
paymentProviderId - ID
name - String!
currencies - [String!]
countriesCode2 - [String!]
instruments - [String!]
default - Boolean
disabled - DateTime
displayName - String
logo - String
Example
{
  "paymentProviderId": "4",
  "name": "abc123",
  "currencies": ["abc123"],
  "countriesCode2": ["xyz789"],
  "instruments": ["abc123"],
  "default": false,
  "disabled": "2007-12-03T10:15:30Z",
  "displayName": "xyz789",
  "logo": "xyz789"
}
Types

PaymentProviderByInstrument

Fields
Field Name Description
id - ID
instrument - PaymentInstrument
provider - PaymentProvider
Example
{
  "id": "4",
  "instrument": "CreditCard",
  "provider": PaymentProvider
}
Types

PostAddress

Fields
Input Field Description
postCode - String
town - String
street - String
subStreet - String
stateName - String
buildingName - String
buildingNumber - String
flatNumber - String
addressStartDate - DateTime
addressEndDate - DateTime
Example
{
  "postCode": "abc123",
  "town": "abc123",
  "street": "abc123",
  "subStreet": "abc123",
  "stateName": "xyz789",
  "buildingName": "xyz789",
  "buildingNumber": "abc123",
  "flatNumber": "abc123",
  "addressStartDate": "2007-12-03T10:15:30Z",
  "addressEndDate": "2007-12-03T10:15:30Z"
}
Types

Rate

Fields
Field Name Description
currencyFrom - String!
currencyTo - String!
originalRate - Float!
depositRate - Float!
withdrawRate - Float!
Example
{
  "currencyFrom": "abc123",
  "currencyTo": "xyz789",
  "originalRate": 123.45,
  "depositRate": 987.65,
  "withdrawRate": 123.45
}
Types

RequiredUserPermission

Fields
Input Field Description
objectCode - String
fullAccess - Boolean
Example
{
  "objectCode": "xyz789",
  "fullAccess": false
}
Types

RiskAlert

Fields
Field Name Description
riskAlertId - ID
userId - String!
user - User
riskAlertTypeCode - RiskAlertCodes!
created - DateTime!
details - String
Example
{
  "riskAlertId": 4,
  "userId": "xyz789",
  "user": User,
  "riskAlertTypeCode": "USER_AGE",
  "created": "2007-12-03T10:15:30Z",
  "details": "xyz789"
}
Types

RiskAlertCodes

Values
Enum Value Description

USER_AGE

TOO_MANY_FAILED_LOGIN_ATTEMPTS

UNUSUAL_USER_IP_ADDRESS

TWO_OR_MORE_CUSTOMERS_WITHDRAWAL_SAME_ADDRESS

DEPOSIT_X_PERCENT_UP_THAN_THE_LAST_ONE

DEPOSIT_ABOVE_10K

DEPOSIT_ABOVE_50K

DEPOSIT_ABOVE_X_AMOUNT_IN_Y_TIMEFRAME

SUMSUB_WORDS

WITHDRAWAL_OWNER

OPENPAYD_DECLINED
Example
"USER_AGE"
Types

RiskAlertResultList

Fields
Field Name Description
count - Int
list - [RiskAlert!]
Example
{"count": 123, "list": [RiskAlert]}
Types

RiskAlertType

Fields
Field Name Description
riskAlertTypeCode - RiskAlertCodes!
description - String
created - DateTime!
disabled - DateTime
Example
{
  "riskAlertTypeCode": "USER_AGE",
  "description": "abc123",
  "created": "2007-12-03T10:15:30Z",
  "disabled": "2007-12-03T10:15:30Z"
}
Types

RiskAlertTypeInput

Fields
Input Field Description
riskAlertTypeCode - RiskAlertCodes!
description - String
disabled - DateTime
Example
{
  "riskAlertTypeCode": "USER_AGE",
  "description": "abc123",
  "disabled": "2007-12-03T10:15:30Z"
}
Types

RiskLevel

Values
Enum Value Description

Low

Medium

High
Example
"Low"
Types

SettingsCommon

Fields
Field Name Description
settingsCommonId - String
liquidityProvider - String
mailProvider - String
custodyProvider - String
kycProvider - String
kycBaseAddress - String
adminEmails - [String!]
stoppedForServicing - Boolean
additionalSettings - String
proxyLiquidityProviderUrl - String
proxyLiquidityProviderApiSecret - String
proxyLiquidityProviderApiKey - String
proxyLiquidityProvider - String
proxyLiquidityProviderTransactionChangedCallback - String
textPages - [TextPage]
Example
{
  "settingsCommonId": "xyz789",
  "liquidityProvider": "xyz789",
  "mailProvider": "abc123",
  "custodyProvider": "xyz789",
  "kycProvider": "abc123",
  "kycBaseAddress": "xyz789",
  "adminEmails": ["xyz789"],
  "stoppedForServicing": true,
  "additionalSettings": "xyz789",
  "proxyLiquidityProviderUrl": "abc123",
  "proxyLiquidityProviderApiSecret": "xyz789",
  "proxyLiquidityProviderApiKey": "xyz789",
  "proxyLiquidityProvider": "xyz789",
  "proxyLiquidityProviderTransactionChangedCallback": "xyz789",
  "textPages": [TextPage]
}
Types

SettingsCommonInput

Fields
Input Field Description
liquidityProvider - String
custodyProvider - String
mailProvider - String
kycProvider - String
adminEmails - [String!]
stoppedForServicing - Boolean
additionalSettings - String
Example
{
  "liquidityProvider": "abc123",
  "custodyProvider": "abc123",
  "mailProvider": "abc123",
  "kycProvider": "xyz789",
  "adminEmails": ["xyz789"],
  "stoppedForServicing": true,
  "additionalSettings": "xyz789"
}
Types

SettingsCost

Fields
Field Name Description
settingsCostId - ID!
name - String!
description - String
targetFilterType - SettingsCostTargetFilterType
targetFilterValues - [String!]
targetInstruments - [String!]
targetTransactionTypes - [String!]
targetPaymentProviders - [String!]
terms - String
created - DateTime!
createdBy - String
bankAccounts - [WireTransferBankAccount!]
default - Boolean
deleted - DateTime
Example
{
  "settingsCostId": 4,
  "name": "abc123",
  "description": "abc123",
  "targetFilterType": "None",
  "targetFilterValues": ["xyz789"],
  "targetInstruments": ["xyz789"],
  "targetTransactionTypes": ["abc123"],
  "targetPaymentProviders": ["xyz789"],
  "terms": "xyz789",
  "created": "2007-12-03T10:15:30Z",
  "createdBy": "abc123",
  "bankAccounts": [WireTransferBankAccount],
  "default": true,
  "deleted": "2007-12-03T10:15:30Z"
}
Types

SettingsCostInput

Fields
Input Field Description
name - String
description - String
targetFilterType - SettingsCostTargetFilterType
targetFilterValues - [String!]
targetInstruments - [PaymentInstrument!]
targetTransactionTypes - [TransactionType!]
targetPaymentProviders - [String!]
terms - String
bankAccountIds - [String!]
default - Boolean
deleted - DateTime
Example
{
  "name": "abc123",
  "description": "xyz789",
  "targetFilterType": "None",
  "targetFilterValues": ["xyz789"],
  "targetInstruments": ["CreditCard"],
  "targetTransactionTypes": ["Buy"],
  "targetPaymentProviders": ["xyz789"],
  "terms": "xyz789",
  "bankAccountIds": ["xyz789"],
  "default": false,
  "deleted": "2007-12-03T10:15:30Z"
}
Types

SettingsCostListResult

Fields
Field Name Description
count - Int
list - [SettingsCost!]
Example
{"count": 123, "list": [SettingsCost]}
Types

SettingsCostShort

Fields
Field Name Description
terms - String
bankAccounts - [WireTransferBankAccountShort!]
Example
{
  "terms": "xyz789",
  "bankAccounts": [WireTransferBankAccountShort]
}
Types

SettingsCostTargetFilterType

Values
Enum Value Description

None

PSP

Country
Example
"None"
Types

SettingsCurrency

Fields
Field Name Description
symbol - ID!
name - String
precision - Int!
minAmount - Float!
maxAmount - Float!
rateFactor - Float!
validateAsSymbol - String
fiat - Boolean
defaultBankTransferProvider - String
defaultWireTransferProvider - String
defaultCreditCardProvider - String
explorerLink - String
ethFlag - Boolean
trxFlag - Boolean
disabled - String
displaySymbol - String
Example
{
  "symbol": 4,
  "name": "abc123",
  "precision": 987,
  "minAmount": 987.65,
  "maxAmount": 123.45,
  "rateFactor": 987.65,
  "validateAsSymbol": "abc123",
  "fiat": false,
  "defaultBankTransferProvider": "xyz789",
  "defaultWireTransferProvider": "abc123",
  "defaultCreditCardProvider": "abc123",
  "explorerLink": "abc123",
  "ethFlag": true,
  "trxFlag": false,
  "disabled": "abc123",
  "displaySymbol": "xyz789"
}
Types

SettingsCurrencyListResult

Fields
Field Name Description
count - Int
list - [SettingsCurrency!]
Example
{"count": 123, "list": [SettingsCurrency]}
Types

SettingsCurrencyWithDefaults

Fields
Field Name Description
settingsCurrency - SettingsCurrencyListResult
defaultFiat - String
defaultCrypto - String
Example
{
  "settingsCurrency": SettingsCurrencyListResult,
  "defaultFiat": "xyz789",
  "defaultCrypto": "xyz789"
}
Types

SettingsFee

Fields
Field Name Description
settingsFeeId - ID!
name - String!
description - String
targetFilterType - SettingsFeeTargetFilterType
targetFilterValues - [String!]
targetInstruments - [String!]
targetUserTypes - [UserType!]
targetUserModes - [UserMode!]
targetTransactionTypes - [String!]
targetPaymentProviders - [String!]
terms - String!
wireDetails - String!
created - DateTime!
createdBy - String
default - Boolean
deleted - DateTime
currency - String
rateToEur - Float
costs - [SettingsCost!]
Example
{
  "settingsFeeId": 4,
  "name": "xyz789",
  "description": "xyz789",
  "targetFilterType": "None",
  "targetFilterValues": ["abc123"],
  "targetInstruments": ["abc123"],
  "targetUserTypes": ["Merchant"],
  "targetUserModes": ["InternalWallet"],
  "targetTransactionTypes": ["abc123"],
  "targetPaymentProviders": ["xyz789"],
  "terms": "abc123",
  "wireDetails": "abc123",
  "created": "2007-12-03T10:15:30Z",
  "createdBy": "abc123",
  "default": false,
  "deleted": "2007-12-03T10:15:30Z",
  "currency": "xyz789",
  "rateToEur": 987.65,
  "costs": [SettingsCost]
}
Types

SettingsFeeInput

Fields
Input Field Description
name - String
description - String
targetFilterType - SettingsFeeTargetFilterType
targetFilterValues - [String!]
targetInstruments - [PaymentInstrument!]
targetUserTypes - [UserType!]
targetUserModes - [UserMode!]
targetTransactionTypes - [TransactionType!]
targetPaymentProviders - [String!]
terms - String
wireDetails - String
default - Boolean
deleted - DateTime
Example
{
  "name": "abc123",
  "description": "xyz789",
  "targetFilterType": "None",
  "targetFilterValues": ["abc123"],
  "targetInstruments": ["CreditCard"],
  "targetUserTypes": ["Merchant"],
  "targetUserModes": ["InternalWallet"],
  "targetTransactionTypes": ["Buy"],
  "targetPaymentProviders": ["abc123"],
  "terms": "xyz789",
  "wireDetails": "xyz789",
  "default": false,
  "deleted": "2007-12-03T10:15:30Z"
}
Types

SettingsFeeListResult

Fields
Field Name Description
count - Int
list - [SettingsFee!]
Example
{"count": 987, "list": [SettingsFee]}
Types

SettingsFeeShort

Fields
Field Name Description
terms - String!
wireDetails - String!
currency - String
rateToEur - Float
costs - [SettingsCostShort!]
requiredFields - [String]
Example
{
  "terms": "xyz789",
  "wireDetails": "xyz789",
  "currency": "xyz789",
  "rateToEur": 123.45,
  "costs": [SettingsCostShort],
  "requiredFields": ["abc123"]
}
Types

SettingsFeeTargetFilterType

Values
Enum Value Description

None

AccountId

WidgetId

Country

AccountType

InitiateFrom
Example
"None"
Types

SettingsKyc

Fields
Field Name Description
settingsKycId - ID!
name - String!
description - String
targetKycProviders - [KycProvider!]
targetUserType - UserType!
targetUserModes - [UserMode!]
targetFilterType - SettingsKycTargetFilterType
targetFilterValues - [String!]
levels - [SettingsKycLevel!]
requireUserFullName - Boolean
requireUserPhone - Boolean
requireUserBirthday - Boolean
requireUserAddress - Boolean
requireUserFlatNumber - Boolean
created - DateTime!
createdBy - String
default - Boolean
deleted - DateTime
Example
{
  "settingsKycId": "4",
  "name": "abc123",
  "description": "xyz789",
  "targetKycProviders": ["Local"],
  "targetUserType": "Merchant",
  "targetUserModes": ["InternalWallet"],
  "targetFilterType": "None",
  "targetFilterValues": ["xyz789"],
  "levels": [SettingsKycLevel],
  "requireUserFullName": false,
  "requireUserPhone": true,
  "requireUserBirthday": true,
  "requireUserAddress": true,
  "requireUserFlatNumber": true,
  "created": "2007-12-03T10:15:30Z",
  "createdBy": "abc123",
  "default": true,
  "deleted": "2007-12-03T10:15:30Z"
}
Types

SettingsKycInput

Fields
Input Field Description
name - String
description - String
targetKycProviders - [KycProvider!]
targetUserType - UserType!
targetUserModes - [UserMode!]
targetFilterType - SettingsKycTargetFilterType
targetFilterValues - [String!]
levelIds - [String!]
requireUserFullName - Boolean
requireUserPhone - Boolean
requireUserBirthday - Boolean
requireUserAddress - Boolean
requireUserFlatNumber - Boolean
default - Boolean
deleted - DateTime
Example
{
  "name": "abc123",
  "description": "xyz789",
  "targetKycProviders": ["Local"],
  "targetUserType": "Merchant",
  "targetUserModes": ["InternalWallet"],
  "targetFilterType": "None",
  "targetFilterValues": ["xyz789"],
  "levelIds": ["xyz789"],
  "requireUserFullName": false,
  "requireUserPhone": true,
  "requireUserBirthday": true,
  "requireUserAddress": false,
  "requireUserFlatNumber": false,
  "default": true,
  "deleted": "2007-12-03T10:15:30Z"
}
Types

SettingsKycLevel

Fields
Field Name Description
settingsKycLevelId - ID!
name - String
originalLevelName - String
originalFlowName - String
description - String
userType - UserType
order - Int
data - String
created - DateTime
createdBy - String
Example
{
  "settingsKycLevelId": "4",
  "name": "xyz789",
  "originalLevelName": "abc123",
  "originalFlowName": "abc123",
  "description": "xyz789",
  "userType": "Merchant",
  "order": 123,
  "data": "xyz789",
  "created": "2007-12-03T10:15:30Z",
  "createdBy": "xyz789"
}
Types

SettingsKycLevelInput

Fields
Input Field Description
name - String!
originalLevelName - String
originalFlowName - String
data - String!
description - String
userType - UserType!
order - Int
Example
{
  "name": "xyz789",
  "originalLevelName": "abc123",
  "originalFlowName": "xyz789",
  "data": "xyz789",
  "description": "xyz789",
  "userType": "Merchant",
  "order": 123
}
Types

SettingsKycLevelListResult

Fields
Field Name Description
count - Int
list - [SettingsKycLevel!]
Example
{"count": 987, "list": [SettingsKycLevel]}
Types

SettingsKycLevelShort

Fields
Field Name Description
settingsKycLevelId - ID!
name - String
originalLevelName - String
originalFlowName - String
description - String
userType - UserType
order - Int
data - String
Example
{
  "settingsKycLevelId": "4",
  "name": "xyz789",
  "originalLevelName": "xyz789",
  "originalFlowName": "xyz789",
  "description": "abc123",
  "userType": "Merchant",
  "order": 987,
  "data": "xyz789"
}
Types

SettingsKycListResult

Fields
Field Name Description
count - Int
list - [SettingsKyc!]
Example
{"count": 987, "list": [SettingsKyc]}
Types

SettingsKycShort

Fields
Field Name Description
requireUserFullName - Boolean
requireUserPhone - Boolean
requireUserBirthday - Boolean
requireUserAddress - Boolean
requireUserFlatNumber - Boolean
levels - [SettingsKycLevelShort!]
Example
{
  "requireUserFullName": false,
  "requireUserPhone": false,
  "requireUserBirthday": false,
  "requireUserAddress": true,
  "requireUserFlatNumber": true,
  "levels": [SettingsKycLevelShort]
}
Types

SettingsKycTargetFilterType

Values
Enum Value Description

None

AccountId

WidgetId

Country

InitiateFrom
Example
"None"
Types

SettingsKycTier

Fields
Field Name Description
settingsKycTierId - ID!
name - String!
description - String
amount - Float
targetKycProviders - [KycProvider!]
targetUserType - UserType!
targetUserModes - [UserMode!]
targetFilterType - SettingsKycTargetFilterType
targetFilterValues - [String!]
levelId - String!
level - SettingsKycLevel
requireUserFullName - Boolean
requireUserPhone - Boolean
requireUserBirthday - Boolean
requireUserAddress - Boolean
requireUserFlatNumber - Boolean
created - DateTime!
createdBy - String
default - Boolean
deleted - DateTime
Example
{
  "settingsKycTierId": "4",
  "name": "xyz789",
  "description": "xyz789",
  "amount": 987.65,
  "targetKycProviders": ["Local"],
  "targetUserType": "Merchant",
  "targetUserModes": ["InternalWallet"],
  "targetFilterType": "None",
  "targetFilterValues": ["abc123"],
  "levelId": "abc123",
  "level": SettingsKycLevel,
  "requireUserFullName": false,
  "requireUserPhone": true,
  "requireUserBirthday": false,
  "requireUserAddress": false,
  "requireUserFlatNumber": true,
  "created": "2007-12-03T10:15:30Z",
  "createdBy": "abc123",
  "default": true,
  "deleted": "2007-12-03T10:15:30Z"
}
Types

SettingsKycTierInput

Fields
Input Field Description
name - String
description - String
amount - Float
targetKycProviders - [KycProvider!]
targetUserType - UserType
targetUserModes - [UserMode!]
targetFilterType - SettingsKycTargetFilterType
targetFilterValues - [String!]
levelId - String
requireUserFullName - Boolean
requireUserPhone - Boolean
requireUserBirthday - Boolean
requireUserAddress - Boolean
requireUserFlatNumber - Boolean
default - Boolean
deleted - DateTime
Example
{
  "name": "xyz789",
  "description": "abc123",
  "amount": 123.45,
  "targetKycProviders": ["Local"],
  "targetUserType": "Merchant",
  "targetUserModes": ["InternalWallet"],
  "targetFilterType": "None",
  "targetFilterValues": ["xyz789"],
  "levelId": "abc123",
  "requireUserFullName": true,
  "requireUserPhone": false,
  "requireUserBirthday": true,
  "requireUserAddress": true,
  "requireUserFlatNumber": false,
  "default": false,
  "deleted": "2007-12-03T10:15:30Z"
}
Types

SettingsKycTierListResult

Fields
Field Name Description
count - Int
list - [SettingsKycTier!]
Example
{"count": 987, "list": [SettingsKycTier]}
Types

SettingsKycTierShort

Fields
Field Name Description
name - String!
description - String
amount - Float
requireUserFullName - Boolean
requireUserPhone - Boolean
requireUserBirthday - Boolean
requireUserAddress - Boolean
requireUserFlatNumber - Boolean
Example
{
  "name": "xyz789",
  "description": "abc123",
  "amount": 123.45,
  "requireUserFullName": true,
  "requireUserPhone": false,
  "requireUserBirthday": false,
  "requireUserAddress": true,
  "requireUserFlatNumber": true
}
Types

SettingsKycTierShortEx

Fields
Field Name Description
settingsKycTierId - String!
name - String!
description - String
amount - Float
requireUserFullName - Boolean
requireUserPhone - Boolean
requireUserBirthday - Boolean
requireUserAddress - Boolean
requireUserFlatNumber - Boolean
levelId - String
levelName - String
levelDescription - String
originalLevelName - String
originalFlowName - String
Example
{
  "settingsKycTierId": "abc123",
  "name": "abc123",
  "description": "abc123",
  "amount": 987.65,
  "requireUserFullName": true,
  "requireUserPhone": false,
  "requireUserBirthday": false,
  "requireUserAddress": true,
  "requireUserFlatNumber": true,
  "levelId": "xyz789",
  "levelName": "xyz789",
  "levelDescription": "xyz789",
  "originalLevelName": "xyz789",
  "originalFlowName": "abc123"
}
Types

SettingsKycTierShortExListResult

Fields
Field Name Description
count - Int
list - [SettingsKycTierShortEx!]
Example
{"count": 987, "list": [SettingsKycTierShortEx]}
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"
Types

StringMap

Fields
Field Name Description
key - String!
value - String
Example
{
  "key": "abc123",
  "value": "abc123"
}
Types

SupportTicket

Fields
Field Name Description
supportTicketId - ID!
userId - String
user - User
title - String
description - String
category - SupportTicketCategory
files - [String!]
created - DateTime
Example
{
  "supportTicketId": "4",
  "userId": "xyz789",
  "user": User,
  "title": "xyz789",
  "description": "xyz789",
  "category": "Authorization",
  "files": ["xyz789"],
  "created": "2007-12-03T10:15:30Z"
}
Types

SupportTicketCategory

Values
Enum Value Description

Authorization

Transaction

Exchange
Example
"Authorization"
Types

SupportTicketListResult

Fields
Field Name Description
count - Int
list - [SupportTicket!]
Example
{"count": 123, "list": [SupportTicket]}
Types

TextPage

Fields
Field Name Description
page - Int
text - String
Example
{"page": 123, "text": "abc123"}
Types

Transaction

Fields
Field Name Description
transactionId - ID!
code - String
userId - String!
userReferralCode - Int!
userIp - String
userTierId - String
userTier - SettingsKycTierShortEx
requiredUserTierId - String
requiredUserTier - SettingsKycTierShortEx
sourceVaultId - String
sourceVault - String
user - User
created - DateTime
updated - DateTime
executed - DateTime
type - TransactionType!
status - TransactionStatus!
subStatus - String
kycStatus - TransactionKycStatus
accountStatus - AccountStatus
feeFiat - Float
feePercent - Float
feeMinFiat - Float
feeDetails - String
approxNetworkFee - Float
approxNetworkFeeFiat - Float
userDefaultFiatCurrency - String!
userDefaultCryptoCurrency - String!
currencyToSpend - String
amountToSpend - Float
amountToSpendWithoutFee - Float
currencyToReceive - String!
initialAmountToReceive - Float
initialAmountToReceiveWithoutFee - Float
amountToReceive - Float
amountToReceiveWithoutFee - Float
amountInEur - Float
initialRate - Float
rate - Float
rateFiatToEur - Float
destVaultId - String
destVault - String
destination - String
countryCode2 - String
countryCode3 - String
accountType - String
source - TransactionSource
instrument - PaymentInstrument
instrumentDetails - String
custodyProvider - CustodyProvider
custodyDetails - String
paymentProvider - String
paymentOrderId - String
paymentOrder - PaymentOrder
liquidityProvider - LiquidityProvider
liquidityOrderId - String
liquidityOrder - LiquidityOrder
transferOrderId - String
transferOrder - TransferOrder
transferOrderBlockchainLink - String
benchmarkTransferOrderId - String
benchmarkTransferOrder - TransferOrder
benchmarkTransferOrderBlockchainLink - String
userBalanceTotalBefore - Float
userBalanceAvailableBefore - Float
userBalanceTotalAfter - Float
userBalanceAvailableAfter - Float
totalUserAmountBeforeTransactionInEur - Float
hasBeenBenchmarked - Boolean
widgetId - String
widgetCode - String
widgetUserParamsId - String
widgetUserParams - String
widget - String
destinationUserId - String
manuallyEditedAmounts - Boolean
manuallyEditedFee - Boolean
manuallyEditedStatus - Boolean
manuallyEditedKycStatus - Boolean
manuallyEditedAccountStatus - Boolean
risk - RiskLevel!
riskCodes - [String!]
backups - [String!]
comment - String
data - String
verifyWhenPaid - Boolean
requestParams - String
cryptoInvoiceName - String
sourceAddress - String
Example
{
  "transactionId": 4,
  "code": "abc123",
  "userId": "abc123",
  "userReferralCode": 123,
  "userIp": "xyz789",
  "userTierId": "xyz789",
  "userTier": SettingsKycTierShortEx,
  "requiredUserTierId": "abc123",
  "requiredUserTier": SettingsKycTierShortEx,
  "sourceVaultId": "abc123",
  "sourceVault": "abc123",
  "user": User,
  "created": "2007-12-03T10:15:30Z",
  "updated": "2007-12-03T10:15:30Z",
  "executed": "2007-12-03T10:15:30Z",
  "type": "Buy",
  "status": "New",
  "subStatus": "abc123",
  "kycStatus": "KycWaiting",
  "accountStatus": "Live",
  "feeFiat": 123.45,
  "feePercent": 987.65,
  "feeMinFiat": 123.45,
  "feeDetails": "xyz789",
  "approxNetworkFee": 987.65,
  "approxNetworkFeeFiat": 987.65,
  "userDefaultFiatCurrency": "abc123",
  "userDefaultCryptoCurrency": "abc123",
  "currencyToSpend": "abc123",
  "amountToSpend": 987.65,
  "amountToSpendWithoutFee": 987.65,
  "currencyToReceive": "xyz789",
  "initialAmountToReceive": 987.65,
  "initialAmountToReceiveWithoutFee": 123.45,
  "amountToReceive": 123.45,
  "amountToReceiveWithoutFee": 123.45,
  "amountInEur": 987.65,
  "initialRate": 123.45,
  "rate": 123.45,
  "rateFiatToEur": 123.45,
  "destVaultId": "abc123",
  "destVault": "abc123",
  "destination": "abc123",
  "countryCode2": "abc123",
  "countryCode3": "abc123",
  "accountType": "abc123",
  "source": "QuickCheckout",
  "instrument": "CreditCard",
  "instrumentDetails": "xyz789",
  "custodyProvider": "Fireblocks",
  "custodyDetails": "xyz789",
  "paymentProvider": "xyz789",
  "paymentOrderId": "abc123",
  "paymentOrder": PaymentOrder,
  "liquidityProvider": "Bitstamp",
  "liquidityOrderId": "xyz789",
  "liquidityOrder": LiquidityOrder,
  "transferOrderId": "abc123",
  "transferOrder": TransferOrder,
  "transferOrderBlockchainLink": "abc123",
  "benchmarkTransferOrderId": "abc123",
  "benchmarkTransferOrder": TransferOrder,
  "benchmarkTransferOrderBlockchainLink": "xyz789",
  "userBalanceTotalBefore": 987.65,
  "userBalanceAvailableBefore": 123.45,
  "userBalanceTotalAfter": 123.45,
  "userBalanceAvailableAfter": 123.45,
  "totalUserAmountBeforeTransactionInEur": 987.65,
  "hasBeenBenchmarked": true,
  "widgetId": "abc123",
  "widgetCode": "abc123",
  "widgetUserParamsId": "abc123",
  "widgetUserParams": "abc123",
  "widget": "abc123",
  "destinationUserId": "xyz789",
  "manuallyEditedAmounts": true,
  "manuallyEditedFee": false,
  "manuallyEditedStatus": false,
  "manuallyEditedKycStatus": false,
  "manuallyEditedAccountStatus": true,
  "risk": "Low",
  "riskCodes": ["xyz789"],
  "backups": ["xyz789"],
  "comment": "abc123",
  "data": "abc123",
  "verifyWhenPaid": true,
  "requestParams": "abc123",
  "cryptoInvoiceName": "abc123",
  "sourceAddress": "xyz789"
}
Types

TransactionInput

Fields
Input Field Description
type - TransactionType!
source - TransactionSource!
sourceVaultId - String
destVaultId - String
destination - String
currencyToSpend - String
currencyToReceive - String
amountToSpend - Float!
instrument - PaymentInstrument
instrumentDetails - String
paymentProvider - String
widgetUserParamsId - String
data - String
verifyWhenPaid - Boolean
sourceAddress - String
Example
{
  "type": "Buy",
  "source": "QuickCheckout",
  "sourceVaultId": "abc123",
  "destVaultId": "abc123",
  "destination": "xyz789",
  "currencyToSpend": "xyz789",
  "currencyToReceive": "xyz789",
  "amountToSpend": 123.45,
  "instrument": "CreditCard",
  "instrumentDetails": "abc123",
  "paymentProvider": "abc123",
  "widgetUserParamsId": "abc123",
  "data": "xyz789",
  "verifyWhenPaid": false,
  "sourceAddress": "abc123"
}
Types

TransactionKycStatus

Values
Enum Value Description

KycWaiting

KycRejected

KycApproved
Example
"KycWaiting"
Types

TransactionListResult

Fields
Field Name Description
count - Int
list - [Transaction!]
Example
{"count": 123, "list": [Transaction]}
Types

TransactionMerchantInput

Fields
Input Field Description
type - TransactionType!
source - TransactionSource!
sourceVaultId - String
destVaultId - String
destination - String
currencyToSpend - String
amountToSpend - Float!
amountToSpendWithoutFee - Float
currencyToReceive - String
initialAmountToReceive - Float
initialAmountToReceiveWithoutFee - Float
amountToReceive - Float
amountToReceiveWithoutFee - Float
amountInEur - Float
initialRate - Float
rate - Float
rateFiatToEur - Float
instrument - PaymentInstrument
instrumentDetails - String
paymentProvider - String
widgetUserParamsId - String
data - String
status - TransactionStatus
transactionChangedCallback - String
sourceAddress - String
Example
{
  "type": "Buy",
  "source": "QuickCheckout",
  "sourceVaultId": "abc123",
  "destVaultId": "abc123",
  "destination": "xyz789",
  "currencyToSpend": "xyz789",
  "amountToSpend": 123.45,
  "amountToSpendWithoutFee": 987.65,
  "currencyToReceive": "xyz789",
  "initialAmountToReceive": 987.65,
  "initialAmountToReceiveWithoutFee": 123.45,
  "amountToReceive": 123.45,
  "amountToReceiveWithoutFee": 123.45,
  "amountInEur": 123.45,
  "initialRate": 987.65,
  "rate": 987.65,
  "rateFiatToEur": 123.45,
  "instrument": "CreditCard",
  "instrumentDetails": "abc123",
  "paymentProvider": "xyz789",
  "widgetUserParamsId": "abc123",
  "data": "abc123",
  "status": "New",
  "transactionChangedCallback": "xyz789",
  "sourceAddress": "abc123"
}
Types

TransactionServiceNotificationType

Values
Enum Value Description

PaymentStatusChanged

CryptoPartPaid

CryptoFullPaid
Example
"PaymentStatusChanged"
Types

TransactionShort

Fields
Field Name Description
transactionId - ID!
code - String
userId - String
userReferralCode - Int!
sourceVaultId - String
sourceVault - String
userIp - String
userTierId - String
userTier - SettingsKycTierShortEx
requiredUserTierId - String
requiredUserTier - SettingsKycTierShortEx
created - DateTime
updated - DateTime
executed - DateTime
type - TransactionType!
status - TransactionStatus!
subStatus - String
kycStatus - TransactionKycStatus
accountStatus - AccountStatus
feeFiat - Float
feePercent - Float
feeMinFiat - Float
feeDetails - String
approxNetworkFee - Float
approxNetworkFeeFiat - Float
currencyToSpend - String
amountToSpend - Float
amountToSpendWithoutFee - Float
currencyToReceive - String
initialAmountToReceive - Float
initialAmountToReceiveWithoutFee - Float
amountToReceive - Float
amountToReceiveWithoutFee - Float
amountInEur - Float
initialRate - Float
rate - Float
rateFiatToEur - Float
destVaultId - String
destVault - String
destination - String
countryCode2 - String
countryCode3 - String
accountType - String
source - TransactionSource
instrument - PaymentInstrument
instrumentDetails - String
custodyProvider - CustodyProvider
custodyDetails - String
paymentProvider - String
liquidityProvider - LiquidityProvider
paymentOrder - PaymentOrder
liquidityOrder - LiquidityOrder
transferOrder - TransferOrder
widgetId - String
widgetCode - String
widgetUserParamsId - String
widgetUserParams - String
widget - String
destinationUserId - String
risk - RiskLevel!
riskCodes - [String!]
cryptoInvoiceName - String
data - String
sourceAddress - String
Example
{
  "transactionId": 4,
  "code": "xyz789",
  "userId": "abc123",
  "userReferralCode": 123,
  "sourceVaultId": "abc123",
  "sourceVault": "abc123",
  "userIp": "xyz789",
  "userTierId": "xyz789",
  "userTier": SettingsKycTierShortEx,
  "requiredUserTierId": "abc123",
  "requiredUserTier": SettingsKycTierShortEx,
  "created": "2007-12-03T10:15:30Z",
  "updated": "2007-12-03T10:15:30Z",
  "executed": "2007-12-03T10:15:30Z",
  "type": "Buy",
  "status": "New",
  "subStatus": "xyz789",
  "kycStatus": "KycWaiting",
  "accountStatus": "Live",
  "feeFiat": 123.45,
  "feePercent": 123.45,
  "feeMinFiat": 987.65,
  "feeDetails": "abc123",
  "approxNetworkFee": 123.45,
  "approxNetworkFeeFiat": 987.65,
  "currencyToSpend": "xyz789",
  "amountToSpend": 987.65,
  "amountToSpendWithoutFee": 987.65,
  "currencyToReceive": "abc123",
  "initialAmountToReceive": 123.45,
  "initialAmountToReceiveWithoutFee": 987.65,
  "amountToReceive": 987.65,
  "amountToReceiveWithoutFee": 123.45,
  "amountInEur": 123.45,
  "initialRate": 123.45,
  "rate": 123.45,
  "rateFiatToEur": 123.45,
  "destVaultId": "xyz789",
  "destVault": "xyz789",
  "destination": "abc123",
  "countryCode2": "xyz789",
  "countryCode3": "xyz789",
  "accountType": "abc123",
  "source": "QuickCheckout",
  "instrument": "CreditCard",
  "instrumentDetails": "xyz789",
  "custodyProvider": "Fireblocks",
  "custodyDetails": "xyz789",
  "paymentProvider": "xyz789",
  "liquidityProvider": "Bitstamp",
  "paymentOrder": PaymentOrder,
  "liquidityOrder": LiquidityOrder,
  "transferOrder": TransferOrder,
  "widgetId": "xyz789",
  "widgetCode": "xyz789",
  "widgetUserParamsId": "abc123",
  "widgetUserParams": "xyz789",
  "widget": "xyz789",
  "destinationUserId": "abc123",
  "risk": "Low",
  "riskCodes": ["abc123"],
  "cryptoInvoiceName": "abc123",
  "data": "xyz789",
  "sourceAddress": "xyz789"
}
Types

TransactionShortListResult

Fields
Field Name Description
count - Int
list - [TransactionShort!]
Example
{"count": 987, "list": [TransactionShort]}
Types

TransactionSource

Values
Enum Value Description

QuickCheckout

Widget

Wallet
Example
"QuickCheckout"
Types

TransactionStatsByStatus

Fields
Field Name Description
status - TransactionStatus
volume - TransactionStatsVolume
Example
{"status": "New", "volume": TransactionStatsVolume}
Types

TransactionStatsVolume

Fields
Field Name Description
count - Int
volume - Float
Example
{"count": 987, "volume": 987.65}
Types

TransactionStatus

Values
Enum Value Description

New

Pending

Processing

Paid

AddressDeclined

PaymentDeclined

ExchangeDeclined

TransferDeclined

TransferBlocked

Exchanging

Exchanged

TransferBenchmarkWaiting

BenchmarkTransfering

BenchmarkTransfered

BenchmarkTransferDeclined

Sending

SendingWaiting

Sent

Distributing

DistributingWaiting

Distributed

Completed

Abandoned

Canceled

Chargeback

KycDeclined
Example
"New"
Types

TransactionStatusDescriptor

Fields
Field Name Description
notifyUser - Boolean!
canBeCancelled - Boolean!
description - String!
userStatus - UserTransactionStatus!
adminStatus - AdminTransactionStatus!
level - TransactionStatusLevel!
repeatFromStatus - TransactionStatus
updateWhenOwnLiquidityProvider - Boolean
Example
{
  "notifyUser": false,
  "canBeCancelled": true,
  "description": "abc123",
  "userStatus": "New",
  "adminStatus": "New",
  "level": "info",
  "repeatFromStatus": "New",
  "updateWhenOwnLiquidityProvider": true
}
Types

TransactionStatusDescriptorMap

Fields
Field Name Description
key - TransactionStatus!
value - TransactionStatusDescriptor!
Example
{"key": "New", "value": TransactionStatusDescriptor}
Types

TransactionStatusHistory

Fields
Field Name Description
transactionStatusHistoryId - ID!
transactionId - String
userId - String
created - DateTime
oldStatus - String
newStatus - String
newStatusReason - String
initialTransactionHandlingData - String
transactionHandlingData - String
transactionDataBefore - String
transactionDataAfter - String
Example
{
  "transactionStatusHistoryId": "4",
  "transactionId": "xyz789",
  "userId": "abc123",
  "created": "2007-12-03T10:15:30Z",
  "oldStatus": "abc123",
  "newStatus": "abc123",
  "newStatusReason": "abc123",
  "initialTransactionHandlingData": "abc123",
  "transactionHandlingData": "abc123",
  "transactionDataBefore": "abc123",
  "transactionDataAfter": "abc123"
}
Types

TransactionStatusHistoryListResult

Fields
Field Name Description
count - Int
list - [TransactionStatusHistory!]
Example
{"count": 987, "list": [TransactionStatusHistory]}
Types

TransactionStatusLevel

Values
Enum Value Description

info

error
Example
"info"
Types

TransactionType

Values
Enum Value Description

Buy

Sell

Transfer

Receive

Exchange

System

Deposit

Withdrawal

MerchantBuy

MerchantSell
Example
"Buy"
Types

TransactionUpdateInput

Fields
Input Field Description
sourceVaultId - String
currencyToSpend - String
currencyToReceive - String
amountToSpend - Float
amountToReceive - Float
rate - Float
destination - String
feeFiat - Float
widgetId - String
widgetUserParamsId - String
status - TransactionStatus
subStatus - String
kycStatus - TransactionKycStatus
launchAfterUpdate - Boolean
accountStatus - AccountStatus
transferOrderChanges - TransactionUpdateTransferOrderChanges
benchmarkTransferOrderChanges - TransactionUpdateTransferOrderChanges
comment - String
requestParams - String
cryptoInvoiceName - String
Example
{
  "sourceVaultId": "xyz789",
  "currencyToSpend": "abc123",
  "currencyToReceive": "abc123",
  "amountToSpend": 123.45,
  "amountToReceive": 987.65,
  "rate": 987.65,
  "destination": "abc123",
  "feeFiat": 123.45,
  "widgetId": "abc123",
  "widgetUserParamsId": "xyz789",
  "status": "New",
  "subStatus": "xyz789",
  "kycStatus": "KycWaiting",
  "launchAfterUpdate": false,
  "accountStatus": "Live",
  "transferOrderChanges": TransactionUpdateTransferOrderChanges,
  "benchmarkTransferOrderChanges": TransactionUpdateTransferOrderChanges,
  "comment": "abc123",
  "requestParams": "xyz789",
  "cryptoInvoiceName": "xyz789"
}
Types

TransactionUpdateTransferOrderChanges

Fields
Input Field Description
orderId - String
hash - String
Example
{
  "orderId": "xyz789",
  "hash": "xyz789"
}
Types

TransferOrder

Fields
Field Name Description
orderId - ID
userId - String!
transactionId - String
provider - String
operation - String
signed - String
created - DateTime
published - DateTime
publishingResult - String
executed - DateTime
executingResult - String
amount - Float
currency - String
sourceVaultId - String
source - String
destination - String
type - TransferType
originalOrderId - String
transferHash - String
transferDetails - String
status - String
subStatus - String
feeCurrency - Float
cryptoInvoiceName - String
Example
{
  "orderId": "4",
  "userId": "xyz789",
  "transactionId": "xyz789",
  "provider": "xyz789",
  "operation": "abc123",
  "signed": "xyz789",
  "created": "2007-12-03T10:15:30Z",
  "published": "2007-12-03T10:15:30Z",
  "publishingResult": "xyz789",
  "executed": "2007-12-03T10:15:30Z",
  "executingResult": "abc123",
  "amount": 987.65,
  "currency": "abc123",
  "sourceVaultId": "xyz789",
  "source": "xyz789",
  "destination": "abc123",
  "type": "Send",
  "originalOrderId": "xyz789",
  "transferHash": "abc123",
  "transferDetails": "abc123",
  "status": "xyz789",
  "subStatus": "xyz789",
  "feeCurrency": 123.45,
  "cryptoInvoiceName": "abc123"
}
Types

TransferStats

Fields
Field Name Description
ratio - Float
approved - TransactionStatsVolume
declined - TransactionStatsVolume
failed - TransactionStatsVolume
chargedBack - TransactionStatsVolume
abandoned - TransactionStatsVolume
inProcess - TransactionStatsVolume
byStatus - [TransactionStatsByStatus!]
toMerchant - MerchantOrCustomerStats
toCustomer - MerchantOrCustomerStats
fee - TransactionStatsVolume
Example
{
  "ratio": 123.45,
  "approved": TransactionStatsVolume,
  "declined": TransactionStatsVolume,
  "failed": TransactionStatsVolume,
  "chargedBack": TransactionStatsVolume,
  "abandoned": TransactionStatsVolume,
  "inProcess": TransactionStatsVolume,
  "byStatus": [TransactionStatsByStatus],
  "toMerchant": MerchantOrCustomerStats,
  "toCustomer": MerchantOrCustomerStats,
  "fee": TransactionStatsVolume
}
Types

TransferType

Values
Enum Value Description

Send

Receive
Example
"Send"
Types

TwoFactorAuthenticationResult

Fields
Field Name Description
otpauthUrl - String!
code - String!
qr - String!
Example
{
  "otpauthUrl": "xyz789",
  "code": "xyz789",
  "qr": "abc123"
}
Types

User

Fields
Field Name Description
userId - ID!
email - String!
type - UserType
mode - UserMode
merchantIds - [String!]
firstName - String
lastName - String
avatar - String
birthday - DateTime
countryCode2 - String
countryCode3 - String
postCode - String
town - String
street - String
subStreet - String
stateName - String
buildingName - String
buildingNumber - String
flatNumber - String
addressStartDate - DateTime
addressEndDate - DateTime
phone - String
termsOfUse - Boolean
created - DateTime
updated - DateTime
deleted - DateTime
accountStatus - AccountStatus
accessFailedCount - Int
emailConfirmed - DateTime
roles - [UserRole!]
contacts - [UserContact!]
bankAccounts - [UserBankAccount!]
permissions - [UserRolePermission!]
is2faEnabled - Boolean
hasEmailAuth - Boolean
changePasswordRequired - Boolean
referralCode - Int
systemUser - Boolean!
notificationSubscriptions - [UserNotificationSubscription!]
kycProvider - String
kycTierId - String
kycTier - SettingsKycTierShort
kycApplicantId - String
kycValid - Boolean
kycReviewDate - DateTime
kycStatus - String
kycStatusDate - DateTime
kycReviewComment - String
kycPrivateComment - String
kycReviewRejectedType - String
kycReviewRejectedLabels - [String!]
kycReviewResult - String
kycStatusUpdateRequired - Boolean
kycDocs - [String!]
custodyProvider - String
vaults - [UserVaultIdObj!]
defaultFiatCurrency - String
defaultCryptoCurrency - String
risk - RiskLevel
riskCodes - [String!]
riskAlertCount - Int
widgetId - String
widgetCode - String
affiliateId - String
affiliateCode - String
totalDepositCompleted - Float
totalDepositCompletedCount - Int
totalDepositInProcess - Float
totalDepositInProcessCount - Int
totalWithdrawalCompleted - Float
totalWithdrawalCompletedCount - Int
totalWithdrawalInProcess - Float
totalWithdrawalInProcessCount - Int
totalBoughtCompleted - Float
totalBoughtCompletedCount - Int
totalBoughtInProcess - Float
totalBoughtInProcessCount - Int
totalSoldCompleted - Float
totalSoldCompletedCount - Int
totalSoldInProcess - Float
totalSoldInProcessCount - Int
totalSentCompleted - Float
totalSentCompletedCount - Int
totalSentInProcess - Float
totalSentInProcessCount - Int
totalReceivedCompleted - Float
totalReceivedCompletedCount - Int
totalReceivedInProcess - Float
totalReceivedInProcessCount - Int
totalTransactionCount - Int
avarageTransaction - Float
manuallyEditedRisk - Boolean
lastLogin - DateTime
data - String
fiatVaults - [FiatVault!]
gender - Gender
addressLine - String
openpaydIds - String
openpaydAccountHolderId - String
Example
{
  "userId": 4,
  "email": "xyz789",
  "type": "Merchant",
  "mode": "InternalWallet",
  "merchantIds": ["xyz789"],
  "firstName": "xyz789",
  "lastName": "xyz789",
  "avatar": "abc123",
  "birthday": "2007-12-03T10:15:30Z",
  "countryCode2": "xyz789",
  "countryCode3": "xyz789",
  "postCode": "abc123",
  "town": "xyz789",
  "street": "abc123",
  "subStreet": "xyz789",
  "stateName": "abc123",
  "buildingName": "xyz789",
  "buildingNumber": "xyz789",
  "flatNumber": "abc123",
  "addressStartDate": "2007-12-03T10:15:30Z",
  "addressEndDate": "2007-12-03T10:15:30Z",
  "phone": "abc123",
  "termsOfUse": false,
  "created": "2007-12-03T10:15:30Z",
  "updated": "2007-12-03T10:15:30Z",
  "deleted": "2007-12-03T10:15:30Z",
  "accountStatus": "Live",
  "accessFailedCount": 987,
  "emailConfirmed": "2007-12-03T10:15:30Z",
  "roles": [UserRole],
  "contacts": [UserContact],
  "bankAccounts": [UserBankAccount],
  "permissions": [UserRolePermission],
  "is2faEnabled": true,
  "hasEmailAuth": false,
  "changePasswordRequired": false,
  "referralCode": 123,
  "systemUser": true,
  "notificationSubscriptions": [
    UserNotificationSubscription
  ],
  "kycProvider": "xyz789",
  "kycTierId": "abc123",
  "kycTier": SettingsKycTierShort,
  "kycApplicantId": "xyz789",
  "kycValid": true,
  "kycReviewDate": "2007-12-03T10:15:30Z",
  "kycStatus": "xyz789",
  "kycStatusDate": "2007-12-03T10:15:30Z",
  "kycReviewComment": "abc123",
  "kycPrivateComment": "xyz789",
  "kycReviewRejectedType": "xyz789",
  "kycReviewRejectedLabels": ["xyz789"],
  "kycReviewResult": "xyz789",
  "kycStatusUpdateRequired": false,
  "kycDocs": ["xyz789"],
  "custodyProvider": "abc123",
  "vaults": [UserVaultIdObj],
  "defaultFiatCurrency": "abc123",
  "defaultCryptoCurrency": "xyz789",
  "risk": "Low",
  "riskCodes": ["abc123"],
  "riskAlertCount": 987,
  "widgetId": "xyz789",
  "widgetCode": "xyz789",
  "affiliateId": "abc123",
  "affiliateCode": "xyz789",
  "totalDepositCompleted": 987.65,
  "totalDepositCompletedCount": 987,
  "totalDepositInProcess": 123.45,
  "totalDepositInProcessCount": 123,
  "totalWithdrawalCompleted": 123.45,
  "totalWithdrawalCompletedCount": 987,
  "totalWithdrawalInProcess": 123.45,
  "totalWithdrawalInProcessCount": 987,
  "totalBoughtCompleted": 123.45,
  "totalBoughtCompletedCount": 987,
  "totalBoughtInProcess": 987.65,
  "totalBoughtInProcessCount": 123,
  "totalSoldCompleted": 123.45,
  "totalSoldCompletedCount": 987,
  "totalSoldInProcess": 987.65,
  "totalSoldInProcessCount": 123,
  "totalSentCompleted": 123.45,
  "totalSentCompletedCount": 123,
  "totalSentInProcess": 987.65,
  "totalSentInProcessCount": 987,
  "totalReceivedCompleted": 987.65,
  "totalReceivedCompletedCount": 123,
  "totalReceivedInProcess": 123.45,
  "totalReceivedInProcessCount": 987,
  "totalTransactionCount": 987,
  "avarageTransaction": 123.45,
  "manuallyEditedRisk": false,
  "lastLogin": "2007-12-03T10:15:30Z",
  "data": "xyz789",
  "fiatVaults": [FiatVault],
  "gender": "O",
  "addressLine": "xyz789",
  "openpaydIds": "abc123",
  "openpaydAccountHolderId": "abc123"
}
Types

UserAction

Fields
Field Name Description
userActionId - ID!
userId - String!
objectId - String
actionType - UserActionType
linkedIds - [String!]
info - String
result - UserActionResult
status - String
date - DateTime
Example
{
  "userActionId": 4,
  "userId": "abc123",
  "objectId": "abc123",
  "actionType": "signup",
  "linkedIds": ["xyz789"],
  "info": "xyz789",
  "result": "unknown",
  "status": "abc123",
  "date": "2007-12-03T10:15:30Z"
}
Types

UserActionListResult

Fields
Field Name Description
count - Int
list - [UserAction!]
Example
{"count": 987, "list": [UserAction]}
Types

UserActionResult

Values
Enum Value Description

unknown

succeeded

failed

canceled

error

notVerified
Example
"unknown"
Types

UserActionType

Values
Enum Value Description

signup

login

logout

send

receive

buy

sell

transfer

exchange

system

settleTransaction

unbenchmarkTransaction

paidTransaction

updateTransaction

abandonTransaction

abandonCryptoInvoice

cancelTransaction

createUser

addWidgetUserParams

updateUser

deleteUser

createApiKey

deleteApiKey

changeRiskAlertSettings

Deposit

Withdrawal

MerchantBuy

MerchantSell

generateKycToken

kycCallback

addBlackCountry

removeBlackCountry

createCryptoInvoice
Example
"signup"
Types

UserBalanceHistoryPeriod

Values
Enum Value Description

LastWeek

LastMonth

LastYear

All
Example
"LastWeek"
Types

UserBalanceHistoryRecord

Fields
Field Name Description
userBalanceId - String
userId - String!
date - DateTime!
asset - String!
balance - Float
balanceEur - Float
balanceFiat - Float
transactionId - String
Example
{
  "userBalanceId": "xyz789",
  "userId": "abc123",
  "date": "2007-12-03T10:15:30Z",
  "asset": "xyz789",
  "balance": 123.45,
  "balanceEur": 987.65,
  "balanceFiat": 987.65,
  "transactionId": "abc123"
}
Types

UserBalanceHistoryRecordListResult

Fields
Field Name Description
count - Int
list - [UserBalanceHistoryRecord]
Example
{"count": 987, "list": [UserBalanceHistoryRecord]}
Types

UserBankAccount

Fields
Field Name Description
userBankAccountId - String
userId - String!
beneficiaryName - String
beneficiaryAddress - String
bankName - String
bankAddress - String
swiftBic - String
iban - String
currency - String
displayName - String
description - String
created - DateTime!
Example
{
  "userBankAccountId": "abc123",
  "userId": "xyz789",
  "beneficiaryName": "abc123",
  "beneficiaryAddress": "xyz789",
  "bankName": "xyz789",
  "bankAddress": "abc123",
  "swiftBic": "abc123",
  "iban": "xyz789",
  "currency": "xyz789",
  "displayName": "xyz789",
  "description": "xyz789",
  "created": "2007-12-03T10:15:30Z"
}
Types

UserBankAccountInput

Fields
Input Field Description
beneficiaryName - String
beneficiaryAddress - String
bankName - String
bankAddress - String
swiftBic - String
iban - String
currency - String
displayName - String
description - String
Example
{
  "beneficiaryName": "xyz789",
  "beneficiaryAddress": "xyz789",
  "bankName": "abc123",
  "bankAddress": "abc123",
  "swiftBic": "xyz789",
  "iban": "xyz789",
  "currency": "xyz789",
  "displayName": "abc123",
  "description": "xyz789"
}
Types

UserContact

Fields
Field Name Description
userContactId - String
userId - String
contactEmail - String
displayName - String
assetId - String
address - String
created - DateTime
Example
{
  "userContactId": "abc123",
  "userId": "abc123",
  "contactEmail": "xyz789",
  "displayName": "abc123",
  "assetId": "abc123",
  "address": "abc123",
  "created": "2007-12-03T10:15:30Z"
}
Types

UserContactInput

Fields
Input Field Description
contactEmail - String
displayName - String
assetId - String
address - String
Example
{
  "contactEmail": "xyz789",
  "displayName": "xyz789",
  "assetId": "abc123",
  "address": "xyz789"
}
Types

UserContactListResult

Fields
Field Name Description
count - Int
list - [UserContact!]
Example
{"count": 123, "list": [UserContact]}
Types

UserCurrencyProfit

Fields
Field Name Description
currencyFrom - String
profit - Float
profitEur - Float
profitFiat - Float
profitPercent - Float
userBalanceHistory - UserBalanceHistoryRecordListResult
Example
{
  "currencyFrom": "abc123",
  "profit": 123.45,
  "profitEur": 123.45,
  "profitFiat": 987.65,
  "profitPercent": 987.65,
  "userBalanceHistory": UserBalanceHistoryRecordListResult
}
Types

UserDevice

Fields
Field Name Description
userDeviceId - String
userId - String
created - DateTime
countryCode2 - String
countryCode3 - String
city - String
region - String
eu - String
metro - Int
area - Int
location - String
browser - String
device - String
deviceConfirmed - DateTime
Example
{
  "userDeviceId": "abc123",
  "userId": "xyz789",
  "created": "2007-12-03T10:15:30Z",
  "countryCode2": "xyz789",
  "countryCode3": "abc123",
  "city": "abc123",
  "region": "abc123",
  "eu": "xyz789",
  "metro": 987,
  "area": 123,
  "location": "abc123",
  "browser": "abc123",
  "device": "xyz789",
  "deviceConfirmed": "2007-12-03T10:15:30Z"
}
Types

UserDeviceListResult

Fields
Field Name Description
count - Int
list - [UserDevice]
Example
{"count": 123, "list": [UserDevice]}
Types

UserInput

Fields
Input Field Description
email - String
type - UserType
mode - UserMode
firstName - String
lastName - String
birthday - DateTime
countryCode2 - String
countryCode3 - String
postCode - String
town - String
street - String
subStreet - String
stateName - String
buildingName - String
buildingNumber - String
flatNumber - String
addressStartDate - DateTime
addressEndDate - DateTime
phone - String
avatar - String
termsOfUse - Boolean
accountStatus - AccountStatus
defaultFiatCurrency - String
defaultCryptoCurrency - String
risk - RiskLevel
riskCodes - [String!]
widgetId - String
changePasswordRequired - Boolean
kycProvider - KycProvider
kycTierId - String
deleted - DateTime
gender - Gender
Example
{
  "email": "xyz789",
  "type": "Merchant",
  "mode": "InternalWallet",
  "firstName": "abc123",
  "lastName": "xyz789",
  "birthday": "2007-12-03T10:15:30Z",
  "countryCode2": "abc123",
  "countryCode3": "xyz789",
  "postCode": "abc123",
  "town": "xyz789",
  "street": "xyz789",
  "subStreet": "abc123",
  "stateName": "abc123",
  "buildingName": "abc123",
  "buildingNumber": "abc123",
  "flatNumber": "abc123",
  "addressStartDate": "2007-12-03T10:15:30Z",
  "addressEndDate": "2007-12-03T10:15:30Z",
  "phone": "abc123",
  "avatar": "xyz789",
  "termsOfUse": true,
  "accountStatus": "Live",
  "defaultFiatCurrency": "xyz789",
  "defaultCryptoCurrency": "abc123",
  "risk": "Low",
  "riskCodes": ["xyz789"],
  "widgetId": "xyz789",
  "changePasswordRequired": false,
  "kycProvider": "Local",
  "kycTierId": "abc123",
  "deleted": "2007-12-03T10:15:30Z",
  "gender": "O"
}
Types

UserListResult

Fields
Field Name Description
count - Int
list - [User!]
Example
{"count": 987, "list": [User]}
Types

UserMode

Values
Enum Value Description

InternalWallet

ExternalWallet

OneTimeWallet
Example
"InternalWallet"
Types

UserNotification

Fields
Field Name Description
userNotificationId - ID!
userId - String
user - User
userNotificationTypeCode - String!
userNotificationLevel - UserNotificationLevel
created - DateTime
viewed - DateTime
title - String
text - String
linkedId - String
linkedTable - String
params - String
Example
{
  "userNotificationId": 4,
  "userId": "abc123",
  "user": User,
  "userNotificationTypeCode": "abc123",
  "userNotificationLevel": "Request",
  "created": "2007-12-03T10:15:30Z",
  "viewed": "2007-12-03T10:15:30Z",
  "title": "abc123",
  "text": "xyz789",
  "linkedId": "abc123",
  "linkedTable": "xyz789",
  "params": "xyz789"
}
Types

UserNotificationLevel

Values
Enum Value Description

Request

Debug

Info

Warning

Error
Example
"Request"
Types

UserNotificationListResult

Fields
Field Name Description
count - Int
list - [UserNotification!]
Example
{"count": 987, "list": [UserNotification]}
Types

UserNotificationSubscription

Fields
Field Name Description
userNotificationSubscriptionId - ID!
userId - String
userNotificationTypeCode - String!
siteNotification - Boolean
emailNotification - Boolean
Example
{
  "userNotificationSubscriptionId": 4,
  "userId": "abc123",
  "userNotificationTypeCode": "xyz789",
  "siteNotification": true,
  "emailNotification": true
}
Types

UserProfit

Fields
Field Name Description
userId - String!
currencyTo - String
period - UserBalanceHistoryPeriod!
profits - [UserCurrencyProfit!]
Example
{
  "userId": "abc123",
  "currencyTo": "abc123",
  "period": "LastWeek",
  "profits": [UserCurrencyProfit]
}
Types

UserProfitInput

Fields
Input Field Description
currencyTo - String
period - UserBalanceHistoryPeriod!
Example
{
  "currencyTo": "xyz789",
  "period": "LastWeek"
}
Types

UserRole

Fields
Field Name Description
userRoleId - String
name - String!
code - String!
immutable - Boolean
Example
{
  "userRoleId": "abc123",
  "name": "xyz789",
  "code": "xyz789",
  "immutable": false
}
Types

UserRolePermission

Fields
Field Name Description
roleCode - String!
roleName - String!
objectCode - String!
objectName - String!
objectDescription - String!
fullAccess - Boolean!
Example
{
  "roleCode": "xyz789",
  "roleName": "abc123",
  "objectCode": "abc123",
  "objectName": "abc123",
  "objectDescription": "abc123",
  "fullAccess": true
}
Types

UserState

Fields
Field Name Description
date - DateTime
kycProviderLink - String
totalAmountEur - Float
transactionSummary - [UserTransactionSummary!]
vaults - [VaultAccountEx!]
fiatVaults - [FiatVault!]
externalWallets - [ExternalWallet!]
Arguments
skip - Int
first - Int
orderBy - [OrderBy!]
notifications - UserNotificationListResult
Arguments
unreadOnly - Boolean
skip - Int
first - Int
orderBy - [OrderBy!]
Example
{
  "date": "2007-12-03T10:15:30Z",
  "kycProviderLink": "abc123",
  "totalAmountEur": 987.65,
  "transactionSummary": [UserTransactionSummary],
  "vaults": [VaultAccountEx],
  "fiatVaults": [FiatVault],
  "externalWallets": [ExternalWallet],
  "notifications": UserNotificationListResult
}
Types

UserStateInput

Fields
Input Field Description
currencyTo - String
Example
{"currencyTo": "xyz789"}
Types

UserTransactionStats

Fields
Field Name Description
transactionCount - Int
amount - Float
amountEur - Float
amountFiat - Float
Example
{
  "transactionCount": 123,
  "amount": 123.45,
  "amountEur": 123.45,
  "amountFiat": 987.65
}
Types

UserTransactionStatus

Values
Enum Value Description

New

Processing

Confirming

Completed

Canceled

UnderReview

Declined

SendingError
Example
"New"
Types

UserTransactionSummary

Fields
Field Name Description
assetId - String
in - UserTransactionStats
out - UserTransactionStats
Example
{
  "assetId": "xyz789",
  "in": UserTransactionStats,
  "out": UserTransactionStats
}
Types

UserType

Values
Enum Value Description

Merchant

Personal
Example
"Merchant"
Types

UserVaultIdObj

Fields
Field Name Description
userVaultId - ID!
userId - String
custodyProvider - String
originalId - String
name - String
default - Boolean
created - DateTime
disabled - DateTime
subWallets - [String!]
additionalSettings - String
Example
{
  "userVaultId": 4,
  "userId": "abc123",
  "custodyProvider": "abc123",
  "originalId": "abc123",
  "name": "abc123",
  "default": true,
  "created": "2007-12-03T10:15:30Z",
  "disabled": "2007-12-03T10:15:30Z",
  "subWallets": ["xyz789"],
  "additionalSettings": "xyz789"
}
Types

VaultAccount

Fields
Field Name Description
id - ID
userId - String
name - String
custodyProviderLink - String
rawData - String
assets - [VaultAccountAsset!]
Example
{
  "id": 4,
  "userId": "abc123",
  "name": "xyz789",
  "custodyProviderLink": "xyz789",
  "rawData": "abc123",
  "assets": [VaultAccountAsset]
}
Types

VaultAccountAsset

Fields
Field Name Description
id - String
originalId - String
total - Float
available - Float
pending - Float
lockedAmount - Float
totalStakedCPU - String
totalStakedNetwork - String
selfStakedCPU - String
selfStakedNetwork - String
pendingRefundCPU - String
pendingRefundNetwork - String
addresses - [VaultAccountAssetAddress!]
Example
{
  "id": "abc123",
  "originalId": "xyz789",
  "total": 987.65,
  "available": 987.65,
  "pending": 987.65,
  "lockedAmount": 123.45,
  "totalStakedCPU": "xyz789",
  "totalStakedNetwork": "xyz789",
  "selfStakedCPU": "xyz789",
  "selfStakedNetwork": "abc123",
  "pendingRefundCPU": "abc123",
  "pendingRefundNetwork": "xyz789",
  "addresses": [VaultAccountAssetAddress]
}
Types

VaultAccountAssetAddress

Fields
Field Name Description
address - String
legacyAddress - String
description - String
type - String
addressFormat - String
Example
{
  "address": "xyz789",
  "legacyAddress": "xyz789",
  "description": "xyz789",
  "type": "xyz789",
  "addressFormat": "xyz789"
}
Types

VaultAccountEx

Fields
Field Name Description
id - String
userId - String
name - String
custodyProviderLink - String
default - Boolean
rawData - String
assets - [VaultAccountAsset!]
Arguments
skip - Int
first - Int
orderBy - [OrderBy!]
totalBalanceEur - Float
availableBalanceEur - Float
totalBalanceFiat - Float
availableBalanceFiat - Float
balancesPerAsset - [BalancePerAsset!]
Example
{
  "id": "xyz789",
  "userId": "xyz789",
  "name": "xyz789",
  "custodyProviderLink": "xyz789",
  "default": false,
  "rawData": "xyz789",
  "assets": [VaultAccountAsset],
  "totalBalanceEur": 987.65,
  "availableBalanceEur": 987.65,
  "totalBalanceFiat": 123.45,
  "availableBalanceFiat": 123.45,
  "balancesPerAsset": [BalancePerAsset]
}
Types

Void

Types

WalletAssetStatus

Values
Enum Value Description

WAITING_FOR_APPROVAL

APPROVED

CANCELLED

REJECTED

FAILED
Example
"WAITING_FOR_APPROVAL"
Types

Widget

Fields
Field Name Description
widgetId - ID!
code - String!
userId - String!
userCode - String
name - String!
description - String
created - DateTime!
createdBy - String
createdByUser - User
transactionTypes - [TransactionType!]
currenciesCrypto - [String!]
currenciesFiat - [String!]
destinationAddress - String
countriesCode2 - [String!]
instruments - [PaymentInstrument!]
paymentProviders - [String!]
liquidityProvider - LiquidityProvider
additionalSettings - String
currentUserEmail - String
currentUserParams - String
hasFixedAddress - Boolean!
secret - String
Example
{
  "widgetId": 4,
  "code": "xyz789",
  "userId": "abc123",
  "userCode": "abc123",
  "name": "xyz789",
  "description": "xyz789",
  "created": "2007-12-03T10:15:30Z",
  "createdBy": "abc123",
  "createdByUser": User,
  "transactionTypes": ["Buy"],
  "currenciesCrypto": ["xyz789"],
  "currenciesFiat": ["xyz789"],
  "destinationAddress": "abc123",
  "countriesCode2": ["abc123"],
  "instruments": ["CreditCard"],
  "paymentProviders": ["xyz789"],
  "liquidityProvider": "Bitstamp",
  "additionalSettings": "xyz789",
  "currentUserEmail": "xyz789",
  "currentUserParams": "abc123",
  "hasFixedAddress": false,
  "secret": "abc123"
}
Types

WidgetInput

Fields
Input Field Description
name - String!
description - String
transactionTypes - [TransactionType!]
currenciesCrypto - [String!]
currenciesFiat - [String!]
destinationAddress - String!
countriesCode2 - [String!]
instruments - [PaymentInstrument!]
paymentProviders - [String!]
liquidityProvider - LiquidityProvider
additionalSettings - String
secret - String
Example
{
  "name": "abc123",
  "description": "abc123",
  "transactionTypes": ["Buy"],
  "currenciesCrypto": ["xyz789"],
  "currenciesFiat": ["abc123"],
  "destinationAddress": "xyz789",
  "countriesCode2": ["xyz789"],
  "instruments": ["CreditCard"],
  "paymentProviders": ["xyz789"],
  "liquidityProvider": "Bitstamp",
  "additionalSettings": "abc123",
  "secret": "abc123"
}
Types

WidgetListResult

Fields
Field Name Description
count - Int
list - [Widget!]
Example
{"count": 987, "list": [Widget]}
Types

WidgetUpdateInput

Fields
Input Field Description
name - String!
userId - String!
description - String
transactionTypes - [TransactionType!]
currenciesCrypto - [String!]
currenciesFiat - [String!]
destinationAddress - String!
countriesCode2 - [String!]
instruments - [PaymentInstrument!]
paymentProviders - [String!]
liquidityProvider - LiquidityProvider
additionalSettings - String
secret - String
Example
{
  "name": "xyz789",
  "userId": "abc123",
  "description": "abc123",
  "transactionTypes": ["Buy"],
  "currenciesCrypto": ["abc123"],
  "currenciesFiat": ["abc123"],
  "destinationAddress": "xyz789",
  "countriesCode2": ["abc123"],
  "instruments": ["CreditCard"],
  "paymentProviders": ["abc123"],
  "liquidityProvider": "Bitstamp",
  "additionalSettings": "xyz789",
  "secret": "xyz789"
}
Types

WidgetUserParams

Fields
Field Name Description
widgetUserParamsId - ID
widgetId - String
userId - String
created - DateTime!
params - String
Example
{
  "widgetUserParamsId": "4",
  "widgetId": "xyz789",
  "userId": "xyz789",
  "created": "2007-12-03T10:15:30Z",
  "params": "abc123"
}
Types

WidgetUserParamsInput

Fields
Input Field Description
widgetId - String!
userEmail - String!
params - String
Example
{
  "widgetId": "xyz789",
  "userEmail": "xyz789",
  "params": "abc123"
}
Types

WireTransferBankAccount

Fields
Field Name Description
bankAccountId - ID!
name - String
description - String
created - DateTime!
createdBy - String
au - String
uk - String
eu - String
openpayd - Boolean
openpaydObject - String
deleted - DateTime
Example
{
  "bankAccountId": "4",
  "name": "xyz789",
  "description": "abc123",
  "created": "2007-12-03T10:15:30Z",
  "createdBy": "xyz789",
  "au": "xyz789",
  "uk": "xyz789",
  "eu": "xyz789",
  "openpayd": false,
  "openpaydObject": "xyz789",
  "deleted": "2007-12-03T10:15:30Z"
}
Types

WireTransferBankAccountInput

Fields
Input Field Description
name - String
description - String
au - String
uk - String
eu - String
openpayd - Boolean
deleted - DateTime
Example
{
  "name": "xyz789",
  "description": "xyz789",
  "au": "xyz789",
  "uk": "xyz789",
  "eu": "xyz789",
  "openpayd": false,
  "deleted": "2007-12-03T10:15:30Z"
}
Types

WireTransferBankAccountListResult

Fields
Field Name Description
count - Int
list - [WireTransferBankAccount!]
Example
{"count": 987, "list": [WireTransferBankAccount]}
Types

WireTransferBankAccountShort

Fields
Field Name Description
bankAccountId - ID!
name - String
description - String
au - String
uk - String
eu - String
openpaydObject - String
openpayd - Boolean
Example
{
  "bankAccountId": "4",
  "name": "xyz789",
  "description": "abc123",
  "au": "xyz789",
  "uk": "xyz789",
  "eu": "abc123",
  "openpaydObject": "xyz789",
  "openpayd": true
}
Types

liquidityProviderBalance

Fields
Field Name Description
currency - String
balance - Float
Example
{"currency": "abc123", "balance": 123.45}

Subscriptions

kycCompletedNotification

Response

Returns a Void

Example

Query
subscription kycCompletedNotification {
  kycCompletedNotification
}
Response
{"data": {"kycCompletedNotification": null}}
Subscriptions

kycServiceNotification

Response

Returns a Void

Example

Query
subscription kycServiceNotification {
  kycServiceNotification
}
Response
{"data": {"kycServiceNotification": null}}
Subscriptions

newNotification

Response

Returns a Void

Example

Query
subscription newNotification {
  newNotification
}
Response
{"data": {"newNotification": null}}
Subscriptions

transactionServiceNotification

Response

Returns a Void

Example

Query
subscription transactionServiceNotification {
  transactionServiceNotification
}
Response
{"data": {"transactionServiceNotification": null}}
Documentation by Anvil SpectaQL