Retrieve a request to activate a loyalty / gift card.
GET ~/loyalty/cards/activation/:request-id
Headers
Field | Type | Description |
---|---|---|
Authorization | String |
Bearer authentication token prefixed with |
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 activation request that needs to be updated |
Response
Field | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
id | String |
Unique number identifying this activation request |
||||||||||
event | String |
The event describing this activation request |
||||||||||
type | String |
The type of card being activated. Currently only supports 'giftcard'. |
||||||||||
status | String |
The current status of the request.
|
||||||||||
orderId | String |
Unique number identifying the order this request relates to |
||||||||||
reference | String |
A free-text field for entering external identifiers eg: card activation 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_activate",
"orderId": "122",
"status": "cancelled",
"cancelledReason": "Customer no longer wanted the gift card",
"reference": "1af533-23f342d-2342",
"amount": "2500",
"processedByApp": "543",
"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/activation/124",
"log": "https://sandbox.doshii.co/pos/v3/loyalty/cards/activation/124/logs"
}
Comments
0 comments
Please sign in to leave a comment.