Articles in this section

Get Card Enquiry Request

Avatar
John Twomey
  • Updated
Follow

Retrieve a request to enquire on the balance of a loyalty / gift card.

GET ~/loyalty/cards/enquiry/:request-id

Headers

Field Type Description
doshii-location-id String

The hashed ID of the location you're targeting. See Hashed Location IDs

Parameters

Field Type Description
:request-id String

The ID of the card enquiry request

Response

Field Type Description
id String

Unique number identifying this card balance enquiry request
event String

The event describing this request
type String

The type of card being queried. Currently only supports 'giftcard'.
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
orderId String

Unique number identifying the order this request relates to
reference String

A free-text field for entering external identifiers eg: card enquiry reference no.
amount String

An integer indicating the card balance in cents
notes String

A free-text field for the POS to provide any notes to the card provider
cancelledReason String

A free-text field for the POS or App to provide details on why the request was cancelled/rejected
updatedAt String

Date when the record is last updated
createdAt String

Date when the record is created
uri String

The url to access the card request details
log String

The url to access the card request audit activity
processedByApp String

ID identifying the App that is processing the card request. Will not return if not set.
posTerminalId String

A hashed ID of the POS terminal that is associated to this transaction. Will not return if not set.
requestedAppId String

ID identifying the App that the POS has requested to process this transaction. Will not return if not set.

Examples

Response

{
   "id": "124",
   "type": "giftcard",
   "event": "card_enquiry",
   "orderId": "122",
   "status": "cancelled",
   "cancelledReason": "Customer no longer wanted to use the gift card",
   "requestedAppId": "543",
   "updatedAt": "2018-09-27T04:58:38.485Z",
   "createdAt": "2018-09-27T04:58:38.485Z",
   "uri": "https://sandbox.doshii.co/partner/v3/loyalty/cards/enquiry/124",
   "log": "https://sandbox.doshii.co/partner/v3/loyalty/cards/enquiry/124/logs"
}

 

Comments

0 comments

Please sign in to leave a comment.