triPOS REST API

<back to all web services

CreatePaymetricTokenRequest

The following routes are available for this service:
POST/api/v1/token/paymetric/{transactionId}Creates a Paymetric token based on a previous transaction ID.
CreatePaymetricTokenRequest Parameters:
NameParameterData TypeRequiredDescription
TransactionIdpathstringYesThe ID of a previous transaction.
VaultIdbodystringNoThe Vault ID with Paymetric.
LaneIdbodyintNoThe lane ID.
CreatePaymetricTokenResponse Parameters:
NameParameterData TypeRequiredDescription
AccountNumberbodystringNoThe card account number.
CardLogobodystringNoThe card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
ExpirationMonthbodystringNoThe card's expiration month
ExpirationYearbodystringNoThe card's expiration year
MerchantIdbodystringNoThe merchant ID used to process the transaction.
TokenProviderbodystringNoThe Token Provider.
TokenIdbodystringNoThe Token ID.
TransactionDateTimebodystringNoTransaction date/time in ISO8601 format
ProcessorbodyProcessorNoResponse information from the processor.
ApiResponse Parameters:
NameParameterData TypeRequiredDescription
ErrorsbodyList<ApiError>NoA list of errors that occurred.
HasErrorsbodyboolNoIndicates if there are errors.
LinksbodyIEnumerable<ApiLink>NoA list of resource links
LogsbodyList<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.
TypebodystringNoThe type of object held in the result.
WarningsbodyList<ApiWarning>NoA list of warnings that occurred.
Processor Parameters:
NameParameterData TypeRequiredDescription
ProcessorLogsbodyList<string>No[DEPRECATED] Use logs.
ProcessorRawResponsebodystringNo[DEPRECATED] Use rawResponse.
ProcessorReferenceNumberbodystringNo[DEPRECATED] Use the same reference number passed in the request.
ProcessorRequestFailedbodyboolNo[DEPRECATED] Use top level properties (e.g. hasErrors).
ProcessorRequestWasApprovedbodyboolNo[DEPRECATED] Use top level properties (e.g isApproved).
ProcessorResponseCodebodyProcessorResponseCodeNo[DEPRECATED] Use expressResponseCode.

Allowable Values

  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
ProcessorResponseMessagebodystringNo[DEPRECATED] Use expressResponseMessage.
ExpressResponseCodebodystringNoThe response code received from Express.
ExpressResponseMessagebodystringNoThe response message received from Express.
HostResponseCodebodystringNoThe response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
HostResponseMessagebodystringNoThe response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
LogsbodyList<string>NoA list of messages pertaining processing the transaction.
RawResponsebodystringNoThe raw processor response. In the case of Express, this is the raw XML returned by the Express platform.

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/CreatePaymetricTokenRequest HTTP/1.1 
Host: booking.pufferdayspa.com 
Content-Type: application/json
Content-Length: length

{"transactionId":"String","vaultId":"String","laneId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"accountNumber":"String","cardLogo":"String","expirationMonth":"String","expirationYear":"String","merchantId":"String","tokenProvider":"String","tokenId":"String","transactionDateTime":"String","_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"},"_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"}]}