Integratie met eigen RetailVista giftkaart

Dit document beschrijft hoe een integratie gemaakt kan worden met de verkochte giftkaarten in RetailVista. Deze beschrijving bestaat uit twee hoofdonderdelen, het opvragen van giftkaart saldi en het opnemen of afwaarderen van saldi van giftkaarten. Voor deze laatste dient een webshop producent een certificering bij NedFox af te ronden. De reden daarvoor is dat het om verwerking van geldstromen gaat, waarbij een correcte procedurele werking van groot belang is.

Voor beide onderdelen is communicatie met de Retail3000 frontoffice omgeving van belang.  

Communicatie met Retail3000 Frontoffice

Om giftkaarten op te vragen en eventueel te muteren moet er verbinding gemaakt worden met de frontoffice webservices van Retail3000. Deze webservices zijn in principe publiek benaderbaar, standaard zonder IP restricties en via een beveiligde (https) verbinding. De exacte URL verschilt per klant installatie en kunt u opvragen bij NedFox.

Giftkaart functies

De giftkaart functies bevinden zich in de webservice PosComponents.asmx. Elke giftkaart functie werkt met een Request en een Response object.

De volgende functies zijn beschikbaar:

GiftCardResponse GiftCardActivate(GiftCardActivationRequest request)

Deze functie kan gebruikt worden om een giftkaart te activeren met een op te geven saldo. Deze functie mag alleen na certificering gebruikt worden.

GiftCardResponse GiftCardActivateCheck(GiftCardActivationRequest request)

Deze functie kan gebruikt worden om te checken of activeren mogelijk is met een op te geven gewenste saldo. Deze functie activeert de kaart niet maar is uitsluitend bedoeld om na te gaan of de uiteindelijke activering correct zou gaan verlopen. Dit kan gebruikt worden om na een succesvolle check de bijbehorende betaling uit te laten voeren waarna de giftkaart definitief geactiveerd wordt.

GiftCardResponse GiftCardWithdrawCheck(GiftCardWithdrawalRequest request)

Deze functie kan gebruikt worden om te checken of een afwaardering van de giftkaart met een op te geven saldo correct zou gaan verlopen. Deze functie kan gebruikt worden in een betaal cyclus eerst te controleren of een giftkaart voldoende saldo heeft.

GiftCardResponse GiftCardInfo(GiftCardRequest request)

Deze functie geeft alle beschikbare giftkaart informatie terug zoals het saldo, vervaldatum, aantal reeds uitgevoerde transacties etc.

GiftCardResponse GenerateReturnGiftCard(GiftCardActivationRequest request)

Deze functie kan gebruikt worden om een retour giftkaart te genereren als gevolg van artikelen die terug gekomen zjin. Een retour giftkaart kan verschillen van een normale giftkaart omdat er speciale retour definities ingesteld worden in RetailVista zoals geldigheidsduur etc.

GiftCardResponse GiftCardWithdraw(GiftCardWithdrawalRequest request)

Deze functie kan gebruikt worden om een op te geven saldo van een giftkaart af te waarderen.

De volgende Request objecten zijn beschikbaar:

GiftCardActivationRequest:GiftCardRequest

Dit is een object wat gebruikt kan worden voor het activeren van een nieuwe giftkaart.

GiftCardWithdrawalRequest:GiftCardRequest

Dit is  een object wat gebruikt kan worden voor het afwaarderen van saldo van een giftkaart.

GiftCardRequest

Dit is een object wat gebruikt kan worden om informatie over een giftkaart op te vragen.

GiftCardCredentials

De volgende Response objecten zijn beschikbaar:

GiftCardResponse

Alle giftkaart functies gebruiken hetzelfde retour response object als antwoord op een giftkaart functie.

GiftCardResult

Enum GiftCardResultStatus

NotSpecified,

Success,

CreditException,

CardException,

ServerException

Enum GiftCardResultExceptionCode

NotSpecified,

InsufficientBalance,

MaxTransactionsReached,

CardNotFound,

CardExpired,

CardBlocked,

CardNotActivated,

CardAlreadyActivated,

InvalidVerificationCode,

InvalidCredentials,

InvalidBalance,

InvalidCardStatus

GiftCardServiceObjectInfo

Enum GiftCardServiceObjectStatus

NotSpecified = 0,

Active = 1,

Blocked = 2,

NotActivated = 3,

GiftCardReference