Skip to main content

Objects

ActionStatusType

Fields

NameDescription

enabled
Boolean

infoText
String

AdminUserLoginResponse

Fields

NameDescription

isAuthSuccessful
Boolean

isTfaEnabled
Boolean

refreshToken
String

tempToken
String

user
AdminUserType

AdminUserType

Fields

NameDescription

id
ID!

Id of the UserProfile

firstName
String

middleName
String

lastName
String

email
String

phone
String

authToken
String

isActive
Boolean!

userName
String!

title
ManagerTitle

addressLine1
String

city
String

territory
String

zip
String

name
String

language
LanguageType

User's current language

country
CountryType

roles
[AdminKindEnumType]

permissions
[InterfacePermissions]

assignedToCountryIds
[ID]

assignedNetworkIds
[ID]

assignedServiceIds
[ID]

assignedLocationIds
[ID]

accessLevel
[AssignableRoleNames]

deleted
Boolean

authenticationMutations

Fields

NameDescription

passwordAuth
LoginResponseUnion

Login user on the system.

Arguments

NameDescription

username
String!

password
String!

deviceId
String

appVersion
String

Provide app version to be able to track if user tries to login with an obsolete app version.

codeAuth
LoginResponseUnion

Login user on the system.

Arguments

NameDescription

username
String!

code
String!

deviceId
String

appVersion
String

Provide app version to be able to track if user tries to login with an obsolete app version.

refresh
LoginResponseUnion

Login user on the system.

Arguments

NameDescription

refreshToken
String

deviceId
String!

appVersion
String

Provide app version to be able to track if user tries to login with an obsolete app version.

setupTwoFactorKey
TfaSetup

Arguments

NameDescription

username
String!

requestAuthenticatorReset
Boolean

Arguments

NameDescription

username
String!

resetAuthenticator
TfaSetup

Arguments

NameDescription

username
String!

verificationCode
String!

sendCode
Boolean

Arguments

NameDescription

username
String!

authenticationQueries

Fields

NameDescription

tfaSetup
TfaSetup

Arguments

NameDescription

id
ID!

isTwoFactorKeyConfigured
Boolean

Arguments

NameDescription

username
String!

CalcResultType

Fields

NameDescription

sendAmount
Decimal

fee
Decimal

totalToPay
Decimal

recipientReceives
Decimal

quote
Decimal

quoteId
ID

expectedPayoutTime
DateTime

CalculatorDefaultType

Fields

NameDescription

fromCountryId
ID

toCountryId
ID

paymentServiceId
ID

paymentNetworkId
ID

sendingAmount
Decimal

receivingAmount
Decimal

CorridorGroupType

Fields

NameDescription

from
CountryType

toCountries
[CountryServicesType]

CorridorLimits

Fields

NameDescription

paymentNetwork
PaymentNetworkType

currency
String

locations
[Location]

CountryServicesType

Fields

NameDescription

country
CountryType

paymentServices
[ServiceNetworkType]

CountryType

Fields

NameDescription

id
ID!

isoCode2
String!

isoCode3
String

name
String!

isActive
Boolean!

isSender
Boolean!

isRecipient
Boolean!

phonePrefix
Int!

maxAmount
Decimal!

currency
String

region
RegionType

isReceiver
Boolean

Replaced with isRecipient

CustomPropertyType

Fields

NameDescription

id
ID!

key
String!

value
String

tag
String

DeleteAccountResponseType

Fields

NameDescription

id
ID!

status
ResponseStatus

infoMessage
String

steps
[DeleteAccountStepType]

canAbandon
Boolean

DeleteAccountStepType

Fields

NameDescription

title
String

infoMessage
String

description
String

statusMessage
String

executed
DateTime

resolved
DateTime

status
DeleteAccountStepStatus

DocumentCategoryType

Fields

NameDescription

id
ID!

code
String!

name
String!

DocumentType

Fields

NameDescription

id
ID!

documentExp
CustomDateGraphType

documentNumber
String

documentIssuer
String

documentNote
String

documentSource
String

documentState
String

description
String

created
CustomDateGraphType

isPrimary
Boolean

cardNumber
String

createdByName
String

category
DocumentCategoryType

files
[FileType]

EndUserLoginResponse

Fields

NameDescription

isAuthSuccessful
Boolean

isTfaEnabled
Boolean

refreshToken
String

tempToken
String

user
EndUserType

EndUserType

Fields

NameDescription

id
ID!

firstName
String

lastName
String

middleName
String

userRef
String

deleted
Boolean

userName
String!

email
String

phone
String

authToken
String

city
String

socialNumberType
String

socialNumber
String

type
String

addressLine1
String

addressLine2
String

isPEP
Boolean

zip
String

territory
String

unitNumber
String

streetNumber
String

streetType
String

birthDate
CustomDateGraphType

created
DateTime

nationalityCountryId
ID

countryOfBirthId
ID

emailVerified
Boolean!

phoneVerified
Boolean!

moneySent
Decimal

moneyReceived
Decimal

language
LanguageType

User's current language

country
CountryType

transactionsCount
Int

recipientsCount
Int

roles
[AdminKindEnumType]

permissions
[InterfacePermissions]

Arguments

NameDescription

action
String

filesCount
Int

authMethod
AuthMethod

customProperties
[CustomPropertyType]

unseenMessagesCount
Int

userStatusInfo
UserStatusInfoType

phoneVerificationEnabled
Boolean

emailVerificationEnabled
Boolean

profileImageThumbnailId
String

profileImageMediumId
String

profileImageId
String

FieldConfigType

Fields

NameDescription

name
String!

Used to define the name of an input field within a form. This attribute is crucial when submitting the form data to the backend server. The name attribute is paired with the value attribute to create key-value pairs, where the name represents the variable name, and the value is the data entered by the user.

type
String

text | numbers | password | address-autocomplete | email | select | date | multiselect | checkbox | radio | file-upload | relationship-select | country-select

  • relationship-select shows a list of relationships from the relationships query;
  • country-select should always show the sender countries, except on the recipient where it should show recipient countries;

description
String

Specifies the descriptive text associated with an input element.

label
String

Specifies the descriptive text associated with an input element

value
String

  • type:any: Specifies default value for the field.
  • type:file-upload: value must be file.id.
  • type:relationship-select: value must be relationship.id.

required
Boolean

Specifies whether the field is required or optional.

visible
Boolean

Specifies whether the field is visible or not.

max
Int

  • type:numbers: Specifies the maximum allowable numerical value.
  • type:date: Specifies the maximum number of years e.g. 10 for document expiry date would be currentDate + 10.

min
Int

  • type:numbers: Specifies the minimum allowable numerical value.
  • type:date: Specifies the minimum number of years e.g. 18 for registration would be currentDate - 18.

maxLength
Int

  • type:text: Specifies the max length of the value.

minLength
Int

  • type:text: Specifies the min length of the value.

pattern
String

  • type:any: Specifies the regex validation for the value.
  • type:file-upload: List of allowed file types (.jpg,.jpeg,.gif)

orderNumber
Int

Defines order of element in the form rendering.

section
String

Utilized for visually organizing fields, a section can be employed to represent multiple fields with the same value. In cases where several fields share a common attribute within a section, the initial occurrence of the section can serve as the title. For instance, in a recipients form, a section might be applied to distinguish a basic set of fields from the bank information.

editable
Boolean!

Specifies whether the field is editable or read-only.

values
[LabelValueType]

List of predefined values that user can select.

  • type:select
  • type:multiselect
  • type:radio.

properties
[PropertyType]

FieldsConfigType

Fields

NameDescription

country
String

countryIsoCode2

fields
[FieldConfigType]

FieldSetType

Fields

NameDescription

name
String!

description
String

label
String

group
String

groupPolicy
String

  • AllRequired - all sections in the group must be filled and valid.
  • OneRequired - one section from the group must be filled and valid.
  • NoneRequired - all sections in the group are optional.

fields
[FieldConfigType]

FileType

Fields

NameDescription

id
ID!

name
String!

size
Int!

contentType
String

description
String

created
CustomDateGraphType

document
DocumentType

FlagType

Fields

NameDescription

id
ID!

name
String!

code
FlagCode!

presentedCode
String!

presentedColor
String!

isWarning
Boolean!

isBlocking
Boolean

level
FlagLevel

FrontendConfigurationType

Fields

NameDescription

id
ID

inputDateFormat
String

mobileInputDateFormat
String

dateFormatShort
String

dateFormatLong
String

mobileDateOnlyFormatMedium
String

mobileDateTimeFormatMedium
String

calculatorDefault
CalculatorDefaultType

inbounds
[InboundServiceType]

Arguments

NameDescription

pageRequest
PageRequestInboundsFilterType

authMethod
String

forceEmailVerification
Boolean

endUserTwoFactorProvider
String

managementTwoFactorProvider
String

isTwoFactorAuthEnabled
Boolean

Deprecated: Use value of endUserTwoFactorProvider, if null, two factor is disabled

twoFactorAuthenticationProvider
String

Deprecated: Use endUserTwoFactorProvider instead

protectedActions
[String]

InboundAccountType

Fields

NameDescription

inboundCode
String

inboundName
String

accountType
InboundAccountEnumType

id
String

routingNumber
String

lastFourNumbers
String

accountSubType
InboundAccountSubEnumType

holderName
String

fingerprint
String

status
InboundAccountStatusEnumType

name
String

accountNumber
String

maxAmount
Decimal

expiryDate
DateTime

bsb
String

payID
String

payIDType
String

description
String

InboundAuthTokenType

Fields

NameDescription

accessToken
String

refreshToken
String

tokenType
String

scope
String

expiresIn
Int

userAccountId
String

redirectUrl
String

isSandbox
Boolean

isKYCMissing
Boolean

InboundPaymentMethodType

Fields

NameDescription

id
String!

paymentMethodType
String!

account
InboundAccountType!

InboundResponseType

Fields

NameDescription

inbound
String

errorMessage
String

errorCode
String

navigateURL
String

inboundRefNo
String

success
Boolean

newTab
Boolean

inboundName
String

inboundType
String

InboundServiceType

Fields

NameDescription

displayName
String!

code
String!

isDefault
Boolean!

paymentMethods
[InboundPaymentMethodType]

paymentMethodRequired
Boolean!

Defines if end user has to add new payment method for this inbound service.

maxAmount
Decimal

displayType
String

Defines any special rules on how to render UI, e.g. how PaymentMethods should be displayed.

KYCVerificationType

Fields

NameDescription

fields
[FieldSetType]

Fields for KYC form. If value is empty, form should not be displayed.

status
Int

Status of KYC verification request

outcome
Int

Outcome of KYC verification request

subtitle
String

Additional information for title

title
String

Title to display on KYC screen

description
String

Additional information about KYC process

redirectURL
String

If value is not empty, user should be redirected to the URL to complete KYC

errorMessage
String

Additional information in case of an error

LabelValueType

Fields

NameDescription

label
String

value
String

LanguageType

Fields

NameDescription

id
Int!

isoCode2
String!

isoCode3
String

name
String!

isDefault
Boolean!

Location

Fields

NameDescription

id
ID!

internalId
ID

name
String!

code
String

phone
String

city
String

addressLine1
String

addressLine2
String

zip
String

isActive
Boolean

countryId
ID

paymentServiceId
ID

paymentNetworkId
ID

country
CountryType

paymentService
PaymentServiceType

paymentNetwork
PaymentNetworkType

payoutAgents
[UserInfoType]

payoutAgentIds
[ID]

MessageType

Fields

NameDescription

id
ID!

text
String

subject
String

seen
DateTime

file
FileType

sender
UserInfoType

receiver
UserInfoType

created
DateTime!

messagingMutations

Fields

NameDescription

sendMessage
MessageType

Arguments

NameDescription

data
MessageInputType!

markMessagesSeen
Boolean

Arguments

NameDescription

transactionId
ID

ticketId
ID

messagingQueries

Fields

NameDescription

id
ID

messages
[MessageType]

Arguments

NameDescription

ticketId
ID

Mutations

Fields

NameDescription

user
userMutations

messaging
messagingMutations

authentication
authenticationMutations

NotificationPayloadType

Fields

NameDescription

transactionId
String

ticketId
String

NotificationType

Fields

NameDescription

id
ID

action
String

type
String

title
String

description
String

seen
CustomDateGraphType

payload
NotificationPayloadType

created
DateTime

OnboardingStepType

Fields

NameDescription

id
ID!

active
Boolean!

action
String!

title
String!

description
String!

actionLabel
String!

OnboardingType

Fields

NameDescription

id
ID!

visible
Boolean!

steps
[OnboardingStepType]

PaginatorDocumentType

Fields

NameDescription

totalCount
Int

data
[DocumentType]

PaginatorFileType

Fields

NameDescription

totalCount
Int

data
[FileType]

PaginatorInboundAccountType

Fields

NameDescription

totalCount
Int

data
[InboundAccountType]

PaginatorNotificationType

Fields

NameDescription

totalCount
Int

data
[NotificationType]

PaginatorRaisedFlagType

Fields

NameDescription

totalCount
Int

data
[RaisedFlagType]

PaginatorRecipientType

Fields

NameDescription

totalCount
Int

data
[Recipient]

PaginatorTicketType

Fields

NameDescription

totalCount
Int

data
[TicketType]

PaginatorTransactionHType

Fields

NameDescription

totalCount
Int

data
[TransactionChange]

PaginatorTransactionType

Fields

NameDescription

totalCount
Int

data
[Transaction]

PaymentNetworkType

Fields

NameDescription

id
ID!

name
String!

code
String!

extendedName
String

PaymentServiceType

Fields

NameDescription

id
ID!

name
String!

code
String!

PropertyType

Fields

NameDescription

key
String

type
String

value
String

description
String

publicQueries

Only public queries do not require authentication.

Fields

NameDescription

id
ID

countries
[CountryType]

List of countries available on the system. Depending on the arguments, could be used on registration or edit end user profile (isSender: true), on recipient management (isRecipient: true).

Arguments

NameDescription

isSender
Boolean

  • true - sending countries only;
  • false - not sending countries only;
  • null - all countries;

isRecipient
Boolean

  • true - recipient countries only;
  • false - not recipient countries only;
  • null - all countries;

isActive
Boolean

  • true - active countries only;
  • false - inactive countries only;
  • null - all countries;

states
[StateType]

List of states in specified country.

Arguments

NameDescription

countryIsoCode2
String

translations
[TranslationType]

List of translations defined on the system.

Arguments

NameDescription

langId
Int

isoCode2
String

corridorsGroups
[CorridorGroupType]

List of active corridor groups to be used on the calculator.

Arguments

NameDescription

countryFrom
String

countryTo
String

countryFromId
ID

countryToId
ID

calculateAmount
CalcResultType

Calculate fees and get details related for the future transaction.

Arguments

NameDescription

countryFromId
ID!

countryToId
ID!

sendAmount
Float

receiveAmount
Float

serviceId
ID!

networkId
ID!

locationId
ID

fieldsConfig
[FieldsConfigType]

Retrieve fields configuration to create dynamic forms.

Arguments

NameDescription

countryCode
String

ISO Code 2

fieldsGroup
String!

Use following values to retrieve specific configuration:

  • user for registration
  • updateUser for end user profile editing
  • recipient for add/edit recipient
  • Questionnaire for questionnaire definition

purposes
[PurposeType]

List of purposes on the system. Purpose.ID should be used on createTransaction mutation.

relationships
[RelationshipType]

List of relationships on the system. Relationship.ID should be used on addRecipient and updateRecipient, mutation.

Arguments

NameDescription

active
Boolean

addressLookup
String

Suggests valid addresses based on provided input.

Arguments

NameDescription

query
String

type
String

frontendConfiguration
FrontendConfigurationType

Retrieve default settings for the frontend application.

PurposeType

Fields

NameDescription

id
ID!

isActive
Boolean!

name
String!

code
String

Queries

Fields

NameDescription

messaging
messagingQueries

user
userQueries

public
publicQueries

authentication
authenticationQueries

RaisedFlagType

Fields

NameDescription

id
ID!

description
String

created
DateTime!

resolved
DateTime

If not set current raised flag is not resolved yet.

ticket
TicketType

flag
FlagType

transaction
Transaction

user
UserInfoType

resolvedBy
UserInfoType

resolvedNote
String

createdByName
String

userRef
String

level
FlagLevel

forUserId
ID

Recipient

Money recipient

Fields

NameDescription

id
ID!

created
DateTime!

firstName
String

middleName
String

lastName
String

dateOfBirth
CustomDateGraphType

email
String

addressLine1
String

addressLine2
String

city
String

bankName
String

bankAccNumber
String

iban
String

bankAccountType
String

routingNumber
String

zip
String

provinceState
String

phone
String!

country
CountryType!

name
String

sendingCurrency
String

moneySent
Decimal

relationship
RelationshipType

phoneCode
String

documentType
String

documentNumber
String

documentExpiration
CustomDateGraphType

verificationStatus
RecipientKycStatus

RegionType

Fields

NameDescription

id
ID!

isActive
Boolean!

maxAmount
Decimal!

name
String!

code
String!

RelationshipType

Fields

NameDescription

id
ID!

isActive
Boolean!

name
String!

ServiceNetworkType

Fields

NameDescription

paymentService
PaymentServiceType

networks
[CorridorLimits]

StateType

Fields

NameDescription

id
String

name
String

countryIsoCode2
String

TfaSetup

Fields

NameDescription

authenticatorKey
String

formattedKey
String

TicketType

Fields

NameDescription

id
ID!

created
DateTime!

subject
String

description
String

internalNote
String

number
Int!

status
TicketStatus

raisedFlag
RaisedFlagType

createdByName
String

files
[FileType]

messages
[MessageType]

unseenMessagesCount
Int

Transaction

Fields

NameDescription

id
ID!

created
DateTime!

transactionId
String!

type
Int

DEPOSIT = 1, WITHDRAWAL = 2, P2P = 3, REMITTANCE = 4

paidAmount
Decimal!

amount
Decimal!

currency
String!

quote
Decimal!

fixedFee
Float!

variableFee
Float!

fixedFeePaid
Decimal!

variableFeePaid
Decimal!

receivingAmount
Decimal!

receivingCurrency
String!

inboundName
String

inbound
String

inboundRefNo
String

inboundStatus
String

isRefundInitiated
Boolean

refundStatus
String

pickupCode
String

expectedPayoutTime
DateTime

recipientName
String

recipientFirstName
String

recipientLastName
String

recipientMiddleName
String

recipientDateOfBirth
Date

recipientPhone
String

recipientFullPhone
String

recipientBankAccount
String

recipientEmail
String

recipientAddress1
String

recipientAddress2
String

recipientCountry
String

recipientCity
String

recipientId
ID

userId
ID

userFirstName
String

userLastName
String

userMiddleName
String

userSocialNumber
String

userEmail
String

userPhone
String

userCity
String

userAddressLine1
String

userAddressLine2
String

userBirthDate
DateTime

userZip
String

userUnitNumber
String

userTerritory
String

userCountry
String

userUserName
String

fromId
ID!

fromName
String

fromIsoCode2
String

fromIsoCode3
String

toId
ID!

toName
String

toIsoCode2
String

toIsoCode3
String

paymentServiceId
ID

paymentServiceCode
String

paymentServiceName
String

paymentNetworkId
ID

paymentNetworkName
String

paymentNetworkCode
String

paymentMethodName
String

paymentMethodNumber
String

status
TransactionStatusType

purposeId
ID

purposeName
String

relationshipId
ID

relationshipName
String

receipt
FileType

raisedFlags
[RaisedFlagType]

If resolved not set all (resolved and not resolved) raised flags will be returned. If level is not set, raised flags for transaction and transaction's sender will be returned. blocking is set to return only blocking flags by default.

Arguments

NameDescription

level
FlagLevel

resolved
Boolean

blocking
FlagBlockingFilter

Defines if all flags will be included in the response, or only blocking flags. Only blocking flags are returned by default.

transactionStatusInfo
TransactionStatusInfoType

confirmedAmount
Decimal

locationInfo
String

locationName
String

locationAddressLine1
String

locationAddressLine2
String

locationCity
String

locationZip
String

locationPhone
String

tags
[String]

paymentInstructions
String

continue
ActionStatusType

Deprecated: Replaced with canContinue.

canContinue
ActionStatusType

canCancel
ActionStatusType

pendingAction
Int

Pending action for transaction. 0 - no action, 1 - accept, 2 - confirm, 3 - cancel, 4 - reject

TransactionChange

Transaction status change.

Fields

NameDescription

id
ID!

The unique identifier of the transaction change.

created
DateTime!

note
String!

createdByName
String

transactionStatus
TransactionStatusType

transaction
Transaction

TransactionStatusInfoType

Fields

NameDescription

statusId
Int

name
String

icon
String

note
String

isWarning
Boolean

isInfo
Boolean

flagCount
Int

flagTooltip
String

ticketCount
Int

ticketTooltip
String

TransactionStatusType

Fields

NameDescription

id
ID!

name
String!

TranslationType

Fields

NameDescription

id
Int!

key
String!

value
String!

language
LanguageType

tags
[String]

UserInfoType

Fields

NameDescription

id
ID!

firstName
String

lastName
String

middleName
String

userRef
String

deleted
Boolean

userMutations

Fields

NameDescription

register
EndUserType

Register user on the system. Use the public.fieldsConfig query to retrieve fields needed for registration.

Arguments

NameDescription

data
EndUserRegisterType!

login
EndUserType

Login user on the system.

Arguments

NameDescription

username
String!

password
String!

appVersion
String

Provide app version to be able to track if user tries to login with an obsolete app version.

requestResetPassword
Boolean

Send a reset password request for a user.

Arguments

NameDescription

username
String!

resetPassword
Boolean

Complete reset password flow for a user.

Arguments

NameDescription

username
String!

code
String!

newPassword
String!

verify
EndUserType

Verify communication channels that the user provided.

Arguments

NameDescription

code
String!

type
String

EMAIL | PHONE

resendVerificationCode
Boolean

Resend verification codes to communication channel that the user provided.

Arguments

NameDescription

type
String

EMAIL | PHONE

markNotificationsSeen
Boolean

You can mark notifications seen by a list of ID's or all at once.

Arguments

NameDescription

ids
[ID]

all
Boolean

setPushToken
Boolean

Use to set push token provided by an iOS or Android device using Firebase. You can refer to the Firebase documentation for step-by-step instructions on how to set up push notifications on your app for both iOS and Android.

Arguments

NameDescription

pushToken
String

changePassword
Boolean

Change password for a user.

Arguments

NameDescription

oldPassword
String!

newPassword
String!

generateInboundToken
InboundAuthTokenType

Generate inbound token to initialise inbound widget.

Arguments

NameDescription

inbound
String!

MOOV

removeInboundAccount
Boolean

Use to remove the inbound account from the list of inbound accounts.

Arguments

NameDescription

id
String!

accountType
InboundAccountEnumType!

inbound
String!

addProperties
[CustomPropertyType]

Add a new property to the custom properties.

Arguments

NameDescription

properties
[CustomPropertyInputType]

flagCode
FlagCode

updateProfile
EndUserType

Update the user's profile. Use the public.fieldsConfig query to retrieve fields needed for updating a profile.

Arguments

NameDescription

data
EndUserProfileType!

createRecipient
Recipient

Use the public.fieldsConfig query to retrieve fields needed for recipient creation.

Arguments

NameDescription

data
RecipientInputType!

updateRecipient
Recipient

Use the public.fieldsConfig query to retrieve fields needed for recipient update.

Arguments

NameDescription

data
RecipientInputType!

deleteRecipient
Boolean

Remove the recipient from the list. Recipients can be deleted only if there are no related transactions.

Arguments

NameDescription

id
ID!

createTransaction
Transaction

To be able to create the transaction provide necessary arguments.

  • Please note that you should send only sendAmount or receiveAmount.
  • The serviceId, networkId, and locationId should be provided from the public.corridorsGroups query.
  • The quoteId should be used from the calculate public.calculateAmount query.

Arguments

NameDescription

countryFromId
ID!

countryToId
ID!

sendAmount
Float

receiveAmount
Float

serviceId
ID!

networkId
ID!

recipientId
ID!

purposeId
ID

quoteId
ID

locationId
ID

initiateTransaction
Transaction

Arguments

NameDescription

data
TransactionInputType!

twoFactorCode
String

confirmTransaction
Transaction

Arguments

NameDescription

id
ID!

confirm
Boolean

initiatePayment
InboundResponseType

Once the transaction is created you should initiate payment with the selected inbound. The list of available inbounds for a transaction can be obtained by running userQueries.inbounds with transaction.id argument.

Arguments

NameDescription

transactionId
ID!

inbound
String

paymentMethodId
String

currentUrl
String

twoFactorCode
String

cancelTransaction
Transaction

Is used to cancel a transaction. To be sure that the transaction can be canceled check canCancel property in the transaction.

Arguments

NameDescription

transactionId
ID!

kycVerify
Boolean

Used to verify data provided in the KYC form. Form definition can be obtained from the userQueries.kycFieldsConfig query. Data will be rejected even before checking with the KYC provider if there is no active raised flag with presentedCode:KYC_MISSING.

Arguments

NameDescription

data
VerifyDataInputType!

resendEmail
Boolean

Resend email related to specific action.

Arguments

NameDescription

id
ID!

emailType
EmailTemplateEnumType!

  • PAYMENT_INSTRUCTIONS to resend payment instructions to the user only if inbound is MANUAL. The id should be transaction.id.

addConsent
String

Use it to track contents from the user during the following mutations: register, initiateTransaction, and verify. Consents should be recorded if a user has ConsentCreate permission.

As permissions are available only after a user is logged in, after register mutation, use user.login mutation, and after login, if permissions exist, add consent for registration.

Arguments

NameDescription

consentType
Int!

REGISTER: 1, TRANSACTION: 2, KYC: 3

metadata
String

addPaymentMethod
InboundAccountType

Use it to add a new payment method to user's payment methods.

Arguments

NameDescription

paymentMethod
PaymentMethodInputType!

changePaymentMethodStatus
Boolean

Use it to change a payment method status.

Arguments

NameDescription

paymentMethodId
String!

newStatus
String!

inboundCode
String!

updatePaymentMethod
InboundAccountType

Use it to update a payment method details.

Arguments

NameDescription

paymentMethod
PaymentMethodInputType!

deleteAccount
DeleteAccountResponseType

Use it to initiate account deletion process.

confirmIdentity
EndUserType

Login user before account deletion to confirm it's identity.

Arguments

NameDescription

username
String!

password
String!

action
AccountAction!

Case in which user needs to confirm it's identity.

appVersion
String

Provide app version to be able to track if user tries to login with an obsolete app version.

requestKYCVerification
KYCVerificationType

Initiates KYC process for current user. If KYC process is in progress, returns status of current KYC process.

submitKYCData
KYCVerificationType

Submit data from KYC form

Arguments

NameDescription

data
VerifyDataInputType!

requestOTPCode
Boolean

Arguments

NameDescription

action
ProtectedActions!

deleteProfilePicture
Boolean

userQueries

All data related to the currently logged user.

Fields

NameDescription

id
ID

onboarding
OnboardingType

Get list of onboarding steps and their status.

Arguments

NameDescription

type
String

Allowed values: circles

kycFieldsConfig
[FieldSetType]

Retrieve fields configuration to create KYC dynamic forms.

Arguments

NameDescription

countryIsoCode2
String

endUser
EndUserType

Currently logged in user details.

inbounds
[InboundServiceType]

Get available inbounds list for a specific transaction.

Arguments

NameDescription

transactionId
ID

transactionType
Int

inboundAccounts
PaginatorInboundAccountType

Get list of the inbound accounts.

Arguments

NameDescription

pageRequest
PageRequestType

customProperties
[CustomPropertyType]

Get data for logged user.

Arguments

NameDescription

tag
String

  • QUESTIONNAIRE: to get questionnaire data;

documents
PaginatorDocumentType

List of documents (e.g. passport, driver's license...) for the user.

Arguments

NameDescription

pageRequest
PageRequestType

ticket
TicketType

Get one ticket.

Arguments

NameDescription

id
ID!

tickets
PaginatorTicketType

List of tickets for the user.

Arguments

NameDescription

pageRequest
PageRequestTicketsFilterType

transaction
Transaction

Get one transaction.

Arguments

NameDescription

id
ID!

transactions
PaginatorTransactionType

List of transactions for the user.

Arguments

NameDescription

pageRequest
PageRequestTransactionsFilterType

transactionHistory
PaginatorTransactionHType

Transaction history list for specific transaction.

Arguments

NameDescription

pageRequest
PageRequestTransactionHistoryFilterType

recipient
Recipient

Get one recipient.

Arguments

NameDescription

id
ID!

recipients
PaginatorRecipientType

List of recipients for the user.

Arguments

NameDescription

pageRequest
PageRequestRecipientsFilterType

raisedFlags
PaginatorRaisedFlagType

resolved: null all raised flags will be returned (resolved and not resolved).

If userId is set, but:

  • level: null - user's raised flags and user's transaction raised flags will be returned,
  • level: User - just user's flags will be returned,
  • level: Transaction - just flags from all user's transactions will be returned.

If transactionId is set, but:

  • level: null - transaction's flags and sender's flags will be returned,
  • level: User - sender's flags will be returned,
  • level: Transaction - just flags for transaction will be returned,
  • blocking - if null, all flags will be returned.

Arguments

NameDescription

pageRequest
PageRequestRaisedFlagsFilterType

files
PaginatorFileType

List of files for the user.

Arguments

NameDescription

pageRequest
PageRequestFilesFilterType

notifications
PaginatorNotificationType

List of notifications for the user.

Arguments

NameDescription

pageRequest
PageRequestNotificationsFilterType

notification
NotificationType

Get one notification for the user.

Arguments

NameDescription

id
ID!

inboundAccount
InboundAccountType

Get one inbound account for the user.

Arguments

NameDescription

accountId
String

inboundCode
String

syncTransactionStatus
Transaction

Sync transaction status on selected provider(inbound, outbound).

Arguments

NameDescription

id
ID!

type
String

providerCode
String

tfaSetup
TfaSetup

Arguments

NameDescription

id
ID!

wallet
WalletType

recipientInfo
UserInfoType

Arguments

NameDescription

contactData
String

UserStatusInfoType

Fields

NameDescription

userId
ID

flagCount
Int

flagTooltip
String

ticketCount
Int

ticketTooltip
String

unresolvedFlagsCount
Int

WalletType

Fields

NameDescription

name
String

currency
String

balance
Decimal

available
Decimal