| POST | /api/v1/refund/{paymentAccountId} | Creates a new payment account refund based on the passed in parameters. |
|---|
| 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 of the transaction. This amount is added to the TotalAmount before the cardholder is charged |
| PaymentAccountId | path | string | Yes | The payment account ID. |
| TransactionAmount | body | decimal | No | The total transaction amount. This is the amount of funds to move on the card |
| LaneId | body | int | No | Specifies which lane to use for the card sale. |
| ClerkNumber | body | string | No | An optional clerk number for reference. |
| 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 added to the transaction |
| CardLogo | body | string | No | The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other. |
| TerminalId | body | string | No | The ID of the terminal used during the transaction |
| TotalAmount | body | decimal | No | The total amount of the transaction. |
| PaymentAccountId | body | string | No | The payment account ID. |
| PaymentAccountReferenceNumber | body | string | No | The payment account reference number. |
| ReferenceNumber | body | string | No | The reference number. |
| 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/PaymentAccountRefundRequest 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,"paymentAccountId":"String","transactionAmount":0,"laneId":0,"clerkNumber":"String","referenceNumber":"String","shiftId":"String","ticketNumber":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"convenienceFeeAmount":0,"cardLogo":"String","terminalId":"String","totalAmount":0,"paymentAccountId":"String","paymentAccountReferenceNumber":"String","referenceNumber":"String","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"}]}