triPOS REST API

<back to all web services

EbtVoucherRequest

The following routes are available for this service:
POST/api/v1/ebtVoucherCreates a new EBT voucher sale based on the passed in amount
EbtVoucherRequest Parameters:
NameParameterData TypeRequiredDescription
VoucherNumberbodystringNoThe voucher number to complete a foodstamp purchase.
ApprovalNumberbodystringNoThe approval number of a voice authorization
TransactionAmountbodydecimalNoThe total transaction amount. This is the amount of funds to move on the card.
ConfigurationbodyEbtVoucherRequestConfigurationNoAny value included in this section will override the corresponding value set in the triPOS.config
IsCscSupportedbodystringNoInvokes prompt for cardholder to enter card security code for manual keyed card entry.
LaneRequest Parameters:
NameParameterData TypeRequiredDescription
CardHolderPresentCodeformCardHolderPresentCode?NoDefines whether the cardholder 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

  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
ClerkNumberformstringNoAn optional clerk number for reference.
LaneIdformintNoSpecifies which lane to use.
ReferenceNumberformstringNoA user defined reference number.
ShiftIdformstringNoAn optional shift id for reference.
TicketNumberformstringNoAn optional ticket number.
RequestConfiguration Parameters:
NameParameterData TypeRequiredDescription
AllowPartialApprovalsformbool?NoIf set to false, partial approvals are not allowed
CheckForDuplicateTransactionsformbool?NoIf set to true, enables duplicate checking logic for the transaction at the host.
MarketCodeformMarketCodeNoThe market code of the transaction.

Allowable Values

  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
BaseCardResponse Parameters:
NameParameterData TypeRequiredDescription
AccountNumberformstringNoThe card account number.
BinValueformstringNoThe BIN entry that matched the account number.
CardHolderNameformstringNoThe cardholder name.
CardLogoformstringNoThe card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
CurrencyCodeformCurrencyCodeNoThe currency code used in the transaction.

Allowable Values

  • None
  • Cad
  • Gbp
  • Usd
CountryCodeformCountryCode?NoThe country code used in the transaction.

Allowable Values

  • Can
  • Gbr
  • Usa
LanguageformLanguageCode?NoThe language used in the transaction.

Allowable Values

  • English
  • French
  • Spanish
DebitAccountTypeformDebitAccountType?NoThe account type selected and used in the transaction.

Allowable Values

  • None
  • Checking
  • Savings
EntryModeformstringNoDescription of how card was entered.

Allowable Values

  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
ExpirationYearformstringNoThe card's expiration year
ExpirationMonthformstringNoThe card's expiration month
NetworkLabelformstringNoLabel that shows the network where the transaction was routed for authorization
PaymentTypeformPaymentTypeNoDescription of payment type utilized.

Allowable Values

  • None
  • Credit
  • Debit
  • Gift
  • Ebt
PinVerifiedformboolNoTrue if the PIN was verified, false if not verified or undetermined.
SignatureformSignatureNoThe signature data.
TerminalIdformstringNoThe ID of the terminal used during the transaction
TotalAmountformdecimalNoThe total amount of the transaction.
EBTTypeformEbtTypeSelection?NoThe type of the EBT card
BalanceAmountformdecimal?NoThe balance of the gift card.
BalanceCurrencyCodeformCurrencyCode?NoThe balance currency code.
PreReadIdformGuidNoUnique ID. If checkForPreReadId field is true, then this ID will be required for the Quick Chip portion of the transaction to be successful.
ForeignCurrencyCodeformstringNoCurrency code of the foreign currency.
ForeignTransactionAmountformstringNoTransaction amount shown in the foreign currency.
ConversionRateformstringNoConversion rate for the ForeignCurrencyCode.
OdometerformstringNoFleet Odometer Input On The Device
FleetUserIDformstringNoFleet UserID Input On The Device
FleetJobNumberformstringNoFleet Job Number Input On The Device
PurchaseDeviceSequenceNumberformstringNoFleet Purchase Device Sequence Number from the card
VehicleIDformstringNoFleet Vehicle ID Input On The Device
BinAttributesformDictionary<string, bool>NoAvailable binAttributes of card. more»
DriverIDformstringNoFleet DriverID Input On The Device
IsFleetOdometerPrintformboolNois Fleet Odometer value Print On the Receipt or not
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ApprovalNumberformstringNoApproval number from the processor. Depending on card type and processor an approval number might not be returned.
IsApprovedformboolNoSet to true if the host approved the transaction.
ProcessorformProcessorNoResponse information from the processor.
StatusCodeformTransactionFlowStatusNoThe 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
  • PreReadSuccessful
  • ContactlessMsdDisabled
  • ContactlessEmvDisabled
  • ContactlessMsdNotSupported
  • ProgrammaticallyCancelled
  • DccRequested
TransactionDateTimeformstringNoTransaction date/time in ISO8601 format
TransactionIdformstringNoThe transaction ID from the processor
MerchantIdformstringNoThe Merchant used to process the transaction.
IsOfflineformboolNoA boolean value indicating whether triPOS is disconnected from the host.
ApiResponse Parameters:
NameParameterData TypeRequiredDescription
ErrorsformList<ApiError>NoA list of errors that occurred.
HasErrorsformboolNoIndicates if there are errors.
LinksformIEnumerable<ApiLink>NoA list of resource links
LogsformList<string>NoA list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
TypeformstringNoThe type of object held in the result.
WarningsformList<ApiWarning>NoA list of warnings that occurred.
ApiError Parameters:
NameParameterData TypeRequiredDescription
UserMessageformstringNoAn error message targeted at the end user of the integrated business application.
DeveloperMessageformstringNoAn error message targeted at the developer of the integrated business application.
ErrorTypeformstringNoCode associated with the error if it exists.
ExceptionMessageformstringNoThe body of the exception message.
ExceptionTypeFullNameformstringNoThe full name of the exception.
ExceptionTypeShortNameformstringNoThe short name of the exception.
ApiLink Parameters:
NameParameterData TypeRequiredDescription
HrefformstringNoA target (a URI)
MethodformstringNoThe HTTP method to access the HREF target
RelationformstringNoThe relation aka. 'rel' (the name of the link)
ApiWarning Parameters:
NameParameterData TypeRequiredDescription
DeveloperMessageformstringNoA warning message targeted at the developer of the integrated business application.
UserMessageformstringNoA warning message targeted at the end user of the integrated business application.
Processor Parameters:
NameParameterData TypeRequiredDescription
ProcessorLogsformList<string>No[DEPRECATED] Use logs.
ProcessorRawResponseformstringNo[DEPRECATED] Use rawResponse.
ProcessorReferenceNumberformstringNo[DEPRECATED] Use the same reference number passed in the request.
ProcessorRequestFailedformboolNo[DEPRECATED] Use top level properties (e.g. hasErrors).
ProcessorRequestWasApprovedformboolNo[DEPRECATED] Use top level properties (e.g isApproved).
ProcessorResponseCodeformProcessorResponseCodeNo[DEPRECATED] Use expressResponseCode.

Allowable Values

  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
  • NotAllowed
ProcessorResponseMessageformstringNo[DEPRECATED] Use expressResponseMessage.
ExpressResponseCodeformstringNoThe response code received from Express.
ExpressResponseMessageformstringNoThe response message received from Express.
HostResponseCodeformstringNoThe response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
HostResponseMessageformstringNoThe response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
LogsformList<string>NoA list of messages pertaining processing the transaction.
RawResponseformstringNoThe raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
RawRequestformstringNo
ProcessorNameformProcessorNameNo
Signature Parameters:
NameParameterData TypeRequiredDescription
SignatureDataformbyte[]NoThe byte array of the signature in the format specified by Format.
SignatureFormatformstringNoThe format of the signature.

Allowable Values

  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
SignatureStatusCodeformSignatureStatusCodeNoIndicates why a signature is or is not present.

Allowable Values

  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
  • SignatureRequiredButPromptSuppressedByMerchant
  • SignatureNotRequiredByUnattendedPinPad

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/EbtVoucherRequest HTTP/1.1 
Host: triposqa.vantiv.com 
Content-Type: application/json
Content-Length: length

{"voucherNumber":"String","approvalNumber":"String","transactionAmount":0,"configuration":{"checkForDuplicateTransactions":false,"marketCode":"Default"},"isCscSupported":"String","cardHolderPresentCode":"Default","clerkNumber":"String","laneId":0,"referenceNumber":"String","ticketNumber":"String"}

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

{"accountNumber":"String","binValue":"String","cardHolderName":"String","cardLogo":"String","currencyCode":"None","countryCode":"0","language":"English","accountType":"None","entryMode":"String","expirationYear":"String","expirationMonth":"String","networkLabel":"String","paymentType":"None","pinVerified":false,"signature":{"data":"AA==","format":"String","statusCode":"Unknown"},"terminalId":"String","totalAmount":0,"ebtType":"None","balanceAmount":0,"balanceCurrencyCode":"None","foreignCurrencyCode":"String","foreignTransactionAmount":"String","conversionRate":"String","odometer":"String","fleetUserID":"String","fleetJobNumber":"String","purchaseDeviceSequenceNumber":"String","vehicleID":"String","binAttributes":{"String":false},"driverID":"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","rawRequest":"String","processorName":"Unknown"},"statusCode":"None","transactionDateTime":"String","transactionId":"String","merchantId":"String","isOffline":false,"_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"}]}