Articles in this section

Update Card Enquiry Request

Avatar
John Twomey
  • Updated
Follow

Update a request to enquire on the balance of a loyalty / gift card. See the Gift Cards Enquiry sequence diagram for more details.

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

Headers

Field Type Description
Authorization String

Bearer authentication token prefixed with Bearer and a space. See Authentication for more information.
Content-Type String

Request content type, must be 'application/json'
vendor String

The POS vendor name retrieved from Doshii dashboard
doshii-terminal-id String

The hashed Id of a POS Terminal registered within Doshii via the Create POS Terminal endpoint

Parameters

Field Type Description
:request-id String

The ID of the card enquiry request that needs to be updated
eventoptional String

The loyalty card request event - card_enquiry
cardRef String

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

The status of the card balance enquiry. Can be either 'complete' or 'cancelled'.
orderIdoptional String

posId identifying the order this card enquiry relates to
cardAuthorisationKeyoptional String

Any authorisation code required to query the card balance.
cardProviderAuthIdoptional String

The Auth ID issued by the card provider to be provided as part of the request to authorise a card enquiry.
cardProviderAuthPasswordoptional String

The Auth Password issued by the card provider to be provided as part of the request to authorise a card enquiry.
notesoptional String

A free-text field for entering any notes for the card provider.
cancelledReasonoptional String

A free-text field for providing a reason for the request to be cancelled.
logoptional Object

An optional object containing additional log properties you might want to store on the card request. 
  employeeIdoptional String

A Doshii employeeId for the employee making the action
  employeeNameoptional String

The name of the employee making the action
  employeePosRefoptional String

A POS reference for the employee making the action
  deviceRefoptional String

An internal reference for the device at which the request was made
  deviceNameoptional String

A name for the device at which the request was made
  areaoptional String

The area at which the request was made

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
expiryDate String

Date indicating when the card will expire
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

Request

{
    "cardRef": "1234-5678-9012",
    "event": "card_enquiry",
    "status": "cancelled",
    "cancelledReason": "Customer no longer wanted the gift card",
    "orderId": "122",
    "cardAuthorisationKey": "1234",
    "cardProviderAuthId": "username",
    "cardProviderAuthPassword": "password"
}

Response

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

 

Comments

0 comments

Please sign in to leave a comment.