POS-Register-v2

A Barion wikiből
  • Tervezet
  • Üzlet
  • Informatika
  • Pénzügy
  • Jog
  • 50%
  • Online elfogadó
  • Mobil elfogadó
  • Pénztárgép
  • Feltöltés
  • Piactér
  • Nonprofit
  • Parkolas

Bolt és bolt tulajdonos Barion felhasználó létrehozásának indítása

POST /v2/POS/Register

Az alábbi hívással egy erre felhatalmazott partner (pl. SaaS e-commerce szolgáltató, piactér) regisztrációt és bolt nyitás indíthat, átadva a felhasználó és boltja adatait, a fizetés működéséhez szükséges technikai paramétereket (pl. visszahívási URL), valamint validált e-mail címet.

Az adatokat a Barion egy külön e célra létrehozott űrlapon jeleníti meg, ahol a titkos jelszó és biztonsági kérdés és a kondíciók elfogadása után a felhasználó egy gombbal regisztrálhat és boltot is nyithat. Az e-mail címen kívül minden átírható. A regisztráció nem igényel külön e-mail validálást, ha az űrlap hibátlanul van kitöltve, a regisztráció és bolt nyitás azonnal végbe megy, és a felhasználót visszairányítja a Barion a partner által megadott URL-re.

Ezt követően a partner lekérdezheti a már kész bolt adatait, és azonnal kezelheti a boltot, fizetéseket. A kész bolt adatait a v2/POS/Status API hívással lehet lekérdezni.

Mivel a bolt által validált e-mail címeket használunk, a visszaélések elkerülése végett ezt az API-t csak erre külön felhatalmazott partner hívhatja meg, titkos partner kulcsával. Partner kulcsért keresse munkatársainkat a Barion ügyfélszolgálaton.

A boltokat és egyéb elfogadókat a Barion API-ban egységesen POS-nak nevezzük, a nemzetközileg elterjedt Point of Sale, azaz az értékesítés helye elnevezésből. Ilyen szempontból az adakozás gyűjtő szervezet is POS-nak minősül.

Bemenet

Mező neve Mező típusa Kötelező Megkötések Alapértelmezett érték Leírás Formátum / Példa
PartnerKey Guid Kötelező nincs nincs A regisztrációt kezdeményező partner titkos azonosítója. 3B787A6C-0407-426B-9C9A-A5505A5C3EE6
ReferalCode string Opcionális Létező meghívó kód nincs A létrejövő Barion regisztráció meghívója "123456789"
PartnerReturnUrl string Kötelező URL nincs A lekérdezni kívánt regisztráció azonosítója. "https://partner.example.com/shopconfig"
ValidatedEmailAddress string Kötelező nincs nincs A bolthoz tartozó Barion azonosítóként szolgáló validált e-mailcím gizmoshop@example.com
POS POS kötelező nincs nincs A bolt adatai, különösen azok, amelyek a fizetés működéshez szükségesek POS
POSOwner PosOwner opcionális nincs nincs A bolt tulajdonosainak adatai, lehet magánszemély vagy cég, csak a releváns rész kerül feldolgozásra PosOwner

Kimenet

A kimenet minden hívás esetén hasonló felépítésű. Amennyiben sikeres hívás történt az Error hibatömb üresen érkezik. Ha hiba történt, akkor a hibatömbben láthatóak ezek a hibák, de ilyen esetben csak a hibákat tartalmazó tömb érkezik a hívóhoz.

Sikeres

Mező Típus Leírás Formátum / Példa
RegistrationId Guid Visszakapjuk a regisztráció azonosítóját, amellyel később az állapotát és a fizetés indításához szükséges POSKey-t lekérdezhetjük. 88234556-0305-4F6F-DDDD-FFDD44556AA
RegistrationStatus string A létrejött bolt állapota. Ha sikeresen létrejött a bolt, akkor PREPARED. "PREPARED"

Sikertelen

Hiba esetén a válasz egy hibalistát ad vissza. Ebben megtalálhatóak az előforduló hibák. A lista formátuma:

{
    Errors: [
        {
            ErrorCode: "",
            Title: "",
            Description: ""
        }
    ]
}
Hiba kódja Hiba leírása
InvalidPartnerKey A titkos PartnerKey nem megfelelő, nem indíthat regisztrációt.

Példák

Regisztrációs folyamat indítása cég részére

Automatikus bolt nyitás és regisztráció indítása a Gizmo Inc. elnevezésű cég Gizmo Shop nevű boltjának.

Bemenet

{
    PartnerKey: "3B787A6C-0407-426B-9C9A-A5505A5C3EE6",
    ReferalCode: "123456789",
 
    PartnerReturnUrl: "https://partner.example.com/shopconfig",
 
    ValidatedEmailAddress: "gizmoshop@example.com",
 
    POS: {
        Name: "Gizmo Shop",
        Description: "Selling gizmos, such as toys and mobile phone accessories",
        POSUrl: "http://shop.example.com",
        CallbackUrl: "http://shop.example.com/callback",
        RedirectUrl: "http://shop.example.com/returnfrompayment",
        POSAvatarUrl: "https://shop.example.com/avatar/gizmo.png"
    },
 
    POSOwner: {
        Type: "ORGANIZATION",
        Name: "Gizmo Inc.",
        CountryCode: "HU",
        City: "Budapest",
        Zip: "1117",
        Street: "Infopark sétány",
        Number: "1",
        RepFirstName: "Zalán",
        RepLastName: "Horváth"
    },
}

Kimenet A kimenet minden esetben az indított regisztráció azonosítója, vagy hibaüzenet.

{
     RegistrationId: "88234556-0305-4F6F-DDDD-FFDD44556AA3"
     RegistrationStatus: "PREPARED"
}

Átirányítás a kimenet alapján Sikeres regisztráció indítás után a bolt tulajdonost át kell irányítani a Barion gyorsított regisztrációs oldalára, átadva az előző API hívásnál kapott regisztráció azonosítót.

https://secure.barion.com/POS/Register?RegistrationId=88234556-0305-4F6F-DDDD-FFDD44556AA3

Regisztrációs folyamat indítása magánszemély részére

Automatikus bolt nyitás és regisztráció indítása a Kovács Péter magánszemély Gizmo Shop nevű boltjának. A regisztráció további menet azonos a cégnél leírtakkal.

{
    PartnerKey: "3B787A6C-0407-426B-9C9A-A5505A5C3EE6",
    ReferalCode: "123456789",
 
    PartnerReturnUrl: "https://partner.example.com/shopconfig",
 
    ValidatedEmailAddress: "gizmoshop@example.com",
 
    POS: {
        Name: "Gizmo Shop",
        Description: "Selling gizmos, such as toys and mobile phone accessories",
        POSUrl: "http://shop.example.com",
        CallbackUrl: "http://shop.example.com/callback",
        RedirectUrl: "http://shop.example.com/returnfrompayment",
        POSAvatarUrl: "https://shop.example.com/avatar/gizmo.png"
    },
 
    POSOwner: {
        Type: "NATURALPERSON",
        FirstName: "Péter",
        LastName: "Kovács",
        BirthYear: "1978"
    },
}

Hívás minimum információval

A hívásnál ezek a mezők minimálisan kötelezőek:

{
    PartnerKey: "3B787A6C-0407-426B-9C9A-A5505A5C3EE6",
 
    PartnerReturnUrl: "https://partner.example.com/shopconfig",
 
    ValidatedEmailAddress: "gizmosho@example.com",
 
    POS: {
        POSUrl: "http://shop.example.com",
        RedirectUrl: "http://shop.example.com/returnfrompayment",
    },
}

A példában szereplő azonosítók

  • PartnerKey, a regisztrációt végző partner titkos azonosítója: 3B787A6C-0407-426B-9C9A-A5505A5C3EE6
  • A példa regisztráció RegistrationId azonosítója: 88234556-0305-4F6F-DDDD-FFDD44556AA3
  • A megnyitott bolt titkos POSKey azonosítója: 999FFDDA-04FF-333F-CCCC-345FCB555FFC