POS-Status-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

Partner által automatikusan indított regisztráció állapotának és bolt paraméterek lekérése

GET /v2/POS/Status

Az alábbi hívással egy erre felhatalmazott partner (pl. SaaS e-commerce szolgáltató, piactér) lekérdezheti a regisztráció állapotát, illetve sikeres regisztráció esetén a kész bolt adatait, és azonnal kezelheti a boltot, fizetéseket.

A gyorsított bolt nyitást a v2/POS/Register API hívással lehet elindítani.

Ha a regisztráció és a bolt nyitás sikeres, a v2/Payment/Start API hívással lehet Barion Smart Gateway fizetéseket indítani, a fizetések indításához szükséges POSKey paramétert a jelen szócikkben bemutatott API hívással lehet megkapni.

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
RegistrationId Guid Kötelező nincs nincs A lekérdezni kívánt regisztráció azonosítója. 88234556-0305-4F6F-DDDD-FFDD44556AA3

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 lekérdezésnél használt regisztráció azonosítóját. 88234556-0305-4F6F-DDDD-FFDD44556AA
RegistrationStatus string A létrejött bolt állapota. Ha sikeresen létrejött a bolt, akkor PREPARED, ha jóvá is hagyták, akkor APPROVED, ha elutasították REJECTED. "PREPARED"
POSKey Guid A létrejött bolt titkos azonosítója, amely a fizetési tranzakciók indítására hatalmazza fel a birtokosát, de pénzügyi tranzakciók indítására vagy egyéb lekérdezésekre nem. 999FFDDA-04FF-333F-CCCC-345FCB555FFC

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.
InvalidRegistration Nem megfelelő RegistrationId, ilyen azonosítóval nem indítottak regisztrációt, vagy nem ez a partner indította, így nem kérdezheti le.

Példák

Folyamat állapotának lekérése

Bemenet

https://api.barion.com/v2/POS/Status?PartnerKey=3B787A6C-0407-426B-9C9A-A5505A5C3EE6&RegistrationId=88234556-0305-4F6F-DDDD-FFDD44556AA3

Kimenet

{
     RegistrationId: "88234556-0305-4F6F-DDDD-FFDD44556AA3",
     RegistrationStatus: "PREPARED"
     POSKey: "999FFDDA-04FF-333F-CCCC-345FCB555FFC"
}

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