triPOS REST API

<back to all web services

CreatePaymentAccountCreditRequest

The following routes are available for this service:
POST/api/v1/paymentAccountCreates a card account token based on the given data
POST/api/v1/paymentAccount/credit[Deprecated] Use /v1/paymentAccount instead
CreatePaymentAccountCreditRequest Parameters:
NameParameterData TypeRequiredDescription
AddressbodyAddressNoThe cardholder address information for the transaction.
ExpirationMonthbodystringNoThe expiration month.
ExpirationYearbodystringNoThe expiration year.
LaneIdbodyintNoThe lane ID.
PaymentAccountReferenceNumberbodystringNoThe payment account reference number
InokeManualEntrybodyboolNo Invokes manual card entry.
IsCscSupportedbodystringNoInvokes prompt for cardholder to enter card security code for manual keyed card entry.
ConfigurationbodyTokenRequestConfigurationNoAny value included in this section will override the corresponding value set in the triPOS.config
Address Parameters:
NameParameterData TypeRequiredDescription
BillingAddress1formstringNoThe street address used for billing purposes.
BillingAddress2formstringNoThe street address used for billing purposes.
BillingCityformstringNoThe name of the city used for billing purposes.
BillingEmailformstringNoThe e-mail address used for billing purposes.
BillingNameformstringNoThe name used for billing purposes.
BillingPhoneformstringNoThe phone number used for billing purposes. The recommended format is (800)555-1212.
BillingPostalCodeformstringNoThe postal code used for billing purposes.
BillingStateformstringNoThe name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
ShippingAddress1formstringNoThe street address used for shipping purposes.
ShippingAddress2formstringNoThe street address used for shipping purposes.
ShippingCityformstringNoThe name of the city used for shipping purposes.
ShippingEmailformstringNoThe e-mail address used for shipping purposes.
ShippingNameformstringNoThe name used for shipping purposes.
ShippingPhoneformstringNoThe phone number used for shipping purposes. The recommended format is (800)555-1212
ShippingPostalCodeformstringNoThe postal code used for shipping purposes.
ShippingStateformstringNoThe name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
TokenRequestConfiguration Parameters:
NameParameterData TypeRequiredDescription
CardReadRetriesformint?NoNumber of retries in case of bad card read. The default value is 1.
CreatePaymentAccountCreditResponse Parameters:
NameParameterData TypeRequiredDescription
BinValueformstringNoThe BIN entry that matched the account number.
CardLogoformstringNoThe card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
CardHolderNameformstringNoThe cardholder name.
EntryModeformstringNoDescription of how card was entered.

Allowable Values

  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
ExpirationYearformstringNoThe card's expiration year
ExpirationMonthformstringNoThe card's expiration month
PaymentAccountIdformstringNothe payment account ID.
PaymentAccountReferenceNumberformstringNothe payment account reference number.
TerminalIdformstringNoThe ID of the terminal used during the transaction.
AccountNumberformstringNoThe credit card number with the value masked except for the last 4.
FsaCardformstringNoIndicates whether the card used was a FSA card.
Note: Maybe = No BIN entry to determine if FSA.

Allowable Values

  • NotApplicable
  • No
  • Yes
  • Maybe
BinAttributesformDictionary<string, bool>NoAvailable binAttributes of card. more»
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

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/CreatePaymentAccountCreditRequest HTTP/1.1 
Host: triposqa.vantiv.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"},"expirationMonth":"String","expirationYear":"String","laneId":0,"paymentAccountReferenceNumber":"String","invokeManualEntry":false,"isCscSupported":"String","configuration":{"cardReadRetries":0}}

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

{"binValue":"String","cardLogo":"String","cardHolderName":"String","entryMode":"String","expirationYear":"String","expirationMonth":"String","paymentAccountId":"String","paymentAccountReferenceNumber":"String","terminalId":"String","accountNumber":"String","fsaCard":"String","binAttributes":{"String":false},"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":[{"href":"/api/v1/paymentAccount/String","method":"PUT","rel":"paymentAccountCredit"},{"href":"/api/v1/paymentAccount/String","method":"DELETE","rel":"paymentAccountCredit"},{"href":"/api/v1/sale/String","method":"POST","rel":"paymentAccountSale"},{"href":"/api/v1/authorization/String","method":"POST","rel":"paymentAccountAuthorization"},{"href":"/api/v1/refund/String","method":"POST","rel":"paymentAccountRefund"}],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}