triPOS REST API

<back to all web services

PaymentAccountSaleRequest

The following routes are available for this service:
POST/api/v1/sale/{paymentAccountId}Creates a new payment account sale based on the passed in amounts.
PaymentAccountSaleRequest Parameters:
NameParameterData TypeRequiredDescription
PaymentAccountIdpathstringYesThe payment account ID.
AddressbodyAddressNoThe cardholder address information for the transaction.
ConfigurationbodyRequestConfigurationNoAny value included in this section will override the corresponding value set in the triPOS.config
ConvenienceFeeAmountbodydecimalNoThe convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
TipAmountbodydecimalNoThe tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
TransactionAmountbodydecimalNoThe total transaction amount. This is the amount of funds to move on the card
LaneIdbodyintNoSpecifies which lane to use for the card sale.
ClerkNumberbodystringNoAn optional clerk number for reference.
ReferenceNumberbodystringNoA user defined reference number. This reference number is returned in the response
ShiftIdbodystringNoAn optional shift id for reference.
TicketNumberbodystringNoAn optional ticket number.
Address Parameters:
NameParameterData TypeRequiredDescription
BillingAddress1bodystringNoThe street address used for billing purposes.
BillingAddress2bodystringNoThe street address used for billing purposes.
BillingCitybodystringNoThe name of the city used for billing purposes.
BillingEmailbodystringNoThe e-mail address used for billing purposes.
BillingNamebodystringNoThe name used for billing purposes.
BillingPhonebodystringNoThe phone number used for billing purposes. The recommended format is (800)555-1212.
BillingPostalCodebodystringNoThe postal code used for billing purposes.
BillingStatebodystringNoThe name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
ShippingAddress1bodystringNoThe street address used for shipping purposes.
ShippingAddress2bodystringNoThe street address used for shipping purposes.
ShippingCitybodystringNoThe name of the city used for shipping purposes.
ShippingEmailbodystringNoThe e-mail address used for shipping purposes.
ShippingNamebodystringNoThe name used for shipping purposes.
ShippingPhonebodystringNoThe phone number used for shipping purposes. The recommended format is (800)555-1212
ShippingPostalCodebodystringNoThe postal code used for shipping purposes.
ShippingStatebodystringNoThe name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
RequestConfiguration Parameters:
NameParameterData TypeRequiredDescription
AllowPartialApprovalsbodybool?NoIf set to true, partial approvals are allowed
CheckForDuplicateTransactionsbodybool?NoIf set to true, enables duplicate checking logic for the transaction at the host.
CurrencyCodebodyCurrencyCode?NoThe currency code of the transaction.

Allowable Values

  • None
  • Cad
  • Usd
  • Eur
MarketCodebodyMarketCodeNoThe market code of the transaction.

Allowable Values

  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
PaymentAccountSaleResponse Parameters:
NameParameterData TypeRequiredDescription
PaymentAccountIdbodystringNoThe payment account ID.
PaymentAccountReferenceNumberbodystringNoThe payment account reference number.
AvsResponseCodebodystringNoThe AVS response code.
ApprovedAmountbodydecimalNoThe amount approved by the processor. This is the actual amount that will be charged or credited.
CardLogobodystringNoThe card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
ConvenienceFeeAmountbodydecimalNoThe convenience fee added to the transaction
SubTotalAmountbodydecimalNoThe original amount sent for the transaction.
TipAmountbodydecimalNoThe tip amount added to the transaction.
TerminalIdbodystringNoThe ID of the terminal used during the transaction
TotalAmountbodydecimalNoThe total amount of the transaction.
ReferenceNumberbodystringNoThe reference number.
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ApprovalNumberbodystringNoApproval number from the processor. Depending on card type and processor an approval number might not be returned.
IsApprovedbodyboolNoSet to true if the host approved the transaction.
ProcessorbodyProcessorNoResponse information from the processor.
StatusCodebodyTransactionFlowStatusNoThe status code for the transaction.

Allowable Values

  • None
  • Success
  • Declined
  • Approved
  • Restart
  • Failed
  • HostError
  • Timeout
  • FailedVerification
  • CardError
  • UnknownCard
  • UnsupportedCard
  • DeviceError
  • Cancelled
  • ChipError
  • PinPadError
  • PinPadTimeout
  • InvalidLane
  • SwipedCardIsChipCapable
  • ApprovedByMerchant
  • ChipReaderError
  • UseChipReader
  • UseMagneticStripe
  • CardRemoved
  • CardBlocked
  • CardNotSupported
  • BadCard
  • CandidateListEmpty
  • IssuerAuthenticationFailed
  • CardDataEncryptionNotEnabled
  • ApprovedExceptCashback
  • ApplicationBlocked
TransactionDateTimebodystringNoTransaction date/time in ISO8601 format
TransactionIdbodystringNoThe transaction ID from the processor
MerchantIdbodystringNoThe 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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/PaymentAccountSaleRequest HTTP/1.1 
Host: booking.pufferdayspa.com 
Content-Type: application/json
Content-Length: length

{"paymentAccountId":"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,"laneId":0,"clerkNumber":"String","referenceNumber":"String","shiftId":"String","ticketNumber":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"paymentAccountId":"String","paymentAccountReferenceNumber":"String","avsResponseCode":"String","approvedAmount":0,"cardLogo":"String","convenienceFeeAmount":0,"subTotalAmount":0,"tipAmount":0,"terminalId":"String","totalAmount":0,"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"}]}