Creates a new user, associates it with the given member ids and links it with the given linkedMemberIds

Lookup a user based on a provided member Id. This endpoint will return all relevant information on the user like memberIds, points (if enabled), coupons (if enabled) and linked users (if enabled).

Deletes the user on the specified memberId. Deleting a user will delete all cards, coupons, points, etc. associated with the user. This operation cannot be undone.

Add/remove member ids and add/remove linked users

Lookup a user based on token. This endpoint keeps the footprint small and will only return the most basic user and card information.

Lookup a user based on a provided token. This endpoint will return all relevant information on the user like memberIds, points (if enabled), coupons (if enabled) and linked users (if enabled).

Like the get user endpoint this endpoint returns the user found, based on the provided token. In addition, this endpoint will also return all directly linked members complete with coupons, points etc.

Like the get user endpoint this endpoint returns the user found, based on the provided member id. In addition, this endpoint will also return all directly linked members complete with coupons, points etc.

For online card registration via web or a smartphone app, a Storebox provided PCI-DSS compliant webpage must be used to comply with international card issuer standards. This webpage can be integrated with an existing webpage using an iframe or a mobile app by using a webview.

The flow can be seen in the following Figure:

Upon completed card registration Storebox can send a notification.

Strong Customer Authentication

To have Strong Customer Authentication (SCA) like 3D Secure activated contact Storebox.

If SCA is enabled, a declineurl must also be provided, when loading the cardframe. The SCA flow will start automatically after the card submit and will redirect the user through the relevant verification flow.

Only if the SCA flow is successfull will the card be added to Storebox and the user will be redirected to the accept URL. If the flow for some reason is unsuccessfull the user will be redirected to the decline URL.

Basic example

Server-side you generate the cardframe URL with all parameters (salt must never fall in the hands of client) and provide it to the client.

A quick demo can be had via https://developer.storebox.com/frame/index.html

Example data:

• id="yourcustomerid"
• accepturl="https://developer.storebox.com/frame/accepted.html"
• declineurl="https://developer.storebox.com/frame/declined.html"
• callbackurl="https://storebox.com"
• cssurl="https://developer.storebox.com/frame/assets/card.css?v=5"
• languageurl="https://developer.storebox.com/frame/assets/lang.json?v=6"
• provider="yourproviderid" (Provided by Storebox)
• salt="4H8r63CSEYvbdJarNpF7" (Provided by Storebox. Must never be available clientside)

Hash generation: md5(id + accepturl + declineurl + callbackurl + cssurl + languageurl + salt) md5 -s yourcustomeridhttps://developer.storebox.com/frame/accepted.htmlhttps://developer.storebox.com/frame/declined.htmlhttps://storebox.comhttps://developer.storebox.com/frame/assets/card.css?v=5https://developer.storebox.com/frame/assets/lang.json?v=64H8r63CSEYvbdJarNpF7

Final URL with proper URL encoded parameters, provider and hash that is provided to client: https://test-loyalty.storebox.com/v2/cards/url?id=yourcustomerid1&accepturl=https%3A%2F%2Fdeveloper.storebox.com%2Fframe%2Faccepted.html&declineurl=https%3A%2F%2Fdeveloper.storebox.com%2Fframe%2Fdeclined.html&callbackurl=https%3A%2F%2Fstorebox.com&cssurl=https%3A%2F%2Fdeveloper.storebox.com%2Fframe%2Fassets%2Fcard.css%3Fv%3D5&languageurl=https%3A%2F%2Fdeveloper.storebox.com%2Fframe%2Fassets%2Flang.json%3Fv%3D6&provider=yourproviderid&hash=1045d4756af23a321429ae55766bd15d

Result in browser

Styling

The card frame is styled via the CSS specified in the cssurlparameter in the initial call.

The stylesheet is cached and is only downloaded if the URL changes. For this reason a version parameter can be used in the cssurl, for example https://.../style.css?v=1. Please refrain from using a constantly changing parameter, like a timestamp.

This is the Card Frame HTML structure that can be styled:

<form class="">
  <div class="field field-input">
    <div class="field-label">Kortnummer</div>
    <input type="tel" value="" placeholder="Kortnummer" name="CardNumber" id="CardNumber" autocomplete="off" required="" class="">
    <span class="field-validation-error">Ugyldigt kortnummer</span>
  </div>
  <div class="field field-input">
    <div class="field-label">Udløbsmåned</div>
    <input type="tel" value="" placeholder="Indtast udløbsmåned" name="ExpMonth" id="ExpMonth" autocomplete="off" required="" maxlength="2" class="">
    <span class="field-validation-valid"></span>
  </div>
  <div class="field field-input">
    <div class="field-label">Udløbsår</div>
    <input type="tel" value="" placeholder="Indtast udløbsår" name="ExpYear" id="ExpYear" autocomplete="off" required="" maxlength="2" class="">
    <span class="field-validation-valid"></span>
  </div>
  <div class="field field-btn">
    <input type="submit" value="Gem kort" class="button" id="submit" name="add" disabled="disabled">
  </div>
</form>

<div class="generalError">
</div>

<div class="maxCards">
</div>

JSON language file

A JSON file specified in languageurl configures the text displayed in the card input. The file contains a translation label and value like in the following example. The language file must be provided in UTF-8.

{
  "expMonth": {
    "errorInvalid": "Skal være mellem 1 og 12",
    "label": "Udløbsmåned",
    "placeholder": "Indtast udløbsmåned"
  },
  "expYear":{
    "label": "Udløbsår",
    "placeholder": "Indtast udløbsår",
    "errorExpired":"Kortet er udløbet"
  },
  "error":{
    "generalError":"Der skete en fejl. Prøv venligst igen",
    "maxCards":"Du kan ikke tilføje flere kort"
  },
  "btn":{
    "save":"Gem kort"
  },
  "card":{
    "errorInvalid":"Ugyldigt kortnummer",
    "unsupportedType":"Denne korttype kan ikke bruges",
    "unsupportedBinRange":"Dette kortnummer kan ikke bruges",
    "label":"Kortnummer",
    "placeholder":"Indtast kortnummer",
    "duplicate":"Kortet er allerede registreret"
  }
}

The text values are cached and are only downloaded if the URL changes. For this reason a version parameter should be used in the languageurl, for example https://.../en.json?v=1. Please refrain from using a constantly changing parameter, like a timestamp.

Card Created Notification

When a card has been fully processed a callback (GET) will happen if the callbackUrl parameter was defined on initial cardframe request.

A call to list cards is only guaranteed to include a newly created card after the notification has been sent. Under some circumstances a notification may be sent more than once. The notification will be sent as a server to server GET request and is documented under 'Callbacks' below.

The callback does not act upon the responses sent from the callbackurl endpoint. I.e. a redirect will not be followed.

Returns a list of cards registered to the user

If existing cards are stored in Storebox, which have not yet been verified by 3DS, this endpoint can be used to start the 3DS flow.

The card owner must complete the authentication, so this endpoint will redirect and start the 3DS flow. The endpoint integration must therefore be from a browser or webview like the card frame.

After a successful completion the card will be marked as verified.

Deletes the card referenced by cardId. This also deletes the card in the PCI-DSS environment and cannot be undone.

Update the name of the card. Emojis are not supported.

Verifies that an activation code is known. This may be done before starting a signup flow.

Enroll the pending card and enable it to be lookup up

Returns all user coupons, that are not in authorized state

Assigns a coupon as defined in the request to the member referenced by the token.

Returns all the coupons to a user. Before the coupons are returned they are all authorized, so they are ready to be captured or cancelled. Please note! Authorized coupons (or usages on multi-use coupons) are locked until the authorizations have been either cancelled or captured or a 3 hour window has passed and the authorization is auto cancelled.

Assign multiple coupons as defined in the request to multiple users. Each user in the list will be given coupons based on the contents of the couponTemplates in the request.

Please note that the term couponTemplates in this context is literal and refers only to the request data as templates for issuing coupons for that specific request. It is not a reference to the Coupon Template concept and endpoints and no template is persisted in any way. Use the 'create coupon template' method in case a persisted template is desired, from which coupons can be assigned at any time.

Endpoint to delete a specific coupon. This cannot be undone.

Authorize/reserve a coupon to avoid simultaneous uses of the same coupon.

An authorization attempt will fail if:

• The coupon is already authorized (incl. multiuse/unlimited coupons)
• An authorization is attempted before startDate or after expiryDate.

Endpoint for capturing or cancelling multiple coupons in a single request.

• A capture will remove the coupon from the user (or deduct a usage).
• A cancel will remove the reservation on the coupon and make it available for another authorization.

If you do not want to authorize a coupon before using it, this endpoint allows for capturing a coupon that has not been authorized.

This may be because the presence of a coupon simply marks the user as being a certain kind of user (premium/platin/etc.), so mutual exclusion is not an issue.

Capturing the coupon allows Storebox to collect statistics about the usage.

Creates a new template. Once a template is created, progress for individual users can be registered towards its progress goal, it can be assigned on signup or it can be used to directly assign coupons to users.

Get all Coupon Templates

Update an existing Coupon Template

Delete a Coupon Template

Get a specific Coupon Template

Using templateId to reference a coupon template and register user progress towards a coupon. Once the progressGoal is reached a coupon is automatically assigned to the user. Progress counts up by the registered progress. Progress and issuing of coupons is cyclic. If the registered progress exceeds progressGoal then any leftover progress goes towards next coupon.

Example: progressGoal is 5. Current progress is 4. Registering progress of 3 will assign a coupon and the progress is now 2.

Using campaignCode to reference a coupon template and register user progress towards a coupon. Once the progressGoal is reached a coupon is automatically assigned to the user. Progress counts up by the registered progress. Progress and issuing of coupons is cyclic. If the registered progress exceeds progressGoal then any leftover progress goes towards next coupon.

Example: progressGoal is 5. Current progress is 4. Registering progress of 3 will assign a coupon and the progress is now 2.

Get all progress information on a specific member.

Assign a single coupon based on a Coupon Template to a single user

Assign coupon to all users based on a specific template

Set extra information as name/value pairs on a template. The name/value pairs are returned in coupons created be the referenced template. If a metatdata name already exists, it is overriden with the new value.

Creates a new assignment filter for the coupon template. When assigning a coupon based on a template, the filter is used to ensure that the users metadata qualifies for the coupon. Currently only 'country' is supported.

Get all filters for the template

Delete all filters for the template

Delete specific filters to the template

Get the available points from the default point bank. The points available equals to: sum in point bank - authorized points.