| POST | /api/v1/gift/activate | Activates the given gift card with the specified amount. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TransactionAmount | body | decimal | No | The total transaction amount. This is the amount of funds to move on the card |
| Configuration | body | RequestConfiguration | No | Any value included in this section will override the corresponding value set in the triPOS.config |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CardHolderPresentCode | body | CardHolderPresentCode? | No | Defines whether the card holder is present at the transaction. This value is optional, but recommended to be set. If this value is not set in the request, it will be automatically set based on the market code.Allowable Values
|
| ClerkNumber | body | string | No | An optional clerk number for reference. |
| LaneId | body | int | No | Specifies which lane to use. |
| ReferenceNumber | body | string | No | A user defined reference number. This reference number is returned in the response |
| ShiftId | body | string | No | An optional shift id for reference. |
| TicketNumber | body | string | No | An optional ticket number. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowPartialApprovals | body | bool? | No | If set to true, partial approvals are allowed |
| CheckForDuplicateTransactions | body | bool? | No | If set to true, enables duplicate checking logic for the transaction at the host. |
| CurrencyCode | body | CurrencyCode? | No | The currency code of the transaction.Allowable Values
|
| MarketCode | body | MarketCode | No | The market code of the transaction. Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountNumber | body | string | No | The card account number. |
| BalanceAmount | body | decimal | No | The balance of the gift card. |
| BalanceCurrencyCode | body | string | No | The balance currency code. |
| BinValue | body | string | No | The BIN entry that matched the account number. |
| CardLogo | body | string | No | The card logo (e.g. Visa, Mastercard, etc). |
| EntryMode | body | string | No | Description of how card was entered: Keyed, Swiped, Chip. |
| TerminalId | body | string | No | The ID of the terminal used during the transaction |
| TotalAmount | body | decimal | No | The total amount of the transaction. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApprovalNumber | body | string | No | Approval number from the processor. Depending on card type and processor an approval number might not be returned. |
| IsApproved | body | bool | No | Set to true if the host approved the transaction. |
| Processor | body | Processor | No | Response information from the processor. |
| StatusCode | body | TransactionFlowStatus | No | The status code for the transaction.Allowable Values
|
| TransactionDateTime | body | string | No | Transaction date/time in ISO8601 format |
| TransactionId | body | string | No | The transaction ID from the processor |
| MerchantId | body | string | No | The Merchant used to process the transaction. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/ActivateGiftRequest HTTP/1.1
Host: booking.pufferdayspa.com
Content-Type: application/json
Content-Length: length
{"transactionAmount":0,"configuration":{"allowPartialApprovals":false,"checkForDuplicateTransactions":false,"currencyCode":"None","marketCode":"Default"},"cardHolderPresentCode":"Default","clerkNumber":"String","laneId":0,"referenceNumber":"String","shiftId":"String","ticketNumber":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"accountNumber":"String","balanceAmount":0,"balanceCurrencyCode":"String","binValue":"String","cardLogo":"String","entryMode":"String","terminalId":"String","totalAmount":0,"approvalNumber":"String","isApproved":false,"_processor":{"processorLogs":["String"],"processorRawResponse":"String","processorReferenceNumber":"String","processorRequestFailed":false,"processorRequestWasApproved":false,"processorResponseCode":"Unknown","processorResponseMessage":"String","expressResponseCode":"String","expressResponseMessage":"String","hostResponseCode":"String","hostResponseMessage":"String","logs":["String"],"rawResponse":"String"},"statusCode":"None","transactionDateTime":"String","transactionId":"String","merchantId":"String","_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}