RICHTLIJNEN EN BESTANDEN
'BEWAAR IN OK' BUTTON

OK CARD is a service that allows consumers to add their existing loyalty cards, giftcards, coupons and tickets to their OK app. Cards are added to the OK app by scanning the barcode printed on the card or by taking pictures of the card. OK maintains a list of specific and generic card presets and customers can request their own card presets.

Creating the deep-link

The ‘Add to OK’ link gives consumers an easy way to add cards to their OK App for which they do not have a physical card. This allows card issuers, such as merchants, ticketing service providers, loyalty service providers, to promote adding loyalty cards to the OK App from marketing communications, such as: emails, their e-commerce apps or other dynamic and static media.

The ‘Add to OK’ link can be constructed by adding the identifier of the card preset and the card number / barcode value to a URL. That URL can then be published online as a link or offline as a QR code. Additionally other card meta-data can be added to the link as well as some tracking information.

When a user opens the link on their mobile device with the OK App installed, the card is immediately added to their OK App. If the user does not have the OK App installed, a landing page is shown that invites the user to download and install it. After that, the user is directed to the Apple App Store or Google Play Store. After installing the app, the card is automatically added.

When the user opens the link on a desktop browser, a landing page is shown. If the user has the OK App installed, they can use it to scan the QR code presented to them. The same QR code could also be printed.

Query paramaters

The ‘Add to OK’ link can have the following formats:

https://open.ok.app/cards/add?cp=1234

https://open.ok.app/cards/add?cp=1234&utm_source=pos

https://open.ok.app/cards/add?cp=1234&bc=1234567891234&bt=EAN_13

https://open.ok.app/cards/add?cp=1234&bc=1234567891234&bt=CODE_128&pc=234567

https://open.ok.app/cards/add?cp=1234&bc=1234567891234&bt=CODE_128&pc=234567&ed=31-12-2024&df=dd-MM-yyyy&ba=21,00

The following parameters are available for all card preset types:

• cp – STRING – Identifier of the card preset
• bc – STRING – Barcode value of the specific card
• bt – STRING – Barcode type (required if no barcode type is configured on the card preset)
• na – STRING – (optional) Name of the card E.g. ‘Bonuskaart van Anna’

For gift card presets the following parameter are available:

• pc – STRING – Pin code for the giftcard
• ed – STRING – Expiration date/time of the gift card (default format is ISO8601)
• df – STRING – Alternative format of the expiration data/time, must be set if the ed value is not formatted using the default format
• ba – STRING – Balance of the gift card. Both dot and comma are allowed decimal separators.

For coupons / discount codes the following parameters are available:

• de – STRING – Description of the campaign
• co – STRING – Conditions of the campaign
• dc – STRING – Additional discount code
• wu – STRING – Web shop URL
• sd – STRING – Start date/time of the validity of the coupon (default format is ISO8601)
• ed – STRING – Expiration date/time of the validity of the coupon (default format is ISO8601)
• df – STRING – Alternative format of the start/expiration data/time, must be set if the ed value is not formatted using the default format

For tracking:

• utm_campaign – STRING – (optional) Marketing campaign information
• utm_medium – STRING – (optional) Marketing campaign information
• utm_source – STRING – (optional) Marketing campaign information
• utm_content – STRING – (optional) Marketing campaign information

Notes:

• Barcode type values: AZTEC,CODABAR,CODE_39,CODE_93,CODE_128,DATA_MATRIX,EAN_8,EAN_13,ITF,MAXICODE,PDF_417,QR_CODE,RSS_14,RSS_EXPANDED,UPC_A,UPC_E,UPC_EAN_EXTENSION,STRING,NONE
• Date/time format syntax according to Unicode Technical Standard #35)
• Query parameters must appear in the specified order
• All values must be URL encoded
• Identifier of the card preset can be obtained through your account manager
• dc is intended to be used if a barcode and discount should be combined on a single card, otherwise use barcode type STRING and the bc parameter