Integratie met eigen RetailVista giftkaart
  • 10 Mar 2024
  • 3 Minuten te lezen
  • Bijdragers
  • Donker
    Licht
  • Pdf

Integratie met eigen RetailVista giftkaart

  • Donker
    Licht
  • Pdf

Samenvatting van het artikel

<span class="fr-marker" data-id="0" data-type="true" style="display: none; line-height: 0;"></span><span class="fr-marker" data-id="0" data-type="false" style="display: none; line-height: 0;"></span<span class="fr-marker" data-id="0" data-type="true" style="display: none; line-height: 0;"></span><span class="fr-marker" data-id="0" data-type="false" style="display: none; line-height: 0;"></span<span class="fr-marker" data-id="0" data-type="true" style="display: none; line-height: 0;"></span><span class="fr-marker" data-id="0" data-type="false" style="display: none; line-height: 0;"></span>

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.

Balance

Decimal

Opwaardeer bedrag op nieuwe giftkaart

GiftCardWithdrawalRequest:GiftCardRequest

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

Withdrawal

Decimal

Af te waarderen bedrag

GiftCardRequest

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

RequestId

Int32

Unieke waarde, response object geeft deze waarde weer terug zodat duidelijk is welke response bij welk request hoort

CardNumber

Int64

Giftkaartnummer

VerificationCode

String

Als bij de giftkaart een verificatiecode opgegeven is als extra veiligheid, dan moet die code worden meegegeven om toegang te krijgen tot die giftkaart

Reference

Reference

Te vermelden referentie in geval van transacties

Credentials

GiftCardCredentials

Autorisatie object

GiftCardCredentials

MerchantUsername

String

Retail3000 gebruikersnaam

MerchantPassword

String

Retail3000 wachtwoord

CompanyNumber

Int32

Retail3000 bedrijf nummer

StoreNumber

Int16

Retail3000 vestiging nummer

PosTerminalNumber

Int16

POS terminal nummer waar mutatie op plaats vindt

De volgende Response objecten zijn beschikbaar:

GiftCardResponse

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

RequestId

Int32

Deze response is antwoord op request met deze RequestId waarde

Result

GiftCardResult

Resultaat van request

CardInfo

GiftCardServiceObjectInfo

Giftkaart info

Reference

GiftCardReference

Retail3000 referentie op saldo mutatie

GiftCardResult

Status

<enum>GiftCardResultStatus

Resultaat status

ExceptionCode

<enum>GiftCardResultExceptionCode

Foutmelding code, NotSpecified indien geen fout

Message

String

Toelichting tekst op resultaat

Enum GiftCardResultStatus

NotSpecified,

Success,

CreditException,

CardException,

ServerException

 

Enum GiftCardResultExceptionCode

NotSpecified,

InsufficientBalance,

MaxTransactionsReached,

CardNotFound,

CardExpired,

CardBlocked,

CardNotActivated,

CardAlreadyActivated,

InvalidVerificationCode,

InvalidCredentials,

InvalidBalance,

InvalidCardStatus

 

GiftCardServiceObjectInfo

GiftCardTypeId

Int32

Primary key GiftCardTypes tabel

CustomerId

Int32

Primary key Customers tabel

CardNumber

Int64

Giftkaart nummer

VerificationCode

String

Verificatie code van giftkaart

Status

<enum>GiftCardServiceObjectStatus

Status van de giftkaart

InitialBalance

Decimal

Initiele giftkaart waarde

Balance

Decimal

Actuele giftkaart waarde

TransactionsRemaining

Int32

Aantal nog mogelijke transacties

ExpiryDate

DateTime

Vervaldatum van de giftkaart

Enum GiftCardServiceObjectStatus

NotSpecified = 0,

Active = 1,

Blocked = 2,

NotActivated = 3,

 

GiftCardReference

TransactionId

Int32

Door Retail3000 toegekend transactie ID

 


 

 


Was dit artikel nuttig?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.