Greiðslusíður

Greiðslusíður Áskels má tengja beint af eigin vef eða samfélagsmiðli. Grunnslóðin inniheldur auðkenni síðu, t.d. https://askell.is/public/payments/<id>/. Ekki er hægt að sérsníða þessa slóð að svo komnu en það er væntanlegt. Að auki styður slóðin nokkra valkvæðar færibreytur sem gera kleift að forsníða gögn eða stjórna hegðun formsins.

Valkvæðar færibreytur

Allar breytur hér að neðan eru valkvæðar og má nota fleiri en eina í einu. Þegar breytur fylla út reiti eru þeir einungis lesnir þegar síðan hleðst upp og gildin verða læst (ekki breytanleg af notanda) til að tryggja að framsendar upplýsingar haldist óbreyttar.

Stiki	Tegund	Lýsing
name	str	Upphafsstillir fullt nafn viðskiptavinarins og gerir nafnsreit óvirkan svo notandi geti ekki breytt þeim upplýsingum sem komu úr þínu kerfi.
email	str	Upphafsstillir netfang og læsir reitnum. Gott þegar greiðsluslóð er send í tölvupósti og netfangið er þegar staðfest.
phone	str	Upphafsstillir símanúmer og læsir reitnum. Hægt að setja bæði innlendar og alþjóðlegar sniðlengdir (t.d. +3547701234).
reference	str	Upphafsstillir kennitölu eða annað viðskiptavinatilvísunargildi. Reiturinn verður sjálfgefið óvirkur svo númerið haldist óbreytt. Ef engin tilvísun fylgir er reiturinn áfram sýnilegur og krefst inntaks notanda.
hide_reference	bool (true eða 1)	Felur kennitölu/tilvísanareitinn úr viðmótinu þegar hann hefur verið forskráður með reference. Gildir ekki nema reference hafi gildi.
subscription_reference	str	Tilvísun í ytra kerfi fyrir það sem keypt er. Á eldri greiðslusíðum fer hún á nýju áskriftina og á V2 greiðslusíðum á samninginn, sjá Tilvísun áskriftar. Þessi breyta er gagnleg þegar verið er að halda utan um sérsniðnar tilvísanir í ytra kerfi.
language	str	Stýrir tungumáli greiðslusíðunnar. Gildin en (enska) og is (íslenska) eru studd og sjálfgefið er is ef engin breyta fylgir.

Tilvísun áskriftar

Hvar subscription_reference endar fer eftir tegund greiðslusíðunnar:

• Eldri greiðslusíður, sem selja verðleiðir áskriftarleiða, setja hana í reference á nýju áskriftinni (Subscription). Sé henni sleppt fær áskriftin tilvísun viðskiptavinarins.

• V2 greiðslusíður, sem selja pakka eða vörur úr vörulista, setja hana í reference á samningnum sem verður til (SubscriptionContract, sjá Áskriftarsamningar V2). Þar er ekkert sjálfgefið gildi: sé henni sleppt er reference samningsins null. Tilvísun viðskiptavinarins er eftir sem áður í customer_reference.

Tilvísunin má vera að hámarki 128 stafir; lengri tilvísun er hafnað með HTTP 400 og villu á subscription_reference á báðum tegundum greiðslusíðna. Á V2 greiðslusíðum má tilvísunin heldur ekki innihalda kommu. Þá er greiðslunni hafnað með HTTP 400 og kóðanum invalid_subscription_reference ({"message": ..., "code": ...}) áður en viðskiptavinur, greiðslumáti eða samningur er vistaður. Þetta gildir jafnt um kortagreiðslur og bankakröfur.

Samningar sem V2 greiðslusíða stofnar fá einnig askell_source í metadata svo rekja megi þá til síðunnar:

{
  "askell_source": {
    "type": "payment_page",
    "payment_page_id": 12
  }
}

Sérsniðnir reitir

Á V2 greiðslusíðum, sem selja úr sölurás, má í stjórnborði skilgreina sérsniðna reiti sem kaupandinn fyllir út á greiðslusíðunni, t.d. nafn fyrirtækis, stærð á bol eða samþykki fyrir markpósti. Svörin eru vistuð sem sjálfstæðir lyklar í metadata samningsins sem verður til, við hlið askell_source, og birtast því í vefþjónustunni og í vefkrókum samninga:

{
  "company_name": "Fyrirtæki ehf.",
  "shirt_size": "L",
  "contact_ok": true,
  "askell_source": {
    "type": "payment_page",
    "payment_page_id": 12
  }
}

Hver reitur hefur lykil, titil, tegund, valkvæðan hjálpartexta og stillingu um hvort svara þurfi honum. Tegundin ræður því hvaða gildi lendir í metadata:

Tegund	Gildi í metadata
text	Texti, að hámarki 500 stafir.
textarea	Lengri texti, að hámarki 2000 stafir.
select	Einn af valkostum reitsins (1–50 valkostir, hver að hámarki 100 stafir).
checkbox	true eða false. Hakreitur er alltaf vistaður og nauðsynlegur hakreitur verður að vera hakaður.

Bil fremst og aftast í textasvörum eru fjarlægð og auðum svörum við valkvæðum texta- og fellilistareitum er sleppt. Greiðslusíða getur haft að hámarki 20 reiti. Lykill verður að byrja á lágstaf, innihalda eingöngu lágstafi, tölustafi og undirstrik (að hámarki 50 stafir) og vera einkvæmur á síðunni. Lyklar sem Áskell notar sjálfur í metadata, svo sem askell_source og billing_anchor_mode, eru fráteknir, sem og allir lyklar sem byrja á askell_ og lyklarnir constructor og prototype, sem greiðslusíðan getur ekki geymt svör undir.

Eingöngu lyklar sem síðan skilgreinir eru vistaðir og aðrir lyklar sem berast eru hunsaðir. Standist svar ekki skilgreininguna, t.d. ef nauðsynlegum reit er ekki svarað, er greiðslunni hafnað með HTTP 400 og kóðanum invalid_custom_fields áður en viðskiptavinur, greiðslumáti eða samningur er vistaður. Villurnar fylgja í errors, flokkaðar eftir lykli:

{
  "message": "Invalid custom fields",
  "code": "invalid_custom_fields",
  "errors": {"company_name": ["This field is required."]}
}

Greiðslusíður sem selja eldri áskriftarleiðir styðja ekki sérsniðna reiti.

Notkunardæmi

Eftirfarandi dæmi sýnir hvernig hægt er að fylla út helstu reiti áður en notandi lendir á greiðslusíðunni:

https://askell.is/public/payments/0/?name=J%C3%B3n%20J%C3%B3nsson&email=jon%40d%C3%A6example.com&phone=+3547701234&reference=0101701234

Í þessu tilviki þarf viðskiptavinurinn eingöngu að staðfesta skilmála og greiðslumáta þar sem allar persónuupplýsingar eru þegar skráðar.

Greiðslusíður sem selja eldri áskriftarleiðir

Greiðslusíða sem selur eldri áskriftarleiðir (PlanVariant) stofnar eldri áskrift þegar greitt er. Ef áskriftarlíkan aðgangsins er contracts (Eingöngu nýjar áskriftir í stjórnborði) hafnar greiðslusíðan kaupum með villu 400 og code legacy_subscriptions_disabled, bæði þegar kort er staðfest og þegar greiðsla er kláruð, áður en kortið er staðfest eða skuldfært og áður en viðskiptavinur eða áskrift er stofnuð.

Áskriftarhnappurinn (/subscribe-button/{plan_id}/) hafnar kaupum á sama hátt, áður en viðskiptavinur er stofnaður eða nokkuð er skuldfært. Þar sem hann er form fyrir kaupandann svarar hann þó með villusíðu (400) með skilaboðum til kaupandans, en ekki JSON svari með code.

Áður en aðgangur er færður alfarið yfir á áskriftarsamninga þarf því að láta greiðslusíðurnar selja úr sölurás í stað eldri áskriftarleiða. Greiðslusíður sem selja úr sölurás virka óbreyttar. Sjá einnig Áskriftir.