Skip to main content

Retrieve an account

Returns user account information.

Query Parameters
  • include[] string[]

    Possible values: [operators, settings, doing_business_as, bank_accounts, app_settings, country_details, timeoffset_details, permissions]

    A list of additional information you want to receive for the user. By default only personal and merchant profile information will be returned.

Responses

OK


Schema
  • account object

    Account information.

  • username string

    Type of the account.

  • type string

    Possible values: [normal, operator]

    The role of the user.

  • personal_profile object

    Account's personal profile.

  • first_name string

    First name of the user

  • last_name string

    Last name of the user

  • date_of_birth string

    Date of birth

  • mobile_phone string

    Mobile phone number

  • address object

    Details of the registered address.

  • address_line1 string

    Address line 1

  • address_line2 string

    Address line 2

  • city string

    City

  • country string

    Country ISO 3166-1 code

  • region_id number

    Country region id

  • region_name string

    Region name

  • region_code string

    Region code

  • post_code string

    Postal code

  • landline string

    Landline number

  • first_name string

    undefined

  • last_name string

    undefined

  • company string

    undefined

  • country_details object

    Country Details

  • currency string

    Currency ISO 4217 code

  • iso_code string

    Country ISO code

  • en_name string

    Country EN name

  • native_name string

    Country native name

  • timeoffset_details object

    TimeOffset Details

  • post_code string

    Postal code

  • offset number

    UTC offset

  • dst boolean

    Daylight Saving Time

  • state_id string

    undefined

  • complete boolean
  • merchant_profile object

    Account's merchant profile

  • merchant_code string

    Unique identifying code of the merchant profile

  • company_name string

    Company name

  • website string

    Website

  • legal_type object

    Id of the legal type of the merchant profile

  • id number

    Unique id

  • full_description string

    Legal type description

  • description string

    Legal type short description

  • sole_trader boolean

    Sole trader legal type if true

  • merchant_category_code string

    Merchant category code

  • mobile_phone string

    Mobile phone number

  • company_registration_number string

    Company registration number

  • vat_id string

    Vat ID

  • permanent_certificate_access_code string

    Permanent certificate access code (Portugal)

  • nature_and_purpose string

    Nature and purpose of the business

  • address object

    Details of the registered address.

  • address_line1 string

    Address line 1

  • address_line2 string

    Address line 2

  • city string

    City

  • country string

    Country ISO 3166-1 code

  • region_id number

    Country region id

  • region_name string

    Region name

  • region_code string

    Region code

  • post_code string

    Postal code

  • landline string

    Landline number

  • first_name string

    undefined

  • last_name string

    undefined

  • company string

    undefined

  • country_details object

    Country Details

  • currency string

    Currency ISO 4217 code

  • iso_code string

    Country ISO code

  • en_name string

    Country EN name

  • native_name string

    Country native name

  • timeoffset_details object

    TimeOffset Details

  • post_code string

    Postal code

  • offset number

    UTC offset

  • dst boolean

    Daylight Saving Time

  • state_id string

    undefined

  • business_owners object[]

    Account's business address information

  • first_name string

    BO's first name

  • last_name string

    BO's last name of the user

  • date_of_birth string

    Date of birth

  • mobile_phone string

    Mobile phone number

  • landline string

    BO's Landline

  • ownership number

    Ownership percentage

  • doing_business_as object

    Doing Business As information

  • business_name string

    Doing business as name

  • company_registration_number string

    Doing business as company registration number

  • vat_id string

    Doing business as vat id

  • website string

    Doing business as website

  • email string

    Doing business as email

  • address
  • address_line1 string

    Address line 1

  • address_line2 string

    Address line 2

  • city string

    City

  • country string

    Country ISO 3166-1 code

  • region_id number

    Country region id

  • region_name string

    Country region name

  • post_code string

    Postal code

  • settings object

    Merchant settings (like \"payout_type\", \"payout_period\")

  • tax_enabled boolean

    Whether to show tax in receipts (saved per transaction)

  • payout_type string

    Payout type

  • payout_period string

    Payout frequency

  • payout_on_demand_available boolean

    Whether merchant can edit payouts on demand

  • payout_on_demand boolean

    Whether merchant will receive payouts on demand

  • printers_enabled boolean

    Whether to show printers in mobile app

  • payout_instrument string

    Payout Instrument

  • moto_payment string

    Possible values: [UNAVAILABLE, ENFORCED, ON, OFF]

    Whether merchant can make MOTO payments

  • stone_merchant_code string

    Stone merchant code

  • adyen_merchant_code string

    Adyen merchant code

  • adyen_user string

    Adyen username

  • adyen_password string

    Adyen password

  • adyen_company string

    Adyen company

  • daily_payout_email boolean

    Whether merchant will receive daily payout emails

  • monthly_payout_email boolean

    Whether merchant will receive monthly payout emails

  • gross_settlement boolean

    Whether merchant has gross settlement enabled

  • vat_rates object

    Merchant VAT rates

  • id number

    Internal ID

  • description string

    Description

  • rate number

    Rate

  • ordering number

    Ordering

  • country string

    Country ISO code

  • locale string

    Merchant locale (for internal usage only)

  • bank_accounts object[]
  • bank_code string

    Bank code

  • branch_code string

    Branch code

  • swift string

    SWIFT code

  • account_number string

    Account number

  • iban string

    IBAN

  • account_type string

    Type of the account

  • account_category string

    Account category - business or personal

  • account_holder_name string
  • status string

    Status in the verification process

  • primary boolean

    The primary bank account is the one used for settlemnts

  • created_at string

    Creation date of the bank account

  • bank_name string

    Bank name

  • extdev boolean

    True if the merchant is extdev

  • payout_zone_migrated boolean

    True if the payout zone of this merchant is migrated

  • country string

    Merchant country isocode (for internal usage only)

  • operators object[]
  • username string

    Username of the operator

  • app_settings object

    Mobile app settings

  • checkout_preference string

    Checkout preference

  • include_vat boolean

    Include vat.

  • manual_entry_tutorial boolean

    Manual entry tutorial.

  • mobile_payment_tutorial boolean

    Mobile payment tutorial.

  • tax_enabled boolean

    Tax enabled.

  • mobile_payment string

    Mobile payment.

  • reader_payment string

    Reader payment.

  • cash_payment string

    Cash payment.

  • advanced_mode string

    Advanced mode.

  • expected_max_transaction_amount number

    Expected max transaction amount.

  • manual_entry string

    Manual entry.

  • terminal_mode_tutorial boolean

    Terminal mode tutorial.

  • tipping string

    Tipping.

  • tip_rates float[]

    Tip rates.

  • barcode_scanner string

    Barcode scanner.

  • referral string

    Referral.

  • permissions object

    User permissions

  • create_moto_payments boolean

    Create MOTO payments

  • full_transaction_history_view boolean

    Can view full merchant transaction history

  • refund_transactions boolean

    Refund transactions

  • create_referral boolean

    Create referral

  • is_migrated_payleven_br boolean

    Merchant comes from payleven BR migration