Upon Card enquiry request – Doshii Guide

When a new card enquiry request is created

EVENT card_enquiry

Parameters

Field

Type

Description

String

Unique number identifying the card enquiry request

locationId

String

Unique hashed id for this Location. See Hashed Location IDs

status

String

The current status of the request.

status	description
pending	POS requests a balnce enquiry for card
cancelled	POS or Partner has cancelled the request
complete	The Partner has confirmed the card details and provided the card balance information back to the POS

uri

String

The card enquiry request details url

posTerminalId

String

A hashed ID of the POS terminal that is associated to this card enquiry request. Will not return if not set.

requestData

Object

An optional list of properties that support the card enquiry request. Will not be included in the event if not set. This information will only be available via the event, it cannot be retrieved at a later date from the card enquiry request.

cardRef

String

The unique card number (typically printed on the card).

cardAuthorisationKey

String

An authorisation code that is associated to the card to allow the POS to enquire on the card balance. This could take the form of the secure pin code on the back of a gift card, or a passphrase required by venue staff, etc.

amount

String

An integer indicating the amount in cents that the POS believes is remaining on the card.

cardProviderAuthId

String

The Auth ID issued to the POS/venue by the card provider to authorise the request.

cardProviderAuthPassword

String

The Auth Password issued to the POS/venue by the card provider to authorise the request.

Example

Event

{
    "event": "card_enquiry",
    "data": {
        "id": "1354",
        "locationId": "aH43yx2",
        "status": "pending",
        "posTerminalId": "23fd46",
        "requestData": {
            "cardRef": "1234-5678-9012",
            "cardAuthorisationKey": "1234",
            "cardProviderAuthId": "username",
            "cardProviderAuthPassword": "password"
        }
        "uri": "https://sandbox.doshii.co/partner/v3/loyalty/cards/enquiry/1354"
    }
}