| POST | /api/v1/authorization/{transactionId}/completion | Updates a previous card authorization with the final totals. | This completes the original authorization and initiates and exchange of funds. The transactionId is the value returned by the original authorization. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TransactionId | path | string | Yes | The ID of a previous authorization transaction. |
| Address | body | Address | No | The cardholder address information for the transaction. |
| 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 |
| TipAmount | body | decimal | No | The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged. |
| TransactionAmount | body | decimal | No | The total transaction amount. This is the amount of funds to move on the card |
| Healthcare | body | Healthcare | No | The healthcare section that contains all applicable healthcare-qualified amounts. more» |
| Lodging | body | LodgingTransactionCompletion | No | The lodging parameters to be passed in for a lodging transaction. more» |
| 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 |
|---|---|---|---|---|
| BillingAddress1 | body | string | No | The street address used for billing purposes. |
| BillingAddress2 | body | string | No | The street address used for billing purposes. |
| BillingCity | body | string | No | The name of the city used for billing purposes. |
| BillingEmail | body | string | No | The e-mail address used for billing purposes. |
| BillingName | body | string | No | The name used for billing purposes. |
| BillingPhone | body | string | No | The phone number used for billing purposes. The recommended format is (800)555-1212. |
| BillingPostalCode | body | string | No | The postal code used for billing purposes. |
| BillingState | body | string | No | The name of the state used for billing purposes. This value may be any 2 character state code or the full state name. |
| ShippingAddress1 | body | string | No | The street address used for shipping purposes. |
| ShippingAddress2 | body | string | No | The street address used for shipping purposes. |
| ShippingCity | body | string | No | The name of the city used for shipping purposes. |
| ShippingEmail | body | string | No | The e-mail address used for shipping purposes. |
| ShippingName | body | string | No | The name used for shipping purposes. |
| ShippingPhone | body | string | No | The phone number used for shipping purposes. The recommended format is (800)555-1212 |
| ShippingPostalCode | body | string | No | The postal code used for shipping purposes. |
| ShippingState | body | string | No | The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name. |
| 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 |
|---|---|---|---|---|
| Total | body | decimal? | No | The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present. |
| Clinic | body | decimal? | No | The total amount of healthcare-qualified goods that fall into the category of 'clinic'. |
| Dental | body | decimal? | No | The total amount of healthcare-qualified goods that fall into the category of 'dental'. |
| Prescription | body | decimal? | No | The total amount of healthcare-qualified goods that fall into the category of 'prescription'. |
| Vision | body | decimal? | No | The total amount of healthcare-qualified goods that fall into the category of 'vision'. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerName | body | string | No | The lodging customer name. |
| AgreementNumber | body | string | No | The lodging agreement number. |
| CheckInDate | body | string | No | The check-in date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD. |
| CheckOutDate | body | string | No | The check-out date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD. |
| RoomAmount | body | decimal | No | The nightly rate for one room. |
| NoShow | body | bool | No | Set to true to indicate no show. Otherwise, value defaults to false. |
| Duration | body | int | No | The number of hotel stay days. Set to 1 for no show. |
| ExtraChargesDetail | body | LodgingExtraChargesDetail[] | No | Pass in up to 6 values that describe the extra charges. If not passed in, this value defaults to NotUsed.Allowable Values
|
| PrestigiousPropertyCode | body | LodgingPrestigiousPropertyCode | No | The lodging prestigious property code. If not passed in, this value defaults to NonParticipant.Allowable Values
|
| SpecialProgramCode | body | LodgingSpecialProgramCode | No | The lodging special program code. If not passed in, this value defaults to Default.Allowable Values
|
| ChargeType | body | LodgingChargeType | No | The lodging charge type. If not passed in, this value defaults to Default.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApprovedAmount | body | decimal | No | The amount approved by the processor. This is the actual amount that will be charged or credited. |
| ConvenienceFeeAmount | body | decimal | No | The convenience fee added to the transaction |
| SubTotalAmount | body | decimal | No | The original amount sent for the transaction. |
| TipAmount | body | decimal | No | The tip amount added to the transaction. |
| Emv | body | Emv | No | The fields used on the receipt for an EMV transaction. Null if the transaction was not EMV. |
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/AuthorizationCompletionRequest HTTP/1.1
Host: booking.pufferdayspa.com
Content-Type: application/json
Content-Length: length
{"transactionId":"String","address":{"billingAddress1":"String","billingAddress2":"String","billingCity":"String","billingEmail":"String","billingName":"String","billingPhone":"String","billingPostalCode":"String","billingState":"String","shippingAddress1":"String","shippingAddress2":"String","shippingCity":"String","shippingEmail":"String","shippingName":"String","shippingPhone":"String","shippingPostalCode":"String","shippingState":"String"},"configuration":{"allowPartialApprovals":false,"checkForDuplicateTransactions":false,"currencyCode":"None","marketCode":"Default"},"convenienceFeeAmount":0,"tipAmount":0,"transactionAmount":0,"healthcare":{"total":0,"clinic":0,"dental":0,"prescription":0,"vision":0},"lodging":{"customerName":"String","agreementNumber":"String","checkInDate":"String","checkOutDate":"String","roomAmount":0,"noShow":false,"duration":0,"extraChargesDetail":["NotUsed"],"prestigiousPropertyCode":"NonParticipant","specialProgramCode":"Default","chargeType":"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
{"approvedAmount":0,"convenienceFeeAmount":0,"subTotalAmount":0,"tipAmount":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"}]}