OPAY / Techninė informacija / Web API / Pardavėjo siunčiami duomenys

Pardavėjo siunčiami duomenys

Pardavėjo siunčiamų duomenų (parametrų) kiekis vykdant Pirkėjo nukreipimą į OPAY skiriasi priklausomai nuo to, kokiomis Mokėjimo paslaugomis Pardavėjas naudojasi, remiantis Sutartimi sudaryta tarp OPAY ir Pardavėjo. Pardavėjas, kiekvieną kartą siųsdamas užklausą, gali nurodyti tam apmokėjimui norimus atsiskaitymo būdus (norimą Mokėjimo paslaugą), Sutartyje apibrėžtų Mokėjimo paslaugų ribose. Dalis siunčiamų parametrų sutampa visiems atsiskaitymo būdams. Atkreipkite dėmesį į kiekvienam atsiskaitymo būdui (Mokėjimo paslaugai) reikalingus ir privalomais pažymėtus parametrus.

Pardavėjas, pateikdamas mažesnį kiekį privalomų parametrų ir norėdamas tikslingai atsisakyti kai kurių atsiskaitymo būdų (Mokėjimo paslaugų), turi tai pranešti parametrais show_channels ir/arba hide_channels, atsisakant tų atsiskaitymo būdų, kurie ir taip Pirkėjui būtų nerodomi dėl neužtenkamų privalomų parametrų. Jei to Pardavėjas nepadarys, OPAY sistema kas kartą informuos Pardavėją el. paštu apie dėl per mažai pateiktų privalomų parametrų, galimai per klaidą nerodomus atsiskaitymo būdus.

Sistemai siunčiami duomenys privalo būti UTF-8 koduotės. Duomenys siunčiami HTTP POST arba GET metodu, adresu https://gateway.opay.lt/pay/.

Lentelės Nr. 1 stulpelių paaiškinimas:

  • Parametras. Parametro pavadinimas.
  • Maksimalus reikšmės ilgis.Parametrui priskirtos reikšmės simbolių kiekis negali būti didesnis nei šiame stulpelyje nurodyta reikšmė.
  • Reikšmės tipas. str – tekstas (galimos raidės, skaičiai ir kiti UTF-8 koduotės simboliai, jei prie parametro aprašymo nėra tiksliai nurodytos galimos reikšmės), int – sveikas skaičius (galimi tik skaičiai, be kablelių ar taškų).
  • Standartinė reikšmė (angl. „default“). Nepateikus parametro ar pateikus su neteisingais duomenimis, bus taikoma šiame stulpelyje nurodyta standartinė reikšmė (jei tokia pateikta).
  • Banklink, Card, Financing, Mobilewallet. Šioms grupėms priklausantiems atsiskaitymo būdams reikalingi parametrai.
  • Banktransfer, Cash. Šioms grupėms priklausantiems atsiskaitymo būdams reikalingi parametrai.
  • Privalomas. Jei parametras, pažymėtas privalomu, bus pateiktas su neteisingais duomenimis ar nepateiktas iš viso, tai atsiskaitymo būdas, kuriam šis parametras yra reikalingas, bus Pirkėjui neatvaizduojamas. Atkreipkite dėmesį kaip sutampa ar nesutampa (pvz., Banklink ir Banktransfer) stulpeliuose pažymėti laukai su privalomais pažymėtais laukais. Gali būti, kad dėl klaidos neužteks privalomų parametrų pateikti Banklink atsiskaitymo būdą, bet Banktransfer atsiskaitymo būdui reikalingų privalomų parametrų užteks.
  • Aprašymas. Šiame stulpelyje pateikiamas detalus parametro paaiškinimas ar komentaras.

Duomenys gali būti siunčiami kaip vienas parametras. Siunčiant duomenis šiuo būdu, duomenys turi būti sudedami į vieną eilutę, kuri yra paverčiama į base64 koduotę ir siunčiama vieninteliu parametru pavadinimu encoded. Plačiau apie tai skaitykite skiltyje Duomenų kodavimas siekiant išvengti galimų iškraipymų.

Lentelė Nr. 1

Pardavėjo siunčiamų duomenų aprašymas (HTTP POST arba GET parametrai).

  pažymėta.
  nepažymėta.
Parametras
tipas(maks. ilgis)
Galimos reikšmės,
standartinė reikšmė
Banklink, Card, Financing, Mobilewallet Banktransfer, Cash Privalomas Rodyti aprašymus Slėpti aprašymus
website_id
str(10)
        Rodyti aprašymą Slėpti aprašymą
Pardavėjo interneto Parduotuvės unikalus kodas, kurį OPAY suteikia ir nurodo Pardavėjo ir OPAY pasirašytoje Sutartyje.
order_nr
str(40)
        Rodyti aprašymą Slėpti aprašymą
Pardavėjo Parduotuvės sugeneruotas užsakymo numeris. Pardavėjas jį pateikia tam, kad OPAY atsakyme matydamas šį numerį Pardavėjas žinotų kurio tai užsakymo mokėjimo patvirtinimas ar pranešimas apie nepavykusį mokėjimą.
redirect_url
str(255)
        Rodyti aprašymą Slėpti aprašymą
Pilnas HTTP internetinis adresas su nurodytu protokolu (pvz.: https://puslapis.lt/failas.jsp). Tai adresas, kur nukreipiamas Pirkėjas po apmokėjimo.
redirect_on_success
int(1)
0, 1       Rodyti aprašymą Slėpti aprašymą
Kai kuriais atvejais grįžtantis Pirkėjas į Pardavėjo puslapį (į redirect_url) negali kartu atsinešti OPAY pasirašyto duomenų paketo, kuris sakytų jog mokėjimas įvykęs. Tai sąlygoja kai kurių OPAY Partnerių (pvz., kai kurių bankų) negalėjimas iš karto po atlikto mokėjimo suteikti OPAY informaciją ar mokėjimas yra pavykęs.
Parametro galimos reikšmės:
  • 1. Jeigu nurodysite 1, tai tokiu atveju Pirkėjui OPAY atvaizduos langą „Mokėjimas apdorojamas“ iki tol, kol OPAY gaus informaciją apie mokėjimo būseną. Po to, pavykusio mokėjimo atveju, Pirkėjas iškarto bus nukreiptas į Pardavėjo puslapį (redirect_url) su duomenų paketu (pranešimu) patvirtinančiu sėkmingą mokėjimą (status = 1) arba, nepavykusio mokėjimo atveju, grąžintas į OPAY atsiskaitymo būdų pasirinkimo langą su prašymu pasirinkti kitą atsiskaitymo būdą.
  • 0. Jeigu nurodysite 0, tai, jei pirkėjo grąžininimo į pardavėjo puslapį (redirect_url) metu OPAY neturės informacijos apie mokėjimo būseną, Pirkėjas bus grąžintas su duomenų paketu (pranešimu) „Mokėjimo nurodymas priimtas“ (status = 2), o jei OPAY informaciją turės, tada grąžins įprastai su duomenų paketu „Mokėjimas įvykdytas sėkmingai“ (status = 1).
    Reikšmė 0 nurodo OPAY nenaudoti laukimo lango „Mokėjimas apdorojamas“, o iškarto nukreipti Pirkėją kartu perduodant informaciją apie mokėjimą tokią, kokią OPAY turi.
Naudojant laukimo langą „Mokėjimas apdorojamas“, į Pardavėjo puslapį bus grąžinami tik Pirkėjai sėkmingai atlikę mokėjimą. Šiuo atveju Pardavėjo sistema gali atlikti reikiamus veiksmus, t.y. iškarto suteikti paslaugą ar bent jau padėkoti už sėkmingai atliktą mokėjimą.
web_service_url
str(255)
        Rodyti aprašymą Slėpti aprašymą
HTTP adresas su nurodytu protokolu (pvz.: https://puslapis.lt/failas.jsp), kuriuo bus siunčiamas OPAY serverio atsakymas apie mokėjimą.
back_url
str(255)
        Rodyti aprašymą Slėpti aprašymą
Pilnas HTTP adresas su nurodytu protokolu (pvz.: https://puslapis.lt/failas.jsp). Jeigu pateiktas šis adresas, tai OPAY, atsiskaitymo puslapyje Pirkėjui paspaudus „Grįžti į pardavėjo tinklalapį“, nukreips Pirkėją nurodytu adresu kartu su HTTP GET metodu perduodamu parametrais (Lentelė Nr. 2, Stulpelis „Kai atsakymo parametras status = 5“).
Verta paminėti porą grąžinamų parametrų:
  • transaction_id, kurio reikšmė yra operacijos, kuri buvo sukurta šiam mokėjimui, unikalus kodas;
  • language, kurio reikšmė yra trijų raidžių kalbos kodas (ISO 639-3), viena iš OPAY palaikomų kalbų. Kalba siunčiama tam, kad jei Pirkėjas OPAY tinklalapyje pakeistų kalbą, tai Pardavėjas grįžusiam Pirkėjui informaciją galėtų atvaizduoti ta pačia kalba.

Nuorodos https://gateway.opay.lt/?tid=<transakcijos kodas> pagalba galėsite grąžinti Pirkėją tiesiai į tą patį atsiskaitymo puslapį, jei Pirkėjas nieko nekeičia pirkinių krepšelyje, o tiesiog naviguoja tarp Pardavėjo ir OPAY atsiskaitymo puslapių.
Atkreipkite dėmesį, kad tai nėra mokėjimo nutraukimo nuoroda, o tiesiog galimybė Pardavėjui leisti laisvai naviguoti tarp OPAY mokėjimui skirto puslapio ir parduotuvės. Šią nuorodą gali paspausti asmuo, kuris nėra pradinis Pirkėjas (ne tas asmuo, kurio prisijungimo sesija galioja Pardavėjo svetainėje), nes mokėjimui skirtą puslapio nuorodą Pirkėjas gali persiųsti apmokėti kitam asmeniui.
Pagal poreikius galite back_url nuorodoje naudoti pirkinių krepšelį ar pan. identifikuojančius parametrus.
Pastaba. Šis parametras skirtas tik labai individualius porekius turintiems Pardavėjams ir jų nestandartinėms sistemoms, kurioms yra būtina navigavimo tarp OPAY ir Pardavėjo tinklalapių galimybė.

standard
str(9)
opay_8.1       Rodyti aprašymą Slėpti aprašymą
Duomenų mainų specifikacijos versija. Pardavėjo/OPAY sistemos turi žinoti kurios specifikacijos pagrindu pateikiami/gaumami duomenys.
language
str(3)
LIT, ENG, LAV, EST, RUS       Rodyti aprašymą Slėpti aprašymą
Kokia kalba rodyti Opay mokėjimo puslapį.
amount
int(10)
        Rodyti aprašymą Slėpti aprašymą
Kokia sumą Pirkėjas turi apmokėti. Suma pteikiama centais.
currency
str(3)
EUR       Rodyti aprašymą Slėpti aprašymą
Kokia valiuta pateikiama suma apmokėjimui.
show_channels
str(1000)
Skaityti aprašymą       Rodyti aprašymą Slėpti aprašymą
Čia galite nurodyti šiam mokėjimui pageidaujamus atsiskaitymo būdus. Žiūrėti “Parametrai show_channels ir hide_channels”.
hide_channels
str(1000)
Skaityti aprašymą       Rodyti aprašymą Slėpti aprašymą
Čia galite nurodyti šiame mokėjime nepageidaujamus atsiskaitymo būdus.Žiūrėti “Parametrai show_channels ir hide_channels”.
country
str(2)
LT       Rodyti aprašymą Slėpti aprašymą
Remiantis nurodyta šalimi, Pirkėjui pateikiami toje šalyje galimi atsiskaitymo būdai (ISO 3166-1 alpha-2).
payment_description
str(128)
Skaityti aprašymą       Rodyti aprašymą Slėpti aprašymą
Pirkėjui atliekant mokėjimą, šis tekstas nurodomas mokėjimo paskirtyje.
Tekstą galite sukurti savo nuožiūra, bet tekste turite naudoti žymes:
{order_nr} – Užsakymo numeris Pardavėjo sistemoje
{website} – tinklalapio (Parduotuvės) adresas
{merchant} – Pardavėjo pavadinimas.
Vietoje žymės OPAY sistema į tekstą įterps jos reikšmę
Privaloma žymė yra {order_nr}, taip pat privaloma bent viena iš žymių {website} arba {merchant}. Pardavėjo sukurtame tekste gali būti naudojami tik šie simboliai:
a – ž A-Ž (lietuviškos mažosios ir didžiosios raidės), 0 – 9, - (trumpas brūkšnelis), ( ) (lenktiniai skliaustai), , (kablelis), ; (kabliataškis), . (taškas), (tarpas).
Standartinė reikšmė: Apmokėjimas pagal užsakymą Nr. {order_nr}, tinklalapyje {website}
time_limit
int(7)
        Rodyti aprašymą Slėpti aprašymą
Minutės, per kiek laiko turi būti atliktas mokėjimas. Plačiau apie šį parametrą skaitykite skiltyje Parametras time_limit
test
str(10)
Skaityti aprašymą       Rodyti aprašymą Slėpti aprašymą
Šiuo parametru reikia pateikti vartotojo, kuriam suteikta teisė testuoti duotąjį tinklalapį, atpažinimo numerį (Vartotojo ID OPAY sistemoje) . Nurodę šį parametrą galėsite testuoti duomenų mainus su OPAY. Realūs mokėjimai nebus vykdomi.
c_email
str(100)
        Rodyti aprašymą Slėpti aprašymą
Pirkėjo el. pašto adresas. Jei jį nurodysite, Pirkėjui nebereikės įvedinėti savo el. pašto adreso OPAY mokėjimo puslapyje.
c_mobile_nr
str(30)
        Rodyti aprašymą Slėpti aprašymą
Pirkėjo mobilaus telefono numeris. Pateikiamas su tarptautiniu kodu.
Pvz.: +37065912387. Jei nurodysite, Pirkėjui, atsiskaitančiam mobiliąja pinigine, nebereikės įvedinėti savo mobilaus telefono numerio OPAY mokėjimo puslapyje.
pass_through_channel_name
str(30)
        Rodyti aprašymą Slėpti aprašymą
Tai nurodymas OPAY sistemai nerodyti mokėjimų pasirinkimo lango, o iškarto nukreipti Pirkėją į norimą atsiskaitymo būdą, pvz.: banklink_swedbank.
Tam, kad šis funkcionalumas suveiktų, parametras c_email negali būti tuščias.
pass_through_only
int(1)
0, 1       Rodyti aprašymą Slėpti aprašymą
Šis parametras gali būti naudojamas tik su parametru pass_through_channel_name.
Standartiškai OPAY sistema veikia taip, kad nepavykus mokėjimui kuriame nors iš mokėjimo būdų, pirkėjas yra grąžinamas į OPAY mokėjimo būdų pasirinkimo langą, o ne atgal į pardavėjo tinklalapį. Taip pirkėjui suteikiama galimybė pasirinkti kitą mokėjimo būdą ar išsiųsti mokėjimą kitam žmogui.
Naudodami parametrą pass_through_only su reikšme 1 (pass_through_only = 1), Jūs nurodote OPAY sistemai, kad sistema naudotų tik mokėjimo būdą, nurodytą parametru pass_through_channel_name. Nepavykus mokėjimui, pirkėjas nebebus grąžinamas į OPAY mokėjimo būdų pasirinkimo puslapį, o bus grąžinamas atgal pas pardavėją, parametre redirect_url nurodytu adresu. Pirkėjas grąžinamas į el. parduotuvę su pranešimu "Atšauktas mokėjimas" (status = 3).
rsa_signature
str(700)
        Rodyti aprašymą Slėpti aprašymą
Parašas, gautas RSA privačiu raktu pasirašius visus siunčiamus duomenis. Tai OPAY rekomenduojamas pasirašymo būdas. Pasirašymo būdai sutariami Sutartyje.
password_signature
str(32)
        Rodyti aprašymą Slėpti aprašymą
Parašas, gautas slaptažodžiu pasirašius visus siunčiamus duomenis.
Slaptažodis yra OPAY suteiktas ir Sutartyje nurodytas unikalus simbolių darinys, žinomas tik OPAY ir Pardavėjui, kuris naudojamas tiek Pardavėjui pasirašant, tiek OPAY tikrinant Pardavėjo parašą ir atvirkščiai, - OPAY pasirašant ir Pardavėjui tikrinant.
Pasirašymo būdai sutariami Sutartyje.