| POST | /api/v1/authorization | Creates a new card authorization based on the passed in parameters. | This creates a transaction used to hold funds when the total amount of the purchase is unknown. The Incremental Authorization HATEAOS link is only supported for AutoRental and HotelLodging. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 | LodgingAuthorization | 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 |
|---|---|---|---|---|
| Duration | body | int | No | The number of hotel stay days. Set to 1 for no show. |
| PrestigiousPropertyCode | body | LodgingPrestigiousPropertyCode | No | The lodging prestigious property code. If not passed in, this value defaults to NonParticipant.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. |
| 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/AuthorizationRequest HTTP/1.1
Host: booking.pufferdayspa.com
Content-Type: application/json
Content-Length: length
{"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":{"duration":0,"prestigiousPropertyCode":"NonParticipant"},"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"}]}