1.6.2 • Published 4 months ago

@flittpayments/checkout v1.6.2

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

Flitt

Flitt Checkout

config

{
  options: {},
  params: {},
  button: {}, // button config 
  fields_custom: [],
  messages: {},
  validate: {},
  css_variable: {},
}

options

NameTypeDefaultDescriptionPriority
methodsArray'card'support card, sepa, banklinks_eu, receipt.
methods_disabledArray[]support card, sepa, banklinks_eu, receipt.
wallet_methods_enabledArray'apple', 'google'support apple, google.
card_iconsArray'mastercard', 'visa'support mastercard, visa, mir, prostir, diners, american_express , jcb, maestro, union_pay.
banklinks_eu_iconsArray[]
local_methods_iconsArray[]
crypto_iconsArray[]
loans_iconsArray[]
emoney_iconsArray[]
wallets_iconsArray[]
titleStringoptions or server
linkStringformat urlserver or options
full_screenBooleantrue
localesArrayallsupport cs, de, en, es, fr, hu, it, ko, lv, pl, ro, ru, sk, uk.
api_domainString'pay.flitt.com'
endpointObject
active_tabString'card'support card, sepa.server or options
active_methodString''server or options
logo_urlStringformat urloptions or server
offerta_urlStringformat urloptions or server
default_countryString
countriesArray
themeObject
show_menu_firstBooleanfalse
disable_requestBooleanfalseno requests are sent to the server
subscriptionObject
loadingStringformat url
amount_readonlyBooleantrue
show_amountBooleantrue
show_emailBooleanfalseserver or options
show_feeBooleantrue
show_langBooleantrue
show_linkBooleantrue
show_order_descBooleantrue
show_pay_button_amountBooleantruedisplaying the amount on the button
show_pay_buttonBooleantrue
show_processedBooleantrue
show_secure_messageBooleantrue
show_test_modeBooleantrue
show_titleBooleantrue

options.endpoint

NameTypeDefaultDescription
gatewayString'/latest/checkout-v2/index.html'
buttonString'/latest/checkout-v2/button/index.html'

options.theme

NameTypeDefaultDescription
typeString'light'support light, dark.
presetString'black'support reset, black, silver, vibrant_silver, vibrant_gold, solid_black, black_and_white, euphoric_pink, heated_steel, nude_pink, tropical_gold, navy_shimmer.
layoutString'default'support default, plain, wallets_only.

options.subscription

NameTypeDefaultDescription
typeString'disable'support disable, hidden, shown_edit_on, shown_edit_off, shown_readonly
periodsArray'day', 'week', 'month'support day, week, month.
quantityBooleanfalse
trialBooleanfalse
unlimitedBooleantrue
readonlyBooleanfalse

params

NameTypeDefaultDescriptionPriority
merchant_idInteger1396424
order_descStringoptions or server
amountIntegernull
currencyString'USD'
response_urlStringformat url
langStringbrowser languageserver or options
required_rectokenStringsupport Y, N, y, n.
verificationStringsupport Y, N, y, n.
verification_typeStringsupport amount, code
tokenStringlength 40
buttonStringlength 20-80
offerBooleanfalse
recurring_dataObject
customObject
customer_dataObject

params.recurring_data

NameTypeDefaultDescription
everyInteger1
periodString'month'support day, week, month.
amountInteger0
end_timeStringformat YYYY-MM-DD
start_timeStringformat YYYY-MM-DD
quantityInteger0
trial_periodString''
trial_quantityInteger0

params.customer_data

NameTypeDefaultDescription
customer_nameString
customer_addressString
customer_zipString
customer_cityString
customer_countryStringdictionary countries
customer_stateString
phonemobileStringformat phone
emailStringformat email

messages

{
  messages: {
    {en}: {
      {id}: {value},
      ...
    },
    ...
  },
}

validate

{
  validate: {
    {en}: {
      {id}: {value},
      ...
    },
    ...
  },
}

css_variable

NameTypeDefaultDescription
border_radiusInteger8from 0 to 24 pixels

Use

$on

var app = checkout({css selector}, {config})

app.$on('success', function(model) {})
app.$on('error', function(model) {})
app.$on('ready', function(model) {})
app.$on('callback', function(model) {})
app.$on('show-pay', function(model) {})

$emit

app.submit()
app.$emit('submit')

app.location({method}, {system})
app.$emit('location', {method}, {system})

app.setParams({params})
app.$emit('setParams', {params})

app.$emit('click-wallet')
app.$emit('click-wallet', 'google')
app.$emit('click-wallet', 'apple')

Destroy app

app.$destroy()
app.$el.remove()

Use validate

https://vee-validate.logaretm.com/v3/guide/rules.html#rules

support after, alpha, date_format, decimal, digits, email, max, min, numeric, required, customer_field, phone, numrange, ccard

<input-text name="email" validate="required|email"></input-text>