Objects

ActionStatusType

Fields

Name	Description
enabled Boolean
infoText String

CalcResultType

Fields

Name	Description
expectedPayoutTime DateTime
fee Decimal
quote Decimal
quoteId ID
recipientReceives Decimal
sendAmount Decimal
totalToPay Decimal

CalculatorDefaultType

Fields

Name	Description
fromCountryId ID!
paymentNetworkId ID
paymentServiceId ID!
receivingAmount Decimal
sendingAmount Decimal
toCountryId ID!

CorridorGroupType

Fields

Name	Description
from CountryType
toCountries [CountryServicesType]

CorridorLimits

Fields

Name	Description
currency String
fixedFee Float	Deprecated: Not applicable for public queries.
locations [Location]
maxAmount Float	Deprecated: Not applicable for public queries.
minAmount Float	Deprecated: Not applicable for public queries.
paymentNetwork PaymentNetworkType
variableFee Float	Deprecated: Not applicable for public queries.

CountryServicesType

Fields

Name	Description
country CountryType
paymentServices [ServiceNetworkType]

CountryType

Fields

Name	Description
currency String
id ID
isActive Boolean
isoCode2 String
isoCode3 String
isReceiver Boolean	Replaced with isRecipient
isRecipient Boolean
isSender Boolean
maxAmount Decimal
name String
phonePrefix Int
region RegionType

CustomPropertyType

Fields

Name	Description
id ID
key String
tag String
value String

DocumentCategoryType

Fields

Name	Description
code String
id ID
name String

DocumentType

Fields

Name	Description
cardNumber String
category DocumentCategoryType
created CustomDateGraphType
description String
documentExp CustomDateGraphType
documentIssuer String
documentNote String
documentNumber String
documentSource String
documentState String
files [FileType]
id ID
isPrimary Boolean

EndUserType

Fields

Name	Description
addressLine1 String
addressLine2 String
authMethod AuthMethod
authToken String
birthDate CustomDateGraphType
city String
country CountryType
countryOfBirthId ID
created DateTime
customProperties [CustomPropertyType]
email String
emailVerified Boolean
filesCount Int
firstName String
id ID
isPEP Boolean
language LanguageType	User's current language
lastName String
middleName String
moneyReceived Decimal
moneySent Decimal
nationalityCountryId ID
permissions [InterfacePermissions]
phone String
phoneVerificationEnabled Boolean
phoneVerified Boolean
recipientsCount Int
roles [AdminKindEnumType]
socialNumber String
socialNumberType String
streetNumber String
streetType String
territory String
transactionsCount Int
type String
unitNumber String
unseenMessagesCount Int
userName String
userRef String
userStatusInfo UserStatusInfoType
zip String

FieldConfigType

Fields

Name	Description
description String	Specifies the descriptive text associated with an input element.
editable Boolean	Specifies whether the field is editable or read-only.
label String	Specifies the descriptive text associated with an input element
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.
maxLength Int	type:text: Specifies the max length of the value.
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.
minLength Int	type:text: Specifies the min length of the value.
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.
orderNumber Int	Defines order of element in the form rendering.
pattern String	type:any: Specifies the regex validation for the value. type:file-upload: List of allowed file types (.jpg,.jpeg,.gif)
properties [FieldPropertyType]
required Boolean	Specifies whether the field is required or optional.
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.
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;
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.
values [LabelValueType]	List of predefined values that user can select. type:select type:multiselect type:radio.
visible Boolean	Specifies whether the field is visible or not.

FieldPropertyType

Fields

Name	Description
type String
value String

FieldsConfigType

Fields

Name	Description
country String	countryIsoCode2
fields [FieldConfigType]

FieldSetType

Fields

Name	Description
description String
fields [FieldConfigType]
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.
label String
name String!

FileType

Fields

Name	Description
blobName String	Deprecated: Legacy code.
contentType String
created CustomDateGraphType
description String
document DocumentType
id ID
name String
size Int

FlagType

Fields

Name	Description
code FlagCode
id ID
isWarning Boolean
level FlagLevel
name String
presentedCode String
presentedColor String

FrontendConfigurationType

Fields

Name	Description
calculatorDefault CalculatorDefaultType
dateFormatLong String
dateFormatShort String
id ID
inbounds [InboundServiceType]	Arguments Name Description pageRequest PageRequestInboundsFilterType
inputDateFormat String
mobileDateOnlyFormatMedium String
mobileDateTimeFormatMedium String
mobileInputDateFormat String

InboundAccountType

Fields

Name	Description
accountNumber String
accountSubType InboundAccountSubType
accountType InboundAccountEnumType
bsb String
description String
expiryDate DateTime
fingerprint String
holderName String
id String
inboundCode String
inboundName String
lastFourNumbers String
maxAmount Decimal
name String
payID String
payIDType String
routingNumber String
status InboundAccountStatus

InboundAuthTokenType

Fields

Name	Description
accessToken String
expiresIn Int
isKYCMissing Boolean
isSandbox Boolean
redirectUrl String
refreshToken String
scope String
tokenType String
userAccountId String

InboundPaymentMethodType

Fields

Name	Description
account InboundAccountType
id String
paymentMethodType String

InboundResponseType

Fields

Name	Description
errorCode String
errorMessage String
inbound String
inboundName String
inboundRefNo String
navigateURL String
newTab Boolean
success Boolean

InboundServiceType

Fields

Name	Description
addNew Boolean
code String
displayName String
isDefault Boolean
maxAmount Decimal
paymentMethods [InboundPaymentMethodType]

LabelValueType

Fields

Name	Description
label String
value String

LanguageType

Fields

Name	Description
id Int!
isDefault Boolean!
isoCode2 String!
isoCode3 String
name String!

Location

Fields

Name	Description
city String
code String
id ID
name String
phone String

MessageType

Fields

Name	Description
created DateTime
file FileType
id ID
receiver UserInfoType
seen DateTime
sender UserInfoType
subject String
text String!

messagingMutations

Fields

Name	Description
markMessagesSeen Boolean	Arguments Name Description transactionId ID ticketId ID
sendMessage MessageType	Arguments Name Description data MessageInputType!

messagingQueries

Fields

Name	Description
id ID
messages [MessageType]	Arguments Name Description ticketId ID

Mutations

Fields

Name	Description
messaging messagingMutations
user userMutations

NotificationPayloadType

Fields

Name	Description
ticketId String
transactionId String

NotificationType

Fields

Name	Description
action String
created DateTime
description String
id ID
payload NotificationPayloadType
seen CustomDateGraphType
title String
type String

OnboardingStepType

Fields

Name	Description
action String
actionLabel String
active Boolean
description String
id ID
title String

OnboardingType

Fields

Name	Description
id ID
steps [OnboardingStepType]
visible Boolean

PaginatorDocumentType

Fields

Name	Description
data [DocumentType]
totalCount Int

PaginatorFileType

Fields

Name	Description
data [FileType]
totalCount Int

PaginatorInboundAccountType

Fields

Name	Description
data [InboundAccountType]
totalCount Int

PaginatorNotificationType

Fields

Name	Description
data [NotificationType]
totalCount Int

PaginatorRaisedFlagType

Fields

Name	Description
data [RaisedFlagType]
totalCount Int

PaginatorRecipientType

Fields

Name	Description
data [Recipient]
totalCount Int

PaginatorTicketType

Fields

Name	Description
data [TicketType]
totalCount Int

PaginatorTransactionHType

Fields

Name	Description
data [TransactionChange]
totalCount Int

PaginatorTransactionType

Fields

Name	Description
data [Transaction]
totalCount Int

PaymentNetworkType

Fields

Name	Description
code String
extendedName String
id ID
name String

PaymentServiceType

Fields

Name	Description
code String
id ID
name String

publicQueries

Only public queries do not require authentication.

Fields

Name	Description
addressLookup String	Suggests valid addresses based on provided input. Arguments Name Description query String type String
calculateAmount CalcResultType	Calculate fees and get details related for the future transaction. Arguments Name Description countryFromId ID! countryToId ID! sendAmount Float receiveAmount Float serviceId ID! networkId ID! locationId ID
corridorsGroups [CorridorGroupType]	List of active corridor groups to be used on the calculator. Arguments Name Description countryFrom String countryTo String countryFromId ID countryToId 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 Name Description 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;
fieldsConfig [FieldsConfigType]	Retrive fields configuration to create dynamic forms. Arguments Name Description countryCode String ISO Code 2 fieldsGroup String! Use following values to retrive specific configuration: user for registration updateUser for end user profile editing recipient for add/edit recipient Questionnaire for questionnaire definition
frontendConfiguration FrontendConfigurationType	Retrive default settings for the frontend application.
id ID
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 Name Description active Boolean
states [StateType]	List of states in specified country. Arguments Name Description countryIsoCode2 String
translations [TranslationType]	List of translations defined on the system. Arguments Name Description langId Int isoCode2 String

PurposeType

Fields

Name	Description
code String
id ID
isActive Boolean
name String

Queries

Fields

Name	Description
messaging messagingQueries
public publicQueries
user userQueries

RaisedFlagType

Fields

Name	Description
created DateTime
createdByName String
description String
flag FlagType
forUserId ID
id ID
level FlagLevel
resolved DateTime	If not set current raised flag is not resolved yet.
resolvedBy UserInfoType
resolvedNote String
ticket TicketType
transaction Transaction
user UserInfoType

Recipient

Money recipient

Fields

Name	Description
addressLine1 String
addressLine2 String
bankAccNumber String
bankName String
city String
country CountryType!
created DateTime
dateOfBirth CustomDateGraphType
email String
firstName String
iban String
id ID!
lastName String
middleName String
moneySent Decimal
name String
phone String
phoneCode String
relationship RelationshipType
sendingCurrency String

RegionType

Fields

Name	Description
code String
id ID
isActive Boolean
maxAmount Decimal
name String

RelationshipType

Fields

Name	Description
id ID
isActive Boolean
name String

ServiceNetworkType

Fields

Name	Description
networks [CorridorLimits]
paymentService PaymentServiceType

StateType

Fields

Name	Description
countryIsoCode2 String!
id String!
name String

TicketType

Fields

Name	Description
created DateTime
createdByName String
description String
files [FileType]
id ID
internalNote String
messages [MessageType]
number Int
raisedFlag RaisedFlagType
status TicketStatus
subject String
unseenMessagesCount Int

Transaction

Fields

Name	Description
amount Decimal
canCancel ActionStatusType
canContinue ActionStatusType
continue ActionStatusType	Deprecated: Replaced with canContinue.
created DateTime
currency String
expectedPayoutTime DateTime
fixedFee Float
fixedFeePaid Decimal
fromId ID
fromIsoCode2 String
fromIsoCode3 String
fromName String
id ID!
inbound String
inboundName String
inboundRefNo String
outboundRefNo String	Deprecated: Legacy code.
paidAmount Decimal
paymentInstructions String
paymentMethodName String
paymentMethodNumber String
paymentNetworkCode String
paymentNetworkId ID
paymentNetworkName String
paymentServiceCode String
paymentServiceId ID
paymentServiceName String
pickupCode String
purposeId ID
purposeName String
quote Decimal
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. Arguments Name Description level FlagLevel resolved Boolean
receipt FileType
receivingAmount Decimal
receivingCurrency String
recipientAddress1 String
recipientAddress2 String
recipientCity String
recipientCountry String
recipientDateOfBirth Date
recipientEmail String
recipientFirstName String
recipientId ID
recipientLastName String
recipientMiddleName String
recipientName String
recipientPhone String
relationshipId ID
relationshipName String
status TransactionStatusType
toId ID
toIsoCode2 String
toIsoCode3 String
toName String
transactionId String
transactionStatusInfo TransactionStatusInfoType
userAddressLine1 String
userAddressLine2 String
userBirthDate Date
userCity String
userCountry String
userEmail String
userFirstName String
userId ID
userLastName String
userMiddleName String
userPhone String
userSocialNumber String
userTerritory String
userUnitNumber String
userUserName String
userZip String
variableFee Float
variableFeePaid Decimal

TransactionChange

Transaction status change.

Fields

Name	Description
created DateTime
createdByName String
id ID!	The unique identifier of the transaction change.
note String
transaction Transaction
transactionStatus TransactionStatusType

TransactionStatusInfoType

Fields

Name	Description
flagCount Int
flagTooltip String
icon String
isInfo Boolean
isWarning Boolean
name String
note String
statusId Int
ticketCount Int
ticketTooltip String

TransactionStatusType

Fields

Name	Description
id ID!
name String

TranslationType

Fields

Name	Description
id Int
key String
language LanguageType
tags [String]
value String

UserInfoType

Fields

Name	Description
firstName String
id ID
lastName String
middleName String

userMutations

Fields

Name	Description
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 Name Description consentType Int! Please check the ConsentTypeEnumeration enum. metadata String
addPaymentMethod InboundAccountType	Use it to add a new payment method to user's payment methods. Arguments Name Description paymentMethod PaymentMethodInputType!
addProperties [CustomPropertyType]	Add a new property to the custom properties. Arguments Name Description properties [CustomPropertyInputType] flagCode FlagCode
cancelTransaction Transaction	Is used to cancel a transaction. To be sure that the transaction can be canceled check canCancel property in the transaction. Arguments Name Description transactionId ID!
changePassword Boolean	Change password for a user. Arguments Name Description oldPassword String! newPassword String!
changePaymentMethodStatus Boolean	Use it to change a payment method status. Arguments Name Description paymentMethodId String! newStatus String! inboundCode String!
createRecipient Recipient	Use the public.fieldsConfig query to retrieve fields needed for recipient creation. Arguments Name Description data RecipientInputType!
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 Name Description countryFromId ID! countryToId ID! sendAmount Float receiveAmount Float serviceId ID! networkId ID! recipientId ID! purposeId ID quoteId ID locationId ID
deleteRecipient Boolean	Remove the recipient from the list. Recipients can be deleted only if there are no related transactions. Arguments Name Description id ID!
generateInboundToken InboundAuthTokenType	Generate inbound token to initialise inbound widget. Arguments Name Description inbound String! MOOV
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 Name Description transactionId ID! inbound String! paymentMethodId String
kycVerify Boolean	⚠️ DEPRECATED: This mutation is deprecated. Use the new two-step KYC flow with requestKYCVerification and submitKYCData mutations instead. See the KYC documentation for details. 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 Name Description data VerifyDataInputType!
login EndUserType	Login user on the system. Arguments Name Description username String! password String! appVersion String Provide app version to be able to track if user tries to login with an obsolete app version.
markNotificationsSeen Boolean	You can mark notifications seen by a list of ID's or all at once. Arguments Name Description ids [ID] all Boolean
register EndUserType	Register user on the system. Use the public.fieldsConfig query to retrieve fields needed for registration. Arguments Name Description data EndUserRegisterType!
removeInboundAccount Boolean	Use to remove the inbound account from the list of inbound accounts. Arguments Name Description id String! accountType InboundAccountEnumType! inbound String!
requestResetPassword Boolean	Send a reset password request for a user. Arguments Name Description username String!
requestKYCVerification KYCVerificationType	Initiates KYC process for current user. If KYC process is in progress, returns status of current KYC process. This mutation returns the KYC form fields, status, and any additional information needed to complete the verification process. See the KYC documentation for complete implementation details. No Arguments Required
resendEmail Boolean	Resend email related to specific action. Arguments Name Description id ID! emailType EmailTemplateEnumType! PAYMENT_INSTRUCTIONS to resend payment instructions to the user only if inbound is MANUAL. The id should be transaction.id.
resendVerificationCode Boolean	Resend verification codes to communication channel that the user provided. Arguments Name Description type String EMAIL | PHONE
resetPassword Boolean	Complete reset password flow for a user. Arguments Name Description username String! code String! newPassword String!
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 Name Description pushToken String
submitKYCData KYCVerificationType	Submit data from KYC form. This is the second step in the KYC verification process after calling requestKYCVerification. The response may contain additional fields if more information is needed, in which case this mutation should be called again with the new data. See the KYC documentation for complete implementation details. Arguments Name Description data VerifyDataInputType! KYC form data collected from the user based on the field definitions returned by requestKYCVerification.
updatePaymentMethod InboundAccountType	Use it to update a payment method details. Arguments Name Description paymentMethod PaymentMethodInputType!
updateProfile EndUserType	Update the user's profile. Use the public.fieldsConfig query to retrieve fields needed for updating a profile. Arguments Name Description data EndUserProfileType!
updateRecipient Recipient	Use the public.fieldsConfig query to retrieve fields needed for recipient update. Arguments Name Description data RecipientInputType!
verify EndUserType	Verify communication channels that the user provided. Arguments Name Description code String! type String EMAIL | PHONE

userQueries

All data related to the currently logged user.

Fields

Name	Description
customProperties [CustomPropertyType]	Get data for logged user. Arguments Name Description tag String QUESTIONNAIRE: to get questionarie data;
documents PaginatorDocumentType	List of documents (e.g. passport, driver's license...) for the user. Arguments Name Description pageRequest PageRequestType
endUser EndUserType	Currently logged in user details.
files PaginatorFileType	List of files for the user. Arguments Name Description pageRequest PageRequestFilesFilterType
id ID
inboundAccount InboundAccountType	Get one inbound account for the user. Arguments Name Description accountId String inboundCode String
inboundAccounts PaginatorInboundAccountType	Get list of the inbound accounts. Arguments Name Description pageRequest PageRequestType
inbounds [InboundServiceType]	Get inbounds list for a specific transaction. Arguments Name Description transactionId ID
kycFieldsConfig [FieldSetType]	⚠️ DEPRECATED: This query is deprecated. Use the new requestKYCVerification mutation instead, which returns form fields directly in its response. See the KYC documentation for details. Retrive fields configuration to create KYC dynamic forms. Arguments Name Description countryIsoCode2 String
notification NotificationType	Get one notification for the user. Arguments Name Description id ID!
notifications PaginatorNotificationType	List of notifications for the user. Arguments Name Description pageRequest PageRequestNotificationsFilterType
onboarding OnboardingType	Get list of onboarding steps and their status. Arguments Name Description type String Allowed values: circles
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. Arguments Name Description pageRequest PageRequestRaisedFlagsFilterType
recipient Recipient	Get one recipient. Arguments Name Description id ID!
recipients PaginatorRecipientType	List of recipients for the user. Arguments Name Description pageRequest PageRequestRecipientsFilterType
ticket TicketType	Get one ticket. Arguments Name Description id ID!
tickets PaginatorTicketType	List of tickets for the user. Arguments Name Description pageRequest PageRequestTicketsFilterType
transaction Transaction	Get one transaction. Arguments Name Description id ID!
transactionHistory PaginatorTransactionHType	Transaction history list for specific transaction. Arguments Name Description pageRequest PageRequestTransactionHistoryFilterType
transactions PaginatorTransactionType	List of transactions for the user. Arguments Name Description pageRequest PageRequestTransactionsFilterType

UserStatusInfoType

Fields

Name	Description
flagCount Int
flagTooltip String
ticketCount Int
ticketTooltip String
unresolvedFlagsCount Int
userId ID