Skip to main content

Account

Account information

type Account {
  id: ID!
  externalId: String
  masterAccountId: ID
  name: String
  paymentMethods: AccountPaymentMethods @deprecated
  publicBusinessDetails: AccountPublicBusinessDetails
  branding: AccountBranding
  defaultCurrency: Currencies @deprecated
  test: Boolean
  blocked: Boolean
  status: AccountStatus!
  reason: String @deprecated
  timezone: String
  adminEmail: String
  apiKey: String
  customDomain: String
  customDomainConfig: CustomDomainConfig
  payoutTerms: AccountPayoutTerms
  business: BusinessData
  representatives: [Representative!]
  iban: String
  bankAccount: BankAccount
  language: String
  tokenizationMethods: AccountTokenizationMethods
  notifications: AccountNotifications
  billingPlan: BillingPlans
  contract: AccountContract
  referralCode: String
  promoCode: String
  allowCreateApiKey: Boolean
  previewFeatures: [String!]
  notConfiguredReason: NotConfiguredReason @deprecated
  notConfiguredNote: String @deprecated
  userNote: String
  createdAt: String!
  approvedAt: String
  updatedAt: String
  rejectedReason: RejectedReason @deprecated
  rejectedNote: String @deprecated
  statusReason: StatusReason
  statusNote: String
}

Fields

`Account.id` ● `ID!` non-null scalar

Account ID

`Account.externalId` ● `String` scalar

Account external ID, provided by the partner (master account)

`Account.masterAccountId` ● `ID` scalar

Master account ID, if the account is a sub-account of a partner (master account)

`Account.name` ● `String` scalar

Account name

`Account.paymentMethods` ● `AccountPaymentMethods` deprecated object

DEPRECATED

not used anymore

`Account.publicBusinessDetails` ● `AccountPublicBusinessDetails` object

Public business information

`Account.branding` ● `AccountBranding` object

Account branding

`Account.defaultCurrency` ● `Currencies` deprecated enum

DEPRECATED

not used anymore

`Account.test` ● `Boolean` scalar

If the account is a test account

`Account.blocked` ● `Boolean` scalar

If the account is blocked

`Account.status` ● `AccountStatus!` non-null enum

Account status

`Account.reason` ● `String` deprecated scalar

DEPRECATED

Use statusReason instead

`Account.timezone` ● `String` scalar

The account default timezone, e.g. Europe/Madrid

`Account.adminEmail` ● `String` scalar

Account admin email

`Account.apiKey` ● `String` scalar

Account API key, used to authenticate requests to REST and GraphQL APIs

`Account.customDomain` ● `String` scalar

Account custom domain, this domain will be used for the hosted payment page

`Account.customDomainConfig` ● `CustomDomainConfig` object

Account custom domain configuration

`Account.payoutTerms` ● `AccountPayoutTerms` object

Account payout terms

`Account.business` ● `BusinessData` object

Business basic data

`Account.representatives` ● `[Representative!]` list object

Legal representatives

`Account.iban` ● `String` scalar

IBAN number to receive settlements

`Account.bankAccount` ● `BankAccount` object

Bank account information

`Account.language` ● `String` scalar

Preferred language

`Account.tokenizationMethods` ● `AccountTokenizationMethods` object

Tokenization methods

`Account.notifications` ● `AccountNotifications` object

Account notifications

`Account.billingPlan` ● `BillingPlans` enum

Billing Plan

`Account.contract` ● `AccountContract` object

Account contract

`Account.referralCode` ● `String` scalar

Account referral code

`Account.promoCode` ● `String` scalar

Account promo code

`Account.allowCreateApiKey` ● `Boolean` scalar

Allow creating API keys, if false, the account will not be able to create new API keys

`Account.previewFeatures` ● `[String!]` list scalar

Access to preview features

`Account.notConfiguredReason` ● `NotConfiguredReason` deprecated enum

DEPRECATED

Use statusReason instead

`Account.notConfiguredNote` ● `String` deprecated scalar

DEPRECATED

Use statusNote instead

`Account.userNote` ● `String` scalar

User provided note

`Account.createdAt` ● `String!` non-null scalar

The date when the account was created in ISO 8601 format

`Account.approvedAt` ● `String` scalar

The date when the account was approved in ISO 8601 format

`Account.updatedAt` ● `String` scalar

The date when the account was updated in ISO 8601 format

`Account.rejectedReason` ● `RejectedReason` deprecated enum

DEPRECATED

Use statusReason instead

`Account.rejectedNote` ● `String` deprecated scalar

DEPRECATED

Use statusNote instead

`Account.statusReason` ● `StatusReason` enum

The reason why the account status was changed

`Account.statusNote` ● `String` scalar

The note about the account status

Returned By

account query ● connectMasterAccount mutation ● disableCustomDomain mutation ● disableTokenizationMethod mutation ● disconnectMasterAccount mutation ● enableCustomDomain mutation ● enableTokenizationMethod mutation ● liveAccount query ● requestAccountReview mutation ● setupAccount mutation ● startCompanyLookup mutation ● updateAccount mutation ● verifyBusinessDetails mutation ● verifyCustomDomain mutation

Fields
Returned By