| POST | /api/v1/refund | Creates a new card refund based on the passed in parameters. | Creates a new card refund based on the passed in parameters. More» |
|---|---|---|---|
| POST | /api/v1/credit | [Deprecated] Use /api/v1/refund instead. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Configuration | body | RequestConfiguration | No | Any value included in this section will override the corresponding value set in the triPOS.config |
| ConvenienceFeeAmount | body | decimal | No | The convenience fee amount. |
| TransactionAmount | body | decimal | No | The total transaction amount. This is the amount of funds to move on the card |
| 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 |
|---|---|---|---|---|
| ConvenienceFeeAmount | body | decimal | No | The convenience fee amount. |
| Emv | body | Emv | No | The fields used on the receipt for an EMV transaction. Null if the transaction was not EMV. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountNumber | body | string | No | The card account number. |
| BinValue | body | string | No | The BIN entry that matched the account number. |
| CardHolderName | body | string | No | The card holder name. |
| CardLogo | body | string | No | The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other. |
| CurrencyCode | body | CurrencyCode | No | The currency code used in the transaction.Allowable Values
|
| EntryMode | body | string | No | Description of how card was entered.Allowable Values |
| ExpirationYear | body | string | No | The card's expiration year |
| ExpirationMonth | body | string | No | The card's expiration month |
| PaymentType | body | PaymentType | No | Description of payment type utilized.Allowable Values
|
| PinVerified | body | bool | No | True if the PIN was verified, false if not verified or undetermined. |
| Signature | body | Signature | No | The signature data. |
| 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 |
|---|---|---|---|---|
| ApplicationIdentifier | body | string | No | The Application Identifier also known as the AID. Identifies the application as described in ISO/IEC 7816-5. Printed receipts are required to contain the AID as hexadecimal characters. |
| ApplicationLabel | body | string | No | Mnemonic associated with the AID according to ISO/IEC 7816-5. If the Application Preferred Name is not available or the Issuer code table index is not supported, then the Application Label should be used on the receipt instead of the Application Preferred Name. |
| ApplicationPreferredName | body | string | No | Preferred mnemonic associated with the AID. When the Application Preferred Name is present and the Issuer code table index is supported, then this data element is mandatory on the receipt. |
| Cryptogram | body | string | No | The EMV cryptogram type and value. It is a preferred best practice to include this data element on the receipt, but is not mandatory. This field contains cryptogram type followed by the cryptogram value. |
| Tags | body | List<Tag> | No | A name value collection of additional EMV tags that are required to appear on the receipt. |
| IssuerCodeTableIndex | body | string | No | Indicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | body | string | No | |
| Value | body | string | No |
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/RefundRequest HTTP/1.1
Host: booking.pufferdayspa.com
Content-Type: application/json
Content-Length: length
{"configuration":{"allowPartialApprovals":false,"checkForDuplicateTransactions":false,"currencyCode":"None","marketCode":"Default"},"convenienceFeeAmount":0,"transactionAmount":0,"cardHolderPresentCode":"Default","clerkNumber":"String","laneId":0,"referenceNumber":"String","shiftId":"String","ticketNumber":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"convenienceFeeAmount":0,"emv":{"applicationIdentifier":"String","applicationLabel":"String","applicationPreferredName":"String","cryptogram":"String","tags":[{"key":"String","value":"String"}],"issuerCodeTableIndex":"String"},"accountNumber":"String","binValue":"String","cardHolderName":"String","cardLogo":"String","currencyCode":"None","entryMode":"String","expirationYear":"String","expirationMonth":"String","paymentType":"None","pinVerified":false,"signature":{"data":"AA==","format":"String","statusCode":"Unknown"},"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"}]}