/api/requestlogs

/api/v1

GET
/api/v1 Returns an array of links for accessing version 1.0 of the triPOS API

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

GetServicesResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  }
}
GetServicesResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
GetServicesResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
POST
/api/v1/authorization Creates a new card authorization based on the passed in parameters

Implementation Notes

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. Additionally, this endpoint supports QuickChip/PreRead functionality. See QuickChip/PreRead documentation for more information.

Parameters

Parameter Parameter Type Data Type Description
action query string The action to perform with the authorization. This can either be 'store' or 'forward'.
requestIdToForward query string The request ID of the stored transaction to forward.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
AuthorizationRequest body POST_AuthorizationRequest/v1/authorization undefined

Request Class

AuthorizationRequest 
{
  "laneId": "int",
  "transactionAmount": "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"
  },
  "autoRental": {
    "duration": "int"
  },
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "commercialCardCustomerCode": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "isManualEntryAllowed": "string",
    "marketCode": "string",
    "promptForSignature": "string",
    "provisionalAmount": "string",
    "userInputTimeout": "string"
  },
  "convenienceFeeAmount": "double",
  "displayTransactionAmount": "boolean",
  "getToken": "string",
  "healthcare": {
    "clinic": "double",
    "dental": "double",
    "prescription": "double",
    "total": "double",
    "vision": "double"
  },
  "invokeManualEntry": "boolean",
  "isCscSupported": "string",
  "lodging": {
    "duration": "int",
    "prestigiousPropertyCode": "string"
  },
  "networkTransactionID": "string",
  "nonFinancialExpected": "boolean",
  "preRead": "boolean",
  "quickChip": "boolean",
  "recurringPaymentType": "string",
  "referenceNumber": "string",
  "salesTaxAmount": "double",
  "shiftId": "string",
  "submissionType": "string",
  "ticketNumber": "string",
  "tipAmount": "double"
}
AuthorizationRequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "isManualEntryAllowed": "string",
  "marketCode": "string",
  "promptForSignature": "string",
  "provisionalAmount": "string",
  "userInputTimeout": "string"
}
AuthorizationRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
transactionAmount true string 10 0.00 The total transaction amount. This is the amount of funds to move on the card
address false POST_Address/v1/authorization The cardholder address information for the transaction.
autoRental false POST_AutoRentalBasic/v1/authorization The auto rental parameters to be passed in for an auto rental transaction. more�
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
commercialCardCustomerCode false string 40 The commercial card customer code for the transaction. This is for Level II.
configuration false POST_AuthorizationRequestConfiguration/v 1/authorization Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double 10 0.00 The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
displayTransactionAmount false boolean 5 false Display the transaction amount during card read.
getToken false string 20 To retrieve Token in the transaction. more�
Values:
  • OmniToken
healthcare false POST_Healthcare/v1/authorization The healthcare section that contains all applicable healthcare-qualified amounts. more�
invokeManualEntry false boolean 5 false Invokes manual card entry.
isCscSupported false string 5 false Invokes prompt for cardholder to enter card security code for manual keyed card entry.
lodging false POST_LodgingAuthorization/v1/authorizati on The lodging parameters to be passed in for a lodging transaction. more�
networkTransactionID false string 40 The card brand specific transaction ID that should be stored by the integrator.
nonFinancialExpected false boolean 5 false Non Financial Card read Expected. Only supported on unattended devices.
preRead false boolean 5 false Flag indicating desire to process authorization as PreRead (i.e. - do ONLY Pre-Read operations, then expecting next endpoint call to be QuickChip) more�.
quickChip false boolean 5 false Flag indicating desire to process authorization as QuickChip (i.e. - Pre-Read has been previously performed) more�.
recurringPaymentType false string 32 Recurring PaymentType,Intent of why the credentials are being stored.
Values:
  • NotUsed
  • Recurring
  • Installment
  • CardHolderInitiated
  • CredentialsOnFile
referenceNumber false string 50 A user defined reference number.
salesTaxAmount false double 10 0.00 The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.
shiftId false string 10 An optional shift id for reference.
submissionType false string 32 SubmissionType,Initial vs Subsequent Transaction.
Values:
  • NotUsed
  • Initial
  • Subsequent
  • Resubmission
  • ReAuthorization
  • DelayedCharges
  • NoShow
ticketNumber false string 50 An optional ticket number.
tipAmount false double 12 0.00 The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
Address
Field Required Data Type Max Length Default Value Description
billingAddress1 false string 50 The street address used for billing purposes.
billingAddress2 false string 50 The street address used for billing purposes.
billingCity false string 40 The name of the city used for billing purposes.
billingEmail false string 80 The e-mail address used for billing purposes.
billingName false string 100 The name used for billing purposes.
billingPhone false string 20 The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string 20 The postal code used for billing purposes.
billingState false string 30 The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
shippingAddress1 false string 50 The street address used for shipping purposes.
shippingAddress2 false string 50 The street address used for shipping purposes.
shippingCity false string 40 The name of the city used for shipping purposes.
shippingEmail false string 80 The e-mail address used for shipping purposes.
shippingName false string 100 The name used for shipping purposes.
shippingPhone false string 20 The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string 20 The postal code used for shipping purposes.
shippingState false string 30 The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
AutoRentalBasic
Field Required Data Type Max Length Default Value Description
duration false int 2 The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.
AuthorizationRequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
isManualEntryAllowed false string 5 true Use this parameter to allow manual entry of card account numbers on the PIN pad.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
promptForSignature false string 32 Never Specifies how the signature prompt should be handled for the request. If a value is not provided, Never will be used. See Signature Prompt.
Values:
  • Always
  • Never
  • None
provisionalAmount false string 10 1 Override provisional amount used for QC transactions, which is $1.00 by default
userInputTimeout false string 10 60000 Specifies the user input timeout.
Healthcare
Field Required Data Type Max Length Default Value Description
clinic false double 12 The total amount of healthcare-qualified goods that fall into the category of 'clinic'.
dental false double 12 The total amount of healthcare-qualified goods that fall into the category of 'dental'.
prescription false double 12 The total amount of healthcare-qualified goods that fall into the category of 'prescription'.
total false double 12 The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.
vision false double 12 The total amount of healthcare-qualified goods that fall into the category of 'vision'.
LodgingAuthorization
Field Required Data Type Max Length Default Value Description
duration false int 2 The number of hotel stay days. Set to 1 for no show.
prestigiousPropertyCode false string 32 NonParticipant The lodging prestigious property code. For an empty or invalid value, this parameter defaults to NonParticipant.
Values:
  • NonParticipant
  • FiveHundredDollarLimit
  • OneThousandDollarLimit
  • OneThousandFiveHundredDollarLimit
AuthorizationRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/v1/authorization",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "autoRental": {
    "description": "The auto rental parameters to be passed in for an auto rental transaction. <a href='../help/kb/autorental.html'>more&raquo;</a>",
    "type": "POST_AutoRentalBasic/v1/authorization",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "commercialCardCustomerCode": {
    "description": "The commercial card customer code for the transaction. This is for Level II.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_AuthorizationRequestConfiguration/v1/authorization",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "displayTransactionAmount": {
    "description": "Display the transaction amount during card read.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "getToken": {
    "description": "To retrieve Token in the transaction. <a href='../help/kb/GetToken.html'>more&raquo;</a>",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "OmniToken"
      ]
    },
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "healthcare": {
    "description": "The healthcare section that contains all applicable healthcare-qualified amounts. <a href='../help/kb/healthcare.html'>more&raquo;</a>",
    "type": "POST_Healthcare/v1/authorization",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "invokeManualEntry": {
    "description": " Invokes manual card entry.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isCscSupported": {
    "description": "Invokes prompt for cardholder to enter card security code for manual keyed card entry.",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "lodging": {
    "description": "The lodging parameters to be passed in for a lodging transaction. <a href='../help/kb/lodging.html'>more&raquo;</a>",
    "type": "POST_LodgingAuthorization/v1/authorization",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "networkTransactionID": {
    "description": "The card brand specific transaction ID that should be stored by the integrator.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "nonFinancialExpected": {
    "description": "Non Financial Card read Expected. Only supported on unattended devices.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "preRead": {
    "description": "Flag indicating desire to process authorization as PreRead (i.e. - do ONLY Pre-Read operations, then expecting next endpoint call to be QuickChip) <a href='..\\help\\kb\\QuickChipConfiguration.html'>more&raquo;</a>.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "quickChip": {
    "description": "Flag indicating desire to process authorization as QuickChip (i.e. - Pre-Read has been previously performed) <a href='..\\help\\kb\\QuickChipConfiguration.html'>more&raquo;</a>.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "recurringPaymentType": {
    "description": "Recurring PaymentType,Intent of why the credentials are being stored.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotUsed",
        "Recurring",
        "Installment",
        "CardHolderInitiated",
        "CredentialsOnFile"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "salesTaxAmount": {
    "description": "The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "submissionType": {
    "description": "SubmissionType,Initial vs Subsequent Transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotUsed",
        "Initial",
        "Subsequent",
        "Resubmission",
        "ReAuthorization",
        "DelayedCharges",
        "NoShow"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": "0.00"
    },
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingState": {
    "description": "The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingState": {
    "description": "The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRentalBasic 
{
  "duration": {
    "description": "The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  }
}
AuthorizationRequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Use this parameter to allow manual entry of card account numbers on the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "true"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  },
  "promptForSignature": {
    "description": "Specifies how the signature prompt should be handled for the request. If a value is not provided, Never will be used. See <a href='../help/kb/signaturePrompt.html'>Signature Prompt</a>.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Always",
        "Never",
        "None"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Never"
    },
    "required": false
  },
  "provisionalAmount": {
    "description": "Override provisional amount used for QC transactions, which is $1.00 by default",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "1"
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Specifies the user input timeout.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "60000"
    },
    "required": false
  }
}
Healthcare 
{
  "clinic": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'clinic'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "dental": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'dental'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "prescription": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'prescription'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "total": {
    "description": "The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "vision": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'vision'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  }
}
LodgingAuthorization 
{
  "duration": {
    "description": "The number of hotel stay days. Set to 1 for no show.",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "prestigiousPropertyCode": {
    "description": "The lodging prestigious property code. For an empty or invalid value, this parameter defaults to NonParticipant.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NonParticipant",
        "FiveHundredDollarLimit",
        "OneThousandDollarLimit",
        "OneThousandFiveHundredDollarLimit"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "NonParticipant"
    },
    "required": false
  }
}

Response Class

AuthorizationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "approvedAmount": "double",
  "balanceAmount": "double",
  "balanceCurrencyCode": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "convenienceFeeAmount": "double",
  "currencyCode": "string",
  "ebtType": "string",
  "emv": {
    "applicationIdentifier": "string",
    "applicationLabel": "string",
    "applicationPreferredName": "string",
    "applicationTransactionCounter": "string",
    "cryptogram": "string",
    "issuerCodeTableIndex": "string",
    "pinBypassed": "boolean",
    "tags": {
      "key": "string",
      "value": "string"
    }
  },
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "fsaCard": "string",
  "isApproved": "boolean",
  "isCardInserted": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "networkLabel": "string",
  "networkTransactionId": "string",
  "nonFinancialData": {
    "cardEntryMode": "string",
    "track1": "string",
    "track2": "string",
    "track3": "string"
  },
  "paymentType": "string",
  "pinVerified": "boolean",
  "quickChipMessage": "string",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "tipAmount": "double",
  "tokenId": "string",
  "tokenProvider": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
AuthorizationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double 10 The amount approved by the processor. This is the actual amount that will be charged or credited.
balanceAmount false double 13 The balance of the gift card.
balanceCurrencyCode false string 4 The balance currency code.
Values:
  • None
  • Usd
binValue false string 6 The BIN entry that matched the account number.
cardHolderName false string 80 The cardholder name.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double 10 The convenience fee added to the transaction
currencyCode false string 4 The currency code used in the transaction.
Values:
  • None
  • Usd
ebtType false string 16 The type of the EBT card
Values:
  • None
  • FoodStamp
  • CashBenefit
emv false Emv The fields used on the receipt for an EMV transaction. Null if the transaction was not EMV.
entryMode false string 32 Description of how card was entered.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
fsaCard false string 32 Indicates whether the card used was a FSA card.
Note: Maybe = No BIN entry to determine if FSA.
Values:
  • NotApplicable
  • No
  • Yes
  • Maybe
isApproved false boolean 5 Set to true if the host approved the transaction.
isCardInserted false boolean 5 Indicates whether the EMV card was still inserted into the payment device when the transaction completed.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
networkLabel false string 30 Label that shows the network where the transaction was routed for authorization
networkTransactionId false string 40 The card brand specific transaction ID that should be stored by the integrator.
nonFinancialData false NonFinancialCard Non Financial data.
paymentType false string 16 Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
  • Ebt
pinVerified false boolean 5 True if the PIN was verified, false if not verified or undetermined.
quickChipMessage false string 500 The message unique to QuickChip pre-read functionality only.
signature false Signature The signature data.
statusCode false string 40 The status code for the transaction.
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
subTotalAmount false double 10 The original amount sent for the transaction.
terminalId false string 40 The ID of the terminal used during the transaction
tipAmount false double 12 The tip amount added to the transaction.
tokenId false string 100 The Token ID.
tokenProvider false string 32 The Token Provider.
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Emv
Field Required Data Type Max Length Default Value Description
applicationIdentifier false string 16 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 false string 16 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 false string 16 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.
applicationTransactionCounter false string 2 The application transaction counter.
cryptogram false string 60 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.
issuerCodeTableIndex false string 2 Indicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name.
pinBypassed false boolean 5 undefined
tags false Array<Tag> A name value collection of additional EMV tags that are required to appear on the receipt.
Tag
Field Required Data Type Max Length Default Value Description
key false string 10 undefined
value false string 64 undefined
NonFinancialCard
Field Required Data Type Max Length Default Value Description
cardEntryMode false string 32 Card entry mode
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
  • FSwipe
track1 false string 79 Track 1 of the non-financial card
track2 false string 40 Track 2 of the non-financial card
track3 false string 128 Track 3 of the non-financial card
Signature
Field Required Data Type Max Length Default Value Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string 32 The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string 50 Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
  • SignatureRequiredButPromptSuppressedByMerchant
  • SignatureNotRequiredByUnattendedPinPad
AuthorizationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved by the processor. This is the actual amount that will be charged or credited.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceAmount": {
    "description": "The balance of the gift card.",
    "type": "double",
    "paramValues": {
      "max": "13",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceCurrencyCode": {
    "description": "The balance currency code.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderName": {
    "description": "The cardholder name.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "ebtType": {
    "description": "The type of the EBT card",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "FoodStamp",
        "CashBenefit"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "emv": {
    "description": "The fields used on the receipt for an EMV transaction. Null if the transaction was not EMV.",
    "type": "Emv",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "fsaCard": {
    "description": "Indicates whether the card used was a FSA card.<br />Note: Maybe = No BIN entry to determine if FSA.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotApplicable",
        "No",
        "Yes",
        "Maybe"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isCardInserted": {
    "description": "Indicates whether the EMV card was still inserted into the payment device when the transaction completed.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "networkLabel": {
    "description": "Label that shows the network where the transaction was routed for authorization",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "networkTransactionId": {
    "description": "The card brand specific transaction ID that should be stored by the integrator.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "nonFinancialData": {
    "description": "Non Financial data.",
    "type": "NonFinancialCard",
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift",
        "Ebt"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "quickChipMessage": {
    "description": "The message unique to QuickChip pre-read functionality only.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "subTotalAmount": {
    "description": "The original amount sent for the transaction.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount added to the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenId": {
    "description": "The Token ID.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenProvider": {
    "description": "The Token Provider.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Emv 
{
  "applicationIdentifier": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "applicationLabel": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "applicationPreferredName": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "applicationTransactionCounter": {
    "description": "The application transaction counter.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "cryptogram": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "60",
      "defaultValue": ""
    },
    "required": false
  },
  "issuerCodeTableIndex": {
    "description": "Indicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "pinBypassed": {
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "tags": {
    "description": "A name value collection of additional EMV tags that are required to appear on the receipt.",
    "type": "Array",
    "items": {
      "$ref": "Tag"
    },
    "required": false
  }
}
Tag 
{
  "key": {
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "value": {
    "type": "string",
    "paramValues": {
      "max": "64",
      "defaultValue": ""
    },
    "required": false
  }
}
NonFinancialCard 
{
  "cardEntryMode": {
    "description": "Card entry mode",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd",
        "FSwipe"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "track1": {
    "description": "Track 1 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "79",
      "defaultValue": ""
    },
    "required": false
  },
  "track2": {
    "description": "Track 2 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "track3": {
    "description": "Track 3 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "128",
      "defaultValue": ""
    },
    "required": false
  }
}
Signature 
{
  "data": {
    "description": "The byte array of the signature in the format specified by Format.",
    "type": "Array",
    "items": {
      "type": "byte"
    },
    "required": false
  },
  "format": {
    "description": "The format of the signature.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PointsLittleEndian",
        "PointsBigEndian",
        "Ascii3Byte"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "Indicates why a signature is or is not present.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "SignatureRequired",
        "SignaturePresent",
        "SignatureRequiredCancelledByCardholder",
        "SignatureRequiredNotSupportedByPinPad",
        "SignatureRequiredPinPadError",
        "SignatureNotRequiredByThresholdAmount",
        "SignatureNotRequiredByPaymentType",
        "SignatureNotRequiredByTransactionType",
        "SignatureRequiredButPromptSuppressedByMerchant",
        "SignatureNotRequiredByUnattendedPinPad"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if client sends in all 5 of the healthcare values as positive values.
400 Returned if any healthcare field has a negative value.
400 Returned if healthcare Total field is less than sum of the other healthcare fields.
400 Returned if MarketCode is not HotelLodging but the request includes lodging parameters on a valid lodging request.
400 Returned if the lodging duration is less than 0 on a valid lodging request.
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
POST
/api/v1/authorization/{paymentAccountId} Creates a new payment account authorization based on the passed in amounts

Parameters

Parameter Parameter Type Data Type Description
paymentAccountId path string The payment account ID.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
PaymentAccountAuthorizationRequest body POST_PaymentAccountAuthorizationRequest/v1/authorization/{paymentAccountId} undefined

Request Class

PaymentAccountAuthorizationRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "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"
  },
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "healthcare": {
    "clinic": "double",
    "dental": "double",
    "prescription": "double",
    "total": "double",
    "vision": "double"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string",
  "tipAmount": "double"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "marketCode": "string"
}
PaymentAccountAuthorizationRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use for the card sale.
transactionAmount true double 10 0.00 The total transaction amount. This is the amount of funds to move on the card
address false POST_Address/v1/authorization/{paymentAc countId} The cardholder address information for the transaction.
clerkNumber false string 10 An optional clerk number for reference.
configuration false POST_RequestConfiguration/v1/authorizati on/{paymentAccountId} Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double 10 0.00 The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
healthcare false POST_Healthcare/v1/authorization/{paymen tAccountId} The healthcare section that contains all applicable healthcare-qualified amounts. more�
referenceNumber false string 50 A user defined reference number.
shiftId false string 10 An optional shift id for reference.
ticketNumber false string 50 An optional ticket number.
tipAmount false double 12 0.00 The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
Address
Field Required Data Type Max Length Default Value Description
billingAddress1 false string 50 The street address used for billing purposes.
billingAddress2 false string 50 The street address used for billing purposes.
billingCity false string 40 The name of the city used for billing purposes.
billingEmail false string 80 The e-mail address used for billing purposes.
billingName false string 100 The name used for billing purposes.
billingPhone false string 20 The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string 20 The postal code used for billing purposes.
billingState false string 30 The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
shippingAddress1 false string 50 The street address used for shipping purposes.
shippingAddress2 false string 50 The street address used for shipping purposes.
shippingCity false string 40 The name of the city used for shipping purposes.
shippingEmail false string 80 The e-mail address used for shipping purposes.
shippingName false string 100 The name used for shipping purposes.
shippingPhone false string 20 The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string 20 The postal code used for shipping purposes.
shippingState false string 30 The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
RequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
Healthcare
Field Required Data Type Max Length Default Value Description
clinic false double 12 The total amount of healthcare-qualified goods that fall into the category of 'clinic'.
dental false double 12 The total amount of healthcare-qualified goods that fall into the category of 'dental'.
prescription false double 12 The total amount of healthcare-qualified goods that fall into the category of 'prescription'.
total false double 12 The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.
vision false double 12 The total amount of healthcare-qualified goods that fall into the category of 'vision'.
PaymentAccountAuthorizationRequest 
{
  "laneId": {
    "description": "Specifies which lane to use for the card sale.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/v1/authorization/{paymentAccountId}",
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/v1/authorization/{paymentAccountId}",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "healthcare": {
    "description": "The healthcare section that contains all applicable healthcare-qualified amounts. <a href='../help/kb/healthcare.html'>more&raquo;</a>",
    "type": "POST_Healthcare/v1/authorization/{paymentAccountId}",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": "0.00"
    },
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingState": {
    "description": "The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingState": {
    "description": "The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  }
}
Healthcare 
{
  "clinic": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'clinic'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "dental": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'dental'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "prescription": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'prescription'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "total": {
    "description": "The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "vision": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'vision'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

PaymentAccountAuthorizationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "approvalNumber": "string",
  "approvedAmount": "double",
  "avsResponseCode": "string",
  "cardLogo": "string",
  "convenienceFeeAmount": "double",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "paymentAccountId": "string",
  "paymentAccountReferenceNumber": "string",
  "referenceNumber": "string",
  "statusCode": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "tipAmount": "double",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
PaymentAccountAuthorizationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double 10 The amount approved by the processor. This is the actual amount that will be charged or credited.
avsResponseCode false string 2 The AVS response code.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double 10 The convenience fee added to the transaction
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
paymentAccountId false string 50 The payment account ID.
paymentAccountReferenceNumber false string 50 The payment account reference number.
referenceNumber false string 50 The reference number.
statusCode false string 40 The status code for the transaction.
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
subTotalAmount false double 10 The original amount sent for the transaction.
terminalId false string 40 The ID of the terminal used during the transaction
tipAmount false double 12 The tip amount added to the transaction.
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
PaymentAccountAuthorizationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved by the processor. This is the actual amount that will be charged or credited.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "avsResponseCode": {
    "description": "The AVS response code.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentAccountId": {
    "description": "The payment account ID.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentAccountReferenceNumber": {
    "description": "The payment account reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "The reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "subTotalAmount": {
    "description": "The original amount sent for the transaction.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount added to the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
POST
/api/v1/authorization/{transactionId}/completion Updates a previous card authorization with the final totals

Implementation Notes

This completes the original authorization and initiates and exchange of funds. The transactionId is the value returned by the original authorization.

Parameters

Parameter Parameter Type Data Type Description
transactionId path string The ID of a previous authorization transaction.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
AuthorizationCompletionRequest body POST_AuthorizationCompletionRequest/v1/authorization/{transactionId}/completion undefined

Request Class

AuthorizationCompletionRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "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"
  },
  "autoRental": {
    "customerName": "string",
    "agreementNumber": "string",
    "vehicleClassCode": "string",
    "noShowIndicator": "string",
    "adjustmentData": {
      "amount": "double",
      "code": "string",
      "extraChargesDetail": "Array<POST_AutoRentalExtraChargesDetail/v1/authorization/{transactionId}/completion>"
    },
    "pickupData": {
      "city": "string",
      "countryCode": "string",
      "date": "string",
      "location": "string",
      "state": "string"
    },
    "returnData": {
      "city": "string",
      "countryCode": "string",
      "date": "string",
      "locationId": "string",
      "state": "string",
      "distance": "int",
      "distanceUnit": "string"
    },
    "dailyRentalRate": "double",
    "weeklyRentalRate": "double",
    "insuranceCharges": "double",
    "duration": "int"
  },
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "commercialCardCustomerCode": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "isManualEntryAllowed": "string",
    "marketCode": "string",
    "promptForSignature": "string",
    "provisionalAmount": "string",
    "userInputTimeout": "string"
  },
  "convenienceFeeAmount": "double",
  "lodging": {
    "agreementNumber": "string",
    "chargeType": "string",
    "checkInDate": "string",
    "checkOutDate": "string",
    "customerName": "string",
    "duration": "int",
    "extraChargesDetail": "Array<POST_LodgingExtraChargesDetail/v1/authorization/{transactionId}/completion>",
    "noShow": "boolean",
    "prestigiousPropertyCode": "string",
    "roomAmount": "double",
    "specialProgramCode": "string"
  },
  "networkTransactionID": "string",
  "recurringPaymentType": "string",
  "referenceNumber": "string",
  "salesTaxAmount": "double",
  "shiftId": "string",
  "submissionType": "string",
  "ticketNumber": "string",
  "tipAmount": "double"
}
AuthorizationCompletionRequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "isManualEntryAllowed": "string",
  "marketCode": "string",
  "promptForSignature": "string",
  "provisionalAmount": "string",
  "userInputTimeout": "string"
}
AuthorizationCompletionRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
transactionAmount true double 10 0.00 The total transaction amount. This is the amount of funds to move on the card
address false POST_Address/v1/authorization/{transacti onId}/completion The cardholder address information for the transaction.
autoRental false POST_AutoRental/v1/authorization/{transa ctionId}/completion The auto rental parameters to be passed in for an auto rental transaction. more�
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
commercialCardCustomerCode false string 40 The commercial card customer code for the transaction. This is for Level II.
configuration false POST_AuthorizationCompletionRequestConfi guration/v1/authorization/{transactionId }/completion Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double 10 0.00 The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
lodging false POST_LodgingTransactionCompletion/v1/aut horization/{transactionId}/completion The lodging parameters to be passed in for a lodging transaction. more�
networkTransactionID false string 40 The card brand specific transaction ID that should be stored by the integrator.
recurringPaymentType false string 32 Intent of why the credentials are being stored.
Values:
  • NotUsed
  • Recurring
  • Installment
  • CardHolderInitiated
  • CredentialsOnFile
referenceNumber false string 50 A user defined reference number.
salesTaxAmount false double 10 0.00 The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.
shiftId false string 10 An optional shift id for reference.
submissionType false string 32 Specifies the type of transaction.
Values:
  • NotUsed
  • Initial
  • Subsequent
  • Resubmission
  • ReAuthorization
  • DelayedCharges
  • NoShow
ticketNumber false string 50 An optional ticket number.
tipAmount false double 12 0.00 The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
Address
Field Required Data Type Max Length Default Value Description
billingAddress1 false string 50 The street address used for billing purposes.
billingAddress2 false string 50 The street address used for billing purposes.
billingCity false string 40 The name of the city used for billing purposes.
billingEmail false string 80 The e-mail address used for billing purposes.
billingName false string 100 The name used for billing purposes.
billingPhone false string 20 The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string 20 The postal code used for billing purposes.
billingState false string 30 The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
shippingAddress1 false string 50 The street address used for shipping purposes.
shippingAddress2 false string 50 The street address used for shipping purposes.
shippingCity false string 40 The name of the city used for shipping purposes.
shippingEmail false string 80 The e-mail address used for shipping purposes.
shippingName false string 100 The name used for shipping purposes.
shippingPhone false string 20 The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string 20 The postal code used for shipping purposes.
shippingState false string 30 The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
AutoRental
Field Required Data Type Max Length Default Value Description
customerName false string 100 Customer Name.
agreementNumber false string 14 Agreement number.
vehicleClassCode false string 32 Classification of rental vehicle
Values:
  • Unused
  • Mini
  • Subcompact
  • Economy
  • Compact
  • Midsize
  • Intermediate
  • Standard
  • Fullsize
  • Luxury
  • Premium
  • Minivan
  • Van12Passenger
  • MovingVan
  • Van15Passenger
  • CargoVan
  • Truck12Foot
  • Truck20Foot
  • Truck24Foot
  • Truck26Foot
  • Moped
  • Stretch
  • Regular
  • Unique
  • Exotic
  • TruckSmallMedium
  • TruckLarge
  • SUVSmall
  • SUVMedium
  • SUVLarge
  • SUVExotic
  • FourWheelDrive
  • Special
  • Miscellaneous
noShowIndicator false string 32 No show indicator. Indicates whether rental vehicle was reserved, but not actually rented.
Values:
  • NotApplicable
  • NoShow
adjustmentData false POST_AutoRentalAdjustmentData/v1/authori zation/{transactionId}/completion Data related to any auto rental adjustments.
pickupData false POST_AutoRentalPickupData/v1/authorizati on/{transactionId}/completion Data related to autorental pickup.
returnData false POST_AutoRentalReturnData/v1/authorizati on/{transactionId}/completion Data related to autorental return.
dailyRentalRate false double 10 0 Rate charged per day Visa/MC � Daily rate required for Corp T&E rate III.
weeklyRentalRate false double 10 0 Rate charged per week Visa/MC � Weekly rate required for Corp T&E rate III.
insuranceCharges false double 10 0.00 If insurance is charged, the insurance amount should be provided.
duration false int 2 The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.
AutoRentalAdjustmentData
Field Required Data Type Max Length Default Value Description
amount false double 10 0.00 Adjustment amount.
code false string 40 Indicates if adjustment for mileage, fuel, vehicle damage, etc. was made to a rental agreement.
Values:
  • NoAdjustments
  • MultipleAdjustments
  • OneAdjustmentCardmemberNotified
  • OneAdjustmentCardmemberNotNotified
extraChargesDetail false Array<POST_AutoRentalExtraChargesDetail/v1/aut horization/{transactionId}/completion> 100 NoExtraCharge Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NoExtraCharge.
Values:
  • NoExtraCharge
  • Gasoline
  • ExtraMileage
  • LateReturn
  • OneWayServiceFee
  • ParkingOrMovingViolation
AutoRentalPickupData
Field Required Data Type Max Length Default Value Description
city false string 18 Auto rental pickup city.
countryCode false string 3 Country code where vehicle was picked up. For US, use 840.
date false string 19 return date in yyyy-MM-ddTHH:mm:ss format.
location false string 38 Name of business where vehicle was picked up.
state false string 3 Abbreviation of state, province, or other country subdivision where vehicle was picked up.
AutoRentalReturnData
Field Required Data Type Max Length Default Value Description
city false string 18 Auto rental return city.
countryCode false string 3 Country code where vehicle was returned. For US, use 840.
date false string 19 return date in yyyy-MM-ddTHH:mm:ss format.
locationId false string 10 Auto Rental location ID where vehicle was returned.
state false string 3 Auto rental return state.
distance false int 5 Numeric distance traveled during rental period.
distanceUnit false string 16 Unit of measurement applicable to distance traveled.
Values:
  • 0 = Unused
  • 1 = Miles
  • 2 = Kilometers
AuthorizationCompletionRequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
isManualEntryAllowed false string 5 true Use this parameter to allow manual entry of card account numbers on the PIN pad.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
promptForSignature false string 32 Never Specifies how the signature prompt should be handled for the request. If a value is not provided, Never will be used. See Signature Prompt.
Values:
  • Always
  • Never
  • None
provisionalAmount false string 10 1 Override provisional amount used for QC transactions, which is $1.00 by default
userInputTimeout false string 10 60000 Specifies the user input timeout.
LodgingTransactionCompletion
Field Required Data Type Max Length Default Value Description
agreementNumber false string 14 The lodging agreement number.
chargeType false string 32 Default The lodging charge type. For an empty or invalid value, this parameter defaults to Default.
Values:
  • Default
  • Restaurant
  • GiftShop
checkInDate false string 10 The check-in date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.
checkOutDate false string 10 The check-out date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.
customerName false string 100 The lodging customer name.
duration false int 2 The number of hotel stay days. Set to 1 for no show.
extraChargesDetail false Array<POST_LodgingExtraChargesDetail/v1/author ization/{transactionId}/completion> 100 NotUsed Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NotUsed.
Values:
  • NotUsed
  • Reserved
  • Restaurant
  • GiftShop
  • MiniBar
  • Telephone
  • Other
  • Laundry
noShow false boolean 5 false Set to true to indicate no show. Otherwise, value defaults to false.
prestigiousPropertyCode false string 32 NonParticipant The lodging prestigious property code. For an empty or invalid value, this parameter defaults to NonParticipant.
Values:
  • NonParticipant
  • FiveHundredDollarLimit
  • OneThousandDollarLimit
  • OneThousandFiveHundredDollarLimit
roomAmount false double 12 0.00 The nightly rate for one room.
specialProgramCode false string 32 Default The lodging special program code. For an empty or invalid value, this parameter defaults to Default.
Values:
  • Default
  • Sale
  • NoShow
  • AdvanceDeposit
AuthorizationCompletionRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/v1/authorization/{transactionId}/completion",
    "required": false
  },
  "autoRental": {
    "description": "The auto rental parameters to be passed in for an auto rental transaction. <a href='../help/kb/autorental.html'>more&raquo;</a>",
    "type": "POST_AutoRental/v1/authorization/{transactionId}/completion",
    "required": false
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "commercialCardCustomerCode": {
    "description": "The commercial card customer code for the transaction. This is for Level II.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_AuthorizationCompletionRequestConfiguration/v1/authorization/{transactionId}/completion",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "lodging": {
    "description": "The lodging parameters to be passed in for a lodging transaction. <a href='../help/kb/lodging.html'>more&raquo;</a>",
    "type": "POST_LodgingTransactionCompletion/v1/authorization/{transactionId}/completion",
    "required": false
  },
  "networkTransactionID": {
    "description": "The card brand specific transaction ID that should be stored by the integrator.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "recurringPaymentType": {
    "description": "Intent of why the credentials are being stored.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotUsed",
        "Recurring",
        "Installment",
        "CardHolderInitiated",
        "CredentialsOnFile"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "salesTaxAmount": {
    "description": "The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "submissionType": {
    "description": "Specifies the type of transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotUsed",
        "Initial",
        "Subsequent",
        "Resubmission",
        "ReAuthorization",
        "DelayedCharges",
        "NoShow"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": "0.00"
    },
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingState": {
    "description": "The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingState": {
    "description": "The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRental 
{
  "customerName": {
    "description": "Customer Name.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "agreementNumber": {
    "description": "Agreement number.",
    "type": "string",
    "paramValues": {
      "max": "14",
      "defaultValue": ""
    },
    "required": false
  },
  "vehicleClassCode": {
    "description": "Classification of rental vehicle",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unused",
        "Mini",
        "Subcompact",
        "Economy",
        "Compact",
        "Midsize",
        "Intermediate",
        "Standard",
        "Fullsize",
        "Luxury",
        "Premium",
        "Minivan",
        "Van12Passenger",
        "MovingVan",
        "Van15Passenger",
        "CargoVan",
        "Truck12Foot",
        "Truck20Foot",
        "Truck24Foot",
        "Truck26Foot",
        "Moped",
        "Stretch",
        "Regular",
        "Unique",
        "Exotic",
        "TruckSmallMedium",
        "TruckLarge",
        "SUVSmall",
        "SUVMedium",
        "SUVLarge",
        "SUVExotic",
        "FourWheelDrive",
        "Special",
        "Miscellaneous"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "noShowIndicator": {
    "description": "No show indicator. Indicates whether rental vehicle was reserved, but not actually rented.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotApplicable",
        "NoShow"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "adjustmentData": {
    "description": "Data related to any auto rental adjustments.",
    "type": "POST_AutoRentalAdjustmentData/v1/authorization/{transactionId}/completion",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "pickupData": {
    "description": "Data related to autorental pickup.",
    "type": "POST_AutoRentalPickupData/v1/authorization/{transactionId}/completion",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "returnData": {
    "description": "Data related to autorental return.",
    "type": "POST_AutoRentalReturnData/v1/authorization/{transactionId}/completion",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "dailyRentalRate": {
    "description": "Rate charged per day Visa/MC � Daily rate required for Corp T&E rate III.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0"
    },
    "required": false
  },
  "weeklyRentalRate": {
    "description": "Rate charged per week Visa/MC � Weekly rate required for Corp T&E rate III.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0"
    },
    "required": false
  },
  "insuranceCharges": {
    "description": "If insurance is charged, the insurance amount should be provided.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "duration": {
    "description": "The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRentalAdjustmentData 
{
  "amount": {
    "description": "Adjustment amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "code": {
    "description": "Indicates if adjustment for mileage, fuel, vehicle damage, etc. was made to a rental agreement.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NoAdjustments",
        "MultipleAdjustments",
        "OneAdjustmentCardmemberNotified",
        "OneAdjustmentCardmemberNotNotified"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "extraChargesDetail": {
    "description": "Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NoExtraCharge.",
    "type": "Array",
    "items": {
      "type": "POST_AutoRentalExtraChargesDetail/v1/authorization/{transactionId}/completion"
    },
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NoExtraCharge",
        "Gasoline",
        "ExtraMileage",
        "LateReturn",
        "OneWayServiceFee",
        "ParkingOrMovingViolation"
      ]
    },
    "paramValues": {
      "max": "100",
      "defaultValue": "NoExtraCharge"
    },
    "required": false
  }
}
AutoRentalPickupData 
{
  "city": {
    "description": "Auto rental pickup city.",
    "type": "string",
    "paramValues": {
      "max": "18",
      "defaultValue": ""
    },
    "required": false
  },
  "countryCode": {
    "description": "Country code where vehicle was picked up. For US, use 840.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "date": {
    "description": "return date in yyyy-MM-ddTHH:mm:ss format.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "location": {
    "description": "Name of business where vehicle was picked up.",
    "type": "string",
    "paramValues": {
      "max": "38",
      "defaultValue": ""
    },
    "required": false
  },
  "state": {
    "description": "Abbreviation of state, province, or other country subdivision where vehicle was picked up.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRentalReturnData 
{
  "city": {
    "description": "Auto rental return city.",
    "type": "string",
    "paramValues": {
      "max": "18",
      "defaultValue": ""
    },
    "required": false
  },
  "countryCode": {
    "description": "Country code where vehicle was returned. For US, use 840.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "date": {
    "description": "return date in yyyy-MM-ddTHH:mm:ss format.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "locationId": {
    "description": "Auto Rental location ID where vehicle was returned.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "state": {
    "description": "Auto rental return state.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "distance": {
    "description": "Numeric distance traveled during rental period.",
    "type": "int",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "distanceUnit": {
    "description": "Unit of measurement applicable to distance traveled.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "0 = Unused",
        "1 = Miles",
        "2 = Kilometers"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  }
}
AuthorizationCompletionRequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Use this parameter to allow manual entry of card account numbers on the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "true"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  },
  "promptForSignature": {
    "description": "Specifies how the signature prompt should be handled for the request. If a value is not provided, Never will be used. See <a href='../help/kb/signaturePrompt.html'>Signature Prompt</a>.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Always",
        "Never",
        "None"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Never"
    },
    "required": false
  },
  "provisionalAmount": {
    "description": "Override provisional amount used for QC transactions, which is $1.00 by default",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "1"
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Specifies the user input timeout.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "60000"
    },
    "required": false
  }
}
LodgingTransactionCompletion 
{
  "agreementNumber": {
    "description": "The lodging agreement number.",
    "type": "string",
    "paramValues": {
      "max": "14",
      "defaultValue": ""
    },
    "required": false
  },
  "chargeType": {
    "description": "The lodging charge type. For an empty or invalid value, this parameter defaults to Default.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Restaurant",
        "GiftShop"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Default"
    },
    "required": false
  },
  "checkInDate": {
    "description": "The check-in date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "checkOutDate": {
    "description": "The check-out date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "customerName": {
    "description": "The lodging customer name.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "duration": {
    "description": "The number of hotel stay days. Set to 1 for no show.",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "extraChargesDetail": {
    "description": "Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NotUsed.",
    "type": "Array",
    "items": {
      "type": "POST_LodgingExtraChargesDetail/v1/authorization/{transactionId}/completion"
    },
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotUsed",
        "Reserved",
        "Restaurant",
        "GiftShop",
        "MiniBar",
        "Telephone",
        "Other",
        "Laundry"
      ]
    },
    "paramValues": {
      "max": "100",
      "defaultValue": "NotUsed"
    },
    "required": false
  },
  "noShow": {
    "description": "Set to true to indicate no show. Otherwise, value defaults to false.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "prestigiousPropertyCode": {
    "description": "The lodging prestigious property code. For an empty or invalid value, this parameter defaults to NonParticipant.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NonParticipant",
        "FiveHundredDollarLimit",
        "OneThousandDollarLimit",
        "OneThousandFiveHundredDollarLimit"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "NonParticipant"
    },
    "required": false
  },
  "roomAmount": {
    "description": "The nightly rate for one room.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "specialProgramCode": {
    "description": "The lodging special program code. For an empty or invalid value, this parameter defaults to Default.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Sale",
        "NoShow",
        "AdvanceDeposit"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Default"
    },
    "required": false
  }
}

Response Class

AuthorizationCompletionResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "approvedAmount": "double",
  "balanceAmount": "double",
  "balanceCurrencyCode": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "convenienceFeeAmount": "double",
  "currencyCode": "string",
  "ebtType": "string",
  "emv": {
    "applicationIdentifier": "string",
    "applicationLabel": "string",
    "applicationPreferredName": "string",
    "applicationTransactionCounter": "string",
    "cryptogram": "string",
    "issuerCodeTableIndex": "string",
    "pinBypassed": "boolean",
    "tags": {
      "key": "string",
      "value": "string"
    }
  },
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "fsaCard": "string",
  "isApproved": "boolean",
  "isCardInserted": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "networkLabel": "string",
  "nonFinancialData": {
    "cardEntryMode": "string",
    "track1": "string",
    "track2": "string",
    "track3": "string"
  },
  "paymentType": "string",
  "pinVerified": "boolean",
  "quickChipMessage": "string",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "tipAmount": "double",
  "tokenId": "string",
  "tokenProvider": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
AuthorizationCompletionResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double 10 The amount approved by the processor. This is the actual amount that will be charged or credited.
balanceAmount false double 13 The balance of the gift card.
balanceCurrencyCode false string 4 The balance currency code.
Values:
  • None
  • Usd
binValue false string 6 The BIN entry that matched the account number.
cardHolderName false string 80 The cardholder name.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double 10 The convenience fee added to the transaction
currencyCode false string 4 The currency code used in the transaction.
Values:
  • None
  • Usd
ebtType false string 16 The type of the EBT card
Values:
  • None
  • FoodStamp
  • CashBenefit
emv false Emv The fields used on the receipt for an EMV transaction. Null if the transaction was not EMV.
entryMode false string 32 Description of how card was entered.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
fsaCard false string 32 Indicates whether the card used was a FSA card.
Note: Maybe = No BIN entry to determine if FSA.
Values:
  • NotApplicable
  • No
  • Yes
  • Maybe
isApproved false boolean 5 Set to true if the host approved the transaction.
isCardInserted false boolean 5 Indicates whether the EMV card was still inserted into the payment device when the transaction completed.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
networkLabel false string 30 Label that shows the network where the transaction was routed for authorization
nonFinancialData false NonFinancialCard Non Financial data.
paymentType false string 16 Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
  • Ebt
pinVerified false boolean 5 True if the PIN was verified, false if not verified or undetermined.
quickChipMessage false string 500 The message unique to QuickChip pre-read functionality only.
signature false Signature The signature data.
statusCode false string 40 The status code for the transaction.
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
subTotalAmount false double 10 The original amount sent for the transaction.
terminalId false string 40 The ID of the terminal used during the transaction
tipAmount false double 12 The tip amount added to the transaction.
tokenId false string 100 The Token ID.
tokenProvider false string 32 The Token Provider.
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Emv
Field Required Data Type Max Length Default Value Description
applicationIdentifier false string 16 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 false string 16 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 false string 16 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.
applicationTransactionCounter false string 2 The application transaction counter.
cryptogram false string 60 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.
issuerCodeTableIndex false string 2 Indicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name.
pinBypassed false boolean 5 undefined
tags false Array<Tag> A name value collection of additional EMV tags that are required to appear on the receipt.
Tag
Field Required Data Type Max Length Default Value Description
key false string 10 undefined
value false string 64 undefined
NonFinancialCard
Field Required Data Type Max Length Default Value Description
cardEntryMode false string 32 Card entry mode
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
  • FSwipe
track1 false string 79 Track 1 of the non-financial card
track2 false string 40 Track 2 of the non-financial card
track3 false string 128 Track 3 of the non-financial card
Signature
Field Required Data Type Max Length Default Value Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string 32 The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string 50 Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
  • SignatureRequiredButPromptSuppressedByMerchant
  • SignatureNotRequiredByUnattendedPinPad
AuthorizationCompletionResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved by the processor. This is the actual amount that will be charged or credited.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceAmount": {
    "description": "The balance of the gift card.",
    "type": "double",
    "paramValues": {
      "max": "13",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceCurrencyCode": {
    "description": "The balance currency code.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderName": {
    "description": "The cardholder name.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "ebtType": {
    "description": "The type of the EBT card",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "FoodStamp",
        "CashBenefit"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "emv": {
    "description": "The fields used on the receipt for an EMV transaction. Null if the transaction was not EMV.",
    "type": "Emv",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "fsaCard": {
    "description": "Indicates whether the card used was a FSA card.<br />Note: Maybe = No BIN entry to determine if FSA.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotApplicable",
        "No",
        "Yes",
        "Maybe"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isCardInserted": {
    "description": "Indicates whether the EMV card was still inserted into the payment device when the transaction completed.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "networkLabel": {
    "description": "Label that shows the network where the transaction was routed for authorization",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "nonFinancialData": {
    "description": "Non Financial data.",
    "type": "NonFinancialCard",
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift",
        "Ebt"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "quickChipMessage": {
    "description": "The message unique to QuickChip pre-read functionality only.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "subTotalAmount": {
    "description": "The original amount sent for the transaction.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount added to the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenId": {
    "description": "The Token ID.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenProvider": {
    "description": "The Token Provider.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Emv 
{
  "applicationIdentifier": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "applicationLabel": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "applicationPreferredName": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "applicationTransactionCounter": {
    "description": "The application transaction counter.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "cryptogram": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "60",
      "defaultValue": ""
    },
    "required": false
  },
  "issuerCodeTableIndex": {
    "description": "Indicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "pinBypassed": {
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "tags": {
    "description": "A name value collection of additional EMV tags that are required to appear on the receipt.",
    "type": "Array",
    "items": {
      "$ref": "Tag"
    },
    "required": false
  }
}
Tag 
{
  "key": {
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "value": {
    "type": "string",
    "paramValues": {
      "max": "64",
      "defaultValue": ""
    },
    "required": false
  }
}
NonFinancialCard 
{
  "cardEntryMode": {
    "description": "Card entry mode",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd",
        "FSwipe"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "track1": {
    "description": "Track 1 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "79",
      "defaultValue": ""
    },
    "required": false
  },
  "track2": {
    "description": "Track 2 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "track3": {
    "description": "Track 3 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "128",
      "defaultValue": ""
    },
    "required": false
  }
}
Signature 
{
  "data": {
    "description": "The byte array of the signature in the format specified by Format.",
    "type": "Array",
    "items": {
      "type": "byte"
    },
    "required": false
  },
  "format": {
    "description": "The format of the signature.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PointsLittleEndian",
        "PointsBigEndian",
        "Ascii3Byte"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "Indicates why a signature is or is not present.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "SignatureRequired",
        "SignaturePresent",
        "SignatureRequiredCancelledByCardholder",
        "SignatureRequiredNotSupportedByPinPad",
        "SignatureRequiredPinPadError",
        "SignatureNotRequiredByThresholdAmount",
        "SignatureNotRequiredByPaymentType",
        "SignatureNotRequiredByTransactionType",
        "SignatureRequiredButPromptSuppressedByMerchant",
        "SignatureNotRequiredByUnattendedPinPad"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if MarketCode is not HotelLodging but the request includes lodging parameters on a valid lodging request.
400 Returned if the lodging checkInDate or checkOutDate is not in the ISO 8601 format of YYYY-MM-DD on a valid lodging request.
400 Returned if the lodging roomAmount is less than 0.00 on a valid lodging request.
400 Returned if the lodging duration is less than 0 on a valid lodging request.
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
POST
/api/v1/authorization/{transactionId}/incremental Increases a previous card authorization by the given transactionAmount

Implementation Notes

This increments the original authorization by the given transactionAmount. The transactionId is the value returned by the original authorization. More�

Parameters

Parameter Parameter Type Data Type Description
transactionId path string The ID of a previous authorization transaction.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
IncrementalAuthorizationRequest body POST_IncrementalAuthorizationRequest/v1/authorization/{transactionId}/incremental undefined

Request Class

IncrementalAuthorizationRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "autoRental": {
    "duration": "int"
  },
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "marketCode": "string"
  },
  "getToken": "string",
  "lodging": {
    "duration": "int"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
TransactionIdRequestConfiguration 
{
  "marketCode": "string"
}
IncrementalAuthorizationRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
transactionAmount true double 10 0.00 The amount by which to increase the authorization amount.
autoRental false POST_AutoRentalBasic/v1/authorization/{t ransactionId}/incremental The auto rental parameters to be passed in for an auto rental transaction. more�
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
configuration false POST_TransactionIdRequestConfiguration/v 1/authorization/{transactionId}/incremen tal Applicable configuration values that can be set per request.
getToken false string 20 To retrieve Token in the transaction. more�
Values:
  • OmniToken
lodging false POST_LodgingIncrementalAuthorization/v1/ authorization/{transactionId}/incrementa l The lodging parameter to be passed in for a lodging transaction. more�
referenceNumber false string 50 A user defined reference number.
shiftId false string 10 An optional shift id for reference.
ticketNumber false string 50 An optional ticket number.
AutoRentalBasic
Field Required Data Type Max Length Default Value Description
duration false int 2 The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.
TransactionIdRequestConfiguration
Field Required Data Type Max Length Default Value Description
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
LodgingIncrementalAuthorization
Field Required Data Type Max Length Default Value Description
duration false int 2 The number of hotel stay days. Set to 1 for no show.
IncrementalAuthorizationRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The amount by which to increase the authorization amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "autoRental": {
    "description": "The auto rental parameters to be passed in for an auto rental transaction. <a href='../help/kb/autorental.html'>more&raquo;</a>",
    "type": "POST_AutoRentalBasic/v1/authorization/{transactionId}/incremental",
    "required": false
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Applicable configuration values that can be set per request.",
    "type": "POST_TransactionIdRequestConfiguration/v1/authorization/{transactionId}/incremental",
    "required": false
  },
  "getToken": {
    "description": "To retrieve Token in the transaction. <a href='../help/kb/GetToken.html'>more&raquo;</a>",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "OmniToken"
      ]
    },
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "lodging": {
    "description": "The lodging parameter to be passed in for a lodging transaction. <a href='../help/kb/lodging.html'>more&raquo;</a>",
    "type": "POST_LodgingIncrementalAuthorization/v1/authorization/{transactionId}/incremental",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRentalBasic 
{
  "duration": {
    "description": "The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  }
}
TransactionIdRequestConfiguration 
{
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  }
}
LodgingIncrementalAuthorization 
{
  "duration": {
    "description": "The number of hotel stay days. Set to 1 for no show.",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

IncrementalAuthorizationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "cardLogo": "string",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "marketCode": "string",
  "merchantId": "string",
  "referenceNumber": "string",
  "statusCode": "string",
  "terminalId": "string",
  "tokenId": "string",
  "tokenProvider": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
IncrementalAuthorizationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
marketCode false string 32 The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
merchantId false string 50 The Merchant used to process the transaction.
referenceNumber false string 50 The transaction's reference number.
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction
tokenId false string 100 The Token ID.
tokenProvider false string 32 The Token Provider.
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
IncrementalAuthorizationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "The transaction's reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenId": {
    "description": "The Token ID.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenProvider": {
    "description": "The Token Provider.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if the laneId, transactionId or transactionAmount are missing from the request.
400 Returned if the triPOS.config marketCode AND the request configuration marketCode are both null or default. One must be set to a non-default value.
400 Returned if your MarketCode is not HotelLodging but your request includes lodging parameters.
400 Returned if the lodging duration is less than 0 on a valid lodging request.
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
POST
/api/v1/authorization/token Creates a new card authorization using a token based on the passed in amounts

Implementation Notes

See OmniToken documentation for more information.

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
TokenAuthorizationRequest body POST_TokenAuthorizationRequest/v1/authorization/token undefined

Request Class

TokenAuthorizationRequest 
{
  "cardLogo": "string",
  "laneId": "int",
  "tokenId": "string",
  "tokenProvider": "string",
  "transactionAmount": "double",
  "vaultId": "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"
  },
  "autoRental": {
    "duration": "int"
  },
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "expirationMonth": "string",
  "expirationYear": "string",
  "healthcare": {
    "clinic": "double",
    "dental": "double",
    "prescription": "double",
    "total": "double",
    "vision": "double"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string",
  "tipAmount": "double"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "marketCode": "string"
}
TokenAuthorizationRequest
Field Required Data Type Max Length Default Value Description
cardLogo true string 20 The card logo of the card that the token represents.
Values:
  • Visa
  • MasterCard
  • Amex
  • Discover
  • Diners
  • StoredValue
  • Other
  • JCB
  • CarteBlanche
  • Interac
laneId true int Specifies which lane to use for the card sale.
tokenId true string 100 The token ID used for the sale.
tokenProvider true string 32 The type of token ID used for the sale.
Values:
  • OmniToken
transactionAmount true double 10 0.00 The total transaction amount. This is the amount of funds to move on the card
vaultId true string 10 The Vault ID used to create the token.
address false POST_Address/v1/authorization/token The cardholder address information for the transaction.
autoRental false POST_AutoRentalBasic/v1/authorization/to ken The auto rental parameters to be passed in for an auto rental transaction. more�
clerkNumber false string 10 An optional clerk number for reference.
configuration false POST_RequestConfiguration/v1/authorizati on/token Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double 10 0.00 The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
expirationMonth false string 2 The expiration month of the card the token represents. Although this is not required, it is recommended for fraud protection.
expirationYear false string 2 The expiration year of the card the token represents. Although this is not required, it is recommended for fraud protection.
healthcare false POST_Healthcare/v1/authorization/token The healthcare section that contains all applicable healthcare-qualified amounts. more�
referenceNumber false string 50 A user defined reference number.
shiftId false string 10 An optional shift id for reference.
ticketNumber false string 50 An optional ticket number.
tipAmount false double 12 0.00 The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
Address
Field Required Data Type Max Length Default Value Description
billingAddress1 false string 50 The street address used for billing purposes.
billingAddress2 false string 50 The street address used for billing purposes.
billingCity false string 40 The name of the city used for billing purposes.
billingEmail false string 80 The e-mail address used for billing purposes.
billingName false string 100 The name used for billing purposes.
billingPhone false string 20 The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string 20 The postal code used for billing purposes.
billingState false string 30 The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
shippingAddress1 false string 50 The street address used for shipping purposes.
shippingAddress2 false string 50 The street address used for shipping purposes.
shippingCity false string 40 The name of the city used for shipping purposes.
shippingEmail false string 80 The e-mail address used for shipping purposes.
shippingName false string 100 The name used for shipping purposes.
shippingPhone false string 20 The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string 20 The postal code used for shipping purposes.
shippingState false string 30 The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
AutoRentalBasic
Field Required Data Type Max Length Default Value Description
duration false int 2 The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.
RequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
Healthcare
Field Required Data Type Max Length Default Value Description
clinic false double 12 The total amount of healthcare-qualified goods that fall into the category of 'clinic'.
dental false double 12 The total amount of healthcare-qualified goods that fall into the category of 'dental'.
prescription false double 12 The total amount of healthcare-qualified goods that fall into the category of 'prescription'.
total false double 12 The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.
vision false double 12 The total amount of healthcare-qualified goods that fall into the category of 'vision'.
TokenAuthorizationRequest 
{
  "cardLogo": {
    "description": "The card logo of the card that the token represents.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Visa",
        "MasterCard",
        "Amex",
        "Discover",
        "Diners",
        "StoredValue",
        "Other",
        "JCB",
        "CarteBlanche",
        "Interac"
      ]
    },
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": true
  },
  "laneId": {
    "description": "Specifies which lane to use for the card sale.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "tokenId": {
    "description": "The token ID used for the sale.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": true
  },
  "tokenProvider": {
    "description": "The type of token ID used for the sale.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "OmniToken"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "vaultId": {
    "description": "The Vault ID used to create the token.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/v1/authorization/token",
    "required": false
  },
  "autoRental": {
    "description": "The auto rental parameters to be passed in for an auto rental transaction. <a href='../help/kb/autorental.html'>more&raquo;</a>",
    "type": "POST_AutoRentalBasic/v1/authorization/token",
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/v1/authorization/token",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The expiration month of the card the token represents. Although this is not required, it is recommended for fraud protection.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The expiration year of the card the token represents. Although this is not required, it is recommended for fraud protection.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "healthcare": {
    "description": "The healthcare section that contains all applicable healthcare-qualified amounts. <a href='../help/kb/healthcare.html'>more&raquo;</a>",
    "type": "POST_Healthcare/v1/authorization/token",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": "0.00"
    },
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingState": {
    "description": "The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingState": {
    "description": "The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRentalBasic 
{
  "duration": {
    "description": "The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  }
}
Healthcare 
{
  "clinic": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'clinic'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "dental": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'dental'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "prescription": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'prescription'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "total": {
    "description": "The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "vision": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'vision'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

TokenAuthorizationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "approvedAmount": "double",
  "avsResponseCode": "string",
  "cardLogo": "string",
  "convenienceFeeAmount": "double",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "referenceNumber": "string",
  "statusCode": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "tipAmount": "double",
  "tokenId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
TokenAuthorizationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double 10 The amount approved by the processor. This is the actual amount that will be charged or credited.
avsResponseCode false string 2 The AVS response code.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double 10 The convenience fee added to the transaction
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
referenceNumber false string 50 The reference number.
statusCode false string 40 The status code for the transaction.
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
subTotalAmount false double 10 The original amount sent for the transaction.
terminalId false string 40 The ID of the terminal used during the transaction
tipAmount false double 12 The tip amount added to the transaction.
tokenId false string 100 The token ID.
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
TokenAuthorizationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved by the processor. This is the actual amount that will be charged or credited.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "avsResponseCode": {
    "description": "The AVS response code.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "The reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "subTotalAmount": {
    "description": "The original amount sent for the transaction.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount added to the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenId": {
    "description": "The token ID.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
POST
/api/v1/balance Requests a balance for a gift card

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
BalanceRequest body POST_BalanceRequest/v1/balance undefined

Request Class

BalanceRequest 
{
  "laneId": "int",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "marketCode": "string"
  },
  "ebtType": "string",
  "invokeManualEntry": "boolean",
  "isCscSupported": "string",
  "referenceNumber": "string",
  "shiftId": "string",
  "storeCard": {
    "Id": "string",
    "Password": "string"
  },
  "ticketNumber": "string"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "marketCode": "string"
}
BalanceRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
configuration false POST_RequestConfiguration/v1/balance Any value included in this section will override the corresponding value set in the triPOS.config
ebtType false string 16 EbtType may be FoodStamp or CashBenefit
Values:
  • None
  • FoodStamp
  • CashBenefit
invokeManualEntry false boolean 5 false Invokes manual card entry.
isCscSupported false string 5 false Invokes prompt for cardholder to enter card security code for manual keyed card entry.
referenceNumber false string 50 A user defined reference number.
shiftId false string 10 An optional shift id for reference.
storeCard false POST_StoreCard/v1/balance Information necessary to process a StoreCard transaction.
ticketNumber false string 50 An optional ticket number.
RequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
StoreCard
Field Required Data Type Max Length Default Value Description
Id false string 32 The ID of a StoreCard.
Password false string 32 The password of StoreCard.
BalanceRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/v1/balance",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "ebtType": {
    "description": "EbtType may be FoodStamp or CashBenefit",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "FoodStamp",
        "CashBenefit"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "invokeManualEntry": {
    "description": "Invokes manual card entry.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isCscSupported": {
    "description": "Invokes prompt for cardholder to enter card security code for manual keyed card entry.",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "storeCard": {
    "description": "Information necessary to process a StoreCard transaction.",
    "type": "POST_StoreCard/v1/balance",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  }
}
StoreCard 
{
  "Id": {
    "description": "The ID of a StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "Password": {
    "description": "The password of StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

BalanceResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "balanceAmount": "double",
  "balanceCurrencyCode": "string",
  "binValue": "string",
  "cardLogo": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "paymentType": "string",
  "statusCode": "string",
  "terminalId": "string",
  "transactionDateTime": "string",
  "transactionId": "string"
}
BalanceResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
balanceAmount false double 13 The balance of the gift card.
balanceCurrencyCode false string 4 The balance currency code.
binValue false string 6 The BIN entry that matched the account number.
cardLogo false string 20 The card logo (e.g. Visa, Mastercard, etc).
entryMode false string 32 Description of how card was entered: Keyed, Swiped, Chip.
expirationMonth false string 2 The card's expiration month. NOTE: Not all cards that support balance inquiry will have an expiration date.
expirationYear false string 2 The card's expiration year. NOTE: Not all cards that support balance inquiry will have an expiration date.
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
paymentType false string 16 Description of how card payment type: None, Credit, Debit.
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
BalanceResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceAmount": {
    "description": "The balance of the gift card.",
    "type": "double",
    "paramValues": {
      "max": "13",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceCurrencyCode": {
    "description": "The balance currency code.",
    "type": "string",
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo (e.g. Visa, Mastercard, etc).",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered: Keyed, Swiped, Chip.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month. NOTE: Not all cards that support balance inquiry will have an expiration date.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year. NOTE: Not all cards that support balance inquiry will have an expiration date.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentType": {
    "description": "Description of how card payment type: None, Credit, Debit.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
GET
/api/v1/barcode/{laneId} Initiates and retrieves the data from a barcode scan.

Implementation Notes

Use the barcode endpoint to initiate and retrieve the data from a barcode scan of a capable PIN pad. See barcode documentation for more information.

Parameters

Parameter Parameter Type Data Type Description
laneId path int The lane ID.
aimerLightsOn query string Sets the Aimer LED lights on/off.
image query string Sets the Image Mode to 1D, 2D, etc.
lighting query string Sets the Lighting Mode to a shorter or longer exposure time.
message query string The message to be displayed on the PIN pad screen.
scanLightsOn query string Sets the Scan LED lights on/off.
timeout query string Sets the amount of time (in seconds) triPOS should wait to receive the barcode data
useTrigger query string Sets the option to use the trigger to start a scan.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

BarcodeResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "laneId": "int",
  "readData": "string",
  "result": "string",
  "symbology": {
    "name": "string",
    "code": "int"
  }
}
BarcodeResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
laneId false int The lane ID.
readData false string 2000 The data read by a barcode scan in Base64.
result false string 32 The result of the barcode scan.
Values:
  • Success
  • Failure
  • BarcodeDataReadError
symbology false BarcodeSymbology The symbology of the barcode read.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
BarcodeSymbology
Field Required Data Type Max Length Default Value Description
name true string 40 undefined
code true int 40 undefined
Values:
  • 0 (AllSymbologies)
  • 1 (EAN13)
  • 2 (EAN8)
  • 3 (UPCA)
  • 4 (UPCE)
  • 5 (EAN13_2)
  • 6 (EAN8_2)
  • 7 (UPCA_2)
  • 8 (UPCE_2)
  • 9 (EAN13_5)
  • 10 (EAN8_5)
  • 11 (UPCA_5)
  • 12 (UPCE_5)
  • 13 (Code39)
  • 15 (Interleaved_2_of_5)
  • 16 (Standard_2_of_5)
  • 17 (Matrix_2_of_5)
  • 19 (CodaBar)
  • 20 (AmesCode)
  • 21 (MSI)
  • 22 (Plessey)
  • 23 (Code128)
  • 24 (Code16k)
  • 25 (Code93)
  • 26 (Code11)
  • 27 (Telepen)
  • 28 (Code49)
  • 29 (Code39_ItalianCPI)
  • 30 (CodablockA)
  • 31 (CodablockF)
  • 32 (Codablock256)
  • 33 (PDF417)
  • 34 (GS1_128)
  • 35 (ISBT128)
  • 36 (MicroPDF)
  • 37 (GS1_DataBarOmni)
  • 38 (GS1_DataBarLimited)
  • 39 (GS1_DataBarExpanded)
  • 40 (DataMatrix)
  • 41 (QRCode)
  • 42 (GS1_DataBar_Omni_Dir_Composite_CC_A)
  • 43 (GS1_DataBar)
  • 44 (GS1_DataBar_Expanded_Composite_CC_A)
  • 45 (GS1_Composite_GS1_128_Composite_CC_A)
  • 46 (EAN_13_Composite_CC_A)
  • 47 (EAN_8_Composite_CC_A)
  • 48 (UPC_A_Composite_CC_A)
  • 49 (UPC_E_Composite_CC_A)
  • 50 (GS1_DataBar_Omni_Dir_Composite_CC_B)
  • 51 (GS1_DataBar_Limited_Composite_CC_B)
  • 52 (GS1_DataBar_Expanded_Composite_CC_B)
  • 53 (GS1_Composite_GS1_128_Composite_CC_B)
  • 54 (EAN_13_Composite_CC_B)
  • 55 (EAN_8_Composite_CC_B)
  • 56 (UPC_A_Composite_CC_B)
  • 57 (UPC_E_Composite_CC_B)
  • 58 (GS1_Composite_GS1_128_Composite_CC_C)
  • 59 (ISBN)
  • 60 (Postnet)
  • 61 (Planet)
  • 62 (BPO)
  • 63 (CanadaPost)
  • 64 (AustralianPost)
  • 65 (JapanPost)
  • 66 (DutchPost)
  • 67 (ChinaPost)
  • 68 (KoreanPost)
  • 69 (TLC39)
  • 70 (Trioptic)
  • 71 (ISMN)
  • 72 (ISSN)
  • 73 (Aztec)
  • 74 (SwedenPost)
  • 75 (Infomail)
  • 76 (Multicode)
  • 77 (IncompleteMulticode)
  • -1 (Unknown)
BarcodeResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "laneId": {
    "description": "The lane ID.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "readData": {
    "description": "The data read by a barcode scan in Base64.",
    "type": "string",
    "paramValues": {
      "max": "2000",
      "defaultValue": ""
    },
    "required": false
  },
  "result": {
    "description": "The result of the barcode scan.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Success",
        "Failure",
        "BarcodeDataReadError"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "symbology": {
    "description": "The symbology of the barcode read.",
    "type": "BarcodeSymbology",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
BarcodeSymbology 
{
  "name": {
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": true
  },
  "code": {
    "type": "int",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "0 (AllSymbologies)",
        "1 (EAN13)",
        "2 (EAN8)",
        "3 (UPCA)",
        "4 (UPCE)",
        "5 (EAN13_2)",
        "6 (EAN8_2)",
        "7 (UPCA_2)",
        "8 (UPCE_2)",
        "9 (EAN13_5)",
        "10 (EAN8_5)",
        "11 (UPCA_5)",
        "12 (UPCE_5)",
        "13 (Code39)",
        "15 (Interleaved_2_of_5)",
        "16 (Standard_2_of_5)",
        "17 (Matrix_2_of_5)",
        "19 (CodaBar)",
        "20 (AmesCode)",
        "21 (MSI)",
        "22 (Plessey)",
        "23 (Code128)",
        "24 (Code16k)",
        "25 (Code93)",
        "26 (Code11)",
        "27 (Telepen)",
        "28 (Code49)",
        "29 (Code39_ItalianCPI)",
        "30 (CodablockA)",
        "31 (CodablockF)",
        "32 (Codablock256)",
        "33 (PDF417)",
        "34 (GS1_128)",
        "35 (ISBT128)",
        "36 (MicroPDF)",
        "37 (GS1_DataBarOmni)",
        "38 (GS1_DataBarLimited)",
        "39 (GS1_DataBarExpanded)",
        "40 (DataMatrix)",
        "41 (QRCode)",
        "42 (GS1_DataBar_Omni_Dir_Composite_CC_A)",
        "43 (GS1_DataBar)",
        "44 (GS1_DataBar_Expanded_Composite_CC_A)",
        "45 (GS1_Composite_GS1_128_Composite_CC_A)",
        "46 (EAN_13_Composite_CC_A)",
        "47 (EAN_8_Composite_CC_A)",
        "48 (UPC_A_Composite_CC_A)",
        "49 (UPC_E_Composite_CC_A)",
        "50 (GS1_DataBar_Omni_Dir_Composite_CC_B)",
        "51 (GS1_DataBar_Limited_Composite_CC_B)",
        "52 (GS1_DataBar_Expanded_Composite_CC_B)",
        "53 (GS1_Composite_GS1_128_Composite_CC_B)",
        "54 (EAN_13_Composite_CC_B)",
        "55 (EAN_8_Composite_CC_B)",
        "56 (UPC_A_Composite_CC_B)",
        "57 (UPC_E_Composite_CC_B)",
        "58 (GS1_Composite_GS1_128_Composite_CC_C)",
        "59 (ISBN)",
        "60 (Postnet)",
        "61 (Planet)",
        "62 (BPO)",
        "63 (CanadaPost)",
        "64 (AustralianPost)",
        "65 (JapanPost)",
        "66 (DutchPost)",
        "67 (ChinaPost)",
        "68 (KoreanPost)",
        "69 (TLC39)",
        "70 (Trioptic)",
        "71 (ISMN)",
        "72 (ISSN)",
        "73 (Aztec)",
        "74 (SwedenPost)",
        "75 (Infomail)",
        "76 (Multicode)",
        "77 (IncompleteMulticode)",
        "-1 (Unknown)"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": true
  }
}
GET
/api/v1/binQuery/{laneId} Determine if a card falls into a specific BIN range such as prepaid, healthcare, or debit

Implementation Notes

Use the GET /binQuery/{laneId} endpoint to determine if a card falls into a specific BIN range such as prepaid, healthcare, or debit. The BIN query endpoint always makes an online call to the host in order to ensure the most up-to-date BIN information. If the card swiped or inserted is not found in the online BIN table, this endpoint returns a 404 Not Found HTTP response.

Parameters

Parameter Parameter Type Data Type Description
laneId path int The lane ID.
invokeManualEntry query boolean The flag that invokes manual entry directly.
isCscSupported query string Invokes prompt for cardholder to enter card security code for manual keyed card entry.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

BinQueryResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "check": "boolean",
  "commercial": "boolean",
  "credit": "boolean",
  "debit": "boolean",
  "durbinBinRegulation": "string",
  "ebt": "boolean",
  "fleet": "boolean",
  "gift": "boolean",
  "hsaFsa": "boolean",
  "internationalBin": "boolean",
  "pinlessBillPay": "boolean",
  "prepaid": "boolean",
  "wic": "boolean"
}
BinQueryResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
check false boolean 5 Check card indicator
commercial false boolean 5 Commercial card indicator
credit false boolean 5 Credit card indicator
debit false boolean 5 Debit card indicator
durbinBinRegulation false string 40 Durbin BIN Regulation indicator
Values:
  • Unknown
  • NotRegulated
  • Regulated
  • RegulatedWithFraudAdj
  • NotRegulatedPreferred
  • RegulatedPreferred
  • RegulatedWithFraudAdjPreferred
ebt false boolean 5 EBT card indicator
fleet false boolean 5 Fleet card indicator
gift false boolean 5 Gift card indicator
hsaFsa false boolean 5 HSA/FSA card indicator
internationalBin false boolean 5 International BIN indicator
pinlessBillPay false boolean 5 PINless Bill Pay indicator
prepaid false boolean 5 Prepaid card indicator
wic false boolean 5 WIC card indicator
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
BinQueryResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "check": {
    "description": "Check card indicator",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "commercial": {
    "description": "Commercial card indicator",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "credit": {
    "description": "Credit card indicator",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "debit": {
    "description": "Debit card indicator",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "durbinBinRegulation": {
    "description": "Durbin BIN Regulation indicator",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "NotRegulated",
        "Regulated",
        "RegulatedWithFraudAdj",
        "NotRegulatedPreferred",
        "RegulatedPreferred",
        "RegulatedWithFraudAdjPreferred"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "ebt": {
    "description": "EBT card indicator",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "fleet": {
    "description": "Fleet card indicator",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "gift": {
    "description": "Gift card indicator",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "hsaFsa": {
    "description": "HSA/FSA card indicator",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "internationalBin": {
    "description": "International BIN indicator",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "pinlessBillPay": {
    "description": "PINless Bill Pay indicator",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "prepaid": {
    "description": "Prepaid card indicator",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "wic": {
    "description": "WIC card indicator",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
404 Returned if card is not found in the BIN table
GET
/api/v1/card Return a list of the triPOS Card endpoints

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

CardResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "cardType": "string",
  "financialCard": {
    "accountNumber": "string",
    "binValue": "string",
    "cardEntryMode": "string",
    "cardholderName": "string",
    "cardLogo": "string",
    "encryptedCardData": {
      "cardDataKeySerialNumber": "string",
      "cardNumberMasked": "string",
      "cvv": "string",
      "encryptedFormat": "string",
      "encryptedManualKeyedCardData": "string",
      "encryptedTrack1Data": "string",
      "encryptedTrack2Data": "string",
      "keySerialNumber": "string",
      "magneprintData": "string",
      "pinBlock": "string",
      "track1Data": "string",
      "track2Data": "string",
      "track3Data": "string"
    },
    "expirationMonth": "string",
    "expirationYear": "string"
  },
  "nonFinancialCard": {
    "cardEntryMode": "string",
    "track1": "string",
    "track2": "string",
    "track3": "string"
  }
}
CardResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
cardType false string 32 Indidcates whether the card read was a financial or non-financial card.
Values:
  • Unknown
  • Financial
  • NonFinancial
financialCard false FinancialCard Fields for a financial card response. These fields are populated if the card read was a financial card.
nonFinancialCard false NonFinancialCard Fields for a non-financial card response. These fields are populated if the card read was a non-financial card.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
FinancialCard
Field Required Data Type Max Length Default Value Description
accountNumber false string 19 The card account number.
binValue false string 6 The BIN entry that matched the account number.
cardEntryMode false string 32 Card entry mode
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
cardholderName false string 80 The name of the cardholder as printed on the front of the card
cardLogo false string 20 Brand of the card. Possible values include: Visa, Mastercard, Discover
encryptedCardData false EncryptedCardData The encrypted card data
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
EncryptedCardData
Field Required Data Type Max Length Default Value Description
cardDataKeySerialNumber false string 20 Encrypted card data key serial number.
cardNumberMasked false string 19 The masked card number.
cvv false string 4 Card verification value found on the card.
encryptedFormat false string 10 The format of the encrypted manual keyed card data.
Values:
  • Default
  • Format1
  • Format2
  • Format3
  • Format4
  • Format5
  • Format6
  • Format7
  • Format9
  • Format10
  • Format11
encryptedManualKeyedCardData false string 200 Encrypted manually keyed card data.
encryptedTrack1Data false string 300 Encrypted swiped track 1 data.
encryptedTrack2Data false string 200 Encrypted swiped track 2 data.
keySerialNumber false string 20 PIN key serial number.
magneprintData false string 1500 Raw output of certain devices directly supported by Express.
pinBlock false string 16 Encrypted PIN block information sent from the PIN encryption device.
track1Data false string 79 Clear text swiped track 1 data.
track2Data false string 40 Clear text swiped track 2 data.
track3Data false string 128 Clear text swiped track 3 data.
NonFinancialCard
Field Required Data Type Max Length Default Value Description
cardEntryMode false string 32 Card entry mode
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
  • FSwipe
track1 false string 79 Track 1 of the non-financial card
track2 false string 40 Track 2 of the non-financial card
track3 false string 128 Track 3 of the non-financial card
CardResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "cardType": {
    "description": "Indidcates whether the card read was a financial or non-financial card.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Financial",
        "NonFinancial"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "financialCard": {
    "description": "Fields for a financial card response. These fields are populated if the card read was a financial card.",
    "type": "FinancialCard",
    "required": false
  },
  "nonFinancialCard": {
    "description": "Fields for a non-financial card response. These fields are populated if the card read was a non-financial card.",
    "type": "NonFinancialCard",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
FinancialCard 
{
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardEntryMode": {
    "description": "Card entry mode",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "cardholderName": {
    "description": "The name of the cardholder as printed on the front of the card",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "Brand of the card. Possible values include: Visa, Mastercard, Discover",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedCardData": {
    "description": "The encrypted card data",
    "type": "EncryptedCardData",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  }
}
EncryptedCardData 
{
  "cardDataKeySerialNumber": {
    "description": "Encrypted card data key serial number.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "cardNumberMasked": {
    "description": "The masked card number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "cvv": {
    "description": "Card verification value found on the card.",
    "type": "string",
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedFormat": {
    "description": "The format of the encrypted manual keyed card data.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Format1",
        "Format2",
        "Format3",
        "Format4",
        "Format5",
        "Format6",
        "Format7",
        "Format9",
        "Format10",
        "Format11"
      ]
    },
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedManualKeyedCardData": {
    "description": "Encrypted manually keyed card data.",
    "type": "string",
    "paramValues": {
      "max": "200",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedTrack1Data": {
    "description": "Encrypted swiped track 1 data.",
    "type": "string",
    "paramValues": {
      "max": "300",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedTrack2Data": {
    "description": "Encrypted swiped track 2 data.",
    "type": "string",
    "paramValues": {
      "max": "200",
      "defaultValue": ""
    },
    "required": false
  },
  "keySerialNumber": {
    "description": "PIN key serial number.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "magneprintData": {
    "description": "Raw output of certain devices directly supported by Express.",
    "type": "string",
    "paramValues": {
      "max": "1500",
      "defaultValue": ""
    },
    "required": false
  },
  "pinBlock": {
    "description": "Encrypted PIN block information sent from the PIN encryption device.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "track1Data": {
    "description": "Clear text swiped track 1 data.",
    "type": "string",
    "paramValues": {
      "max": "79",
      "defaultValue": ""
    },
    "required": false
  },
  "track2Data": {
    "description": "Clear text swiped track 2 data.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "track3Data": {
    "description": "Clear text swiped track 3 data.",
    "type": "string",
    "paramValues": {
      "max": "128",
      "defaultValue": ""
    },
    "required": false
  }
}
NonFinancialCard 
{
  "cardEntryMode": {
    "description": "Card entry mode",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd",
        "FSwipe"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "track1": {
    "description": "Track 1 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "79",
      "defaultValue": ""
    },
    "required": false
  },
  "track2": {
    "description": "Track 2 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "track3": {
    "description": "Track 3 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "128",
      "defaultValue": ""
    },
    "required": false
  }
}
GET
/api/v1/card/{laneId} Get card info

Parameters

Parameter Parameter Type Data Type Description
laneId path int The lane ID.
isEncryptedDataNeeded query boolean The flag that indicates if encrypted card data needs to be obtained.
invokeManualEntry query boolean The flag that invokes manual entry directly.
isCscSupported query string Invokes prompt for cardholder to enter card security code for manual keyed card entry.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

CardResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "cardType": "string",
  "financialCard": {
    "accountNumber": "string",
    "binValue": "string",
    "cardEntryMode": "string",
    "cardholderName": "string",
    "cardLogo": "string",
    "encryptedCardData": {
      "cardDataKeySerialNumber": "string",
      "cardNumberMasked": "string",
      "cvv": "string",
      "encryptedFormat": "string",
      "encryptedManualKeyedCardData": "string",
      "encryptedTrack1Data": "string",
      "encryptedTrack2Data": "string",
      "keySerialNumber": "string",
      "magneprintData": "string",
      "pinBlock": "string",
      "track1Data": "string",
      "track2Data": "string",
      "track3Data": "string"
    },
    "expirationMonth": "string",
    "expirationYear": "string"
  },
  "nonFinancialCard": {
    "cardEntryMode": "string",
    "track1": "string",
    "track2": "string",
    "track3": "string"
  }
}
CardResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
cardType false string 32 Indidcates whether the card read was a financial or non-financial card.
Values:
  • Unknown
  • Financial
  • NonFinancial
financialCard false FinancialCard Fields for a financial card response. These fields are populated if the card read was a financial card.
nonFinancialCard false NonFinancialCard Fields for a non-financial card response. These fields are populated if the card read was a non-financial card.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
FinancialCard
Field Required Data Type Max Length Default Value Description
accountNumber false string 19 The card account number.
binValue false string 6 The BIN entry that matched the account number.
cardEntryMode false string 32 Card entry mode
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
cardholderName false string 80 The name of the cardholder as printed on the front of the card
cardLogo false string 20 Brand of the card. Possible values include: Visa, Mastercard, Discover
encryptedCardData false EncryptedCardData The encrypted card data
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
EncryptedCardData
Field Required Data Type Max Length Default Value Description
cardDataKeySerialNumber false string 20 Encrypted card data key serial number.
cardNumberMasked false string 19 The masked card number.
cvv false string 4 Card verification value found on the card.
encryptedFormat false string 10 The format of the encrypted manual keyed card data.
Values:
  • Default
  • Format1
  • Format2
  • Format3
  • Format4
  • Format5
  • Format6
  • Format7
  • Format9
  • Format10
  • Format11
encryptedManualKeyedCardData false string 200 Encrypted manually keyed card data.
encryptedTrack1Data false string 300 Encrypted swiped track 1 data.
encryptedTrack2Data false string 200 Encrypted swiped track 2 data.
keySerialNumber false string 20 PIN key serial number.
magneprintData false string 1500 Raw output of certain devices directly supported by Express.
pinBlock false string 16 Encrypted PIN block information sent from the PIN encryption device.
track1Data false string 79 Clear text swiped track 1 data.
track2Data false string 40 Clear text swiped track 2 data.
track3Data false string 128 Clear text swiped track 3 data.
NonFinancialCard
Field Required Data Type Max Length Default Value Description
cardEntryMode false string 32 Card entry mode
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
  • FSwipe
track1 false string 79 Track 1 of the non-financial card
track2 false string 40 Track 2 of the non-financial card
track3 false string 128 Track 3 of the non-financial card
CardResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "cardType": {
    "description": "Indidcates whether the card read was a financial or non-financial card.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Financial",
        "NonFinancial"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "financialCard": {
    "description": "Fields for a financial card response. These fields are populated if the card read was a financial card.",
    "type": "FinancialCard",
    "required": false
  },
  "nonFinancialCard": {
    "description": "Fields for a non-financial card response. These fields are populated if the card read was a non-financial card.",
    "type": "NonFinancialCard",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
FinancialCard 
{
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardEntryMode": {
    "description": "Card entry mode",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "cardholderName": {
    "description": "The name of the cardholder as printed on the front of the card",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "Brand of the card. Possible values include: Visa, Mastercard, Discover",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedCardData": {
    "description": "The encrypted card data",
    "type": "EncryptedCardData",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  }
}
EncryptedCardData 
{
  "cardDataKeySerialNumber": {
    "description": "Encrypted card data key serial number.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "cardNumberMasked": {
    "description": "The masked card number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "cvv": {
    "description": "Card verification value found on the card.",
    "type": "string",
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedFormat": {
    "description": "The format of the encrypted manual keyed card data.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Format1",
        "Format2",
        "Format3",
        "Format4",
        "Format5",
        "Format6",
        "Format7",
        "Format9",
        "Format10",
        "Format11"
      ]
    },
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedManualKeyedCardData": {
    "description": "Encrypted manually keyed card data.",
    "type": "string",
    "paramValues": {
      "max": "200",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedTrack1Data": {
    "description": "Encrypted swiped track 1 data.",
    "type": "string",
    "paramValues": {
      "max": "300",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedTrack2Data": {
    "description": "Encrypted swiped track 2 data.",
    "type": "string",
    "paramValues": {
      "max": "200",
      "defaultValue": ""
    },
    "required": false
  },
  "keySerialNumber": {
    "description": "PIN key serial number.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "magneprintData": {
    "description": "Raw output of certain devices directly supported by Express.",
    "type": "string",
    "paramValues": {
      "max": "1500",
      "defaultValue": ""
    },
    "required": false
  },
  "pinBlock": {
    "description": "Encrypted PIN block information sent from the PIN encryption device.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "track1Data": {
    "description": "Clear text swiped track 1 data.",
    "type": "string",
    "paramValues": {
      "max": "79",
      "defaultValue": ""
    },
    "required": false
  },
  "track2Data": {
    "description": "Clear text swiped track 2 data.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "track3Data": {
    "description": "Clear text swiped track 3 data.",
    "type": "string",
    "paramValues": {
      "max": "128",
      "defaultValue": ""
    },
    "required": false
  }
}
NonFinancialCard 
{
  "cardEntryMode": {
    "description": "Card entry mode",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd",
        "FSwipe"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "track1": {
    "description": "Track 1 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "79",
      "defaultValue": ""
    },
    "required": false
  },
  "track2": {
    "description": "Track 2 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "track3": {
    "description": "Track 3 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "128",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
404 If no data can be found when the card is swiped, tripos returns an HTTP status code of 404.
GET
/api/v1/card/financial Return a list of the triPOS FinancialCard endpoints

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

FinancialCardResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "binValue": "string",
  "cardEntryMode": "string",
  "cardholderName": "string",
  "cardLogo": "string",
  "encryptedCardData": {
    "cardDataKeySerialNumber": "string",
    "cardNumberMasked": "string",
    "cvv": "string",
    "encryptedFormat": "string",
    "encryptedManualKeyedCardData": "string",
    "encryptedTrack1Data": "string",
    "encryptedTrack2Data": "string",
    "keySerialNumber": "string",
    "magneprintData": "string",
    "pinBlock": "string",
    "track1Data": "string",
    "track2Data": "string",
    "track3Data": "string"
  },
  "expirationMonth": "string",
  "expirationYear": "string"
}
FinancialCardResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
binValue false string 6 The BIN entry that matched the account number.
cardEntryMode false string 32 Card entry mode
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
cardholderName false string 80 The name of the cardholder as printed on the front of the card
cardLogo false string 20 Brand of the card. Possible values include: Visa, Mastercard, Discover
encryptedCardData false EncryptedCardData The encrypted card data
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
EncryptedCardData
Field Required Data Type Max Length Default Value Description
cardDataKeySerialNumber false string 20 Encrypted card data key serial number.
cardNumberMasked false string 19 The masked card number.
cvv false string 4 Card verification value found on the card.
encryptedFormat false string 10 The format of the encrypted manual keyed card data.
Values:
  • Default
  • Format1
  • Format2
  • Format3
  • Format4
  • Format5
  • Format6
  • Format7
  • Format9
  • Format10
  • Format11
encryptedManualKeyedCardData false string 200 Encrypted manually keyed card data.
encryptedTrack1Data false string 300 Encrypted swiped track 1 data.
encryptedTrack2Data false string 200 Encrypted swiped track 2 data.
keySerialNumber false string 20 PIN key serial number.
magneprintData false string 1500 Raw output of certain devices directly supported by Express.
pinBlock false string 16 Encrypted PIN block information sent from the PIN encryption device.
track1Data false string 79 Clear text swiped track 1 data.
track2Data false string 40 Clear text swiped track 2 data.
track3Data false string 128 Clear text swiped track 3 data.
FinancialCardResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardEntryMode": {
    "description": "Card entry mode",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "cardholderName": {
    "description": "The name of the cardholder as printed on the front of the card",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "Brand of the card. Possible values include: Visa, Mastercard, Discover",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedCardData": {
    "description": "The encrypted card data",
    "type": "EncryptedCardData",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
EncryptedCardData 
{
  "cardDataKeySerialNumber": {
    "description": "Encrypted card data key serial number.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "cardNumberMasked": {
    "description": "The masked card number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "cvv": {
    "description": "Card verification value found on the card.",
    "type": "string",
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedFormat": {
    "description": "The format of the encrypted manual keyed card data.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Format1",
        "Format2",
        "Format3",
        "Format4",
        "Format5",
        "Format6",
        "Format7",
        "Format9",
        "Format10",
        "Format11"
      ]
    },
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedManualKeyedCardData": {
    "description": "Encrypted manually keyed card data.",
    "type": "string",
    "paramValues": {
      "max": "200",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedTrack1Data": {
    "description": "Encrypted swiped track 1 data.",
    "type": "string",
    "paramValues": {
      "max": "300",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedTrack2Data": {
    "description": "Encrypted swiped track 2 data.",
    "type": "string",
    "paramValues": {
      "max": "200",
      "defaultValue": ""
    },
    "required": false
  },
  "keySerialNumber": {
    "description": "PIN key serial number.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "magneprintData": {
    "description": "Raw output of certain devices directly supported by Express.",
    "type": "string",
    "paramValues": {
      "max": "1500",
      "defaultValue": ""
    },
    "required": false
  },
  "pinBlock": {
    "description": "Encrypted PIN block information sent from the PIN encryption device.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "track1Data": {
    "description": "Clear text swiped track 1 data.",
    "type": "string",
    "paramValues": {
      "max": "79",
      "defaultValue": ""
    },
    "required": false
  },
  "track2Data": {
    "description": "Clear text swiped track 2 data.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "track3Data": {
    "description": "Clear text swiped track 3 data.",
    "type": "string",
    "paramValues": {
      "max": "128",
      "defaultValue": ""
    },
    "required": false
  }
}
GET
/api/v1/card/financial/{laneId} Get financial card info

Parameters

Parameter Parameter Type Data Type Description
laneId path int The lane ID.
isEncryptedDataNeeded query boolean The flag that indicates if encrypted card data needs to be obtained.
invokeManualEntry query boolean The flag that invokes manual entry directly.
isCscSupported query string Invokes prompt for cardholder to enter card security code for manual keyed card entry.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

FinancialCardResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "binValue": "string",
  "cardEntryMode": "string",
  "cardholderName": "string",
  "cardLogo": "string",
  "encryptedCardData": {
    "cardDataKeySerialNumber": "string",
    "cardNumberMasked": "string",
    "cvv": "string",
    "encryptedFormat": "string",
    "encryptedManualKeyedCardData": "string",
    "encryptedTrack1Data": "string",
    "encryptedTrack2Data": "string",
    "keySerialNumber": "string",
    "magneprintData": "string",
    "pinBlock": "string",
    "track1Data": "string",
    "track2Data": "string",
    "track3Data": "string"
  },
  "expirationMonth": "string",
  "expirationYear": "string"
}
FinancialCardResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
binValue false string 6 The BIN entry that matched the account number.
cardEntryMode false string 32 Card entry mode
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
cardholderName false string 80 The name of the cardholder as printed on the front of the card
cardLogo false string 20 Brand of the card. Possible values include: Visa, Mastercard, Discover
encryptedCardData false EncryptedCardData The encrypted card data
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
EncryptedCardData
Field Required Data Type Max Length Default Value Description
cardDataKeySerialNumber false string 20 Encrypted card data key serial number.
cardNumberMasked false string 19 The masked card number.
cvv false string 4 Card verification value found on the card.
encryptedFormat false string 10 The format of the encrypted manual keyed card data.
Values:
  • Default
  • Format1
  • Format2
  • Format3
  • Format4
  • Format5
  • Format6
  • Format7
  • Format9
  • Format10
  • Format11
encryptedManualKeyedCardData false string 200 Encrypted manually keyed card data.
encryptedTrack1Data false string 300 Encrypted swiped track 1 data.
encryptedTrack2Data false string 200 Encrypted swiped track 2 data.
keySerialNumber false string 20 PIN key serial number.
magneprintData false string 1500 Raw output of certain devices directly supported by Express.
pinBlock false string 16 Encrypted PIN block information sent from the PIN encryption device.
track1Data false string 79 Clear text swiped track 1 data.
track2Data false string 40 Clear text swiped track 2 data.
track3Data false string 128 Clear text swiped track 3 data.
FinancialCardResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardEntryMode": {
    "description": "Card entry mode",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "cardholderName": {
    "description": "The name of the cardholder as printed on the front of the card",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "Brand of the card. Possible values include: Visa, Mastercard, Discover",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedCardData": {
    "description": "The encrypted card data",
    "type": "EncryptedCardData",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
EncryptedCardData 
{
  "cardDataKeySerialNumber": {
    "description": "Encrypted card data key serial number.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "cardNumberMasked": {
    "description": "The masked card number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "cvv": {
    "description": "Card verification value found on the card.",
    "type": "string",
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedFormat": {
    "description": "The format of the encrypted manual keyed card data.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Format1",
        "Format2",
        "Format3",
        "Format4",
        "Format5",
        "Format6",
        "Format7",
        "Format9",
        "Format10",
        "Format11"
      ]
    },
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedManualKeyedCardData": {
    "description": "Encrypted manually keyed card data.",
    "type": "string",
    "paramValues": {
      "max": "200",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedTrack1Data": {
    "description": "Encrypted swiped track 1 data.",
    "type": "string",
    "paramValues": {
      "max": "300",
      "defaultValue": ""
    },
    "required": false
  },
  "encryptedTrack2Data": {
    "description": "Encrypted swiped track 2 data.",
    "type": "string",
    "paramValues": {
      "max": "200",
      "defaultValue": ""
    },
    "required": false
  },
  "keySerialNumber": {
    "description": "PIN key serial number.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "magneprintData": {
    "description": "Raw output of certain devices directly supported by Express.",
    "type": "string",
    "paramValues": {
      "max": "1500",
      "defaultValue": ""
    },
    "required": false
  },
  "pinBlock": {
    "description": "Encrypted PIN block information sent from the PIN encryption device.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "track1Data": {
    "description": "Clear text swiped track 1 data.",
    "type": "string",
    "paramValues": {
      "max": "79",
      "defaultValue": ""
    },
    "required": false
  },
  "track2Data": {
    "description": "Clear text swiped track 2 data.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "track3Data": {
    "description": "Clear text swiped track 3 data.",
    "type": "string",
    "paramValues": {
      "max": "128",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
404 Returned if no financial data can be found when the card is swiped.
GET
/api/v1/card/nonfinancial Return a list of the triPOS NonFinancialCard endpoints

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

NonFinancialCardResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "cardEntryMode": "string",
  "track1": "string",
  "track2": "string",
  "track3": "string"
}
NonFinancialCardResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
cardEntryMode false string 32 Card entry mode
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
track1 false string 79 Track 1 of the non-financial card
track2 false string 40 Track 2 of the non-financial card
track3 false string 128 Track 3 of the non-financial card
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
NonFinancialCardResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "cardEntryMode": {
    "description": "Card entry mode",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "track1": {
    "description": "Track 1 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "79",
      "defaultValue": ""
    },
    "required": false
  },
  "track2": {
    "description": "Track 2 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "track3": {
    "description": "Track 3 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "128",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
GET
/api/v1/card/nonfinancial/{laneId} Get non-financial card info

Parameters

Parameter Parameter Type Data Type Description
laneId path int The lane ID.
invokeManualEntry query boolean The flag that invokes manual entry directly.
isCscSupported query string Invokes prompt for cardholder to enter card security code for manual keyed card entry.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

NonFinancialCardResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "cardEntryMode": "string",
  "track1": "string",
  "track2": "string",
  "track3": "string"
}
NonFinancialCardResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
cardEntryMode false string 32 Card entry mode
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
track1 false string 79 Track 1 of the non-financial card
track2 false string 40 Track 2 of the non-financial card
track3 false string 128 Track 3 of the non-financial card
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
NonFinancialCardResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "cardEntryMode": {
    "description": "Card entry mode",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "track1": {
    "description": "Track 1 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "79",
      "defaultValue": ""
    },
    "required": false
  },
  "track2": {
    "description": "Track 2 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "track3": {
    "description": "Track 3 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "128",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
404 If no 'non-financial' data can be found when the card is swiped, tripos returns an HTTP status code of 404.
GET
/api/v1/configuration Retrieve the HATEOAS links for accessing and modifying the triPOS configuration

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

ConfigurationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  }
}
ConfigurationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
ConfigurationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
GET
/api/v1/configuration/application Retrieve application settings

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

GetApplicationConfigurationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "binFileName": "string",
  "corsAllowedOrigins": "string",
  "defaultRebootTime": "string",
  "pinPadIdleMessage": "string",
  "testMode": "string"
}
GetApplicationConfigurationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
binFileName false string 100 Location of BIN files to be loaded from disk
corsAllowedOrigins false string 4096 Sets the origins allowed to submit requests to triPOS
defaultRebootTime false string 5 Default reboot time used if the reboot time is not specified under the pinpad section of lane configuration. Local time (HHMM in 24h format).
pinPadIdleMessage false string 50 Message to display on the PIN pad when it is idle.
testMode false string 5 Set to 'true' to be in Test/Certification mode or 'false' for Production mode.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
GetApplicationConfigurationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "binFileName": {
    "description": "Location of BIN files to be loaded from disk",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "corsAllowedOrigins": {
    "description": "Sets the origins allowed to submit requests to triPOS",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "defaultRebootTime": {
    "description": "Default reboot time used if the reboot time is not specified under the pinpad section of lane configuration. Local time (HHMM in 24h format).",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "pinPadIdleMessage": {
    "description": "Message to display on the PIN pad when it is idle.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "testMode": {
    "description": "Set to 'true' to be in Test/Certification mode or 'false' for Production mode.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
PUT
/api/v1/configuration/application Update application settings

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
UpdateApplicationConfigurationRequest body PUT_UpdateApplicationConfigurationRequest/v1/configuration/application undefined

Request Class

UpdateApplicationConfigurationRequest 
{
  "pinPadIdleMessage": "string",
  "testMode": "string",
  "binFileName": "string",
  "corsAllowedOrigins": "string",
  "defaultRebootTime": "string",
  "enhancedLaneStatus": "string",
  "quickChip": "string",
  "quickChipDataLifetime": "string"
}
UpdateApplicationConfigurationRequest
Field Required Data Type Max Length Default Value Description
pinPadIdleMessage true string 50 Message to display on the PIN pad when it is idle.
testMode true string 5 false Set to 'true' to be in Test/Certification mode or 'false' for Production mode.
binFileName false string 100 Location of BIN files to be loaded from disk
corsAllowedOrigins false string 4096 Sets the origins allowed to submit requests to triPOS using a comma separated string and HTTP prefix (Example: http://www.elementps.com, http://www.vantiv.com). To disable CORS support set the corsAllowedOrigins to an emptry string. To enable CORS for all domains set corsAllowOrigins to '*'.
defaultRebootTime false string 5 Default reboot time used if the reboot time is not specified under the pinpad section of lane configuration. Local time (HHMM in 24h format).
enhancedLaneStatus false string 5 false Set to 'true' to have POS system able to see expanded/enhanced lane status indicators in response.
quickChip false string 5 false Set to 'true' to enable POS system to support 'quick chip' transaction request.
quickChipDataLifetime false string 3 30 Set to amount of time to wait until quick chip data is cleaned/wiped out (in seconds).
UpdateApplicationConfigurationRequest 
{
  "pinPadIdleMessage": {
    "description": "Message to display on the PIN pad when it is idle.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": true
  },
  "testMode": {
    "description": "Set to 'true' to be in Test/Certification mode or 'false' for Production mode.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "binFileName": {
    "description": "Location of BIN files to be loaded from disk",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "corsAllowedOrigins": {
    "description": "Sets the origins allowed to submit requests to triPOS using a comma separated string and HTTP prefix (Example: http://www.elementps.com, http://www.vantiv.com). To disable CORS support set the corsAllowedOrigins to an emptry string. To enable CORS for all domains set corsAllowOrigins to '*'.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "defaultRebootTime": {
    "description": "Default reboot time used if the reboot time is not specified under the pinpad section of lane configuration. Local time (HHMM in 24h format).",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "enhancedLaneStatus": {
    "description": "Set to 'true' to have POS system able to see expanded/enhanced lane status indicators in response.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "quickChip": {
    "description": "Set to 'true' to enable POS system to support 'quick chip' transaction request.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "quickChipDataLifetime": {
    "description": "Set to amount of time to wait until quick chip data is cleaned/wiped out (in seconds).",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": "30"
    },
    "required": false
  }
}

Response Class

UpdateApplicationConfigurationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "applicationUpdated": "boolean",
  "binFileName": "string",
  "corsAllowedOrigins": "string",
  "defaultRebootTime": "string",
  "enhancedLaneStatus": "string",
  "pinPadIdleMessage": "string",
  "quickChip": "string",
  "quickChipDataLifetime": "string",
  "testMode": "string"
}
UpdateApplicationConfigurationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
applicationUpdated false boolean 5 Success message for application settings update.
binFileName false string 100 Location of BIN files to be loaded from disk
corsAllowedOrigins false string 4096 Sets the origins allowed to submit requests to triPOS
defaultRebootTime false string 5 Default reboot time used if the reboot time is not specified under the pinpad section of lane configuration. Local time (HHMM in 24h format).
enhancedLaneStatus false string 5 Set to 'true' to have POS system able to see expanded/enhanced lane status indicators in response.
pinPadIdleMessage false string 50 Message to display on the PIN pad when it is idle.
quickChip false string 5 Set to 'true' to enable POS system to support 'quick chip' transaction request.
quickChipDataLifetime false string 3 Set to amount of time to wait until quick chip data is cleaned/wiped out (in seconds).
testMode false string 5 Set to 'true' to be in Test/Certification mode or 'false' for Production mode.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
UpdateApplicationConfigurationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "applicationUpdated": {
    "description": "Success message for application settings update.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "binFileName": {
    "description": "Location of BIN files to be loaded from disk",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "corsAllowedOrigins": {
    "description": "Sets the origins allowed to submit requests to triPOS",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "defaultRebootTime": {
    "description": "Default reboot time used if the reboot time is not specified under the pinpad section of lane configuration. Local time (HHMM in 24h format).",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "enhancedLaneStatus": {
    "description": "Set to 'true' to have POS system able to see expanded/enhanced lane status indicators in response.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "pinPadIdleMessage": {
    "description": "Message to display on the PIN pad when it is idle.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "quickChip": {
    "description": "Set to 'true' to enable POS system to support 'quick chip' transaction request.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "quickChipDataLifetime": {
    "description": "Set to amount of time to wait until quick chip data is cleaned/wiped out (in seconds).",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "testMode": {
    "description": "Set to 'true' to be in Test/Certification mode or 'false' for Production mode.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
GET
/api/v1/configuration/host Get host settings

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

GetHostConfigurationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "autoReversalRetryLimit": "int",
  "driver": "string"
}
GetHostConfigurationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
autoReversalRetryLimit false int 2 The number of times to automatically retry a reversal after a system failure
driver false string 32 Driver value of Host settings
Values:
  • Null
  • Express
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
GetHostConfigurationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "autoReversalRetryLimit": {
    "description": "The number of times to automatically retry a reversal after a system failure",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Driver value of Host settings",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "Express"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
PUT
/api/v1/configuration/host Update host settings

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
UpdateHostConfigurationRequest body PUT_UpdateHostConfigurationRequest/v1/configuration/host undefined

Request Class

UpdateHostConfigurationRequest 
{
  "autoReversalRetryLimit": "int",
  "driver": "string"
}
UpdateHostConfigurationRequest
Field Required Data Type Max Length Default Value Description
autoReversalRetryLimit true int 2 1 The number of times to automatically retry a reversal after a failed interaction with the host. This must be a value between 1-4 (Default=1)
driver true string 32 Set to either 'Express' or 'Null'. Use Null to test without any connection to express.
Values:
  • Null
  • Express
UpdateHostConfigurationRequest 
{
  "autoReversalRetryLimit": {
    "description": "The number of times to automatically retry a reversal after a failed interaction with the host. This must be a value between 1-4 (Default=1)",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": "1"
    },
    "required": true
  },
  "driver": {
    "description": "Set to either 'Express' or 'Null'. Use Null to test without any connection to express.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "Express"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  }
}

Response Class

UpdateHostConfigurationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "autoReversalRetryLimit": "int",
  "driver": "string",
  "hostUpdated": "boolean"
}
UpdateHostConfigurationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
autoReversalRetryLimit false int 2 The number of times to automatically retry a reversal after a failure
driver false string 32 Set to either 'Express' or 'Null'. Use Null to test without any connection to express.
Values:
  • Null
  • Express
hostUpdated false boolean 5 Success value for updating host settings.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
UpdateHostConfigurationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "autoReversalRetryLimit": {
    "description": "The number of times to automatically retry a reversal after a failure",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Set to either 'Express' or 'Null'. Use Null to test without any connection to express.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "Express"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "hostUpdated": {
    "description": "Success value for updating host settings.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
GET
/api/v1/configuration/lanes Retrieve all lanes settings

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

GetLanesConfigurationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "ipLanes": {
    "_errors": "Array<ApiError>",
    "_hasErrors": "boolean",
    "_links": "Array<ApiLink>",
    "_logs": "Array<string>",
    "_type": "string",
    "_warnings": "Array<ApiWarning>",
    "description": "string",
    "driver": "string",
    "idleScreenImage": "string",
    "idleScreenMessage": "string",
    "ip": {
      "address": "string",
      "port": "string"
    },
    "isContactlessEmvEntryAllowed": "string",
    "isContactlessMsdEntryAllowed": "string",
    "isDisplayCustomAidScreen": "string",
    "isManualEntryAllowed": "string",
    "isUnattended": "string",
    "laneId": "int",
    "model": "string",
    "preferredAid": "string",
    "rebootTime": "string",
    "store": {
      "transactionAmountLimit": "double"
    },
    "terminalId": "string",
    "terminalType": "string",
    "userInputTimeout": "string"
  },
  "serialLanes": {
    "_errors": "Array<ApiError>",
    "_hasErrors": "boolean",
    "_links": "Array<ApiLink>",
    "_logs": "Array<string>",
    "_type": "string",
    "_warnings": "Array<ApiWarning>",
    "description": "string",
    "driver": "string",
    "idleScreenImage": "string",
    "idleScreenMessage": "string",
    "isContactlessEmvEntryAllowed": "string",
    "isContactlessMsdEntryAllowed": "string",
    "isDisplayCustomAidScreen": "string",
    "isManualEntryAllowed": "string",
    "isUnattended": "string",
    "laneId": "int",
    "model": "string",
    "preferredAid": "string",
    "rebootTime": "string",
    "serial": {
      "baudRate": "string",
      "comPort": "string",
      "dataBits": "string",
      "handshake": "string",
      "parity": "string",
      "stopBits": "string"
    },
    "store": "LaneStore",
    "terminalId": "string",
    "terminalType": "string",
    "userInputTimeout": "string"
  }
}
GetLanesConfigurationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ipLanes false Array<IpLane> List of IP lanes.
serialLanes false Array<SerialLane> List of serial lanes.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
IpLane
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string 500 Description for lane setting.
driver false string 50 Driver value
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
ip false Ip IP device properties.
isContactlessEmvEntryAllowed false string 5 If set to 'true' then EMV contactless entry is allowed via the PIN pad.
isContactlessMsdEntryAllowed false string 5 If set to 'true' then contactless entry is allowed via the PIN pad.
isDisplayCustomAidScreen false string 5 Turn On/Off Custom Multi Aid Screen.
isManualEntryAllowed false string 5 If set to 'true' then manual entry of card account numbers on the PIN pad is allowed
isUnattended false string 5 A boolean value to indicate that the PIN pad is an unattended device.
laneId false int Lane ID for lane setting.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 prefered AID Selection.
rebootTime false string 5 Device reboot time in 24 hour format HH:MM or HHMM
store false LaneStore Store setting for each lane.
terminalId false string 40 Terminal ID of PIN pad.
terminalType false string 32 terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
userInputTimeout false string 10 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.
Ip
Field Required Data Type Max Length Default Value Description
address true string 45 IP address of PIN pad if not connected via serial device.
port false string 5 IP port of PIN pad if not connected via serial device.
LaneStore
Field Required Data Type Max Length Default Value Description
transactionAmountLimit true double 10 When storing, triPOS will decline any transaction greater than this amount.
SerialLane
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string 500 Description for lane setting.
driver false string 50 Driver value
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
isContactlessEmvEntryAllowed false string 5 If set to 'true' then EMV contactless entry is allowed via the PIN pad.
isContactlessMsdEntryAllowed false string 5 If set to 'true' then contactless entry is allowed via the PIN pad.
isDisplayCustomAidScreen false string 5 Turn On/Off Custom Multi Aid Screen.
isManualEntryAllowed false string 5 If set to 'true' then manual entry of card account numbers on the PIN pad is allowed
isUnattended false string 5 A boolean value to indicate that the PIN pad is an unattended device.
laneId false int Lane ID for lane setting.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 prefered AID Selection.
rebootTime false string 5 Device reboot time in 24 hour format HH:MM or HHMM
serial false Serial Serial device properties.
store false LaneStore Store setting for each lane.
terminalId false string 40 Terminal ID of PIN pad.
terminalType false string 32 terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
userInputTimeout false string 10 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.
Serial
Field Required Data Type Max Length Default Value Description
baudRate true string 10 Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string 6 Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string 1 If the PIN pad is connected via serial device, the data bit setting.
handshake true string 32 If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • XonXoff
  • RequestToSend
parity true string 16 If the PIN pad is connected via serial device, the parity setting.
stopBits true string 32 If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
Values:
  • None
  • One
  • OnePointFive
  • Two
GetLanesConfigurationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "ipLanes": {
    "description": "List of IP lanes.",
    "type": "Array",
    "items": {
      "$ref": "IpLane"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "serialLanes": {
    "description": "List of serial lanes.",
    "type": "Array",
    "items": {
      "$ref": "SerialLane"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
IpLane 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Driver value",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "ip": {
    "description": "IP device properties.",
    "type": "Ip",
    "required": false
  },
  "isContactlessEmvEntryAllowed": {
    "description": "If set to 'true' then EMV contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "If set to 'true' then contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "If set to 'true' then manual entry of card account numbers on the PIN pad is allowed",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "prefered AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in 24 hour format HH:MM or HHMM",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "store": {
    "description": "Store setting for each lane.",
    "type": "LaneStore",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalType": {
    "description": "terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "45",
      "defaultValue": ""
    },
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
LaneStore 
{
  "transactionAmountLimit": {
    "description": "When storing, triPOS will decline any transaction greater than this amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}
SerialLane 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Driver value",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessEmvEntryAllowed": {
    "description": "If set to 'true' then EMV contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "If set to 'true' then contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "If set to 'true' then manual entry of card account numbers on the PIN pad is allowed",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "prefered AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in 24 hour format HH:MM or HHMM",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "serial": {
    "description": "Serial device properties.",
    "type": "Serial",
    "required": false
  },
  "store": {
    "description": "Store setting for each lane.",
    "type": "LaneStore",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalType": {
    "description": "terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
Serial 
{
  "baudRate": {
    "description": "Baud rate of serial communications.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "75",
        "110",
        "300",
        "1200",
        "2400",
        "4800",
        "9600",
        "19200",
        "38400",
        "57600",
        "115200"
      ]
    },
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "paramValues": {
      "max": "1",
      "defaultValue": ""
    },
    "required": true
  },
  "handshake": {
    "description": "If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "XonXoff",
        "RequestToSend"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "stopBits": {
    "description": "If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.  ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "One",
        "OnePointFive",
        "Two"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  }
}
GET
/api/v1/configuration/lanes/ip Retrieve all IP lane settings

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

GetIpLanesConfigurationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "ipLanes": {
    "_errors": "Array<ApiError>",
    "_hasErrors": "boolean",
    "_links": "Array<ApiLink>",
    "_logs": "Array<string>",
    "_type": "string",
    "_warnings": "Array<ApiWarning>",
    "description": "string",
    "driver": "string",
    "idleScreenImage": "string",
    "idleScreenMessage": "string",
    "ip": {
      "address": "string",
      "port": "string"
    },
    "isContactlessEmvEntryAllowed": "string",
    "isContactlessMsdEntryAllowed": "string",
    "isDisplayCustomAidScreen": "string",
    "isManualEntryAllowed": "string",
    "isUnattended": "string",
    "laneId": "int",
    "model": "string",
    "preferredAid": "string",
    "rebootTime": "string",
    "store": {
      "transactionAmountLimit": "double"
    },
    "terminalId": "string",
    "terminalType": "string",
    "userInputTimeout": "string"
  },
  "serialLanes": {
    "_errors": "Array<ApiError>",
    "_hasErrors": "boolean",
    "_links": "Array<ApiLink>",
    "_logs": "Array<string>",
    "_type": "string",
    "_warnings": "Array<ApiWarning>",
    "description": "string",
    "driver": "string",
    "idleScreenImage": "string",
    "idleScreenMessage": "string",
    "isContactlessEmvEntryAllowed": "string",
    "isContactlessMsdEntryAllowed": "string",
    "isDisplayCustomAidScreen": "string",
    "isManualEntryAllowed": "string",
    "isUnattended": "string",
    "laneId": "int",
    "model": "string",
    "preferredAid": "string",
    "rebootTime": "string",
    "serial": {
      "baudRate": "string",
      "comPort": "string",
      "dataBits": "string",
      "handshake": "string",
      "parity": "string",
      "stopBits": "string"
    },
    "store": "LaneStore",
    "terminalId": "string",
    "terminalType": "string",
    "userInputTimeout": "string"
  }
}
GetIpLanesConfigurationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ipLanes false Array<IpLane> List of IP lanes.
serialLanes false Array<SerialLane> List of serial lanes.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
IpLane
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string 500 Description for lane setting.
driver false string 50 Driver value
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
ip false Ip IP device properties.
isContactlessEmvEntryAllowed false string 5 If set to 'true' then EMV contactless entry is allowed via the PIN pad.
isContactlessMsdEntryAllowed false string 5 If set to 'true' then contactless entry is allowed via the PIN pad.
isDisplayCustomAidScreen false string 5 Turn On/Off Custom Multi Aid Screen.
isManualEntryAllowed false string 5 If set to 'true' then manual entry of card account numbers on the PIN pad is allowed
isUnattended false string 5 A boolean value to indicate that the PIN pad is an unattended device.
laneId false int Lane ID for lane setting.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 prefered AID Selection.
rebootTime false string 5 Device reboot time in 24 hour format HH:MM or HHMM
store false LaneStore Store setting for each lane.
terminalId false string 40 Terminal ID of PIN pad.
terminalType false string 32 terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
userInputTimeout false string 10 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.
Ip
Field Required Data Type Max Length Default Value Description
address true string 45 IP address of PIN pad if not connected via serial device.
port false string 5 IP port of PIN pad if not connected via serial device.
LaneStore
Field Required Data Type Max Length Default Value Description
transactionAmountLimit true double 10 When storing, triPOS will decline any transaction greater than this amount.
SerialLane
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string 500 Description for lane setting.
driver false string 50 Driver value
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
isContactlessEmvEntryAllowed false string 5 If set to 'true' then EMV contactless entry is allowed via the PIN pad.
isContactlessMsdEntryAllowed false string 5 If set to 'true' then contactless entry is allowed via the PIN pad.
isDisplayCustomAidScreen false string 5 Turn On/Off Custom Multi Aid Screen.
isManualEntryAllowed false string 5 If set to 'true' then manual entry of card account numbers on the PIN pad is allowed
isUnattended false string 5 A boolean value to indicate that the PIN pad is an unattended device.
laneId false int Lane ID for lane setting.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 prefered AID Selection.
rebootTime false string 5 Device reboot time in 24 hour format HH:MM or HHMM
serial false Serial Serial device properties.
store false LaneStore Store setting for each lane.
terminalId false string 40 Terminal ID of PIN pad.
terminalType false string 32 terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
userInputTimeout false string 10 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.
Serial
Field Required Data Type Max Length Default Value Description
baudRate true string 10 Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string 6 Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string 1 If the PIN pad is connected via serial device, the data bit setting.
handshake true string 32 If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • XonXoff
  • RequestToSend
parity true string 16 If the PIN pad is connected via serial device, the parity setting.
stopBits true string 32 If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
Values:
  • None
  • One
  • OnePointFive
  • Two
GetIpLanesConfigurationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "ipLanes": {
    "description": "List of IP lanes.",
    "type": "Array",
    "items": {
      "$ref": "IpLane"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "serialLanes": {
    "description": "List of serial lanes.",
    "type": "Array",
    "items": {
      "$ref": "SerialLane"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
IpLane 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Driver value",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "ip": {
    "description": "IP device properties.",
    "type": "Ip",
    "required": false
  },
  "isContactlessEmvEntryAllowed": {
    "description": "If set to 'true' then EMV contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "If set to 'true' then contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "If set to 'true' then manual entry of card account numbers on the PIN pad is allowed",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "prefered AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in 24 hour format HH:MM or HHMM",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "store": {
    "description": "Store setting for each lane.",
    "type": "LaneStore",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalType": {
    "description": "terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "45",
      "defaultValue": ""
    },
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
LaneStore 
{
  "transactionAmountLimit": {
    "description": "When storing, triPOS will decline any transaction greater than this amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}
SerialLane 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Driver value",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessEmvEntryAllowed": {
    "description": "If set to 'true' then EMV contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "If set to 'true' then contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "If set to 'true' then manual entry of card account numbers on the PIN pad is allowed",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "prefered AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in 24 hour format HH:MM or HHMM",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "serial": {
    "description": "Serial device properties.",
    "type": "Serial",
    "required": false
  },
  "store": {
    "description": "Store setting for each lane.",
    "type": "LaneStore",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalType": {
    "description": "terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
Serial 
{
  "baudRate": {
    "description": "Baud rate of serial communications.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "75",
        "110",
        "300",
        "1200",
        "2400",
        "4800",
        "9600",
        "19200",
        "38400",
        "57600",
        "115200"
      ]
    },
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "paramValues": {
      "max": "1",
      "defaultValue": ""
    },
    "required": true
  },
  "handshake": {
    "description": "If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "XonXoff",
        "RequestToSend"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "stopBits": {
    "description": "If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.  ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "One",
        "OnePointFive",
        "Two"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  }
}
POST
/api/v1/configuration/lanes/ip Creates lane settings with options for IP Address and IP Port

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
CreateIpLaneRequest body POST_CreateIpLaneRequest/v1/configuration/lanes/ip undefined

Request Class

CreateIpLaneRequest 
{
  "driver": "string",
  "ip": {
    "address": "string",
    "port": "string"
  },
  "isContactlessEmvEntryAllowed": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneId": "int",
  "terminalId": "string",
  "terminalType": "string",
  "description": "string",
  "idleScreenImage": "string",
  "idleScreenMessage": "string",
  "isDisplayCustomAidScreen": "string",
  "isUnattended": "string",
  "model": "string",
  "preferredAid": "string",
  "rebootTime": "string",
  "store": {
    "transactionAmountLimit": "double"
  },
  "userInputTimeout": "string"
}
CreateIpLaneRequest
Field Required Data Type Max Length Default Value Description
driver true string 50 PIN pad driver type
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
ip true POST_Ip/v1/configuration/lanes/ip Collection of IP device properties.
isContactlessEmvEntryAllowed true string 5 false Set to true to allow EMV contactless entry.
isContactlessMsdEntryAllowed true string 5 false Set to true to allow contactless entry.
isManualEntryAllowed true string 5 true Set to true to allow manual entry of card account numbers on the PIN pad.
laneId true int The desired lane ID. The lane ID should be a maximum of six digits long.
terminalId true string 40 The Terminal ID to be passed to host.
terminalType true string 32 The terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
description false string 500 Description of lane.
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
isDisplayCustomAidScreen false string 5 false Turn On/Off Custom Multi Aid Screen.
isUnattended false string 5 false A boolean value to indicate that the PIN pad is an unattended device.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 Preferred AID Selection.
rebootTime false string 5 Device reboot time in HH:MM or HHMM 24 hour format.
store false POST_LaneStore/v1/configuration/lanes/ip store
userInputTimeout false string 10 60000 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds
Ip
Field Required Data Type Max Length Default Value Description
address true string 45 IP address of PIN pad if not connected via serial device.
port false string 5 IP port of PIN pad if not connected via serial device.
LaneStore
Field Required Data Type Max Length Default Value Description
transactionAmountLimit true double 10 When storing, triPOS will decline any transaction greater than this amount.
CreateIpLaneRequest 
{
  "driver": {
    "description": "PIN pad driver type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": true
  },
  "ip": {
    "description": "Collection of IP device properties.",
    "type": "POST_Ip/v1/configuration/lanes/ip",
    "required": true
  },
  "isContactlessEmvEntryAllowed": {
    "description": "Set to true to allow EMV contactless entry.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "isContactlessMsdEntryAllowed": {
    "description": "Set to true to allow contactless entry.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "isManualEntryAllowed": {
    "description": "Set to true to allow manual entry of card account numbers on the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "true"
    },
    "required": true
  },
  "laneId": {
    "description": "The desired lane ID. The lane ID should be a maximum of six digits long.",
    "type": "int",
    "allowableValues": {},
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "terminalId": {
    "description": "The Terminal ID to be passed to host.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": true
  },
  "terminalType": {
    "description": "The terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "description": {
    "description": "Description of lane.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "Preferred AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in HH:MM or HHMM 24 hour format.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "store": {
    "description": "store",
    "type": "POST_LaneStore/v1/configuration/lanes/ip",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "60000"
    },
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "45",
      "defaultValue": ""
    },
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
LaneStore 
{
  "transactionAmountLimit": {
    "description": "When storing, triPOS will decline any transaction greater than this amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}

Response Class

CreateIpLaneResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "description": "string",
  "driver": "string",
  "idleScreenImage": "string",
  "idleScreenMessage": "string",
  "ip": {
    "address": "string",
    "port": "string"
  },
  "isContactlessEmvEntryAllowed": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isDisplayCustomAidScreen": "string",
  "isManualEntryAllowed": "string",
  "isUnattended": "string",
  "laneCreated": "boolean",
  "laneId": "int",
  "model": "string",
  "preferredAid": "string",
  "rebootTime": "string",
  "store": {
    "transactionAmountLimit": "double"
  },
  "terminalId": "string",
  "terminalType": "string",
  "userInputTimeout": "string"
}
CreateIpLaneResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string 500 Description for lane setting.
driver false string 50 Driver value
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
ip false Ip IP device properties.
isContactlessEmvEntryAllowed false string 5 If set to 'true' then EMV contactless entry is allowed via the PIN pad.
isContactlessMsdEntryAllowed false string 5 If set to 'true' then contactless entry is allowed via the PIN pad.
isDisplayCustomAidScreen false string 5 Turn On/Off Custom Multi Aid Screen.
isManualEntryAllowed false string 5 If set to 'true' then manual entry of card account numbers on the PIN pad is allowed
isUnattended false string 5 A boolean value to indicate that the PIN pad is an unattended device.
laneCreated false boolean 5 True if lane was created successfully and false otherwise.
laneId false int Lane ID for lane setting.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 prefered AID Selection.
rebootTime false string 5 Device reboot time in 24 hour format HH:MM or HHMM
store false LaneStore Store setting for each lane.
terminalId false string 40 Terminal ID of PIN pad.
terminalType false string 32 terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
userInputTimeout false string 10 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Ip
Field Required Data Type Max Length Default Value Description
address true string 45 IP address of PIN pad if not connected via serial device.
port false string 5 IP port of PIN pad if not connected via serial device.
LaneStore
Field Required Data Type Max Length Default Value Description
transactionAmountLimit true double 10 When storing, triPOS will decline any transaction greater than this amount.
CreateIpLaneResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Driver value",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "ip": {
    "description": "IP device properties.",
    "type": "Ip",
    "required": false
  },
  "isContactlessEmvEntryAllowed": {
    "description": "If set to 'true' then EMV contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "If set to 'true' then contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "If set to 'true' then manual entry of card account numbers on the PIN pad is allowed",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneCreated": {
    "description": "True if lane was created successfully and false otherwise.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "prefered AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in 24 hour format HH:MM or HHMM",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "store": {
    "description": "Store setting for each lane.",
    "type": "LaneStore",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalType": {
    "description": "terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "45",
      "defaultValue": ""
    },
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
LaneStore 
{
  "transactionAmountLimit": {
    "description": "When storing, triPOS will decline any transaction greater than this amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}
DELETE
/api/v1/configuration/lanes/ip/{laneId} Delete ip lanes settings for lane with laneId

Parameters

Parameter Parameter Type Data Type Description
laneId path int The lane ID.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
DeleteLaneRequest body DELETE_DeleteLaneRequest/v1/configuration/lanes/ip/{laneId} undefined

Request Class

DeleteLaneRequest 
{}
DeleteLaneRequest
Field Required Data Type Max Length Default Value Description
DeleteLaneRequest 
{}

Response Class

DeleteLaneResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "laneDeleted": "boolean"
}
DeleteLaneResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
laneDeleted false boolean 5 True if lane was deleted false otherwise.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
DeleteLaneResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "laneDeleted": {
    "description": "True if lane was deleted false otherwise.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if the type of lane being deleted does not match the type of lane in the request URL (i.e. deleting a serial lane from the /v1/configuration/lanes/ip/{laneId} endpoint).
GET
/api/v1/configuration/lanes/ip/{laneId} Retrieve specific IP lane settings

Parameters

Parameter Parameter Type Data Type Description
laneId path int The lane ID.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

GetIpLaneResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "description": "string",
  "driver": "string",
  "idleScreenImage": "string",
  "idleScreenMessage": "string",
  "ip": {
    "address": "string",
    "port": "string"
  },
  "isContactlessEmvEntryAllowed": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isDisplayCustomAidScreen": "string",
  "isManualEntryAllowed": "string",
  "isUnattended": "string",
  "laneId": "int",
  "model": "string",
  "preferredAid": "string",
  "rebootTime": "string",
  "store": {
    "transactionAmountLimit": "double"
  },
  "terminalId": "string",
  "terminalType": "string",
  "userInputTimeout": "string"
}
GetIpLaneResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string 500 Description for lane setting.
driver false string 50 Driver value
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
ip false Ip IP device properties.
isContactlessEmvEntryAllowed false string 5 If set to 'true' then EMV contactless entry is allowed via the PIN pad.
isContactlessMsdEntryAllowed false string 5 If set to 'true' then contactless entry is allowed via the PIN pad.
isDisplayCustomAidScreen false string 5 Turn On/Off Custom Multi Aid Screen.
isManualEntryAllowed false string 5 If set to 'true' then manual entry of card account numbers on the PIN pad is allowed
isUnattended false string 5 A boolean value to indicate that the PIN pad is an unattended device.
laneId false int Lane ID for lane setting.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 prefered AID Selection.
rebootTime false string 5 Device reboot time in 24 hour format HH:MM or HHMM
store false LaneStore Store setting for each lane.
terminalId false string 40 Terminal ID of PIN pad.
terminalType false string 32 terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
userInputTimeout false string 10 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Ip
Field Required Data Type Max Length Default Value Description
address true string 45 IP address of PIN pad if not connected via serial device.
port false string 5 IP port of PIN pad if not connected via serial device.
LaneStore
Field Required Data Type Max Length Default Value Description
transactionAmountLimit true double 10 When storing, triPOS will decline any transaction greater than this amount.
GetIpLaneResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Driver value",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "ip": {
    "description": "IP device properties.",
    "type": "Ip",
    "required": false
  },
  "isContactlessEmvEntryAllowed": {
    "description": "If set to 'true' then EMV contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "If set to 'true' then contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "If set to 'true' then manual entry of card account numbers on the PIN pad is allowed",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "prefered AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in 24 hour format HH:MM or HHMM",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "store": {
    "description": "Store setting for each lane.",
    "type": "LaneStore",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalType": {
    "description": "terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "45",
      "defaultValue": ""
    },
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
LaneStore 
{
  "transactionAmountLimit": {
    "description": "When storing, triPOS will decline any transaction greater than this amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}
PUT
/api/v1/configuration/lanes/ip/{laneId} Updates IP lanes settings

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
UpdateIpLaneRequest body PUT_UpdateIpLaneRequest/v1/configuration/lanes/ip/{laneId} undefined

Request Class

UpdateIpLaneRequest 
{
  "driver": "string",
  "ip": {
    "address": "string",
    "port": "string"
  },
  "isContactlessEmvEntryAllowed": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneId": "int",
  "terminalId": "string",
  "terminalType": "string",
  "description": "string",
  "idleScreenImage": "string",
  "idleScreenMessage": "string",
  "isDisplayCustomAidScreen": "string",
  "isUnattended": "string",
  "model": "string",
  "preferredAid": "string",
  "rebootTime": "string",
  "store": {
    "transactionAmountLimit": "double"
  },
  "userInputTimeout": "string"
}
UpdateIpLaneRequest
Field Required Data Type Max Length Default Value Description
driver true string 50 PIN pad driver type
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
ip true PUT_Ip/v1/configuration/lanes/ip/{laneId } Collection of IP device properties.
isContactlessEmvEntryAllowed true string 5 false Set to true to allow EMV contactless entry.
isContactlessMsdEntryAllowed true string 5 false Set to true to allow contactless entry.
isManualEntryAllowed true string 5 true Set to true to allow manual entry of card account numbers on the PIN pad.
laneId true int The desired lane ID. The lane ID should be a maximum of six digits long.
terminalId true string 40 The Terminal ID to be passed to host.
terminalType true string 32 The terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
description false string 500 Description of lane.
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
isDisplayCustomAidScreen false string 5 false Turn On/Off Custom Multi Aid Screen.
isUnattended false string 5 false A boolean value to indicate that the PIN pad is an unattended device.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 Preferred AID Selection.
rebootTime false string 5 Device reboot time in HH:MM or HHMM 24 hour format.
store false PUT_LaneStore/v1/configuration/lanes/ip/ {laneId} store
userInputTimeout false string 10 60000 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds
Ip
Field Required Data Type Max Length Default Value Description
address true string 45 IP address of PIN pad if not connected via serial device.
port false string 5 IP port of PIN pad if not connected via serial device.
LaneStore
Field Required Data Type Max Length Default Value Description
transactionAmountLimit true double 10 When storing, triPOS will decline any transaction greater than this amount.
UpdateIpLaneRequest 
{
  "driver": {
    "description": "PIN pad driver type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": true
  },
  "ip": {
    "description": "Collection of IP device properties.",
    "type": "PUT_Ip/v1/configuration/lanes/ip/{laneId}",
    "required": true
  },
  "isContactlessEmvEntryAllowed": {
    "description": "Set to true to allow EMV contactless entry.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "isContactlessMsdEntryAllowed": {
    "description": "Set to true to allow contactless entry.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "isManualEntryAllowed": {
    "description": "Set to true to allow manual entry of card account numbers on the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "true"
    },
    "required": true
  },
  "laneId": {
    "description": "The desired lane ID. The lane ID should be a maximum of six digits long.",
    "type": "int",
    "allowableValues": {},
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "terminalId": {
    "description": "The Terminal ID to be passed to host.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": true
  },
  "terminalType": {
    "description": "The terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "description": {
    "description": "Description of lane.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "Preferred AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in HH:MM or HHMM 24 hour format.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "store": {
    "description": "store",
    "type": "PUT_LaneStore/v1/configuration/lanes/ip/{laneId}",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "60000"
    },
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "45",
      "defaultValue": ""
    },
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
LaneStore 
{
  "transactionAmountLimit": {
    "description": "When storing, triPOS will decline any transaction greater than this amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}

Response Class

UpdateIpLaneResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "description": "string",
  "driver": "string",
  "idleScreenImage": "string",
  "idleScreenMessage": "string",
  "ip": {
    "address": "string",
    "port": "string"
  },
  "isContactlessEmvEntryAllowed": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isDisplayCustomAidScreen": "string",
  "isManualEntryAllowed": "string",
  "isUnattended": "string",
  "laneId": "int",
  "laneUpdated": "boolean",
  "model": "string",
  "preferredAid": "string",
  "rebootTime": "string",
  "store": {
    "transactionAmountLimit": "double"
  },
  "terminalId": "string",
  "terminalType": "string",
  "userInputTimeout": "string"
}
UpdateIpLaneResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string 500 Description for lane setting.
driver false string 50 Driver value
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
ip false Ip IP device properties.
isContactlessEmvEntryAllowed false string 5 If set to 'true' then EMV contactless entry is allowed via the PIN pad.
isContactlessMsdEntryAllowed false string 5 If set to 'true' then contactless entry is allowed via the PIN pad.
isDisplayCustomAidScreen false string 5 Turn On/Off Custom Multi Aid Screen.
isManualEntryAllowed false string 5 If set to 'true' then manual entry of card account numbers on the PIN pad is allowed
isUnattended false string 5 A boolean value to indicate that the PIN pad is an unattended device.
laneId false int Lane ID for lane setting.
laneUpdated false boolean 5 True if lane was updated successfully and false otherwise.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 prefered AID Selection.
rebootTime false string 5 Device reboot time in 24 hour format HH:MM or HHMM
store false LaneStore Store setting for each lane.
terminalId false string 40 Terminal ID of PIN pad.
terminalType false string 32 terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
userInputTimeout false string 10 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Ip
Field Required Data Type Max Length Default Value Description
address true string 45 IP address of PIN pad if not connected via serial device.
port false string 5 IP port of PIN pad if not connected via serial device.
LaneStore
Field Required Data Type Max Length Default Value Description
transactionAmountLimit true double 10 When storing, triPOS will decline any transaction greater than this amount.
UpdateIpLaneResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Driver value",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "ip": {
    "description": "IP device properties.",
    "type": "Ip",
    "required": false
  },
  "isContactlessEmvEntryAllowed": {
    "description": "If set to 'true' then EMV contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "If set to 'true' then contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "If set to 'true' then manual entry of card account numbers on the PIN pad is allowed",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "laneUpdated": {
    "description": "True if lane was updated successfully and false otherwise.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "prefered AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in 24 hour format HH:MM or HHMM",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "store": {
    "description": "Store setting for each lane.",
    "type": "LaneStore",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalType": {
    "description": "terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "45",
      "defaultValue": ""
    },
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
LaneStore 
{
  "transactionAmountLimit": {
    "description": "When storing, triPOS will decline any transaction greater than this amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}
GET
/api/v1/configuration/lanes/serial Retrieve all serial lane settings

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

GetSerialLanesConfigurationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "ipLanes": {
    "_errors": "Array<ApiError>",
    "_hasErrors": "boolean",
    "_links": "Array<ApiLink>",
    "_logs": "Array<string>",
    "_type": "string",
    "_warnings": "Array<ApiWarning>",
    "description": "string",
    "driver": "string",
    "idleScreenImage": "string",
    "idleScreenMessage": "string",
    "ip": {
      "address": "string",
      "port": "string"
    },
    "isContactlessEmvEntryAllowed": "string",
    "isContactlessMsdEntryAllowed": "string",
    "isDisplayCustomAidScreen": "string",
    "isManualEntryAllowed": "string",
    "isUnattended": "string",
    "laneId": "int",
    "model": "string",
    "preferredAid": "string",
    "rebootTime": "string",
    "store": {
      "transactionAmountLimit": "double"
    },
    "terminalId": "string",
    "terminalType": "string",
    "userInputTimeout": "string"
  },
  "serialLanes": {
    "_errors": "Array<ApiError>",
    "_hasErrors": "boolean",
    "_links": "Array<ApiLink>",
    "_logs": "Array<string>",
    "_type": "string",
    "_warnings": "Array<ApiWarning>",
    "description": "string",
    "driver": "string",
    "idleScreenImage": "string",
    "idleScreenMessage": "string",
    "isContactlessEmvEntryAllowed": "string",
    "isContactlessMsdEntryAllowed": "string",
    "isDisplayCustomAidScreen": "string",
    "isManualEntryAllowed": "string",
    "isUnattended": "string",
    "laneId": "int",
    "model": "string",
    "preferredAid": "string",
    "rebootTime": "string",
    "serial": {
      "baudRate": "string",
      "comPort": "string",
      "dataBits": "string",
      "handshake": "string",
      "parity": "string",
      "stopBits": "string"
    },
    "store": "LaneStore",
    "terminalId": "string",
    "terminalType": "string",
    "userInputTimeout": "string"
  }
}
GetSerialLanesConfigurationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ipLanes false Array<IpLane> List of IP lanes.
serialLanes false Array<SerialLane> List of serial lanes.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
IpLane
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string 500 Description for lane setting.
driver false string 50 Driver value
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
ip false Ip IP device properties.
isContactlessEmvEntryAllowed false string 5 If set to 'true' then EMV contactless entry is allowed via the PIN pad.
isContactlessMsdEntryAllowed false string 5 If set to 'true' then contactless entry is allowed via the PIN pad.
isDisplayCustomAidScreen false string 5 Turn On/Off Custom Multi Aid Screen.
isManualEntryAllowed false string 5 If set to 'true' then manual entry of card account numbers on the PIN pad is allowed
isUnattended false string 5 A boolean value to indicate that the PIN pad is an unattended device.
laneId false int Lane ID for lane setting.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 prefered AID Selection.
rebootTime false string 5 Device reboot time in 24 hour format HH:MM or HHMM
store false LaneStore Store setting for each lane.
terminalId false string 40 Terminal ID of PIN pad.
terminalType false string 32 terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
userInputTimeout false string 10 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.
Ip
Field Required Data Type Max Length Default Value Description
address true string 45 IP address of PIN pad if not connected via serial device.
port false string 5 IP port of PIN pad if not connected via serial device.
LaneStore
Field Required Data Type Max Length Default Value Description
transactionAmountLimit true double 10 When storing, triPOS will decline any transaction greater than this amount.
SerialLane
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string 500 Description for lane setting.
driver false string 50 Driver value
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
isContactlessEmvEntryAllowed false string 5 If set to 'true' then EMV contactless entry is allowed via the PIN pad.
isContactlessMsdEntryAllowed false string 5 If set to 'true' then contactless entry is allowed via the PIN pad.
isDisplayCustomAidScreen false string 5 Turn On/Off Custom Multi Aid Screen.
isManualEntryAllowed false string 5 If set to 'true' then manual entry of card account numbers on the PIN pad is allowed
isUnattended false string 5 A boolean value to indicate that the PIN pad is an unattended device.
laneId false int Lane ID for lane setting.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 prefered AID Selection.
rebootTime false string 5 Device reboot time in 24 hour format HH:MM or HHMM
serial false Serial Serial device properties.
store false LaneStore Store setting for each lane.
terminalId false string 40 Terminal ID of PIN pad.
terminalType false string 32 terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
userInputTimeout false string 10 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.
Serial
Field Required Data Type Max Length Default Value Description
baudRate true string 10 Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string 6 Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string 1 If the PIN pad is connected via serial device, the data bit setting.
handshake true string 32 If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • XonXoff
  • RequestToSend
parity true string 16 If the PIN pad is connected via serial device, the parity setting.
stopBits true string 32 If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
Values:
  • None
  • One
  • OnePointFive
  • Two
GetSerialLanesConfigurationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "ipLanes": {
    "description": "List of IP lanes.",
    "type": "Array",
    "items": {
      "$ref": "IpLane"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "serialLanes": {
    "description": "List of serial lanes.",
    "type": "Array",
    "items": {
      "$ref": "SerialLane"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
IpLane 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Driver value",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "ip": {
    "description": "IP device properties.",
    "type": "Ip",
    "required": false
  },
  "isContactlessEmvEntryAllowed": {
    "description": "If set to 'true' then EMV contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "If set to 'true' then contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "If set to 'true' then manual entry of card account numbers on the PIN pad is allowed",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "prefered AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in 24 hour format HH:MM or HHMM",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "store": {
    "description": "Store setting for each lane.",
    "type": "LaneStore",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalType": {
    "description": "terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "45",
      "defaultValue": ""
    },
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
LaneStore 
{
  "transactionAmountLimit": {
    "description": "When storing, triPOS will decline any transaction greater than this amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}
SerialLane 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Driver value",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessEmvEntryAllowed": {
    "description": "If set to 'true' then EMV contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "If set to 'true' then contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "If set to 'true' then manual entry of card account numbers on the PIN pad is allowed",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "prefered AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in 24 hour format HH:MM or HHMM",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "serial": {
    "description": "Serial device properties.",
    "type": "Serial",
    "required": false
  },
  "store": {
    "description": "Store setting for each lane.",
    "type": "LaneStore",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalType": {
    "description": "terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
Serial 
{
  "baudRate": {
    "description": "Baud rate of serial communications.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "75",
        "110",
        "300",
        "1200",
        "2400",
        "4800",
        "9600",
        "19200",
        "38400",
        "57600",
        "115200"
      ]
    },
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "paramValues": {
      "max": "1",
      "defaultValue": ""
    },
    "required": true
  },
  "handshake": {
    "description": "If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "XonXoff",
        "RequestToSend"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "stopBits": {
    "description": "If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.  ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "One",
        "OnePointFive",
        "Two"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  }
}
POST
/api/v1/configuration/lanes/serial Creates lane settings with options for serial device

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
CreateSerialLaneRequest body POST_CreateSerialLaneRequest/v1/configuration/lanes/serial undefined

Request Class

CreateSerialLaneRequest 
{
  "driver": "string",
  "isContactlessEmvEntryAllowed": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneId": "int",
  "serial": {
    "baudRate": "string",
    "comPort": "string",
    "dataBits": "string",
    "handshake": "string",
    "parity": "string",
    "stopBits": "string"
  },
  "terminalId": "string",
  "terminalType": "string",
  "description": "string",
  "idleScreenImage": "string",
  "idleScreenMessage": "string",
  "isDisplayCustomAidScreen": "string",
  "isUnattended": "string",
  "model": "string",
  "preferredAid": "string",
  "rebootTime": "string",
  "store": {
    "transactionAmountLimit": "double"
  },
  "userInputTimeout": "string"
}
CreateSerialLaneRequest
Field Required Data Type Max Length Default Value Description
driver true string 50 PIN pad driver type
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
isContactlessEmvEntryAllowed true string 5 false Set to true to allow EMV contactless entry.
isContactlessMsdEntryAllowed true string 5 false Set to true to allow contactless entry.
isManualEntryAllowed true string 5 true Set to true to allow manual entry of card account numbers on the PIN pad.
laneId true int The desired lane ID. The lane ID should be a maximum of six digits long.
serial true POST_Serial/v1/configuration/lanes/seria l Collection of Serial device properties
terminalId true string 40 The Terminal ID to be passed to host.
terminalType true string 32 The terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
description false string 500 Description of lane.
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
isDisplayCustomAidScreen false string 5 false Turn On/Off Custom Multi Aid Screen.
isUnattended false string 5 false A boolean value to indicate that the PIN pad is an unattended device.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 Preferred AID Selection.
rebootTime false string 5 Device reboot time in HH:MM or HHMM 24 hour format.
store false POST_LaneStore/v1/configuration/lanes/se rial store
userInputTimeout false string 10 60000 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds
Serial
Field Required Data Type Max Length Default Value Description
baudRate true string 10 Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string 6 Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string 1 If the PIN pad is connected via serial device, the data bit setting.
handshake true string 32 If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • XonXoff
  • RequestToSend
parity true string 16 If the PIN pad is connected via serial device, the parity setting.
stopBits true string 32 If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
Values:
  • None
  • One
  • OnePointFive
  • Two
LaneStore
Field Required Data Type Max Length Default Value Description
transactionAmountLimit true double 10 When storing, triPOS will decline any transaction greater than this amount.
CreateSerialLaneRequest 
{
  "driver": {
    "description": "PIN pad driver type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": true
  },
  "isContactlessEmvEntryAllowed": {
    "description": "Set to true to allow EMV contactless entry.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "isContactlessMsdEntryAllowed": {
    "description": "Set to true to allow contactless entry.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "isManualEntryAllowed": {
    "description": "Set to true to allow manual entry of card account numbers on the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "true"
    },
    "required": true
  },
  "laneId": {
    "description": "The desired lane ID. The lane ID should be a maximum of six digits long.",
    "type": "int",
    "allowableValues": {},
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "serial": {
    "description": "Collection of Serial device properties",
    "type": "POST_Serial/v1/configuration/lanes/serial",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "terminalId": {
    "description": "The Terminal ID to be passed to host.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": true
  },
  "terminalType": {
    "description": "The terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "description": {
    "description": "Description of lane.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "Preferred AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in HH:MM or HHMM 24 hour format.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "store": {
    "description": "store",
    "type": "POST_LaneStore/v1/configuration/lanes/serial",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "60000"
    },
    "required": false
  }
}
Serial 
{
  "baudRate": {
    "description": "Baud rate of serial communications.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "75",
        "110",
        "300",
        "1200",
        "2400",
        "4800",
        "9600",
        "19200",
        "38400",
        "57600",
        "115200"
      ]
    },
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "paramValues": {
      "max": "1",
      "defaultValue": ""
    },
    "required": true
  },
  "handshake": {
    "description": "If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "XonXoff",
        "RequestToSend"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "stopBits": {
    "description": "If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.  ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "One",
        "OnePointFive",
        "Two"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  }
}
LaneStore 
{
  "transactionAmountLimit": {
    "description": "When storing, triPOS will decline any transaction greater than this amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}

Response Class

CreateSerialLaneResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "description": "string",
  "driver": "string",
  "idleScreenImage": "string",
  "idleScreenMessage": "string",
  "isContactlessEmvEntryAllowed": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isDisplayCustomAidScreen": "string",
  "isManualEntryAllowed": "string",
  "isUnattended": "string",
  "laneCreated": "boolean",
  "laneId": "int",
  "model": "string",
  "preferredAid": "string",
  "rebootTime": "string",
  "serial": {
    "baudRate": "string",
    "comPort": "string",
    "dataBits": "string",
    "handshake": "string",
    "parity": "string",
    "stopBits": "string"
  },
  "store": {
    "transactionAmountLimit": "double"
  },
  "terminalId": "string",
  "terminalType": "string",
  "userInputTimeout": "string"
}
CreateSerialLaneResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string 500 Description for lane setting.
driver false string 50 Driver value
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
isContactlessEmvEntryAllowed false string 5 If set to 'true' then EMV contactless entry is allowed via the PIN pad.
isContactlessMsdEntryAllowed false string 5 If set to 'true' then contactless entry is allowed via the PIN pad.
isDisplayCustomAidScreen false string 5 Turn On/Off Custom Multi Aid Screen.
isManualEntryAllowed false string 5 If set to 'true' then manual entry of card account numbers on the PIN pad is allowed
isUnattended false string 5 A boolean value to indicate that the PIN pad is an unattended device.
laneCreated false boolean 5 True if lane was created successfully and false otherwise.
laneId false int Lane ID for lane setting.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 prefered AID Selection.
rebootTime false string 5 Device reboot time in 24 hour format HH:MM or HHMM
serial false Serial Serial device properties.
store false LaneStore Store setting for each lane.
terminalId false string 40 Terminal ID of PIN pad.
terminalType false string 32 terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
userInputTimeout false string 10 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Serial
Field Required Data Type Max Length Default Value Description
baudRate true string 10 Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string 6 Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string 1 If the PIN pad is connected via serial device, the data bit setting.
handshake true string 32 If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • XonXoff
  • RequestToSend
parity true string 16 If the PIN pad is connected via serial device, the parity setting.
stopBits true string 32 If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
Values:
  • None
  • One
  • OnePointFive
  • Two
LaneStore
Field Required Data Type Max Length Default Value Description
transactionAmountLimit true double 10 When storing, triPOS will decline any transaction greater than this amount.
CreateSerialLaneResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Driver value",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessEmvEntryAllowed": {
    "description": "If set to 'true' then EMV contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "If set to 'true' then contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "If set to 'true' then manual entry of card account numbers on the PIN pad is allowed",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneCreated": {
    "description": "True if lane was created successfully and false otherwise.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "prefered AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in 24 hour format HH:MM or HHMM",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "serial": {
    "description": "Serial device properties.",
    "type": "Serial",
    "required": false
  },
  "store": {
    "description": "Store setting for each lane.",
    "type": "LaneStore",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalType": {
    "description": "terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Serial 
{
  "baudRate": {
    "description": "Baud rate of serial communications.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "75",
        "110",
        "300",
        "1200",
        "2400",
        "4800",
        "9600",
        "19200",
        "38400",
        "57600",
        "115200"
      ]
    },
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "paramValues": {
      "max": "1",
      "defaultValue": ""
    },
    "required": true
  },
  "handshake": {
    "description": "If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "XonXoff",
        "RequestToSend"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "stopBits": {
    "description": "If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.  ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "One",
        "OnePointFive",
        "Two"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  }
}
LaneStore 
{
  "transactionAmountLimit": {
    "description": "When storing, triPOS will decline any transaction greater than this amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}
DELETE
/api/v1/configuration/lanes/serial/{laneId} Delete serial lanes settings for lane with laneId

Parameters

Parameter Parameter Type Data Type Description
laneId path int The lane ID.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
DeleteLaneRequest body DELETE_DeleteLaneRequest/v1/configuration/lanes/serial/{laneId} undefined

Request Class

DeleteLaneRequest 
{}
DeleteLaneRequest
Field Required Data Type Max Length Default Value Description
DeleteLaneRequest 
{}

Response Class

DeleteLaneResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "laneDeleted": "boolean"
}
DeleteLaneResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
laneDeleted false boolean 5 True if lane was deleted false otherwise.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
DeleteLaneResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "laneDeleted": {
    "description": "True if lane was deleted false otherwise.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if the type of lane being deleted does not match the type of lane in the request URL (i.e. deleting a serial lane from the /v1/configuration/lanes/ip/{laneId} endpoint).
GET
/api/v1/configuration/lanes/serial/{laneId} Retrieve specific serial lane settings

Parameters

Parameter Parameter Type Data Type Description
laneId path int The lane ID.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

GetSerialLaneResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "description": "string",
  "driver": "string",
  "idleScreenImage": "string",
  "idleScreenMessage": "string",
  "isContactlessEmvEntryAllowed": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isDisplayCustomAidScreen": "string",
  "isManualEntryAllowed": "string",
  "isUnattended": "string",
  "laneId": "int",
  "model": "string",
  "preferredAid": "string",
  "rebootTime": "string",
  "serial": {
    "baudRate": "string",
    "comPort": "string",
    "dataBits": "string",
    "handshake": "string",
    "parity": "string",
    "stopBits": "string"
  },
  "store": {
    "transactionAmountLimit": "double"
  },
  "terminalId": "string",
  "terminalType": "string",
  "userInputTimeout": "string"
}
GetSerialLaneResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string 500 Description for lane setting.
driver false string 50 Driver value
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
isContactlessEmvEntryAllowed false string 5 If set to 'true' then EMV contactless entry is allowed via the PIN pad.
isContactlessMsdEntryAllowed false string 5 If set to 'true' then contactless entry is allowed via the PIN pad.
isDisplayCustomAidScreen false string 5 Turn On/Off Custom Multi Aid Screen.
isManualEntryAllowed false string 5 If set to 'true' then manual entry of card account numbers on the PIN pad is allowed
isUnattended false string 5 A boolean value to indicate that the PIN pad is an unattended device.
laneId false int Lane ID for lane setting.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 prefered AID Selection.
rebootTime false string 5 Device reboot time in 24 hour format HH:MM or HHMM
serial false Serial Serial device properties.
store false LaneStore Store setting for each lane.
terminalId false string 40 Terminal ID of PIN pad.
terminalType false string 32 terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
userInputTimeout false string 10 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Serial
Field Required Data Type Max Length Default Value Description
baudRate true string 10 Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string 6 Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string 1 If the PIN pad is connected via serial device, the data bit setting.
handshake true string 32 If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • XonXoff
  • RequestToSend
parity true string 16 If the PIN pad is connected via serial device, the parity setting.
stopBits true string 32 If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
Values:
  • None
  • One
  • OnePointFive
  • Two
LaneStore
Field Required Data Type Max Length Default Value Description
transactionAmountLimit true double 10 When storing, triPOS will decline any transaction greater than this amount.
GetSerialLaneResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Driver value",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessEmvEntryAllowed": {
    "description": "If set to 'true' then EMV contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "If set to 'true' then contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "If set to 'true' then manual entry of card account numbers on the PIN pad is allowed",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "prefered AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in 24 hour format HH:MM or HHMM",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "serial": {
    "description": "Serial device properties.",
    "type": "Serial",
    "required": false
  },
  "store": {
    "description": "Store setting for each lane.",
    "type": "LaneStore",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalType": {
    "description": "terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Serial 
{
  "baudRate": {
    "description": "Baud rate of serial communications.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "75",
        "110",
        "300",
        "1200",
        "2400",
        "4800",
        "9600",
        "19200",
        "38400",
        "57600",
        "115200"
      ]
    },
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "paramValues": {
      "max": "1",
      "defaultValue": ""
    },
    "required": true
  },
  "handshake": {
    "description": "If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "XonXoff",
        "RequestToSend"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "stopBits": {
    "description": "If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.  ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "One",
        "OnePointFive",
        "Two"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  }
}
LaneStore 
{
  "transactionAmountLimit": {
    "description": "When storing, triPOS will decline any transaction greater than this amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}
PUT
/api/v1/configuration/lanes/serial/{laneId} Updates serial lanes settings

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
UpdateSerialLaneRequest body PUT_UpdateSerialLaneRequest/v1/configuration/lanes/serial/{laneId} undefined

Request Class

UpdateSerialLaneRequest 
{
  "driver": "string",
  "isContactlessEmvEntryAllowed": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneId": "int",
  "serial": {
    "baudRate": "string",
    "comPort": "string",
    "dataBits": "string",
    "handshake": "string",
    "parity": "string",
    "stopBits": "string"
  },
  "terminalId": "string",
  "terminalType": "string",
  "description": "string",
  "idleScreenImage": "string",
  "idleScreenMessage": "string",
  "isDisplayCustomAidScreen": "string",
  "isUnattended": "string",
  "model": "string",
  "preferredAid": "string",
  "rebootTime": "string",
  "store": {
    "transactionAmountLimit": "double"
  },
  "userInputTimeout": "string"
}
UpdateSerialLaneRequest
Field Required Data Type Max Length Default Value Description
driver true string 50 PIN pad driver type
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
isContactlessEmvEntryAllowed true string 5 false Set to true to allow EMV contactless entry.
isContactlessMsdEntryAllowed true string 5 false Set to true to allow contactless entry.
isManualEntryAllowed true string 5 true Set to true to allow manual entry of card account numbers on the PIN pad.
laneId true int The desired lane ID. The lane ID should be a maximum of six digits long.
serial true PUT_Serial/v1/configuration/lanes/serial /{laneId} Collection of Serial device properties
terminalId true string 40 The Terminal ID to be passed to host.
terminalType true string 32 The terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
description false string 500 Description of lane.
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
isDisplayCustomAidScreen false string 5 false Turn On/Off Custom Multi Aid Screen.
isUnattended false string 5 false A boolean value to indicate that the PIN pad is an unattended device.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 Preferred AID Selection.
rebootTime false string 5 Device reboot time in HH:MM or HHMM 24 hour format.
store false PUT_LaneStore/v1/configuration/lanes/ser ial/{laneId} store
userInputTimeout false string 10 60000 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds
Serial
Field Required Data Type Max Length Default Value Description
baudRate true string 10 Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string 6 Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string 1 If the PIN pad is connected via serial device, the data bit setting.
handshake true string 32 If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • XonXoff
  • RequestToSend
parity true string 16 If the PIN pad is connected via serial device, the parity setting.
stopBits true string 32 If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
Values:
  • None
  • One
  • OnePointFive
  • Two
LaneStore
Field Required Data Type Max Length Default Value Description
transactionAmountLimit true double 10 When storing, triPOS will decline any transaction greater than this amount.
UpdateSerialLaneRequest 
{
  "driver": {
    "description": "PIN pad driver type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": true
  },
  "isContactlessEmvEntryAllowed": {
    "description": "Set to true to allow EMV contactless entry.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "isContactlessMsdEntryAllowed": {
    "description": "Set to true to allow contactless entry.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "isManualEntryAllowed": {
    "description": "Set to true to allow manual entry of card account numbers on the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "true"
    },
    "required": true
  },
  "laneId": {
    "description": "The desired lane ID. The lane ID should be a maximum of six digits long.",
    "type": "int",
    "allowableValues": {},
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "serial": {
    "description": "Collection of Serial device properties",
    "type": "PUT_Serial/v1/configuration/lanes/serial/{laneId}",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "terminalId": {
    "description": "The Terminal ID to be passed to host.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": true
  },
  "terminalType": {
    "description": "The terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "description": {
    "description": "Description of lane.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "Preferred AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in HH:MM or HHMM 24 hour format.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "store": {
    "description": "store",
    "type": "PUT_LaneStore/v1/configuration/lanes/serial/{laneId}",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "60000"
    },
    "required": false
  }
}
Serial 
{
  "baudRate": {
    "description": "Baud rate of serial communications.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "75",
        "110",
        "300",
        "1200",
        "2400",
        "4800",
        "9600",
        "19200",
        "38400",
        "57600",
        "115200"
      ]
    },
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "paramValues": {
      "max": "1",
      "defaultValue": ""
    },
    "required": true
  },
  "handshake": {
    "description": "If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "XonXoff",
        "RequestToSend"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "stopBits": {
    "description": "If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.  ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "One",
        "OnePointFive",
        "Two"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  }
}
LaneStore 
{
  "transactionAmountLimit": {
    "description": "When storing, triPOS will decline any transaction greater than this amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}

Response Class

UpdateSerialLaneResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "description": "string",
  "driver": "string",
  "idleScreenImage": "string",
  "idleScreenMessage": "string",
  "isContactlessEmvEntryAllowed": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isDisplayCustomAidScreen": "string",
  "isManualEntryAllowed": "string",
  "isUnattended": "string",
  "laneId": "int",
  "laneUpdated": "boolean",
  "model": "string",
  "preferredAid": "string",
  "rebootTime": "string",
  "serial": {
    "baudRate": "string",
    "comPort": "string",
    "dataBits": "string",
    "handshake": "string",
    "parity": "string",
    "stopBits": "string"
  },
  "store": {
    "transactionAmountLimit": "double"
  },
  "terminalId": "string",
  "terminalType": "string",
  "userInputTimeout": "string"
}
UpdateSerialLaneResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string 500 Description for lane setting.
driver false string 50 Driver value
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneCXpi
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
  • Unknown
  • IngenicoUpp
idleScreenImage false string 255 The name of the image to display on the PIN pad when it is idle. more�
idleScreenMessage false string 50 Message to display on the PIN pad when it is idle. more�
isContactlessEmvEntryAllowed false string 5 If set to 'true' then EMV contactless entry is allowed via the PIN pad.
isContactlessMsdEntryAllowed false string 5 If set to 'true' then contactless entry is allowed via the PIN pad.
isDisplayCustomAidScreen false string 5 Turn On/Off Custom Multi Aid Screen.
isManualEntryAllowed false string 5 If set to 'true' then manual entry of card account numbers on the PIN pad is allowed
isUnattended false string 5 A boolean value to indicate that the PIN pad is an unattended device.
laneId false int Lane ID for lane setting.
laneUpdated false boolean 5 True if lane was updated successfully and false otherwise.
model false string 15 Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.
preferredAid false string 32 prefered AID Selection.
rebootTime false string 5 Device reboot time in 24 hour format HH:MM or HHMM
serial false Serial Serial device properties.
store false LaneStore Store setting for each lane.
terminalId false string 40 Terminal ID of PIN pad.
terminalType false string 32 terminal type
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
userInputTimeout false string 10 Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Serial
Field Required Data Type Max Length Default Value Description
baudRate true string 10 Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string 6 Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string 1 If the PIN pad is connected via serial device, the data bit setting.
handshake true string 32 If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • XonXoff
  • RequestToSend
parity true string 16 If the PIN pad is connected via serial device, the parity setting.
stopBits true string 32 If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
Values:
  • None
  • One
  • OnePointFive
  • Two
LaneStore
Field Required Data Type Max Length Default Value Description
transactionAmountLimit true double 10 When storing, triPOS will decline any transaction greater than this amount.
UpdateSerialLaneResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "driver": {
    "description": "Driver value",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneCXpi",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull",
        "FinancialCardReadNull",
        "NullPinPadDoesNotSupportSignature",
        "NullPinPadReturnsContactlessMsd",
        "NullPinPadReturnsEncryptedContactlessMsd",
        "ConfigurableNull",
        "Unknown",
        "IngenicoUpp"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenImage": {
    "description": "The name of the image to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "255",
      "defaultValue": ""
    },
    "required": false
  },
  "idleScreenMessage": {
    "description": "Message to display on the PIN pad when it is idle. <a href='../help/kb/idleScreen.html'>more&raquo;</a>",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessEmvEntryAllowed": {
    "description": "If set to 'true' then EMV contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "If set to 'true' then contactless entry is allowed via the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDisplayCustomAidScreen": {
    "description": "Turn On/Off Custom Multi Aid Screen.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "If set to 'true' then manual entry of card account numbers on the PIN pad is allowed",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isUnattended": {
    "description": "A boolean value to indicate that the PIN pad is an unattended device.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "laneUpdated": {
    "description": "True if lane was updated successfully and false otherwise.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "model": {
    "description": "Model identifies the device model (e.g., MX915). It is mandatory for the ux300, but optional for all other devices.",
    "type": "string",
    "paramValues": {
      "max": "15",
      "defaultValue": ""
    },
    "required": false
  },
  "preferredAid": {
    "description": "prefered AID Selection.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "rebootTime": {
    "description": "Device reboot time in 24 hour format HH:MM or HHMM",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "serial": {
    "description": "Serial device properties.",
    "type": "Serial",
    "required": false
  },
  "store": {
    "description": "Store setting for each lane.",
    "type": "LaneStore",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalType": {
    "description": "terminal type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Custom User Input Timeout for prompt screens.Ex: For 30 seconds is 30000 milliseconds.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Serial 
{
  "baudRate": {
    "description": "Baud rate of serial communications.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "75",
        "110",
        "300",
        "1200",
        "2400",
        "4800",
        "9600",
        "19200",
        "38400",
        "57600",
        "115200"
      ]
    },
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "paramValues": {
      "max": "1",
      "defaultValue": ""
    },
    "required": true
  },
  "handshake": {
    "description": "If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "XonXoff",
        "RequestToSend"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "stopBits": {
    "description": "If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.  ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "One",
        "OnePointFive",
        "Two"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  }
}
LaneStore 
{
  "transactionAmountLimit": {
    "description": "When storing, triPOS will decline any transaction greater than this amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}
GET
/api/v1/configuration/server Retrieve server settings

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

GetServerConfigurationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "clientPinPadListeningPort": "string",
  "listeningPort": "string",
  "useHttps": "string"
}
GetServerConfigurationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
clientPinPadListeningPort false string 5 Listening port for incoming client pin pads.
listeningPort false string 5 Listening port for service REST requests.
useHttps false string 5 Set to true to use HTTPS for service REST requests. more�
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
GetServerConfigurationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "clientPinPadListeningPort": {
    "description": "Listening port for incoming client pin pads.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "listeningPort": {
    "description": "Listening port for service REST requests.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "useHttps": {
    "description": "Set to true to use HTTPS for service REST requests.  <a href='../help/kb/useHttps.html'>more�</a>",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
PUT
/api/v1/configuration/server Update server settings

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
UpdateServerConfigurationRequest body PUT_UpdateServerConfigurationRequest/v1/configuration/server undefined

Request Class

UpdateServerConfigurationRequest 
{
  "listeningPort": "string",
  "clientPinPadListeningPort": "string",
  "useHttps": "string"
}
UpdateServerConfigurationRequest
Field Required Data Type Max Length Default Value Description
listeningPort true string 5 Listening port for service REST requests.
clientPinPadListeningPort false string 5 Listening port for incoming client pin pads. Leave blank if your configuration does not include client pin pads.
useHttps false string 5 false Set to true to use HTTPS for service REST requests.
UpdateServerConfigurationRequest 
{
  "listeningPort": {
    "description": "Listening port for service REST requests.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": true
  },
  "clientPinPadListeningPort": {
    "description": "Listening port for incoming client pin pads. Leave blank if your configuration does not include client pin pads.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "useHttps": {
    "description": "Set to true to use HTTPS for service REST requests.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  }
}

Response Class

UpdateServerConfigurationResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "clientPinPadListeningPort": "string",
  "listeningPort": "string",
  "serverSettingsUpdated": "boolean",
  "useHttps": "string"
}
UpdateServerConfigurationResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
clientPinPadListeningPort false string 5 Listening port for incoming client pin pads.
listeningPort false string 5 Listening port for service REST requests.
serverSettingsUpdated false boolean 5 Success value for updating server settings.
useHttps false string 5 Set to true to use HTTPS for service REST requests. more�
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
UpdateServerConfigurationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "clientPinPadListeningPort": {
    "description": "Listening port for incoming client pin pads.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "listeningPort": {
    "description": "Listening port for service REST requests.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "serverSettingsUpdated": {
    "description": "Success value for updating server settings.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "useHttps": {
    "description": "Set to true to use HTTPS for service REST requests.  <a href='../help/kb/useHttps.html'>more�</a>",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
GET
/api/v1/configuration/transaction Retrieve transaction settings

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

GetTransactionConfigurationResponse 
{
  "forward": {
    "forwardMode": "string"
  },
  "isEmvSupported": "boolean",
  "store": {
    "storeMode": "string",
    "unprocessedTotalAmountLimit": "double"
  },
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "allowPartialApprovals": "boolean",
  "cashBackIncrement": "string",
  "cashBackSelections": "string",
  "checkForDuplicateTransactions": "boolean",
  "confirmConvenienceFeeAmount": "boolean",
  "confirmOriginalAmount": "boolean",
  "creditAvsEntryCondition": "string",
  "creditSaleSignatureThresholdAmount": "double",
  "currencyCode": "string",
  "debitSurcharge": "double",
  "emvFallbackAllowed": "string",
  "isCashBackAllowed": "boolean",
  "isCscSupported": "boolean",
  "isDebitRefundSupported": "boolean",
  "isDebitSupported": "boolean",
  "isEbtCashBenefitSupported": "boolean",
  "isEbtFoodStampSupported": "boolean",
  "isEbtRefundSupported": "boolean",
  "isGiftSupported": "boolean",
  "isHealthcareSupported": "boolean",
  "isTipAllowed": "boolean",
  "marketCode": "string",
  "maximumCashbackAmount": "int",
  "signatureFormat": "string",
  "tipSelections": "string"
}
GetTransactionConfigurationResponse
Field Required Data Type Max Length Default Value Description
forward true TransactionForwardConfiguration Forward configuration to control the level of liability when using store and forward functions.
isEmvSupported true boolean 5 Set to true to enable your application to accept EMV transactions. Set to false to not allow EMV transactions.
store true TransactionStoreConfiguration Store configuration to control the level of liability when using store and forward functions.
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
allowPartialApprovals false boolean 5 If set to true, partial approvals are allowed.
cashBackIncrement false string 10 Increments you want customers to be able to get back. Common values include, 1, 5, 10 and 20.
cashBackSelections false string 64 Enter whole numbers separated by commas for the cashback amounts to select from.
checkForDuplicateTransactions false boolean 5 If set to true, enables duplicate checking logic for the transaction at the host. This can be overridden on a per request basis.
confirmConvenienceFeeAmount false boolean 5 Set to true to require the PIN pad to display a confirmation message to the cardholder for the convenienceFeeAmount.
confirmOriginalAmount false boolean 5 If set to true, the PIN Pad will prompt the cardholder to confirm the original amount.
creditAvsEntryCondition false string 16 Set to true when AVS entry (billing postal code entry) should be prompted for credit transactions.
Values:
  • Always
  • Never
  • Keyed
creditSaleSignatureThresholdAmount false double 16 Leave as 0 or empty to always require a signature for credit sale, otherwise set to the amount that must be reached before asking for a signature, such as 25.00
currencyCode false string 4 The currency code that will be used for all transactions.
Values:
  • None
  • Usd
debitSurcharge false double 12 Enter a decimal amount to add to debit transactions. Please read the credit / debit card surcharge statutes as they pertain to your state of business: 'http://www.ncsl.org/research/financial-services-and-commerce/credit-or-debit-card-surcharges-statutes.aspx'
emvFallbackAllowed false string 32 Allow Emv Fallback.
Values:
  • NeverAllow
  • AllowAfterChipError
isCashBackAllowed false boolean 5 Set to true to allow cashback.
isCscSupported false boolean 5 If set to true triPOS will prompt for CVV during manual card entry.
isDebitRefundSupported false boolean 5 Set to true to allow refunds onto a debit card. Not all processors support this.
isDebitSupported false boolean 5 Set to true to allow debit only cards to be used. The credit functionality of check cards will still work if this is set to false.
isEbtCashBenefitSupported false boolean 5 Set to true to allow Ebt Cash benefit cards to be used.
isEbtFoodStampSupported false boolean 5 Set to true to allow Ebt Food stamp cards to be used.
isEbtRefundSupported false boolean 5 Set to true to allow refunds onto a EBT card. Not all processors support this.
isGiftSupported false boolean 5 Set to true to allow gift only cards to be used.
isHealthcareSupported false boolean 5 If set to true, Healthcare fields are allowed.
isTipAllowed false boolean 5 Set to true to allow tips to be added.
marketCode false string 32 The market code specific to the type of transaction being submitted. Can be overridden on a per request basis.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
maximumCashbackAmount false int 10 The maximum cashback amount you want to allow cardholders to get back
signatureFormat false string The format which signature data should come back as.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
tipSelections false string 64 Enter decimal numbers for tip amounts. Add percent sign after the number to display a percent option rather than a dollar amount (i.e. 10%, 15%, 20%). If any value is a percentage, it is assumed that all values are percentages. Add 'none' to show "None" on the pin pad, otherwise "Other" will always be shown on the pin pad.
TransactionForwardConfiguration
Field Required Data Type Max Length Default Value Description
forwardMode false string 32 Allow triPOS to forward transactions automatically upon gaining connectivity, or merchant chooses to forward on per request basis.
Values:
  • PerRequest
  • Automatic
TransactionStoreConfiguration
Field Required Data Type Max Length Default Value Description
storeMode true string 32 Allow triPOS to store transactions automatically upon losing connectivity, or merchant chooses to store on per request basis.
Values:
  • PerRequest
  • Automatic
unprocessedTotalAmountLimit false double 10 When storing, triPOS will decline any transaction that causes the sum of all unprocessed transactions to exceed this maxiumum amount.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
GetTransactionConfigurationResponse 
{
  "forward": {
    "description": "Forward configuration to control the level of liability when using store and forward functions.",
    "type": "TransactionForwardConfiguration",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "isEmvSupported": {
    "description": "Set to true to enable your application to accept EMV transactions. Set to false to not allow EMV transactions.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": true
  },
  "store": {
    "description": "Store configuration to control the level of liability when using store and forward functions.",
    "type": "TransactionStoreConfiguration",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "cashBackIncrement": {
    "description": "Increments you want customers to be able to get back. Common values include, 1, 5, 10 and 20.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "cashBackSelections": {
    "description": "Enter whole numbers separated by commas for the cashback amounts to select from.",
    "type": "string",
    "paramValues": {
      "max": "64",
      "defaultValue": ""
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host. This can be overridden on a per request basis.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "confirmConvenienceFeeAmount": {
    "description": "Set to true to require the PIN pad to display a confirmation message to the cardholder for the convenienceFeeAmount.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "confirmOriginalAmount": {
    "description": "If set to true, the PIN Pad will prompt the cardholder to confirm the original amount.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "creditAvsEntryCondition": {
    "description": "Set to true when AVS entry (billing postal code entry) should be prompted for credit transactions.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Always",
        "Never",
        "Keyed"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "creditSaleSignatureThresholdAmount": {
    "description": "Leave as 0 or empty to always require a signature for credit sale, otherwise set to the amount that must be reached before asking for a signature, such as 25.00",
    "type": "double",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "currencyCode": {
    "description": "The currency code that will be used for all transactions.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "debitSurcharge": {
    "description": "Enter a decimal amount to add to debit transactions. Please read the credit / debit card surcharge statutes as they pertain to your state of business: 'http://www.ncsl.org/research/financial-services-and-commerce/credit-or-debit-card-surcharges-statutes.aspx'",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "emvFallbackAllowed": {
    "description": "Allow Emv Fallback.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NeverAllow",
        "AllowAfterChipError"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "isCashBackAllowed": {
    "description": "Set to true to allow cashback.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isCscSupported": {
    "description": "If set to true triPOS will prompt for CVV during manual card entry.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDebitRefundSupported": {
    "description": "Set to true to allow refunds onto a debit card. Not all processors support this.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDebitSupported": {
    "description": "Set to true to allow debit only cards to be used. The credit functionality of check cards will still work if this is set to false.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isEbtCashBenefitSupported": {
    "description": "Set to true to allow Ebt Cash benefit cards to be used.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isEbtFoodStampSupported": {
    "description": "Set to true to allow Ebt Food stamp cards to be used.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isEbtRefundSupported": {
    "description": "Set to true to allow refunds onto a EBT card. Not all processors support this.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isGiftSupported": {
    "description": "Set to true to allow gift only cards to be used.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isHealthcareSupported": {
    "description": "If set to true, Healthcare fields are allowed.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isTipAllowed": {
    "description": "Set to true to allow tips to be added.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code specific to the type of transaction being submitted. Can be overridden on a per request basis.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "maximumCashbackAmount": {
    "description": "The maximum cashback amount you want to allow cardholders to get back",
    "type": "int",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "signatureFormat": {
    "description": "The format which signature data should come back as.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PointsLittleEndian",
        "PointsBigEndian",
        "Ascii3Byte"
      ]
    },
    "required": false
  },
  "tipSelections": {
    "description": "Enter decimal numbers for tip amounts. Add percent sign after the number to display a percent option rather than a dollar amount (i.e. 10%, 15%, 20%). If any value is a percentage, it is assumed that all values are percentages. Add 'none' to show \"None\" on the pin pad, otherwise \"Other\" will always be shown on the pin pad.",
    "type": "string",
    "paramValues": {
      "max": "64",
      "defaultValue": ""
    },
    "required": false
  }
}
TransactionForwardConfiguration 
{
  "forwardMode": {
    "description": "Allow triPOS to forward transactions automatically upon gaining connectivity, or merchant chooses to forward on per request basis.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PerRequest",
        "Automatic"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}
TransactionStoreConfiguration 
{
  "storeMode": {
    "description": "Allow triPOS to store transactions automatically upon losing connectivity, or merchant chooses to store on per request basis.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PerRequest",
        "Automatic"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "unprocessedTotalAmountLimit": {
    "description": "When storing, triPOS will decline any transaction that causes the sum of all unprocessed transactions to exceed this maxiumum amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
PUT
/api/v1/configuration/transaction Update transaction settings

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
UpdateTransactionConfigurationRequest body PUT_UpdateTransactionConfigurationRequest/v1/configuration/transaction undefined

Request Class

UpdateTransactionConfigurationRequest 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "confirmConvenienceFeeAmount": "boolean",
  "confirmOriginalAmount": "boolean",
  "creditAvsEntryCondition": "string",
  "creditSaleSignatureThresholdAmount": "double",
  "currencyCode": "string",
  "debitSurcharge": "double",
  "emvFallbackAllowed": "string",
  "forward": {
    "forwardMode": "string"
  },
  "isCashBackAllowed": "boolean",
  "isDebitSupported": "boolean",
  "isEbtCashBenefitSupported": "boolean",
  "isEbtFoodStampSupported": "boolean",
  "isEmvSupported": "boolean",
  "isGiftSupported": "boolean",
  "isTipAllowed": "boolean",
  "marketCode": "string",
  "signatureFormat": "string",
  "store": {
    "storeMode": "string",
    "unprocessedTotalAmountLimit": "double"
  },
  "cashBackIncrement": "int",
  "cashbackSelections": "Array<int>",
  "decimalTipSelections": "Array<double>",
  "isCscSupported": "boolean",
  "isDebitRefundSupported": "boolean",
  "isEbtRefundSupported": "boolean",
  "isHealthcareSupported": "boolean",
  "maximumCashbackAmount": "int",
  "noneTipSelection": "boolean",
  "otherCashbackSelection": "boolean",
  "percentTipSelections": "Array<double>"
}
UpdateTransactionConfigurationRequest
Field Required Data Type Max Length Default Value Description
allowPartialApprovals true boolean 5 false If set to true, partial approvals are allowed.
checkForDuplicateTransactions true boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host. This can be overridden on a per request basis.
confirmConvenienceFeeAmount true boolean 5 true Set to true to require the PIN pad to display a confirmation message to the cardholder for the convenienceFeeAmount.
confirmOriginalAmount true boolean 5 false If set to true, the original transaction amount will be confirmed after card information is obtained.
creditAvsEntryCondition true string 16 Set to true when AVS entry (billing postal code entry) should be prompted for credit transactions.
Values:
  • Always
  • Never
  • Keyed
creditSaleSignatureThresholdAmount true double 16 0 Leave as 0 or empty to always require a signature for credit sale, otherwise set to the amount that must be reached before asking for a signature, such as 25.00
currencyCode true string 4 Usd The currency code that will be used for all transactions.
Values:
  • None
  • Usd
debitSurcharge true double 12 0 Enter a decimal amount to add to debit transactions. Please read the credit / debit card surcharge statutes as they pertain to your state of business: 'http://www.ncsl.org/research/financial-services-and-commerce/credit-or-debit-card-surcharges-statutes.aspx'
emvFallbackAllowed true string 32 Allow Emv Fallback.
Values:
  • NeverAllow
  • AllowAfterChipError
forward true PUT_TransactionForwardConfiguration/v1/c onfiguration/transaction Forward configuration to control the level of liability when using store and forward functions.
isCashBackAllowed true boolean 5 false Set to true to allow cashback.
isDebitSupported true boolean 5 true Set to true to allow debit only cards to be used. The credit functionality of check cards will still work if this is set to false.
isEbtCashBenefitSupported true boolean 5 false Set to true to allow Ebt Cash benefit cards to be used. The credit functionality of check cards will still work if this is set to false.
isEbtFoodStampSupported true boolean 5 false Set to true to allow Ebt Food stamp cards to be used. The credit functionality of check cards will still work if this is set to false.
isEmvSupported true boolean 5 false Set to true to enable your application to accept EMV transactions. Set to false to not allow EMV transactions.
isGiftSupported true boolean 5 false Set to true to allow gift only cards to be used. The credit functionality of check cards will still work if this is set to false.
isTipAllowed true boolean 5 false Set to true to allow tips to be added.
marketCode true string 32 Retail The market code specific to the type of transaction being submitted. This global value can be set, but it can be overridden on a per request basis.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
signatureFormat true string 32 The format which signature data should come back as.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
store true PUT_TransactionStoreConfiguration/v1/con figuration/transaction Store configuration to control the level of liability when using store and forward functions.
cashBackIncrement false int 10 Increments you want customers to be able to get back. Common values include, 1, 5, 10 and 20.
cashbackSelections false Array<int> 64 Enter a list of whole numbers separated by commas, instead of using the automatically generated cashBackIncrement values for the cashback amounts to select from, e.g. 5, 20, 50, 100.
decimalTipSelections false Array<double> 16 Enter decimal numbers for tip amounts. If percent values were provided for tip amounts then these values will be ignored.
isCscSupported false boolean 5 false Set to true to prompt for CVV during manual card entry.
isDebitRefundSupported false boolean 5 false Set to true to allow refunds onto a debit card. Not all processors support this.
isEbtRefundSupported false boolean 5 false Set to true to allow refunds onto a EBT foodstamp card. Not all processors support this.
isHealthcareSupported false boolean 5 false If set to true, Healthcare fields are allowed.
maximumCashbackAmount false int 10 The maximum cashback amount you want to allow cardholders to get back
noneTipSelection false boolean 5 false Enter true to show "None" on the PIN pad during tip selection. If false is entered "Other" will be shown instead.
otherCashbackSelection false boolean 5 false Enter true if you would like "Other" option to show up on cashback selection screen.
percentTipSelections false Array<double> Enter decimal numbers to be used as percent values for tip amounts. This means { 10, 15.5, 20.0 } will become the following tip selections (10%, 15.5%, 20%). If percent values are provided for tip amounts then decimal tip amounts will be ignored.
TransactionForwardConfiguration
Field Required Data Type Max Length Default Value Description
forwardMode false string 32 Allow triPOS to forward transactions automatically upon gaining connectivity, or merchant chooses to forward on per request basis.
Values:
  • PerRequest
  • Automatic
TransactionStoreConfiguration
Field Required Data Type Max Length Default Value Description
storeMode true string 32 Allow triPOS to store transactions automatically upon losing connectivity, or merchant chooses to store on per request basis.
Values:
  • PerRequest
  • Automatic
unprocessedTotalAmountLimit false double 10 When storing, triPOS will decline any transaction that causes the sum of all unprocessed transactions to exceed this maxiumum amount.
UpdateTransactionConfigurationRequest 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host. This can be overridden on a per request basis.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "confirmConvenienceFeeAmount": {
    "description": "Set to true to require the PIN pad to display a confirmation message to the cardholder for the convenienceFeeAmount.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "true"
    },
    "required": true
  },
  "confirmOriginalAmount": {
    "description": "If set to true, the original transaction amount will be confirmed after card information is obtained.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "creditAvsEntryCondition": {
    "description": "Set to true when AVS entry (billing postal code entry) should be prompted for credit transactions.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Always",
        "Never",
        "Keyed"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "creditSaleSignatureThresholdAmount": {
    "description": "Leave as 0 or empty to always require a signature for credit sale, otherwise set to the amount that must be reached before asking for a signature, such as 25.00",
    "type": "double",
    "allowableValues": {},
    "paramValues": {
      "max": "16",
      "defaultValue": "0"
    },
    "required": true
  },
  "currencyCode": {
    "description": "The currency code that will be used for all transactions.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": "Usd"
    },
    "required": true
  },
  "debitSurcharge": {
    "description": "Enter a decimal amount to add to debit transactions. Please read the credit / debit card surcharge statutes as they pertain to your state of business: 'http://www.ncsl.org/research/financial-services-and-commerce/credit-or-debit-card-surcharges-statutes.aspx'",
    "type": "double",
    "allowableValues": {},
    "paramValues": {
      "max": "12",
      "defaultValue": "0"
    },
    "required": true
  },
  "emvFallbackAllowed": {
    "description": "Allow Emv Fallback.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NeverAllow",
        "AllowAfterChipError"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "forward": {
    "description": "Forward configuration to control the level of liability when using store and forward functions.",
    "type": "PUT_TransactionForwardConfiguration/v1/configuration/transaction",
    "required": true
  },
  "isCashBackAllowed": {
    "description": "Set to true to allow cashback.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "isDebitSupported": {
    "description": "Set to true to allow debit only cards to be used. The credit functionality of check cards will still work if this is set to false.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "true"
    },
    "required": true
  },
  "isEbtCashBenefitSupported": {
    "description": "Set to true to allow Ebt Cash benefit cards to be used. The credit functionality of check cards will still work if this is set to false.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "isEbtFoodStampSupported": {
    "description": "Set to true to allow Ebt Food stamp cards to be used. The credit functionality of check cards will still work if this is set to false.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "isEmvSupported": {
    "description": "Set to true to enable your application to accept EMV transactions. Set to false to not allow EMV transactions.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "isGiftSupported": {
    "description": "Set to true to allow gift only cards to be used. The credit functionality of check cards will still work if this is set to false.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "isTipAllowed": {
    "description": "Set to true to allow tips to be added.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "marketCode": {
    "description": "The market code specific to the type of transaction being submitted. This global value can be set, but it can be overridden on a per request basis.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": true
  },
  "signatureFormat": {
    "description": "The format which signature data should come back as.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PointsLittleEndian",
        "PointsBigEndian",
        "Ascii3Byte"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "store": {
    "description": "Store configuration to control the level of liability when using store and forward functions.",
    "type": "PUT_TransactionStoreConfiguration/v1/configuration/transaction",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "cashBackIncrement": {
    "description": "Increments you want customers to be able to get back. Common values include, 1, 5, 10 and 20.",
    "type": "int",
    "allowableValues": {},
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "cashbackSelections": {
    "description": "Enter a list of whole numbers separated by commas, instead of using the automatically generated cashBackIncrement values for the cashback amounts to select from, e.g. 5, 20, 50, 100.",
    "type": "Array",
    "items": {
      "type": "int"
    },
    "paramValues": {
      "max": "64",
      "defaultValue": ""
    },
    "required": false
  },
  "decimalTipSelections": {
    "description": "Enter decimal numbers for tip amounts. If percent values were provided for tip amounts then these values will be ignored.",
    "type": "Array",
    "items": {
      "type": "double"
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "isCscSupported": {
    "description": "Set to true to prompt for CVV during manual card entry.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isDebitRefundSupported": {
    "description": "Set to true to allow refunds onto a debit card. Not all processors support this.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isEbtRefundSupported": {
    "description": "Set to true to allow refunds onto a EBT foodstamp card. Not all processors support this.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isHealthcareSupported": {
    "description": "If set to true, Healthcare fields are allowed.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "maximumCashbackAmount": {
    "description": "The maximum cashback amount you want to allow cardholders to get back",
    "type": "int",
    "allowableValues": {},
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "noneTipSelection": {
    "description": "Enter true to show \"None\" on the PIN pad during tip selection. If false is entered \"Other\" will be shown instead.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "otherCashbackSelection": {
    "description": "Enter true if you would like \"Other\" option to show up on cashback selection screen.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "percentTipSelections": {
    "description": "Enter decimal numbers to be used as percent values for tip amounts. This means { 10, 15.5, 20.0 } will become the following tip selections (10%, 15.5%, 20%). If percent values are provided for tip amounts then decimal tip amounts will be ignored.",
    "type": "Array",
    "items": {
      "type": "double"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  }
}
TransactionForwardConfiguration 
{
  "forwardMode": {
    "description": "Allow triPOS to forward transactions automatically upon gaining connectivity, or merchant chooses to forward on per request basis.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PerRequest",
        "Automatic"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}
TransactionStoreConfiguration 
{
  "storeMode": {
    "description": "Allow triPOS to store transactions automatically upon losing connectivity, or merchant chooses to store on per request basis.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PerRequest",
        "Automatic"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "unprocessedTotalAmountLimit": {
    "description": "When storing, triPOS will decline any transaction that causes the sum of all unprocessed transactions to exceed this maxiumum amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

UpdateTransactionConfigurationResponse 
{
  "forward": {
    "forwardMode": "string"
  },
  "isEmvSupported": "boolean",
  "store": {
    "storeMode": "string",
    "unprocessedTotalAmountLimit": "double"
  },
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "allowPartialApprovals": "boolean",
  "cashBackIncrement": "string",
  "cashBackSelections": "string",
  "checkForDuplicateTransactions": "boolean",
  "confirmConvenienceFeeAmount": "boolean",
  "confirmOriginalAmount": "boolean",
  "creditAvsEntryCondition": "string",
  "creditSaleSignatureThresholdAmount": "double",
  "currencyCode": "string",
  "debitSurcharge": "double",
  "emvFallbackAllowed": "string",
  "isCashBackAllowed": "boolean",
  "isCscSupported": "boolean",
  "isDebitRefundSupported": "boolean",
  "isDebitSupported": "boolean",
  "isEbtCashBenefitSupported": "boolean",
  "isEbtFoodStampSupported": "boolean",
  "isEbtRefundSupported": "boolean",
  "isGiftSupported": "boolean",
  "isHealthcareSupported": "boolean",
  "isTipAllowed": "boolean",
  "marketCode": "string",
  "maximumCashbackAmount": "int",
  "signatureFormat": "string",
  "tipSelections": "string",
  "transactionUpdated": "boolean"
}
UpdateTransactionConfigurationResponse
Field Required Data Type Max Length Default Value Description
forward true TransactionForwardConfiguration Forward configuration to control the level of liability when using store and forward functions.
isEmvSupported true boolean 5 Set to true to enable your application to accept EMV transactions. Set to false to not allow EMV transactions.
store true TransactionStoreConfiguration Store configuration to control the level of liability when using store and forward functions.
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
allowPartialApprovals false boolean 5 If set to true, partial approvals are allowed.
cashBackIncrement false string 10 Increments you want customers to be able to get back. Common values include, 1, 5, 10 and 20.
cashBackSelections false string 64 Enter whole numbers separated by commas for the cashback amounts to select from.
checkForDuplicateTransactions false boolean 5 If set to true, enables duplicate checking logic for the transaction at the host. This can be overridden on a per request basis.
confirmConvenienceFeeAmount false boolean 5 Set to true to require the PIN pad to display a confirmation message to the cardholder for the convenienceFeeAmount.
confirmOriginalAmount false boolean 5 If set to true, the PIN Pad will prompt the cardholder to confirm the original amount.
creditAvsEntryCondition false string 16 Set to true when AVS entry (billing postal code entry) should be prompted for credit transactions.
Values:
  • Always
  • Never
  • Keyed
creditSaleSignatureThresholdAmount false double 16 Leave as 0 or empty to always require a signature for credit sale, otherwise set to the amount that must be reached before asking for a signature, such as 25.00
currencyCode false string 4 The currency code that will be used for all transactions.
Values:
  • None
  • Usd
debitSurcharge false double 12 Enter a decimal amount to add to debit transactions. Please read the credit / debit card surcharge statutes as they pertain to your state of business: 'http://www.ncsl.org/research/financial-services-and-commerce/credit-or-debit-card-surcharges-statutes.aspx'
emvFallbackAllowed false string 32 Allow Emv Fallback.
Values:
  • NeverAllow
  • AllowAfterChipError
isCashBackAllowed false boolean 5 Set to true to allow cashback.
isCscSupported false boolean 5 If set to true triPOS will prompt for CVV during manual card entry.
isDebitRefundSupported false boolean 5 Set to true to allow refunds onto a debit card. Not all processors support this.
isDebitSupported false boolean 5 Set to true to allow debit only cards to be used. The credit functionality of check cards will still work if this is set to false.
isEbtCashBenefitSupported false boolean 5 Set to true to allow Ebt Cash benefit cards to be used.
isEbtFoodStampSupported false boolean 5 Set to true to allow Ebt Food stamp cards to be used.
isEbtRefundSupported false boolean 5 Set to true to allow refunds onto a EBT card. Not all processors support this.
isGiftSupported false boolean 5 Set to true to allow gift only cards to be used.
isHealthcareSupported false boolean 5 If set to true, Healthcare fields are allowed.
isTipAllowed false boolean 5 Set to true to allow tips to be added.
marketCode false string 32 The market code specific to the type of transaction being submitted. Can be overridden on a per request basis.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
maximumCashbackAmount false int 10 The maximum cashback amount you want to allow cardholders to get back
signatureFormat false string The format which signature data should come back as.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
tipSelections false string 64 Enter decimal numbers for tip amounts. Add percent sign after the number to display a percent option rather than a dollar amount (i.e. 10%, 15%, 20%). If any value is a percentage, it is assumed that all values are percentages. Add 'none' to show "None" on the pin pad, otherwise "Other" will always be shown on the pin pad.
transactionUpdated false boolean 5 True is transaction settings were updated successfully and false otherwise.
TransactionForwardConfiguration
Field Required Data Type Max Length Default Value Description
forwardMode false string 32 Allow triPOS to forward transactions automatically upon gaining connectivity, or merchant chooses to forward on per request basis.
Values:
  • PerRequest
  • Automatic
TransactionStoreConfiguration
Field Required Data Type Max Length Default Value Description
storeMode true string 32 Allow triPOS to store transactions automatically upon losing connectivity, or merchant chooses to store on per request basis.
Values:
  • PerRequest
  • Automatic
unprocessedTotalAmountLimit false double 10 When storing, triPOS will decline any transaction that causes the sum of all unprocessed transactions to exceed this maxiumum amount.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
UpdateTransactionConfigurationResponse 
{
  "forward": {
    "description": "Forward configuration to control the level of liability when using store and forward functions.",
    "type": "TransactionForwardConfiguration",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "isEmvSupported": {
    "description": "Set to true to enable your application to accept EMV transactions. Set to false to not allow EMV transactions.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": true
  },
  "store": {
    "description": "Store configuration to control the level of liability when using store and forward functions.",
    "type": "TransactionStoreConfiguration",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "cashBackIncrement": {
    "description": "Increments you want customers to be able to get back. Common values include, 1, 5, 10 and 20.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "cashBackSelections": {
    "description": "Enter whole numbers separated by commas for the cashback amounts to select from.",
    "type": "string",
    "paramValues": {
      "max": "64",
      "defaultValue": ""
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host. This can be overridden on a per request basis.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "confirmConvenienceFeeAmount": {
    "description": "Set to true to require the PIN pad to display a confirmation message to the cardholder for the convenienceFeeAmount.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "confirmOriginalAmount": {
    "description": "If set to true, the PIN Pad will prompt the cardholder to confirm the original amount.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "creditAvsEntryCondition": {
    "description": "Set to true when AVS entry (billing postal code entry) should be prompted for credit transactions.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Always",
        "Never",
        "Keyed"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "creditSaleSignatureThresholdAmount": {
    "description": "Leave as 0 or empty to always require a signature for credit sale, otherwise set to the amount that must be reached before asking for a signature, such as 25.00",
    "type": "double",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "currencyCode": {
    "description": "The currency code that will be used for all transactions.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "debitSurcharge": {
    "description": "Enter a decimal amount to add to debit transactions. Please read the credit / debit card surcharge statutes as they pertain to your state of business: 'http://www.ncsl.org/research/financial-services-and-commerce/credit-or-debit-card-surcharges-statutes.aspx'",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "emvFallbackAllowed": {
    "description": "Allow Emv Fallback.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NeverAllow",
        "AllowAfterChipError"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "isCashBackAllowed": {
    "description": "Set to true to allow cashback.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isCscSupported": {
    "description": "If set to true triPOS will prompt for CVV during manual card entry.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDebitRefundSupported": {
    "description": "Set to true to allow refunds onto a debit card. Not all processors support this.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isDebitSupported": {
    "description": "Set to true to allow debit only cards to be used. The credit functionality of check cards will still work if this is set to false.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isEbtCashBenefitSupported": {
    "description": "Set to true to allow Ebt Cash benefit cards to be used.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isEbtFoodStampSupported": {
    "description": "Set to true to allow Ebt Food stamp cards to be used.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isEbtRefundSupported": {
    "description": "Set to true to allow refunds onto a EBT card. Not all processors support this.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isGiftSupported": {
    "description": "Set to true to allow gift only cards to be used.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isHealthcareSupported": {
    "description": "If set to true, Healthcare fields are allowed.",
    "type": "boolean",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isTipAllowed": {
    "description": "Set to true to allow tips to be added.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code specific to the type of transaction being submitted. Can be overridden on a per request basis.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "maximumCashbackAmount": {
    "description": "The maximum cashback amount you want to allow cardholders to get back",
    "type": "int",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "signatureFormat": {
    "description": "The format which signature data should come back as.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PointsLittleEndian",
        "PointsBigEndian",
        "Ascii3Byte"
      ]
    },
    "required": false
  },
  "tipSelections": {
    "description": "Enter decimal numbers for tip amounts. Add percent sign after the number to display a percent option rather than a dollar amount (i.e. 10%, 15%, 20%). If any value is a percentage, it is assumed that all values are percentages. Add 'none' to show \"None\" on the pin pad, otherwise \"Other\" will always be shown on the pin pad.",
    "type": "string",
    "paramValues": {
      "max": "64",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionUpdated": {
    "description": "True is transaction settings were updated successfully and false otherwise.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  }
}
TransactionForwardConfiguration 
{
  "forwardMode": {
    "description": "Allow triPOS to forward transactions automatically upon gaining connectivity, or merchant chooses to forward on per request basis.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PerRequest",
        "Automatic"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}
TransactionStoreConfiguration 
{
  "storeMode": {
    "description": "Allow triPOS to store transactions automatically upon losing connectivity, or merchant chooses to store on per request basis.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PerRequest",
        "Automatic"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "unprocessedTotalAmountLimit": {
    "description": "When storing, triPOS will decline any transaction that causes the sum of all unprocessed transactions to exceed this maxiumum amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
POST
/api/v1/display Displays a text on the PIN pad.

Implementation Notes

Use the display endpoint to display a text on the PIN pad. This endpoint returns an HTTP status code of 200 if the text was successfully displayed on the PIN pad. See display documentation fore more information.

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
DisplayRequest body POST_DisplayRequest/v1/display undefined

Request Class

DisplayRequest 
{
  "laneId": "int",
  "multiLineText": "Array<string>",
  "text": "string"
}
DisplayRequest
Field Required Data Type Max Length Default Value Description
laneId true int The lane ID.
multiLineText false Array<string> 1000 The list of individual lines of text to be displayed on the PIN pad. Only some PIN pads support multi-line display. The maximum number of lines and characters per line varies among PIN pads. Please test the multi-line text with the desired PIN pad to make sure it is displayed as expected. More�
text false string 1000 The full text to display on the PIN pad. triPOS may split the text into multiple lines based on the size of the PIN pad's screen. Please test the text with the desired PIN pad to make sure it is displayed as expected. More�
DisplayRequest 
{
  "laneId": {
    "description": "The lane ID.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "multiLineText": {
    "description": "The list of individual lines of text to be displayed on the PIN pad. Only some PIN pads support multi-line display. The maximum number of lines and characters per line varies among PIN pads. Please test the multi-line text with the desired PIN pad to make sure it is displayed as expected. <a href='../help/kb/display.html'>More&raquo</a>",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "text": {
    "description": "The full text to display on the PIN pad. triPOS may split the text into multiple lines based on the size of the PIN pad's screen. Please test the text with the desired PIN pad to make sure it is displayed as expected. <a href='../help/kb/display.html'>More&raquo</a>",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

DisplayResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  }
}
DisplayResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
DisplayResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if parameter values are missing or invalid.
POST
/api/v1/ebtVoucher Creates a new EBT voucher sale based on the passed in amount

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
EbtVoucherRequest body POST_EbtVoucherRequest/v1/ebtVoucher undefined

Request Class

EbtVoucherRequest 
{
  "approvalNumber": "string",
  "laneId": "int",
  "transactionAmount": "double",
  "voucherNumber": "string",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "checkForDuplicateTransactions": "boolean",
    "marketCode": "string"
  },
  "isCscSupported": "string",
  "referenceNumber": "string",
  "ticketNumber": "string"
}
EbtVoucherRequestConfiguration 
{
  "checkForDuplicateTransactions": "boolean",
  "marketCode": "string"
}
EbtVoucherRequest
Field Required Data Type Max Length Default Value Description
approvalNumber true string 30 The approval number of a voice authorization
laneId true int Specifies which lane to use.
transactionAmount true double 10 0.00 The total transaction amount. This is the amount of funds to move on the card.
voucherNumber true string 40 The voucher number to complete a foodstamp purchase.
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
configuration false POST_EbtVoucherRequestConfiguration/v1/e btVoucher Any value included in this section will override the corresponding value set in the triPOS.config
isCscSupported false string 5 false Invokes prompt for cardholder to enter card security code for manual keyed card entry.
referenceNumber false string 50 A user defined reference number.
ticketNumber false string 50 An optional ticket number.
EbtVoucherRequestConfiguration
Field Required Data Type Max Length Default Value Description
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
EbtVoucherRequest 
{
  "approvalNumber": {
    "description": "The approval number of a voice authorization",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": true
  },
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "voucherNumber": {
    "description": "The voucher number to complete a foodstamp purchase.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_EbtVoucherRequestConfiguration/v1/ebtVoucher",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "isCscSupported": {
    "description": "Invokes prompt for cardholder to enter card security code for manual keyed card entry.",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}
EbtVoucherRequestConfiguration 
{
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  }
}

Response Class

EbtVoucherResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "balanceAmount": "double",
  "balanceCurrencyCode": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "currencyCode": "string",
  "ebtType": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "networkLabel": "string",
  "paymentType": "string",
  "pinVerified": "boolean",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
EbtVoucherResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
balanceAmount false double 13 The balance of the gift card.
balanceCurrencyCode false string 4 The balance currency code.
Values:
  • None
  • Usd
binValue false string 6 The BIN entry that matched the account number.
cardHolderName false string 80 The cardholder name.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
currencyCode false string 4 The currency code used in the transaction.
Values:
  • None
  • Usd
ebtType false string 16 The type of the EBT card
Values:
  • None
  • FoodStamp
  • CashBenefit
entryMode false string 32 Description of how card was entered.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
networkLabel false string 30 Label that shows the network where the transaction was routed for authorization
paymentType false string 16 Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
  • Ebt
pinVerified false boolean 5 True if the PIN was verified, false if not verified or undetermined.
signature false Signature The signature data.
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Signature
Field Required Data Type Max Length Default Value Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string 32 The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string 50 Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
  • SignatureRequiredButPromptSuppressedByMerchant
  • SignatureNotRequiredByUnattendedPinPad
EbtVoucherResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceAmount": {
    "description": "The balance of the gift card.",
    "type": "double",
    "paramValues": {
      "max": "13",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceCurrencyCode": {
    "description": "The balance currency code.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderName": {
    "description": "The cardholder name.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "ebtType": {
    "description": "The type of the EBT card",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "FoodStamp",
        "CashBenefit"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "networkLabel": {
    "description": "Label that shows the network where the transaction was routed for authorization",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift",
        "Ebt"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Signature 
{
  "data": {
    "description": "The byte array of the signature in the format specified by Format.",
    "type": "Array",
    "items": {
      "type": "byte"
    },
    "required": false
  },
  "format": {
    "description": "The format of the signature.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PointsLittleEndian",
        "PointsBigEndian",
        "Ascii3Byte"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "Indicates why a signature is or is not present.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "SignatureRequired",
        "SignaturePresent",
        "SignatureRequiredCancelledByCardholder",
        "SignatureRequiredNotSupportedByPinPad",
        "SignatureRequiredPinPadError",
        "SignatureNotRequiredByThresholdAmount",
        "SignatureNotRequiredByPaymentType",
        "SignatureNotRequiredByTransactionType",
        "SignatureRequiredButPromptSuppressedByMerchant",
        "SignatureNotRequiredByUnattendedPinPad"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if the transaction amount is less than 0 on a valid request.
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
404 Returned if the laneId is not valid.
500 Returned if the PIN pad is disconnected or lane is already in use.
GET
/api/v1/force Returns a the list of force endpoints

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

ForceResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  }
}
ForceResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
ForceResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
POST
/api/v1/force/credit Creates a new credit card force based on the passed in amounts

Implementation Notes

This endpoint supports QuickChip/PreRead functionality. See QuickChip/PreRead documentation for more information.

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
ForceCreditRequest body POST_ForceCreditRequest/v1/force/credit undefined

Request Class

ForceCreditRequest 
{
  "approvalNumber": "string",
  "laneId": "int",
  "transactionAmount": "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"
  },
  "autoRental": {
    "customerName": "string",
    "agreementNumber": "string",
    "vehicleClassCode": "string",
    "noShowIndicator": "string",
    "adjustmentData": {
      "amount": "double",
      "code": "string",
      "extraChargesDetail": "Array<POST_AutoRentalExtraChargesDetail/v1/force/credit>"
    },
    "pickupData": {
      "city": "string",
      "countryCode": "string",
      "date": "string",
      "location": "string",
      "state": "string"
    },
    "returnData": {
      "city": "string",
      "countryCode": "string",
      "date": "string",
      "locationId": "string",
      "state": "string",
      "distance": "int",
      "distanceUnit": "string"
    },
    "dailyRentalRate": "double",
    "weeklyRentalRate": "double",
    "insuranceCharges": "double",
    "duration": "int"
  },
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "commercialCardCustomerCode": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "isManualEntryAllowed": "string",
    "marketCode": "string",
    "promptForSignature": "string",
    "provisionalAmount": "string"
  },
  "displayTransactionAmount": "boolean",
  "invokeManualEntry": "boolean",
  "isCscSupported": "string",
  "lodging": {
    "agreementNumber": "string",
    "chargeType": "string",
    "checkInDate": "string",
    "checkOutDate": "string",
    "customerName": "string",
    "duration": "int",
    "extraChargesDetail": "Array<POST_LodgingExtraChargesDetail/v1/force/credit>",
    "noShow": "boolean",
    "prestigiousPropertyCode": "string",
    "roomAmount": "double",
    "specialProgramCode": "string"
  },
  "networkTransactionID": "string",
  "preRead": "boolean",
  "quickChip": "boolean",
  "recurringPaymentType": "string",
  "referenceNumber": "string",
  "salesTaxAmount": "double",
  "shiftId": "string",
  "submissionType": "string",
  "ticketNumber": "string"
}
ForceCreditRequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "isManualEntryAllowed": "string",
  "marketCode": "string",
  "promptForSignature": "string",
  "provisionalAmount": "string"
}
ForceCreditRequest
Field Required Data Type Max Length Default Value Description
approvalNumber true string 30 The approval number of a voice authorization
laneId true int Specifies which lane to use.
transactionAmount true string 10 0.00 The total transaction amount. This is the amount of funds to move on the card
address false POST_Address/v1/force/credit The cardholder address information for the transaction.
autoRental false POST_AutoRental/v1/force/credit The auto rental parameters to be passed in for an auto rental transaction. more�
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
commercialCardCustomerCode false string 40 The commercial card customer code for the transaction. This is for Level II.
configuration false POST_ForceCreditRequestConfiguration/v1/ force/credit Any value included in this section will override the corresponding value set in the triPOS.config
displayTransactionAmount false boolean 5 false Display the transaction amount during card read.
invokeManualEntry false boolean 5 false Invokes manual card entry.
isCscSupported false string 5 false Invokes prompt for cardholder to enter card security code for manual keyed card entry.
lodging false POST_LodgingTransactionCompletion/v1/for ce/credit The lodging parameters to be passed in for a lodging transaction. more�
networkTransactionID false string 40 The card brand specific transaction ID that should be stored by the integrator.
preRead false boolean 5 false Flag indicating desire to process force credit as PreRead (i.e. - do ONLY Pre-Read operations, then expecting next endpoint call to be QuickChip) more�.
quickChip false boolean 5 false Flag indicating desire to process force credit as QuickChip (i.e. - Pre-Read has been previously performed) more�.
recurringPaymentType false string 32 Intent of why the credentials are being stored.
Values:
  • NotUsed
  • Recurring
  • Installment
  • CardHolderInitiated
  • CredentialsOnFile
referenceNumber false string 50 A user defined reference number.
salesTaxAmount false double 10 0.00 The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.
shiftId false string 10 An optional shift id for reference.
submissionType false string 32 Specifies the type of transaction.
Values:
  • NotUsed
  • Initial
  • Subsequent
  • Resubmission
  • ReAuthorization
  • DelayedCharges
  • NoShow
ticketNumber false string 50 An optional ticket number.
Address
Field Required Data Type Max Length Default Value Description
billingAddress1 false string 50 The street address used for billing purposes.
billingAddress2 false string 50 The street address used for billing purposes.
billingCity false string 40 The name of the city used for billing purposes.
billingEmail false string 80 The e-mail address used for billing purposes.
billingName false string 100 The name used for billing purposes.
billingPhone false string 20 The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string 20 The postal code used for billing purposes.
billingState false string 30 The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
shippingAddress1 false string 50 The street address used for shipping purposes.
shippingAddress2 false string 50 The street address used for shipping purposes.
shippingCity false string 40 The name of the city used for shipping purposes.
shippingEmail false string 80 The e-mail address used for shipping purposes.
shippingName false string 100 The name used for shipping purposes.
shippingPhone false string 20 The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string 20 The postal code used for shipping purposes.
shippingState false string 30 The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
AutoRental
Field Required Data Type Max Length Default Value Description
customerName false string 100 Customer Name.
agreementNumber false string 14 Agreement number.
vehicleClassCode false string 32 Classification of rental vehicle
Values:
  • Unused
  • Mini
  • Subcompact
  • Economy
  • Compact
  • Midsize
  • Intermediate
  • Standard
  • Fullsize
  • Luxury
  • Premium
  • Minivan
  • Van12Passenger
  • MovingVan
  • Van15Passenger
  • CargoVan
  • Truck12Foot
  • Truck20Foot
  • Truck24Foot
  • Truck26Foot
  • Moped
  • Stretch
  • Regular
  • Unique
  • Exotic
  • TruckSmallMedium
  • TruckLarge
  • SUVSmall
  • SUVMedium
  • SUVLarge
  • SUVExotic
  • FourWheelDrive
  • Special
  • Miscellaneous
noShowIndicator false string 32 No show indicator. Indicates whether rental vehicle was reserved, but not actually rented.
Values:
  • NotApplicable
  • NoShow
adjustmentData false POST_AutoRentalAdjustmentData/v1/force/c redit Data related to any auto rental adjustments.
pickupData false POST_AutoRentalPickupData/v1/force/credi t Data related to autorental pickup.
returnData false POST_AutoRentalReturnData/v1/force/credi t Data related to autorental return.
dailyRentalRate false double 10 0 Rate charged per day Visa/MC � Daily rate required for Corp T&E rate III.
weeklyRentalRate false double 10 0 Rate charged per week Visa/MC � Weekly rate required for Corp T&E rate III.
insuranceCharges false double 10 0.00 If insurance is charged, the insurance amount should be provided.
duration false int 2 The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.
AutoRentalAdjustmentData
Field Required Data Type Max Length Default Value Description
amount false double 10 0.00 Adjustment amount.
code false string 40 Indicates if adjustment for mileage, fuel, vehicle damage, etc. was made to a rental agreement.
Values:
  • NoAdjustments
  • MultipleAdjustments
  • OneAdjustmentCardmemberNotified
  • OneAdjustmentCardmemberNotNotified
extraChargesDetail false Array<POST_AutoRentalExtraChargesDetail/v1/for ce/credit> 100 NoExtraCharge Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NoExtraCharge.
Values:
  • NoExtraCharge
  • Gasoline
  • ExtraMileage
  • LateReturn
  • OneWayServiceFee
  • ParkingOrMovingViolation
AutoRentalPickupData
Field Required Data Type Max Length Default Value Description
city false string 18 Auto rental pickup city.
countryCode false string 3 Country code where vehicle was picked up. For US, use 840.
date false string 19 return date in yyyy-MM-ddTHH:mm:ss format.
location false string 38 Name of business where vehicle was picked up.
state false string 3 Abbreviation of state, province, or other country subdivision where vehicle was picked up.
AutoRentalReturnData
Field Required Data Type Max Length Default Value Description
city false string 18 Auto rental return city.
countryCode false string 3 Country code where vehicle was returned. For US, use 840.
date false string 19 return date in yyyy-MM-ddTHH:mm:ss format.
locationId false string 10 Auto Rental location ID where vehicle was returned.
state false string 3 Auto rental return state.
distance false int 5 Numeric distance traveled during rental period.
distanceUnit false string 16 Unit of measurement applicable to distance traveled.
Values:
  • 0 = Unused
  • 1 = Miles
  • 2 = Kilometers
ForceCreditRequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
isManualEntryAllowed false string 5 true Use this parameter to allow manual entry of card account numbers on the PIN pad.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
promptForSignature false string 32 Never Specifies how the signature prompt should be handled for the request. If a value is not provided, Never will be used. See Signature Prompt.
Values:
  • Always
  • Never
  • None
provisionalAmount false string 10 1 Override provisional amount used for QC transactions, which is $1.00 by default
LodgingTransactionCompletion
Field Required Data Type Max Length Default Value Description
agreementNumber false string 14 The lodging agreement number.
chargeType false string 32 Default The lodging charge type. For an empty or invalid value, this parameter defaults to Default.
Values:
  • Default
  • Restaurant
  • GiftShop
checkInDate false string 10 The check-in date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.
checkOutDate false string 10 The check-out date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.
customerName false string 100 The lodging customer name.
duration false int 2 The number of hotel stay days. Set to 1 for no show.
extraChargesDetail false Array<POST_LodgingExtraChargesDetail/v1/force/ credit> 100 NotUsed Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NotUsed.
Values:
  • NotUsed
  • Reserved
  • Restaurant
  • GiftShop
  • MiniBar
  • Telephone
  • Other
  • Laundry
noShow false boolean 5 false Set to true to indicate no show. Otherwise, value defaults to false.
prestigiousPropertyCode false string 32 NonParticipant The lodging prestigious property code. For an empty or invalid value, this parameter defaults to NonParticipant.
Values:
  • NonParticipant
  • FiveHundredDollarLimit
  • OneThousandDollarLimit
  • OneThousandFiveHundredDollarLimit
roomAmount false double 12 0.00 The nightly rate for one room.
specialProgramCode false string 32 Default The lodging special program code. For an empty or invalid value, this parameter defaults to Default.
Values:
  • Default
  • Sale
  • NoShow
  • AdvanceDeposit
ForceCreditRequest 
{
  "approvalNumber": {
    "description": "The approval number of a voice authorization",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": true
  },
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/v1/force/credit",
    "required": false
  },
  "autoRental": {
    "description": "The auto rental parameters to be passed in for an auto rental transaction. <a href='../help/kb/autorental.html'>more&raquo;</a>",
    "type": "POST_AutoRental/v1/force/credit",
    "required": false
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "commercialCardCustomerCode": {
    "description": "The commercial card customer code for the transaction. This is for Level II.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_ForceCreditRequestConfiguration/v1/force/credit",
    "required": false
  },
  "displayTransactionAmount": {
    "description": "Display the transaction amount during card read.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "invokeManualEntry": {
    "description": " Invokes manual card entry.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isCscSupported": {
    "description": "Invokes prompt for cardholder to enter card security code for manual keyed card entry.",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "lodging": {
    "description": "The lodging parameters to be passed in for a lodging transaction. <a href='../help/kb/lodging.html'>more&raquo;</a>",
    "type": "POST_LodgingTransactionCompletion/v1/force/credit",
    "required": false
  },
  "networkTransactionID": {
    "description": "The card brand specific transaction ID that should be stored by the integrator.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "preRead": {
    "description": "Flag indicating desire to process force credit as PreRead (i.e. - do ONLY Pre-Read operations, then expecting next endpoint call to be QuickChip) <a href='..\\help\\kb\\QuickChipConfiguration.html'>more&raquo;</a>.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "quickChip": {
    "description": "Flag indicating desire to process force credit as QuickChip (i.e. - Pre-Read has been previously performed) <a href='..\\help\\kb\\QuickChipConfiguration.html'>more&raquo;</a>.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "recurringPaymentType": {
    "description": "Intent of why the credentials are being stored.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotUsed",
        "Recurring",
        "Installment",
        "CardHolderInitiated",
        "CredentialsOnFile"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "salesTaxAmount": {
    "description": "The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "submissionType": {
    "description": "Specifies the type of transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotUsed",
        "Initial",
        "Subsequent",
        "Resubmission",
        "ReAuthorization",
        "DelayedCharges",
        "NoShow"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingState": {
    "description": "The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingState": {
    "description": "The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRental 
{
  "customerName": {
    "description": "Customer Name.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "agreementNumber": {
    "description": "Agreement number.",
    "type": "string",
    "paramValues": {
      "max": "14",
      "defaultValue": ""
    },
    "required": false
  },
  "vehicleClassCode": {
    "description": "Classification of rental vehicle",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unused",
        "Mini",
        "Subcompact",
        "Economy",
        "Compact",
        "Midsize",
        "Intermediate",
        "Standard",
        "Fullsize",
        "Luxury",
        "Premium",
        "Minivan",
        "Van12Passenger",
        "MovingVan",
        "Van15Passenger",
        "CargoVan",
        "Truck12Foot",
        "Truck20Foot",
        "Truck24Foot",
        "Truck26Foot",
        "Moped",
        "Stretch",
        "Regular",
        "Unique",
        "Exotic",
        "TruckSmallMedium",
        "TruckLarge",
        "SUVSmall",
        "SUVMedium",
        "SUVLarge",
        "SUVExotic",
        "FourWheelDrive",
        "Special",
        "Miscellaneous"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "noShowIndicator": {
    "description": "No show indicator. Indicates whether rental vehicle was reserved, but not actually rented.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotApplicable",
        "NoShow"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "adjustmentData": {
    "description": "Data related to any auto rental adjustments.",
    "type": "POST_AutoRentalAdjustmentData/v1/force/credit",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "pickupData": {
    "description": "Data related to autorental pickup.",
    "type": "POST_AutoRentalPickupData/v1/force/credit",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "returnData": {
    "description": "Data related to autorental return.",
    "type": "POST_AutoRentalReturnData/v1/force/credit",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "dailyRentalRate": {
    "description": "Rate charged per day Visa/MC � Daily rate required for Corp T&E rate III.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0"
    },
    "required": false
  },
  "weeklyRentalRate": {
    "description": "Rate charged per week Visa/MC � Weekly rate required for Corp T&E rate III.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0"
    },
    "required": false
  },
  "insuranceCharges": {
    "description": "If insurance is charged, the insurance amount should be provided.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "duration": {
    "description": "The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRentalAdjustmentData 
{
  "amount": {
    "description": "Adjustment amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "code": {
    "description": "Indicates if adjustment for mileage, fuel, vehicle damage, etc. was made to a rental agreement.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NoAdjustments",
        "MultipleAdjustments",
        "OneAdjustmentCardmemberNotified",
        "OneAdjustmentCardmemberNotNotified"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "extraChargesDetail": {
    "description": "Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NoExtraCharge.",
    "type": "Array",
    "items": {
      "type": "POST_AutoRentalExtraChargesDetail/v1/force/credit"
    },
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NoExtraCharge",
        "Gasoline",
        "ExtraMileage",
        "LateReturn",
        "OneWayServiceFee",
        "ParkingOrMovingViolation"
      ]
    },
    "paramValues": {
      "max": "100",
      "defaultValue": "NoExtraCharge"
    },
    "required": false
  }
}
AutoRentalPickupData 
{
  "city": {
    "description": "Auto rental pickup city.",
    "type": "string",
    "paramValues": {
      "max": "18",
      "defaultValue": ""
    },
    "required": false
  },
  "countryCode": {
    "description": "Country code where vehicle was picked up. For US, use 840.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "date": {
    "description": "return date in yyyy-MM-ddTHH:mm:ss format.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "location": {
    "description": "Name of business where vehicle was picked up.",
    "type": "string",
    "paramValues": {
      "max": "38",
      "defaultValue": ""
    },
    "required": false
  },
  "state": {
    "description": "Abbreviation of state, province, or other country subdivision where vehicle was picked up.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRentalReturnData 
{
  "city": {
    "description": "Auto rental return city.",
    "type": "string",
    "paramValues": {
      "max": "18",
      "defaultValue": ""
    },
    "required": false
  },
  "countryCode": {
    "description": "Country code where vehicle was returned. For US, use 840.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "date": {
    "description": "return date in yyyy-MM-ddTHH:mm:ss format.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "locationId": {
    "description": "Auto Rental location ID where vehicle was returned.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "state": {
    "description": "Auto rental return state.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "distance": {
    "description": "Numeric distance traveled during rental period.",
    "type": "int",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "distanceUnit": {
    "description": "Unit of measurement applicable to distance traveled.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "0 = Unused",
        "1 = Miles",
        "2 = Kilometers"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  }
}
ForceCreditRequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Use this parameter to allow manual entry of card account numbers on the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "true"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  },
  "promptForSignature": {
    "description": "Specifies how the signature prompt should be handled for the request. If a value is not provided, Never will be used. See <a href='../help/kb/signaturePrompt.html'>Signature Prompt</a>.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Always",
        "Never",
        "None"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Never"
    },
    "required": false
  },
  "provisionalAmount": {
    "description": "Override provisional amount used for QC transactions, which is $1.00 by default",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "1"
    },
    "required": false
  }
}
LodgingTransactionCompletion 
{
  "agreementNumber": {
    "description": "The lodging agreement number.",
    "type": "string",
    "paramValues": {
      "max": "14",
      "defaultValue": ""
    },
    "required": false
  },
  "chargeType": {
    "description": "The lodging charge type. For an empty or invalid value, this parameter defaults to Default.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Restaurant",
        "GiftShop"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Default"
    },
    "required": false
  },
  "checkInDate": {
    "description": "The check-in date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "checkOutDate": {
    "description": "The check-out date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "customerName": {
    "description": "The lodging customer name.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "duration": {
    "description": "The number of hotel stay days. Set to 1 for no show.",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "extraChargesDetail": {
    "description": "Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NotUsed.",
    "type": "Array",
    "items": {
      "type": "POST_LodgingExtraChargesDetail/v1/force/credit"
    },
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotUsed",
        "Reserved",
        "Restaurant",
        "GiftShop",
        "MiniBar",
        "Telephone",
        "Other",
        "Laundry"
      ]
    },
    "paramValues": {
      "max": "100",
      "defaultValue": "NotUsed"
    },
    "required": false
  },
  "noShow": {
    "description": "Set to true to indicate no show. Otherwise, value defaults to false.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "prestigiousPropertyCode": {
    "description": "The lodging prestigious property code. For an empty or invalid value, this parameter defaults to NonParticipant.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NonParticipant",
        "FiveHundredDollarLimit",
        "OneThousandDollarLimit",
        "OneThousandFiveHundredDollarLimit"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "NonParticipant"
    },
    "required": false
  },
  "roomAmount": {
    "description": "The nightly rate for one room.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "specialProgramCode": {
    "description": "The lodging special program code. For an empty or invalid value, this parameter defaults to Default.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Sale",
        "NoShow",
        "AdvanceDeposit"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Default"
    },
    "required": false
  }
}

Response Class

CreditCardForceResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "balanceAmount": "double",
  "balanceCurrencyCode": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "currencyCode": "string",
  "ebtType": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "networkLabel": "string",
  "paymentType": "string",
  "pinVerified": "boolean",
  "quickChipMessage": "string",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
CreditCardForceResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
balanceAmount false double 13 The balance of the gift card.
balanceCurrencyCode false string 4 The balance currency code.
Values:
  • None
  • Usd
binValue false string 6 The BIN entry that matched the account number.
cardHolderName false string 80 The cardholder name.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
currencyCode false string 4 The currency code used in the transaction.
Values:
  • None
  • Usd
ebtType false string 16 The type of the EBT card
Values:
  • None
  • FoodStamp
  • CashBenefit
entryMode false string 32 Description of how card was entered.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
networkLabel false string 30 Label that shows the network where the transaction was routed for authorization
paymentType false string 16 Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
  • Ebt
pinVerified false boolean 5 True if the PIN was verified, false if not verified or undetermined.
quickChipMessage false string 500 The message unique to QuickChip pre-read functionality only.
signature false Signature The signature data.
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Signature
Field Required Data Type Max Length Default Value Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string 32 The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string 50 Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
  • SignatureRequiredButPromptSuppressedByMerchant
  • SignatureNotRequiredByUnattendedPinPad
CreditCardForceResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceAmount": {
    "description": "The balance of the gift card.",
    "type": "double",
    "paramValues": {
      "max": "13",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceCurrencyCode": {
    "description": "The balance currency code.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderName": {
    "description": "The cardholder name.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "ebtType": {
    "description": "The type of the EBT card",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "FoodStamp",
        "CashBenefit"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "networkLabel": {
    "description": "Label that shows the network where the transaction was routed for authorization",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift",
        "Ebt"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "quickChipMessage": {
    "description": "The message unique to QuickChip pre-read functionality only.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Signature 
{
  "data": {
    "description": "The byte array of the signature in the format specified by Format.",
    "type": "Array",
    "items": {
      "type": "byte"
    },
    "required": false
  },
  "format": {
    "description": "The format of the signature.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PointsLittleEndian",
        "PointsBigEndian",
        "Ascii3Byte"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "Indicates why a signature is or is not present.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "SignatureRequired",
        "SignaturePresent",
        "SignatureRequiredCancelledByCardholder",
        "SignatureRequiredNotSupportedByPinPad",
        "SignatureRequiredPinPadError",
        "SignatureNotRequiredByThresholdAmount",
        "SignatureNotRequiredByPaymentType",
        "SignatureNotRequiredByTransactionType",
        "SignatureRequiredButPromptSuppressedByMerchant",
        "SignatureNotRequiredByUnattendedPinPad"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if MarketCode is not HotelLodging but the request includes lodging parameters on a valid lodging request.
400 Returned if the lodging checkInDate or checkOutDate is not in the ISO 8601 format of YYYY-MM-DD on a valid lodging request.
400 Returned if the lodging roomAmount is less than 0.00 on a valid lodging request.
400 Returned if the lodging duration is less than 0 on a valid lodging request.
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
GET
/api/v1/gift Return the endpoints used to manage Vantiv Gift Cards

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

GiftResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  }
}
GiftResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
GiftResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
POST
/api/v1/gift/activate Activates the given gift card with the specified amount

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
ActivateGiftRequest body POST_ActivateGiftRequest/v1/gift/activate undefined

Request Class

ActivateGiftRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "marketCode": "string"
  },
  "invokeManualEntry": "boolean",
  "isCscSupported": "string",
  "referenceNumber": "string",
  "shiftId": "string",
  "storeCard": {
    "Id": "string",
    "Password": "string"
  },
  "ticketNumber": "string"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "marketCode": "string"
}
ActivateGiftRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
transactionAmount true double 10 0.00 The total transaction amount. This is the amount of funds to move on the card
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
configuration false POST_RequestConfiguration/v1/gift/activa te Any value included in this section will override the corresponding value set in the triPOS.config
invokeManualEntry false boolean 5 false Invokes manual card entry.
isCscSupported false string 5 false Invokes prompt for cardholder to enter card security code for manual keyed card entry.
referenceNumber false string 50 A user defined reference number.
shiftId false string 10 An optional shift id for reference.
storeCard false POST_StoreCard/v1/gift/activate Information necessary to process a StoreCard transaction.
ticketNumber false string 50 An optional ticket number.
RequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
StoreCard
Field Required Data Type Max Length Default Value Description
Id false string 32 The ID of a StoreCard.
Password false string 32 The password of StoreCard.
ActivateGiftRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/v1/gift/activate",
    "required": false
  },
  "invokeManualEntry": {
    "description": " Invokes manual card entry.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isCscSupported": {
    "description": "Invokes prompt for cardholder to enter card security code for manual keyed card entry.",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "storeCard": {
    "description": "Information necessary to process a StoreCard transaction.",
    "type": "POST_StoreCard/v1/gift/activate",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  }
}
StoreCard 
{
  "Id": {
    "description": "The ID of a StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "Password": {
    "description": "The password of StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

ActivateGiftResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "approvedAmount": "double",
  "balanceAmount": "double",
  "balanceCurrencyCode": "string",
  "binValue": "string",
  "cardLogo": "string",
  "entryMode": "string",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ActivateGiftResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double 10 The amount approved for the transaction.
balanceAmount false double 13 The balance of the gift card.
balanceCurrencyCode false string 4 The balance currency code.
binValue false string 6 The BIN entry that matched the account number.
cardLogo false string 20 The card logo (e.g. Visa, Mastercard, etc).
entryMode false string 32 Description of how card was entered: Keyed, Swiped, Chip.
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
ActivateGiftResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved for the transaction.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceAmount": {
    "description": "The balance of the gift card.",
    "type": "double",
    "paramValues": {
      "max": "13",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceCurrencyCode": {
    "description": "The balance currency code.",
    "type": "string",
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo (e.g. Visa, Mastercard, etc).",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered: Keyed, Swiped, Chip.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
POST
/api/v1/gift/reload Reloads the given gift card with the specified amount

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
ReloadGiftRequest body POST_ReloadGiftRequest/v1/gift/reload undefined

Request Class

ReloadGiftRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "marketCode": "string"
  },
  "invokeManualEntry": "boolean",
  "isCscSupported": "string",
  "referenceNumber": "string",
  "shiftId": "string",
  "storeCard": {
    "Id": "string",
    "Password": "string"
  },
  "ticketNumber": "string"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "marketCode": "string"
}
ReloadGiftRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
transactionAmount true double 10 0.00 The total transaction amount. This is the amount of funds to move on the card
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
configuration false POST_RequestConfiguration/v1/gift/reload Any value included in this section will override the corresponding value set in the triPOS.config
invokeManualEntry false boolean 5 false Invokes manual card entry.
isCscSupported false string 5 false Invokes prompt for cardholder to enter card security code for manual keyed card entry.
referenceNumber false string 50 A user defined reference number.
shiftId false string 10 An optional shift id for reference.
storeCard false POST_StoreCard/v1/gift/reload Information necessary to process a StoreCard transaction.
ticketNumber false string 50 An optional ticket number.
RequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
StoreCard
Field Required Data Type Max Length Default Value Description
Id false string 32 The ID of a StoreCard.
Password false string 32 The password of StoreCard.
ReloadGiftRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/v1/gift/reload",
    "required": false
  },
  "invokeManualEntry": {
    "description": " Invokes manual card entry.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isCscSupported": {
    "description": "Invokes prompt for cardholder to enter card security code for manual keyed card entry.",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "storeCard": {
    "description": "Information necessary to process a StoreCard transaction.",
    "type": "POST_StoreCard/v1/gift/reload",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  }
}
StoreCard 
{
  "Id": {
    "description": "The ID of a StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "Password": {
    "description": "The password of StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

ReloadGiftResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "approvedAmount": "double",
  "balanceAmount": "double",
  "balanceCurrencyCode": "string",
  "binValue": "string",
  "cardLogo": "string",
  "entryMode": "string",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ReloadGiftResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double 10 The amount approved for the transaction.
balanceAmount false double 13 The balance of the gift card.
balanceCurrencyCode false string 4 The balance currency code.
binValue false string 6 The BIN entry that matched the account number.
cardLogo false string 20 The card logo (e.g. Visa, Mastercard, etc).
entryMode false string 32 Description of how card was entered: Keyed, Swiped, Chip.
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
ReloadGiftResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved for the transaction.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceAmount": {
    "description": "The balance of the gift card.",
    "type": "double",
    "paramValues": {
      "max": "13",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceCurrencyCode": {
    "description": "The balance currency code.",
    "type": "string",
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo (e.g. Visa, Mastercard, etc).",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered: Keyed, Swiped, Chip.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
POST
/api/v1/idle Displays the idle screen on the specified PIN pad.

Implementation Notes

Use the idle endpoint to return the PIN pad to the idle screen. See idle documentation for more information.

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
IdleRequest body POST_IdleRequest/v1/idle undefined

Request Class

IdleRequest 
{
  "laneId": "int"
}
IdleRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
IdleRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  }
}

Response Class

IdleResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  }
}
IdleResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
IdleResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if the laneId is not valid or the lane is already in use
500 Returned if the PIN pad is disconnected
GET
/api/v1/input/{laneId} Displays the prompt associated to the promptType and accepts input text from the card holder

Implementation Notes

Use the input endpoint to prompt the cardholder for input. This endpoint returns an HTTP status code of 200 if the cardholder pressed the ok or cancel button. See input documentation for more information.

Parameters

Parameter Parameter Type Data Type Description
laneId path string The lane ID.
promptType query string The type of prompt to display on the PIN pad. more�
formatType query string The PIN pad uses this format to display the input on the PIN pad as the cardholder enters it. more�
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

InputResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "cardholderAction": "string",
  "inputText": "string"
}
InputResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
cardholderAction false string 32 The cardholder interaction with the PIN pad.
Values:
  • OK
  • Cancel
  • Timeout
inputText false string 1000 The raw, unformatted text that the cardholder entered into the input field on the PIN pad.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
InputResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "cardholderAction": {
    "description": "The cardholder interaction with the PIN pad.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "OK",
        "Cancel",
        "Timeout"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "inputText": {
    "description": "The raw, unformatted text that the cardholder entered into the input field on the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if parameter values are missing or invalid.
500 Returned if the cardholder allows the PIN pad to time out before submitting input.
POST
/api/v1/paymentAccount Creates a card account token based on the given data

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
CreatePaymentAccountCreditRequest body POST_CreatePaymentAccountCreditRequest/v1/paymentAccount undefined

Request Class

CreatePaymentAccountCreditRequest 
{
  "laneId": "int",
  "paymentAccountReferenceNumber": "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"
  },
  "expirationMonth": "string",
  "expirationYear": "string",
  "invokeManualEntry": "boolean",
  "isCscSupported": "string"
}
CreatePaymentAccountCreditRequest
Field Required Data Type Max Length Default Value Description
laneId true int The lane ID.
paymentAccountReferenceNumber true string 50 The payment account reference number
address false POST_Address/v1/paymentAccount The cardholder address information for the transaction.
expirationMonth false string 2 The expiration month.
expirationYear false string 2 The expiration year.
invokeManualEntry false boolean 5 Invokes manual card entry.
isCscSupported false string 5 false Invokes prompt for cardholder to enter card security code for manual keyed card entry.
Address
Field Required Data Type Max Length Default Value Description
billingAddress1 false string 50 The street address used for billing purposes.
billingAddress2 false string 50 The street address used for billing purposes.
billingCity false string 40 The name of the city used for billing purposes.
billingEmail false string 80 The e-mail address used for billing purposes.
billingName false string 100 The name used for billing purposes.
billingPhone false string 20 The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string 20 The postal code used for billing purposes.
billingState false string 30 The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
shippingAddress1 false string 50 The street address used for shipping purposes.
shippingAddress2 false string 50 The street address used for shipping purposes.
shippingCity false string 40 The name of the city used for shipping purposes.
shippingEmail false string 80 The e-mail address used for shipping purposes.
shippingName false string 100 The name used for shipping purposes.
shippingPhone false string 20 The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string 20 The postal code used for shipping purposes.
shippingState false string 30 The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
CreatePaymentAccountCreditRequest 
{
  "laneId": {
    "description": "The lane ID.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "paymentAccountReferenceNumber": {
    "description": "The payment account reference number",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/v1/paymentAccount",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The expiration month.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The expiration year.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "invokeManualEntry": {
    "description": " Invokes manual card entry.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isCscSupported": {
    "description": "Invokes prompt for cardholder to enter card security code for manual keyed card entry.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingState": {
    "description": "The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingState": {
    "description": "The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

CreatePaymentAccountCreditResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "fsaCard": "string",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "paymentAccountId": "string",
  "paymentAccountReferenceNumber": "string",
  "statusCode": "string",
  "terminalId": "string",
  "transactionDateTime": "string",
  "transactionId": "string"
}
CreatePaymentAccountCreditResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The credit card number with the value masked except for the last 4.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
binValue false string 6 The BIN entry that matched the account number.
cardHolderName false string 80 The cardholder name.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
entryMode false string 32 Description of how card was entered.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
fsaCard false string 32 Indicates whether the card used was a FSA card.
Note: Maybe = No BIN entry to determine if FSA.
Values:
  • NotApplicable
  • No
  • Yes
  • Maybe
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
paymentAccountId false string 50 the payment account ID.
paymentAccountReferenceNumber false string 50 the payment account reference number.
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
CreatePaymentAccountCreditResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The credit card number with the value masked except for the last 4.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderName": {
    "description": "The cardholder name.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "fsaCard": {
    "description": "Indicates whether the card used was a FSA card.<br />Note: Maybe = No BIN entry to determine if FSA.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotApplicable",
        "No",
        "Yes",
        "Maybe"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentAccountId": {
    "description": "the payment account ID.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentAccountReferenceNumber": {
    "description": "the payment account reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
PUT
/api/v1/paymentAccount/{paymentAccountId} Updates a payment account based on the given data

Parameters

Parameter Parameter Type Data Type Description
paymentAccountId path string The payment account ID to update.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
UpdatePaymentAccountCreditRequest body PUT_UpdatePaymentAccountCreditRequest/v1/paymentAccount/{paymentAccountId} undefined

Request Class

UpdatePaymentAccountCreditRequest 
{
  "paymentAccountReferenceNumber": "string",
  "updateCardData": "boolean",
  "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",
  "invokeManualEntry": "boolean",
  "laneId": "int"
}
UpdatePaymentAccountCreditRequest
Field Required Data Type Max Length Default Value Description
paymentAccountReferenceNumber true string 50 The payment account reference number
updateCardData true boolean 5 false The value that is passed in for UpdateCardData. Should be true or false.
address false PUT_Address/v1/paymentAccount/{paymentAc countId} The cardholder address information for the transaction.
expirationMonth false string 2 The expiration month.
expirationYear false string 2 The expiration year.
invokeManualEntry false boolean 5 false Invokes manual card entry.
laneId false int The Lane ID.
Address
Field Required Data Type Max Length Default Value Description
billingAddress1 false string 50 The street address used for billing purposes.
billingAddress2 false string 50 The street address used for billing purposes.
billingCity false string 40 The name of the city used for billing purposes.
billingEmail false string 80 The e-mail address used for billing purposes.
billingName false string 100 The name used for billing purposes.
billingPhone false string 20 The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string 20 The postal code used for billing purposes.
billingState false string 30 The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
shippingAddress1 false string 50 The street address used for shipping purposes.
shippingAddress2 false string 50 The street address used for shipping purposes.
shippingCity false string 40 The name of the city used for shipping purposes.
shippingEmail false string 80 The e-mail address used for shipping purposes.
shippingName false string 100 The name used for shipping purposes.
shippingPhone false string 20 The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string 20 The postal code used for shipping purposes.
shippingState false string 30 The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
UpdatePaymentAccountCreditRequest 
{
  "paymentAccountReferenceNumber": {
    "description": "The payment account reference number",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": true
  },
  "updateCardData": {
    "description": "The value that is passed in for UpdateCardData. Should be true or false.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "PUT_Address/v1/paymentAccount/{paymentAccountId}",
    "required": false
  },
  "expirationMonth": {
    "description": "The expiration month.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The expiration year.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "invokeManualEntry": {
    "description": " Invokes manual card entry.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "laneId": {
    "description": "The Lane ID.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingState": {
    "description": "The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingState": {
    "description": "The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

UpdatePaymentAccountCreditResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "fsaCard": "string",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "paymentAccountId": "string",
  "paymentAccountReferenceNumber": "string",
  "statusCode": "string",
  "terminalId": "string",
  "transactionDateTime": "string",
  "transactionId": "string"
}
UpdatePaymentAccountCreditResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The credit card number with the value masked except for the last 4. This field is only available when updateCardData is set to true in the request.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
binValue false string 6 The BIN entry that matched the account number. This field is only available when updateCardData is set to true in the request.
cardHolderName false string 80 The cardholder name. This field is only available when updateCardData is set to true in the request.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other. This field is only available when updateCardData is set to true in the request.
entryMode false string 32 Description of how card was entered. This field is only available when updateCardData is set to true in the request.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
expirationMonth false string 2 The card's expiration month. This field is only available when updateCardData is set to true in the request.
expirationYear false string 2 The card's expiration year. This field is only available when updateCardData is set to true in the request.
fsaCard false string 32 Indicates whether the card used was a FSA card. This field is only available when updateCardData is set to true in the request.
Note: Maybe = No BIN entry to determine if FSA.
Values:
  • NotApplicable
  • No
  • Yes
  • Maybe
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
paymentAccountId false string 50 the payment account ID.
paymentAccountReferenceNumber false string 50 the payment account reference number.
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
UpdatePaymentAccountCreditResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The credit card number with the value masked except for the last 4. This field is only available when <code>updateCardData</code> is set to true in the request.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number. This field is only available when <code>updateCardData</code> is set to true in the request.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderName": {
    "description": "The cardholder name. This field is only available when <code>updateCardData</code> is set to true in the request.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other. This field is only available when <code>updateCardData</code> is set to true in the request.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered. This field is only available when <code>updateCardData</code> is set to true in the request.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month. This field is only available when <code>updateCardData</code> is set to true in the request.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year. This field is only available when <code>updateCardData</code> is set to true in the request.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "fsaCard": {
    "description": "Indicates whether the card used was a FSA card. This field is only available when <code>updateCardData</code> is set to true in the request.<br />Note: Maybe = No BIN entry to determine if FSA.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotApplicable",
        "No",
        "Yes",
        "Maybe"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentAccountId": {
    "description": "the payment account ID.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentAccountReferenceNumber": {
    "description": "the payment account reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
DELETE
/api/v1/paymentAccount/{paymentAccountId} Marks the given payment account for deletion

Implementation Notes

This endpoint deletes a payment account created with POST /api/v1/paymentAccount. This endpoint returns an HTTP status code of 200 if the payment account was successfully deleted. Other HTTP status code responses indicate failure. If the payment account is not found, an HTTP status code 404 is returned. After a successful delete, this endpoint will continue to return HTTP status code 200 until the Express processing platform purges the payment account from the system. Payment account purge typically happens within 48 hours. After 48 hours, this endpoint will return a 404 Not Found HTTP status code for the deleted payment account.

Parameters

Parameter Parameter Type Data Type Description
paymentAccountId path string The payment account ID to update.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
DeletePaymentAccountRequest body DELETE_DeletePaymentAccountRequest/v1/paymentAccount/{paymentAccountId} undefined

Request Class

DeletePaymentAccountRequest 
{
  "laneId": "int",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
DeletePaymentAccountRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
referenceNumber false string 50 A user defined reference number.
shiftId false string 10 An optional shift id for reference.
ticketNumber false string 50 An optional ticket number.
DeletePaymentAccountRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

DeletePaymentAccountResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "merchantId": "string",
  "paymentAccountId": "string",
  "terminalId": "string",
  "transactionDateTime": "string"
}
DeletePaymentAccountResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
merchantId false string 50 The merchant ID.
paymentAccountId false string 50 The payment account ID that was deleted.
terminalId false string 40 The ID of the terminal used during the transaction
transactionDateTime false string 35 Transaction date/time in ISO8601 format
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
DeletePaymentAccountResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentAccountId": {
    "description": "The payment account ID that was deleted.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
404 The payment account ID could not be found. No action taken, tripos returns an HTTP status code of 404.
POST
/api/v1/reboot Reboots a specified lane

Implementation Notes

Use the reboot endpoint to reboot a specified PIN pad. See reboot documentation for more information.

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
RebootLaneRequest body POST_RebootLaneRequest/v1/reboot undefined

Request Class

RebootLaneRequest 
{
  "laneId": "int"
}
RebootLaneRequest
Field Required Data Type Max Length Default Value Description
laneId true int The desired lane ID. The lane ID should be a maximum of six digits long.
RebootLaneRequest 
{
  "laneId": {
    "description": "The desired lane ID. The lane ID should be a maximum of six digits long.",
    "type": "int",
    "allowableValues": {},
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  }
}

Response Class

RebootLaneResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  }
}
RebootLaneResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
RebootLaneResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if the laneId is null or 0
404 Returned if the laneId is not valid
500 Returned if the PIN pad is disconnected or lane is already in use
POST
/api/v1/receipt Prints a receipt on a PIN pad using the posted data.

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
ReceiptRequest body POST_ReceiptRequest/v1/receipt undefined

Request Class

ReceiptRequest 
{
  "accountNumber": "string",
  "cardLogo": "string",
  "entryMode": "string",
  "isApproved": "boolean",
  "laneId": "int",
  "merchantId": "string",
  "referenceNumber": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "transactionDateTime": "string",
  "approvalNumber": "string",
  "cashbackAmount": "double",
  "copyType": "string",
  "currencyCode": "string",
  "customTemplate": "string",
  "emv": {
    "applicationIdentifier": "string",
    "applicationLabel": "string",
    "applicationPreferredName": "string",
    "cryptogram": "string",
    "tags": {
      "key": "string",
      "value": "string"
    },
    "issuerCodeTableIndex": "string"
  },
  "footer": "Array<string>",
  "header": "Array<string>",
  "hostResponseCode": "string",
  "pinVerified": "boolean",
  "receiptType": "string",
  "tipAmount": "double",
  "totalAmount": "double",
  "transactionId": "string"
}
ReceiptRequest
Field Required Data Type Max Length Default Value Description
accountNumber true string 19 0 The card account number used in the transaction.
cardLogo true string 20 The card logo of the card used in the transaction.
entryMode true string 32 Unknown Entry method used to enter card information, swipe, chip, etc.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
isApproved true boolean 5 false Indicates whether the transaction was approved.
laneId true int The lane ID.
merchantId true string 50 ID of the merchant.
referenceNumber true string 50 The transaction's reference number.
subTotalAmount true double 10 0.00 The subtotal amount of the transaction.
terminalId true string 40 The ID of the terminal used in the transaction.
transactionDateTime true string 35 Date and time of the transaction.
approvalNumber false string 30 Approval number of the transaction.
cashbackAmount false double 10 0.00 Cashback amount the customer received.
copyType false string 32 Indicates whether the receipt is a Merchant Copy or a Customer Copy.
Values:
  • Merchant
  • Customer
  • None
currencyCode false string 4 Usd The currency code used in the transaction.
Values:
  • None
  • Usd
customTemplate false string 4096 A custom template that should be used instead of the default.
emv false POST_ReceiptEmvDto/v1/receipt The EMV information of the EMV card used in the transaction.
footer false Array<string> The list of individual lines of text to be displayed at the bottom of the receipt.
header false Array<string> The list of individual lines of text to be displayed at the top of the receipt.
hostResponseCode false string 3 The code returned by the transaction's processing host.
pinVerified false boolean 5 false Indicates whether the entered PIN was verified.
receiptType false string 32 The type of receipt.
Values:
  • Sale
  • Refund
  • Void
tipAmount false double 12 0.00 The tip amount.
totalAmount false double 12 0.00 The total amount of the transaction.
transactionId false string 19 The ID of the transaction.
ReceiptEmvDto
Field Required Data Type Max Length Default Value Description
applicationIdentifier true string 16 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 true string 16 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 true string 16 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 true string 60 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 true Array<POST_TagDto/v1/receipt> A name value collection of additional EMV tags that are required to appear on the receipt.
issuerCodeTableIndex true string 2 Indicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name.
TagDto
Field Required Data Type Max Length Default Value Description
key true string 10
value true string 64
ReceiptRequest 
{
  "accountNumber": {
    "description": "The card account number used in the transaction.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": "0"
    },
    "required": true
  },
  "cardLogo": {
    "description": "The card logo of the card used in the transaction.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": true
  },
  "entryMode": {
    "description": "Entry method used to enter card information, swipe, chip, etc.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Unknown"
    },
    "required": true
  },
  "isApproved": {
    "description": "Indicates whether the transaction was approved.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": true
  },
  "laneId": {
    "description": "The lane ID.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "merchantId": {
    "description": "ID of the merchant.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": true
  },
  "referenceNumber": {
    "description": "The transaction's reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": true
  },
  "subTotalAmount": {
    "description": "The subtotal amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "terminalId": {
    "description": "The ID of the terminal used in the transaction.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionDateTime": {
    "description": "Date and time of the transaction.",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": true
  },
  "approvalNumber": {
    "description": "Approval number of the transaction.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "cashbackAmount": {
    "description": "Cashback amount the customer received.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "copyType": {
    "description": "Indicates whether the receipt is a Merchant Copy or a Customer Copy.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Merchant",
        "Customer",
        "None"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": "Usd"
    },
    "required": false
  },
  "customTemplate": {
    "description": "A custom template that should be used instead of the default.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "emv": {
    "description": "The EMV information of the EMV card used in the transaction.",
    "type": "POST_ReceiptEmvDto/v1/receipt",
    "required": false
  },
  "footer": {
    "description": "The list of individual lines of text to be displayed at the bottom of the receipt.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "header": {
    "description": "The list of individual lines of text to be displayed at the top of the receipt.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The code returned by the transaction's processing host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "pinVerified": {
    "description": "Indicates whether the entered PIN was verified.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "receiptType": {
    "description": "The type of receipt.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Sale",
        "Refund",
        "Void"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "transactionId": {
    "description": "The ID of the transaction.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ReceiptEmvDto 
{
  "applicationIdentifier": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "applicationLabel": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "applicationPreferredName": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "cryptogram": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "60",
      "defaultValue": ""
    },
    "required": true
  },
  "tags": {
    "description": "A name value collection of additional EMV tags that are required to appear on the receipt.",
    "type": "Array",
    "items": {
      "$ref": "POST_TagDto/v1/receipt"
    },
    "required": true
  },
  "issuerCodeTableIndex": {
    "description": "Indicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": true
  }
}
TagDto 
{
  "key": {
    "description": "",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  },
  "value": {
    "description": "",
    "type": "string",
    "paramValues": {
      "max": "64",
      "defaultValue": ""
    },
    "required": true
  }
}

Response Class

ReceiptResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "laneId": "int",
  "printResult": "string"
}
ReceiptResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
laneId false int The lane ID.
printResult false string 32 The result of the print operation is returned in the printResult field.
Values:
  • PrintSuccess
  • PrintFailure
  • NoPrinter
  • InvalidPrintDataFormat
  • OutOfPaper
  • PrintProblem
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
ReceiptResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "laneId": {
    "description": "The lane ID.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "printResult": {
    "description": "The result of the print operation is returned in the <code>printResult</code> field.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PrintSuccess",
        "PrintFailure",
        "NoPrinter",
        "InvalidPrintDataFormat",
        "OutOfPaper",
        "PrintProblem"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
POST
/api/v1/refund Creates a new card refund based on the passed in parameters

Implementation Notes

Creates a new card refund based on the passed in parameters. More� Additionally, this endpoint supports QuickChip/PreRead functionality. See QuickChip/PreRead documentation for more information.

Parameters

Parameter Parameter Type Data Type Description
action query string The action to perform with the refund. This can either be 'store' or 'forward'. More information on Store and Forward here.
requestIdToForward query string The request ID of the stored transaction to forward.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
RefundRequest body POST_RefundRequest/v1/refund undefined

Request Class

RefundRequest 
{
  "laneId": "int",
  "transactionAmount": "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"
  },
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "commercialCardCustomerCode": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "isGiftSupported": "string",
    "isManualEntryAllowed": "string",
    "marketCode": "string",
    "promptForSignature": "string",
    "provisionalAmount": "string",
    "userInputTimeout": "string"
  },
  "convenienceFeeAmount": "double",
  "displayTransactionAmount": "boolean",
  "getToken": "string",
  "invokeManualEntry": "boolean",
  "isCscSupported": "string",
  "preRead": "boolean",
  "quickChip": "boolean",
  "referenceNumber": "string",
  "salesTaxAmount": "double",
  "shiftId": "string",
  "storeCard": {
    "Id": "string",
    "Password": "string"
  },
  "ticketNumber": "string"
}
RefundRequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "isGiftSupported": "string",
  "isManualEntryAllowed": "string",
  "marketCode": "string",
  "promptForSignature": "string",
  "provisionalAmount": "string",
  "userInputTimeout": "string"
}
RefundRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
transactionAmount true string 10 0.00 The total transaction amount. This is the amount of funds to move on the card
address false POST_Address/v1/refund The cardholder address information for the transaction.
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
commercialCardCustomerCode false string 40 The commercial card customer code for the transaction. This is for Level II.
configuration false POST_RefundRequestConfiguration/v1/refun d Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double 10 0.00 The convenience fee amount.
displayTransactionAmount false boolean 5 false Display the transaction amount during card read.
getToken false string 20 To retrieve Token in the transaction. more�
Values:
  • OmniToken
invokeManualEntry false boolean 5 false Invokes manual card entry.
isCscSupported false string 5 false Invokes prompt for cardholder to enter card security code for manual keyed card entry.
preRead false boolean 5 false Flag indicating desire to process refund as PreRead (i.e. - do ONLY Pre-Read operations, then expecting next endpoint call to be QuickChip) more�.
quickChip false boolean 5 false Flag indicating desire to process refund as QuickChip (i.e. - Pre-Read has been previously performed) more�.
referenceNumber false string 50 A user defined reference number.
salesTaxAmount false double 10 0.00 The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.
shiftId false string 10 An optional shift id for reference.
storeCard false POST_StoreCard/v1/refund Information necessary to process a StoreCard transaction.
ticketNumber false string 50 An optional ticket number.
Address
Field Required Data Type Max Length Default Value Description
billingAddress1 false string 50 The street address used for billing purposes.
billingAddress2 false string 50 The street address used for billing purposes.
billingCity false string 40 The name of the city used for billing purposes.
billingEmail false string 80 The e-mail address used for billing purposes.
billingName false string 100 The name used for billing purposes.
billingPhone false string 20 The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string 20 The postal code used for billing purposes.
billingState false string 30 The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
shippingAddress1 false string 50 The street address used for shipping purposes.
shippingAddress2 false string 50 The street address used for shipping purposes.
shippingCity false string 40 The name of the city used for shipping purposes.
shippingEmail false string 80 The e-mail address used for shipping purposes.
shippingName false string 100 The name used for shipping purposes.
shippingPhone false string 20 The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string 20 The postal code used for shipping purposes.
shippingState false string 30 The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
RefundRequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
isGiftSupported false string 5 false Use this parameter to allow Vantiv gift cards to be used.
isManualEntryAllowed false string 5 true Use this parameter to allow manual entry of card account numbers on the PIN pad.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
promptForSignature false string 32 Always Specifies how the signature prompt should be handled for the request. If a value is not provided, Always will be used. See Signature Prompt.
Values:
  • Always
  • Never
  • None
provisionalAmount false string 10 1 Override provisional amount used for QC transactions, which is $1.00 by default
userInputTimeout false string 10 60000 Specifies the user input timeout.
StoreCard
Field Required Data Type Max Length Default Value Description
Id false string 32 The ID of a StoreCard.
Password false string 32 The password of StoreCard.
RefundRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/v1/refund",
    "required": false
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "commercialCardCustomerCode": {
    "description": "The commercial card customer code for the transaction. This is for Level II.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RefundRequestConfiguration/v1/refund",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "displayTransactionAmount": {
    "description": "Display the transaction amount during card read.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "getToken": {
    "description": "To retrieve Token in the transaction. <a href='../help/kb/GetToken.html'>more&raquo;</a>",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "OmniToken"
      ]
    },
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "invokeManualEntry": {
    "description": " Invokes manual card entry.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isCscSupported": {
    "description": "Invokes prompt for cardholder to enter card security code for manual keyed card entry.",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "preRead": {
    "description": "Flag indicating desire to process refund as PreRead (i.e. - do ONLY Pre-Read operations, then expecting next endpoint call to be QuickChip) <a href='..\\help\\kb\\QuickChipConfiguration.html'>more&raquo;</a>.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "quickChip": {
    "description": "Flag indicating desire to process refund as QuickChip (i.e. - Pre-Read has been previously performed) <a href='..\\help\\kb\\QuickChipConfiguration.html'>more&raquo;</a>.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "salesTaxAmount": {
    "description": "The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "storeCard": {
    "description": "Information necessary to process a StoreCard transaction.",
    "type": "POST_StoreCard/v1/refund",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingState": {
    "description": "The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingState": {
    "description": "The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  }
}
RefundRequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isGiftSupported": {
    "description": "Use this parameter to allow Vantiv gift cards to be used.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Use this parameter to allow manual entry of card account numbers on the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "true"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  },
  "promptForSignature": {
    "description": "Specifies how the signature prompt should be handled for the request. If a value is not provided, Always will be used.  See <a href='../help/kb/signaturePrompt.html'>Signature Prompt</a>.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Always",
        "Never",
        "None"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Always"
    },
    "required": false
  },
  "provisionalAmount": {
    "description": "Override provisional amount used for QC transactions, which is $1.00 by default",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "1"
    },
    "required": false
  },
  "userInputTimeout": {
    "description": "Specifies the user input timeout.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "60000"
    },
    "required": false
  }
}
StoreCard 
{
  "Id": {
    "description": "The ID of a StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "Password": {
    "description": "The password of StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

RefundResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "balanceAmount": "double",
  "balanceCurrencyCode": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "convenienceFeeAmount": "double",
  "currencyCode": "string",
  "ebtType": "string",
  "emv": {
    "applicationIdentifier": "string",
    "applicationLabel": "string",
    "applicationPreferredName": "string",
    "applicationTransactionCounter": "string",
    "cryptogram": "string",
    "issuerCodeTableIndex": "string",
    "pinBypassed": "boolean",
    "tags": {
      "key": "string",
      "value": "string"
    }
  },
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "networkLabel": "string",
  "paymentType": "string",
  "pinVerified": "boolean",
  "quickChipMessage": "string",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "terminalId": "string",
  "tokenId": "string",
  "tokenProvider": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
RefundResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
balanceAmount false double 13 The balance of the gift card.
balanceCurrencyCode false string 4 The balance currency code.
Values:
  • None
  • Usd
binValue false string 6 The BIN entry that matched the account number.
cardHolderName false string 80 The cardholder name.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double 10 The convenience fee amount.
currencyCode false string 4 The currency code used in the transaction.
Values:
  • None
  • Usd
ebtType false string 16 The type of the EBT card
Values:
  • None
  • FoodStamp
  • CashBenefit
emv false Emv The fields used on the receipt for an EMV transaction. Null if the transaction was not EMV.
entryMode false string 32 Description of how card was entered.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
networkLabel false string 30 Label that shows the network where the transaction was routed for authorization
paymentType false string 16 Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
  • Ebt
pinVerified false boolean 5 True if the PIN was verified, false if not verified or undetermined.
quickChipMessage false string 500 The message unique to QuickChip pre-read functionality only.
signature false Signature The signature data.
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction
tokenId false string 100 The Token ID.
tokenProvider false string 32 The Token Provider.
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Emv
Field Required Data Type Max Length Default Value Description
applicationIdentifier false string 16 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 false string 16 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 false string 16 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.
applicationTransactionCounter false string 2 The application transaction counter.
cryptogram false string 60 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.
issuerCodeTableIndex false string 2 Indicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name.
pinBypassed false boolean 5 undefined
tags false Array<Tag> A name value collection of additional EMV tags that are required to appear on the receipt.
Tag
Field Required Data Type Max Length Default Value Description
key false string 10 undefined
value false string 64 undefined
Signature
Field Required Data Type Max Length Default Value Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string 32 The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string 50 Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
  • SignatureRequiredButPromptSuppressedByMerchant
  • SignatureNotRequiredByUnattendedPinPad
RefundResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceAmount": {
    "description": "The balance of the gift card.",
    "type": "double",
    "paramValues": {
      "max": "13",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceCurrencyCode": {
    "description": "The balance currency code.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderName": {
    "description": "The cardholder name.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "ebtType": {
    "description": "The type of the EBT card",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "FoodStamp",
        "CashBenefit"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "emv": {
    "description": "The fields used on the receipt for an EMV transaction. Null if the transaction was not EMV.",
    "type": "Emv",
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "networkLabel": {
    "description": "Label that shows the network where the transaction was routed for authorization",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift",
        "Ebt"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "quickChipMessage": {
    "description": "The message unique to QuickChip pre-read functionality only.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenId": {
    "description": "The Token ID.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenProvider": {
    "description": "The Token Provider.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Emv 
{
  "applicationIdentifier": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "applicationLabel": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "applicationPreferredName": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "applicationTransactionCounter": {
    "description": "The application transaction counter.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "cryptogram": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "60",
      "defaultValue": ""
    },
    "required": false
  },
  "issuerCodeTableIndex": {
    "description": "Indicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "pinBypassed": {
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "tags": {
    "description": "A name value collection of additional EMV tags that are required to appear on the receipt.",
    "type": "Array",
    "items": {
      "$ref": "Tag"
    },
    "required": false
  }
}
Tag 
{
  "key": {
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "value": {
    "type": "string",
    "paramValues": {
      "max": "64",
      "defaultValue": ""
    },
    "required": false
  }
}
Signature 
{
  "data": {
    "description": "The byte array of the signature in the format specified by Format.",
    "type": "Array",
    "items": {
      "type": "byte"
    },
    "required": false
  },
  "format": {
    "description": "The format of the signature.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PointsLittleEndian",
        "PointsBigEndian",
        "Ascii3Byte"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "Indicates why a signature is or is not present.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "SignatureRequired",
        "SignaturePresent",
        "SignatureRequiredCancelledByCardholder",
        "SignatureRequiredNotSupportedByPinPad",
        "SignatureRequiredPinPadError",
        "SignatureNotRequiredByThresholdAmount",
        "SignatureNotRequiredByPaymentType",
        "SignatureNotRequiredByTransactionType",
        "SignatureRequiredButPromptSuppressedByMerchant",
        "SignatureNotRequiredByUnattendedPinPad"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
POST
/api/v1/refund/{paymentAccountId} Creates a new payment account refund based on the passed in parameters

Parameters

Parameter Parameter Type Data Type Description
paymentAccountId path string The payment account ID.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
PaymentAccountRefundRequest body POST_PaymentAccountRefundRequest/v1/refund/{paymentAccountId} undefined

Request Class

PaymentAccountRefundRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "marketCode": "string"
}
PaymentAccountRefundRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use for the card sale.
transactionAmount true double 10 0.00 The total transaction amount. This is the amount of funds to move on the card
clerkNumber false string 10 An optional clerk number for reference.
configuration false POST_RequestConfiguration/v1/refund/{pay mentAccountId} Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double 10 0.00 The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
referenceNumber false string 50 A user defined reference number.
shiftId false string 10 An optional shift id for reference.
ticketNumber false string 50 An optional ticket number.
RequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
PaymentAccountRefundRequest 
{
  "laneId": {
    "description": "Specifies which lane to use for the card sale.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/v1/refund/{paymentAccountId}",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  }
}

Response Class

PaymentAccountRefundResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "approvalNumber": "string",
  "cardLogo": "string",
  "convenienceFeeAmount": "double",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "paymentAccountId": "string",
  "paymentAccountReferenceNumber": "string",
  "referenceNumber": "string",
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
PaymentAccountRefundResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double 10 The convenience fee added to the transaction
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
paymentAccountId false string 50 The payment account ID.
paymentAccountReferenceNumber false string 50 The payment account reference number.
referenceNumber false string 50 The reference number.
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
PaymentAccountRefundResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentAccountId": {
    "description": "The payment account ID.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentAccountReferenceNumber": {
    "description": "The payment account reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "The reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
POST
/api/v1/refund/token Creates a new card refund using a token based on the passed in amounts

Implementation Notes

See OmniToken documentation for more information.

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
TokenRefundRequest body POST_TokenRefundRequest/v1/refund/token undefined

Request Class

TokenRefundRequest 
{
  "cardLogo": "string",
  "laneId": "int",
  "tokenId": "string",
  "tokenProvider": "string",
  "transactionAmount": "double",
  "vaultId": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "expirationMonth": "string",
  "expirationYear": "string",
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "marketCode": "string"
}
TokenRefundRequest
Field Required Data Type Max Length Default Value Description
cardLogo true string 20 The card logo of the card that the token represents.
Values:
  • Visa
  • MasterCard
  • Amex
  • Discover
  • Diners
  • StoredValue
  • Other
  • JCB
  • CarteBlanche
  • Interac
laneId true int Specifies which lane to use for the card sale.
tokenId true string 100 The token ID used for the sale.
tokenProvider true string 32 The type of token ID used for the sale.
Values:
  • OmniToken
transactionAmount true double 10 0.00 The total transaction amount. This is the amount of funds to move on the card
vaultId true string 10 The Vault ID used to create the token.
clerkNumber false string 10 An optional clerk number for reference.
configuration false POST_RequestConfiguration/v1/refund/toke n Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double 10 0.00 The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
expirationMonth false string 2 The expiration month of the card the token represents. Although this is not required, it is recommended for fraud protection.
expirationYear false string 2 The expiration year of the card the token represents. Although this is not required, it is recommended for fraud protection.
referenceNumber false string 50 A user defined reference number.
shiftId false string 10 An optional shift id for reference.
ticketNumber false string 50 An optional ticket number.
RequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
TokenRefundRequest 
{
  "cardLogo": {
    "description": "The card logo of the card that the token represents.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Visa",
        "MasterCard",
        "Amex",
        "Discover",
        "Diners",
        "StoredValue",
        "Other",
        "JCB",
        "CarteBlanche",
        "Interac"
      ]
    },
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": true
  },
  "laneId": {
    "description": "Specifies which lane to use for the card sale.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "tokenId": {
    "description": "The token ID used for the sale.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": true
  },
  "tokenProvider": {
    "description": "The type of token ID used for the sale.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "OmniToken"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "vaultId": {
    "description": "The Vault ID used to create the token.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/v1/refund/token",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The expiration month of the card the token represents. Although this is not required, it is recommended for fraud protection.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The expiration year of the card the token represents. Although this is not required, it is recommended for fraud protection.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  }
}

Response Class

TokenRefundResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "approvalNumber": "string",
  "cardLogo": "string",
  "convenienceFeeAmount": "double",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "referenceNumber": "string",
  "statusCode": "string",
  "terminalId": "string",
  "tokenId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
TokenRefundResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double 10 The convenience fee added to the transaction
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
referenceNumber false string 50 The reference number.
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction
tokenId false string 100 The token ID.
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
TokenRefundResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "The reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenId": {
    "description": "The token ID.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
POST
/api/v1/return/{transactionId}/{paymentType} Creates a new card return based on the passed in parameters

Implementation Notes

Creates a new card return based on the passed in parameters. More�

Parameters

Parameter Parameter Type Data Type Description
paymentType path string The original payment type.
transactionId path string The ID of a previous transaction.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
ReturnRequest body POST_ReturnRequest/v1/return/{transactionId}/{paymentType} undefined

Request Class

ReturnRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "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"
  },
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "commercialCardCustomerCode": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "marketCode": "string",
    "promptForSignature": "string"
  },
  "referenceNumber": "string",
  "salesTaxAmount": "double",
  "shiftId": "string",
  "storeCard": {
    "Id": "string",
    "Password": "string"
  },
  "ticketNumber": "string"
}
ReturnRequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "marketCode": "string",
  "promptForSignature": "string"
}
ReturnRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
transactionAmount true double 10 0.00 The total transaction amount. This is the amount of funds to move on the card
address false POST_Address/v1/return/{transactionId}/{ paymentType} The cardholder address information for the transaction.
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
commercialCardCustomerCode false string 40 The commercial card customer code for the transaction. This is for Level II.
configuration false POST_ReturnRequestConfiguration/v1/retur n/{transactionId}/{paymentType} Any value included in this section will override the corresponding value set in the triPOS.config
referenceNumber false string 50 A user defined reference number.
salesTaxAmount false double 10 0.00 The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.
shiftId false string 10 An optional shift id for reference.
storeCard false POST_StoreCard/v1/return/{transactionId} /{paymentType} Information necessary to process a StoreCard transaction.
ticketNumber false string 50 An optional ticket number.
Address
Field Required Data Type Max Length Default Value Description
billingAddress1 false string 50 The street address used for billing purposes.
billingAddress2 false string 50 The street address used for billing purposes.
billingCity false string 40 The name of the city used for billing purposes.
billingEmail false string 80 The e-mail address used for billing purposes.
billingName false string 100 The name used for billing purposes.
billingPhone false string 20 The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string 20 The postal code used for billing purposes.
billingState false string 30 The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
shippingAddress1 false string 50 The street address used for shipping purposes.
shippingAddress2 false string 50 The street address used for shipping purposes.
shippingCity false string 40 The name of the city used for shipping purposes.
shippingEmail false string 80 The e-mail address used for shipping purposes.
shippingName false string 100 The name used for shipping purposes.
shippingPhone false string 20 The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string 20 The postal code used for shipping purposes.
shippingState false string 30 The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
ReturnRequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
promptForSignature false string 32 Always Specifies how the signature prompt should be handled for the request. If a value is not provided, Always will be used. See Signature Prompt.
Values:
  • Always
  • Never
  • None
StoreCard
Field Required Data Type Max Length Default Value Description
Id false string 32 The ID of a StoreCard.
Password false string 32 The password of StoreCard.
ReturnRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/v1/return/{transactionId}/{paymentType}",
    "required": false
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "commercialCardCustomerCode": {
    "description": "The commercial card customer code for the transaction. This is for Level II.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_ReturnRequestConfiguration/v1/return/{transactionId}/{paymentType}",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "salesTaxAmount": {
    "description": "The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "storeCard": {
    "description": "Information necessary to process a StoreCard transaction.",
    "type": "POST_StoreCard/v1/return/{transactionId}/{paymentType}",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingState": {
    "description": "The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingState": {
    "description": "The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  }
}
ReturnRequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  },
  "promptForSignature": {
    "description": "Specifies how the signature prompt should be handled for the request. If a value is not provided, Always will be used. See <a href='../help/kb/signaturePrompt.html'>Signature Prompt</a>.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Always",
        "Never",
        "None"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Always"
    },
    "required": false
  }
}
StoreCard 
{
  "Id": {
    "description": "The ID of a StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "Password": {
    "description": "The password of StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

ReturnResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "balanceAmount": "double",
  "balanceCurrencyCode": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "currencyCode": "string",
  "ebtType": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "networkLabel": "string",
  "paymentType": "string",
  "pinVerified": "boolean",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ReturnResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
balanceAmount false double 13 The balance of the gift card.
balanceCurrencyCode false string 4 The balance currency code.
Values:
  • None
  • Usd
binValue false string 6 The BIN entry that matched the account number.
cardHolderName false string 80 The cardholder name.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
currencyCode false string 4 The currency code used in the transaction.
Values:
  • None
  • Usd
ebtType false string 16 The type of the EBT card
Values:
  • None
  • FoodStamp
  • CashBenefit
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
networkLabel false string 30 Label that shows the network where the transaction was routed for authorization
paymentType false string 16 Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
  • Ebt
pinVerified false boolean 5 True if the PIN was verified, false if not verified or undetermined.
signature false Signature The signature data.
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Signature
Field Required Data Type Max Length Default Value Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string 32 The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string 50 Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
  • SignatureRequiredButPromptSuppressedByMerchant
  • SignatureNotRequiredByUnattendedPinPad
ReturnResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceAmount": {
    "description": "The balance of the gift card.",
    "type": "double",
    "paramValues": {
      "max": "13",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceCurrencyCode": {
    "description": "The balance currency code.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderName": {
    "description": "The cardholder name.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "ebtType": {
    "description": "The type of the EBT card",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "FoodStamp",
        "CashBenefit"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "networkLabel": {
    "description": "Label that shows the network where the transaction was routed for authorization",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift",
        "Ebt"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Signature 
{
  "data": {
    "description": "The byte array of the signature in the format specified by Format.",
    "type": "Array",
    "items": {
      "type": "byte"
    },
    "required": false
  },
  "format": {
    "description": "The format of the signature.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PointsLittleEndian",
        "PointsBigEndian",
        "Ascii3Byte"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "Indicates why a signature is or is not present.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "SignatureRequired",
        "SignaturePresent",
        "SignatureRequiredCancelledByCardholder",
        "SignatureRequiredNotSupportedByPinPad",
        "SignatureRequiredPinPadError",
        "SignatureNotRequiredByThresholdAmount",
        "SignatureNotRequiredByPaymentType",
        "SignatureNotRequiredByTransactionType",
        "SignatureRequiredButPromptSuppressedByMerchant",
        "SignatureNotRequiredByUnattendedPinPad"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
POST
/api/v1/reversal/{transactionId}/{paymentType} Creates a new full reversal based on given transaction ID, payment type, and the passed in amounts

Parameters

Parameter Parameter Type Data Type Description
paymentType path string The original payment type.
transactionId path string The ID of a previous transaction.
type query string The type of reversal.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
ReversalRequest body POST_ReversalRequest/v1/reversal/{transactionId}/{paymentType} undefined

Request Class

ReversalRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "ebtType": "string",
  "getToken": "string",
  "networkTransactionID": "string",
  "recurringPaymentType": "string",
  "referenceNumber": "string",
  "shiftId": "string",
  "storeCard": {
    "Id": "string",
    "Password": "string"
  },
  "submissionType": "string",
  "ticketNumber": "string",
  "type": "string"
}
TransactionIdRequestConfiguration 
{
  "marketCode": "string"
}
ReversalRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
transactionAmount true double 10 0.00 The original transaction amount.
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
configuration false POST_TransactionIdRequestConfiguration/v 1/reversal/{transactionId}/{paymentType} Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double 10 0.00 The convenience fee amount.
ebtType false string 16 EBT card type of the original transaction. This is required when payment type is EBT.
Values:
  • None
  • FoodStamp
  • CashBenefit
getToken false string 20 To retrieve Token in the transaction.
networkTransactionID false string 40 The card brand specific transaction ID that should be stored by the integrator.
recurringPaymentType false string 32 Intent of why the credentials are being stored.
Values:
  • NotUsed
  • Recurring
  • Installment
  • CardHolderInitiated
  • CredentialsOnFile
referenceNumber false string 50 A user defined reference number.
shiftId false string 10 An optional shift id for reference.
storeCard false POST_StoreCard/v1/reversal/{transactionI d}/{paymentType} Information necessary to process a StoreCard transaction.
submissionType false string 32 Initial vs Subsequent Transaction.
Values:
  • NotUsed
  • Initial
  • Subsequent
  • Resubmission
  • ReAuthorization
  • DelayedCharges
  • NoShow
ticketNumber false string 50 An optional ticket number.
type false string 16 The type of reversal.
TransactionIdRequestConfiguration
Field Required Data Type Max Length Default Value Description
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
StoreCard
Field Required Data Type Max Length Default Value Description
Id false string 32 The ID of a StoreCard.
Password false string 32 The password of StoreCard.
ReversalRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The original transaction amount. ",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_TransactionIdRequestConfiguration/v1/reversal/{transactionId}/{paymentType}",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "ebtType": {
    "description": "EBT card type of the original transaction. This is required when payment type is EBT.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "FoodStamp",
        "CashBenefit"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "getToken": {
    "description": "To retrieve Token in the transaction.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "networkTransactionID": {
    "description": "The card brand specific transaction ID that should be stored by the integrator.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "recurringPaymentType": {
    "description": "Intent of why the credentials are being stored.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotUsed",
        "Recurring",
        "Installment",
        "CardHolderInitiated",
        "CredentialsOnFile"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "storeCard": {
    "description": "Information necessary to process a StoreCard transaction.",
    "type": "POST_StoreCard/v1/reversal/{transactionId}/{paymentType}",
    "required": false
  },
  "submissionType": {
    "description": "Initial vs Subsequent Transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotUsed",
        "Initial",
        "Subsequent",
        "Resubmission",
        "ReAuthorization",
        "DelayedCharges",
        "NoShow"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "type": {
    "description": "The type of reversal.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  }
}
TransactionIdRequestConfiguration 
{
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  }
}
StoreCard 
{
  "Id": {
    "description": "The ID of a StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "Password": {
    "description": "The password of StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

ReversalResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "balanceAmount": "double",
  "cardLogo": "string",
  "convenienceFeeAmount": "double",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "paymentType": "string",
  "statusCode": "string",
  "terminalId": "string",
  "tokenId": "string",
  "tokenProvider": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ReversalResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
balanceAmount false double 13 The balance of the gift card.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other
convenienceFeeAmount false double 10 The convenience fee amount.
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
paymentType false string 16 Original card payment type: Credit, Debit, Gift, EBT
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction
tokenId false string 100 The Token ID.
tokenProvider false string 32 The Token Provider.
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
ReversalResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceAmount": {
    "description": "The balance of the gift card.",
    "type": "double",
    "paramValues": {
      "max": "13",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentType": {
    "description": "Original card payment type: Credit, Debit, Gift, EBT",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenId": {
    "description": "The Token ID.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenProvider": {
    "description": "The Token Provider.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
POST
/api/v1/sale Creates a new card sale based on the passed in amounts.

Implementation Notes

Review this document for information on requiring the PIN pad to prompt for the cardholder to accept the convenienceFeeAmount. Additionally, this endpoint supports QuickChip/PreRead functionality. See QuickChip/PreRead documentation for more information.

Parameters

Parameter Parameter Type Data Type Description
action query string The action to perform with the sale. This can either be 'store' or 'forward'. More information on Store and Forward here.
requestIdToForward query string The request ID of the stored transaction to forward.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
SaleRequest body POST_SaleRequest/v1/sale undefined

Request Class

SaleRequest 
{
  "laneId": "int",
  "transactionAmount": "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"
  },
  "autoRental": {
    "customerName": "string",
    "agreementNumber": "string",
    "vehicleClassCode": "string",
    "noShowIndicator": "string",
    "adjustmentData": {
      "amount": "double",
      "code": "string",
      "extraChargesDetail": "Array<POST_AutoRentalExtraChargesDetail/v1/sale>"
    },
    "pickupData": {
      "city": "string",
      "countryCode": "string",
      "date": "string",
      "location": "string",
      "state": "string"
    },
    "returnData": {
      "city": "string",
      "countryCode": "string",
      "date": "string",
      "locationId": "string",
      "state": "string",
      "distance": "int",
      "distanceUnit": "string"
    },
    "dailyRentalRate": "double",
    "weeklyRentalRate": "double",
    "insuranceCharges": "double",
    "duration": "int"
  },
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "commercialCardCustomerCode": "string",
  "configuration": {
    "allowDebit": "boolean",
    "allowedPaymentTypes": "Array<string>",
    "allowPartialApprovals": "boolean",
    "cashbackOptions": {
      "manualEntry": {
        "amountIncrement": "int",
        "maximumAmount": "int"
      },
      "selectionAmounts": "string"
    },
    "checkForDuplicateTransactions": "boolean",
    "confirmOriginalAmount": "boolean",
    "isGiftSupported": "string",
    "isManualEntryAllowed": "string",
    "marketCode": "string",
    "processUSMaestroDebitOffLinePinCvmAsDebit": "string",
    "promptForSignature": "string",
    "provisionalAmount": "string",
    "thresholdAmount": "double",
    "tipOptions": {
      "otherOption": "string",
      "tipSelections": "string",
      "type": "string"
    },
    "userInputTimeout": "string"
  },
  "convenienceFeeAmount": "double",
  "currencyCode": "string",
  "displayTransactionAmount": "boolean",
  "ebtType": "string",
  "foodStampAmount": "double",
  "getToken": "string",
  "healthcare": {
    "clinic": "double",
    "dental": "double",
    "prescription": "double",
    "total": "double",
    "vision": "double"
  },
  "invokeManualEntry": "boolean",
  "isCscSupported": "string",
  "lodging": {
    "agreementNumber": "string",
    "chargeType": "string",
    "checkInDate": "string",
    "checkOutDate": "string",
    "customerName": "string",
    "duration": "int",
    "extraChargesDetail": "Array<POST_LodgingExtraChargesDetail/v1/sale>",
    "noShow": "boolean",
    "prestigiousPropertyCode": "string",
    "roomAmount": "double",
    "specialProgramCode": "string"
  },
  "networkTransactionID": "string",
  "nonFinancialExpected": "boolean",
  "preRead": "boolean",
  "quickChip": "boolean",
  "recurringPaymentType": "string",
  "referenceNumber": "string",
  "requestedCashbackAmount": "double",
  "salesTaxAmount": "double",
  "shiftId": "string",
  "storeCard": {
    "Id": "string",
    "Password": "string"
  },
  "submissionType": "string",
  "ticketNumber": "string",
  "tipAmount": "double"
}
SaleRequestConfiguration 
{
  "allowDebit": "boolean",
  "allowedPaymentTypes": "Array<string>",
  "allowPartialApprovals": "boolean",
  "cashbackOptions": {
    "manualEntry": {
      "amountIncrement": "int",
      "maximumAmount": "int"
    },
    "selectionAmounts": "string"
  },
  "checkForDuplicateTransactions": "boolean",
  "confirmOriginalAmount": "boolean",
  "isGiftSupported": "string",
  "isManualEntryAllowed": "string",
  "marketCode": "string",
  "processUSMaestroDebitOffLinePinCvmAsDebit": "string",
  "promptForSignature": "string",
  "provisionalAmount": "string",
  "thresholdAmount": "double",
  "tipOptions": {
    "otherOption": "string",
    "tipSelections": "string",
    "type": "string"
  },
  "userInputTimeout": "string"
}
SaleRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
transactionAmount true string 10 0.00 The total transaction amount. This is the amount of funds to move on the card
address false POST_Address/v1/sale The cardholder address information for the transaction.
autoRental false POST_AutoRental/v1/sale The auto rental parameters to be passed in for an auto rental transaction. more�
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
commercialCardCustomerCode false string 40 The commercial card customer code for the transaction. This is for Level II.
configuration false POST_SaleRequestConfiguration/v1/sale Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double 10 0.00 The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged. more�
currencyCode false string 4 Usd The currency code used in the transaction.
Values:
  • None
  • Usd
displayTransactionAmount false boolean 5 false Display the transaction amount during card read.
ebtType false string 16 EbtType may be FoodStamp or CashBenefit
Values:
  • None
  • FoodStamp
  • CashBenefit
foodStampAmount false double 12 If POS app sends FoodStampAmount, then replace OriginalAmount with FoodStampAmount for EBT FoodStamp transactions
getToken false string 20 To retrieve Token in the transaction. more�
Values:
  • OmniToken
healthcare false POST_Healthcare/v1/sale The healthcare section that contains all applicable healthcare-qualified amounts. more�
invokeManualEntry false boolean 5 false Invoke manual entry card read.
isCscSupported false string 5 false Invokes prompt for cardholder to enter card security code for manual keyed card entry.
lodging false POST_LodgingTransactionCompletion/v1/sal e The lodging parameters to be passed in for a lodging transaction. more�
networkTransactionID false string 40 The card brand specific transaction ID that should be stored by the integrator.
nonFinancialExpected false boolean 5 false Non Financial Card read Expected. Only supported on unattended devices.
preRead false boolean 5 false Flag indicating desire to process sale as PreRead (i.e. - do ONLY Pre-Read operations, then expecting next endpoint call to be QuickChip) more�.
quickChip false boolean 5 false Flag indicating desire to process sale as QuickChip (i.e. - Pre-Read has been previously performed) more�.
recurringPaymentType false string 32 Intent of why the credentials are being stored.
Values:
  • NotUsed
  • Recurring
  • Installment
  • CardHolderInitiated
  • CredentialsOnFile
referenceNumber false string 50 A user defined reference number.
requestedCashbackAmount false double 12 The requested cashback amount of the transaction. If the card used is cashback capable, this amount will be added to the total amount of the transaction. If the card is not cashback capable, the transaction will decline. More information on RequestedCashbackAmount here.
salesTaxAmount false double 10 0.00 The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.
shiftId false string 10 An optional shift id for reference.
storeCard false POST_StoreCard/v1/sale Information necessary to process a StoreCard transaction.
submissionType false string 32 Initial vs Subsequent Transaction.
Values:
  • NotUsed
  • Initial
  • Subsequent
  • Resubmission
  • ReAuthorization
  • DelayedCharges
  • NoShow
ticketNumber false string 50 An optional ticket number.
tipAmount false double 12 0.00 The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
Address
Field Required Data Type Max Length Default Value Description
billingAddress1 false string 50 The street address used for billing purposes.
billingAddress2 false string 50 The street address used for billing purposes.
billingCity false string 40 The name of the city used for billing purposes.
billingEmail false string 80 The e-mail address used for billing purposes.
billingName false string 100 The name used for billing purposes.
billingPhone false string 20 The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string 20 The postal code used for billing purposes.
billingState false string 30 The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
shippingAddress1 false string 50 The street address used for shipping purposes.
shippingAddress2 false string 50 The street address used for shipping purposes.
shippingCity false string 40 The name of the city used for shipping purposes.
shippingEmail false string 80 The e-mail address used for shipping purposes.
shippingName false string 100 The name used for shipping purposes.
shippingPhone false string 20 The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string 20 The postal code used for shipping purposes.
shippingState false string 30 The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
AutoRental
Field Required Data Type Max Length Default Value Description
customerName false string 100 Customer Name.
agreementNumber false string 14 Agreement number.
vehicleClassCode false string 32 Classification of rental vehicle
Values:
  • Unused
  • Mini
  • Subcompact
  • Economy
  • Compact
  • Midsize
  • Intermediate
  • Standard
  • Fullsize
  • Luxury
  • Premium
  • Minivan
  • Van12Passenger
  • MovingVan
  • Van15Passenger
  • CargoVan
  • Truck12Foot
  • Truck20Foot
  • Truck24Foot
  • Truck26Foot
  • Moped
  • Stretch
  • Regular
  • Unique
  • Exotic
  • TruckSmallMedium
  • TruckLarge
  • SUVSmall
  • SUVMedium
  • SUVLarge
  • SUVExotic
  • FourWheelDrive
  • Special
  • Miscellaneous
noShowIndicator false string 32 No show indicator. Indicates whether rental vehicle was reserved, but not actually rented.
Values:
  • NotApplicable
  • NoShow
adjustmentData false POST_AutoRentalAdjustmentData/v1/sale Data related to any auto rental adjustments.
pickupData false POST_AutoRentalPickupData/v1/sale Data related to autorental pickup.
returnData false POST_AutoRentalReturnData/v1/sale Data related to autorental return.
dailyRentalRate false double 10 0 Rate charged per day Visa/MC � Daily rate required for Corp T&E rate III.
weeklyRentalRate false double 10 0 Rate charged per week Visa/MC � Weekly rate required for Corp T&E rate III.
insuranceCharges false double 10 0.00 If insurance is charged, the insurance amount should be provided.
duration false int 2 The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.
AutoRentalAdjustmentData
Field Required Data Type Max Length Default Value Description
amount false double 10 0.00 Adjustment amount.
code false string 40 Indicates if adjustment for mileage, fuel, vehicle damage, etc. was made to a rental agreement.
Values:
  • NoAdjustments
  • MultipleAdjustments
  • OneAdjustmentCardmemberNotified
  • OneAdjustmentCardmemberNotNotified
extraChargesDetail false Array<POST_AutoRentalExtraChargesDetail/v1/sal e> 100 NoExtraCharge Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NoExtraCharge.
Values:
  • NoExtraCharge
  • Gasoline
  • ExtraMileage
  • LateReturn
  • OneWayServiceFee
  • ParkingOrMovingViolation
AutoRentalPickupData
Field Required Data Type Max Length Default Value Description
city false string 18 Auto rental pickup city.
countryCode false string 3 Country code where vehicle was picked up. For US, use 840.
date false string 19 return date in yyyy-MM-ddTHH:mm:ss format.
location false string 38 Name of business where vehicle was picked up.
state false string 3 Abbreviation of state, province, or other country subdivision where vehicle was picked up.
AutoRentalReturnData
Field Required Data Type Max Length Default Value Description
city false string 18 Auto rental return city.
countryCode false string 3 Country code where vehicle was returned. For US, use 840.
date false string 19 return date in yyyy-MM-ddTHH:mm:ss format.
locationId false string 10 Auto Rental location ID where vehicle was returned.
state false string 3 Auto rental return state.
distance false int 5 Numeric distance traveled during rental period.
distanceUnit false string 16 Unit of measurement applicable to distance traveled.
Values:
  • 0 = Unused
  • 1 = Miles
  • 2 = Kilometers
SaleRequestConfiguration
Field Required Data Type Max Length Default Value Description
allowDebit false boolean 5 false Use this parameter to allow debit more�.
allowedPaymentTypes false Array<string> 40 Pass in either or both values. If a single value is passed then no AID option will be presented for cardholder to select and automatic AID selection will happen, assuming only one credit/debit AID is available on a card. In case, multiple credit AIDs or multiple debit AIDs are available on a card, then choice will be given to choose among the filtered list of credit/debit AIDs.more�
Values:
  • Credit
  • Debit
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
cashbackOptions false POST_CashbackOptions/v1/sale Use this section to specify cashback options for each request more�.
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
confirmOriginalAmount false boolean 5 false Use this parameter to confirm the sale original amount more�.
isGiftSupported false string 5 false Use this parameter to allow Vantiv gift cards to be used.
isManualEntryAllowed false string 5 true Use this parameter to allow manual entry of card account numbers on the PIN pad.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
processUSMaestroDebitOffLinePinCvmAsDebit false string 5 false Use this parameter to allow Maestro Debit Aids to be processed as Debit if the CVM is Offline PIN
promptForSignature false string 32 UseThreshold Specifies how the signature prompt should be handled for the request. If a value is not provided, UseThreshold will be used. See Signature Prompt.
Values:
  • Always
  • Never
  • UseThreshold
  • None
provisionalAmount false string 10 1 Override provisional amount used for QC transactions, which is $1.00 by default
thresholdAmount false double 12 0.00 Specifies the threshold value to use. If included, will override the value in the triPOS.config when promptForSignature is UseThreshold. See Signature Prompt.
tipOptions false POST_TipOptions/v1/sale If these tip options are sent in, they will override the tip options that are currently set in the triPOS.config. To disable tip, send this section up with empty values. To use the values from the triPOS.config, do not include this section in your request more�.
userInputTimeout false string 10 60000 Specifies the user input timeout.
CashbackOptions
Field Required Data Type Max Length Default Value Description
manualEntry false POST_CashbackManualEntry/v1/sale Configurable settings for allowing a cashback choice through manual entry.
selectionAmounts false string 64 The cashback amounts to display on the PIN pad's selection buttons (i.e. 5,10,20,50).
CashbackManualEntry
Field Required Data Type Max Length Default Value Description
amountIncrement false int 10 1 The PIN pad will only accept a cashback amount in the provided increment (i.e. Set to 5 to only allow cashback amounts in increments of $5.00).
maximumAmount false int 10 The PIN pad will only accept a cashback amount that does not exceed the provided maximum.
TipOptions
Field Required Data Type Max Length Default Value Description
otherOption false string 32 Other option to show to select tip.
Values:
  • Other
  • None
  • OtherNone
  • NoneOther
tipSelections false string 64 CSV tip amount selections.
type false string 10 Type of tip entry: Amount selection, Percentage selection, or Prompt for custom value entry. Note: The Prompt value overrides the otherOption and tipSelections, skipping directly to Tip Amount entry screen.
Values:
  • Amount
  • Percentage
  • Prompt
Healthcare
Field Required Data Type Max Length Default Value Description
clinic false double 12 The total amount of healthcare-qualified goods that fall into the category of 'clinic'.
dental false double 12 The total amount of healthcare-qualified goods that fall into the category of 'dental'.
prescription false double 12 The total amount of healthcare-qualified goods that fall into the category of 'prescription'.
total false double 12 The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.
vision false double 12 The total amount of healthcare-qualified goods that fall into the category of 'vision'.
LodgingTransactionCompletion
Field Required Data Type Max Length Default Value Description
agreementNumber false string 14 The lodging agreement number.
chargeType false string 32 Default The lodging charge type. For an empty or invalid value, this parameter defaults to Default.
Values:
  • Default
  • Restaurant
  • GiftShop
checkInDate false string 10 The check-in date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.
checkOutDate false string 10 The check-out date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.
customerName false string 100 The lodging customer name.
duration false int 2 The number of hotel stay days. Set to 1 for no show.
extraChargesDetail false Array<POST_LodgingExtraChargesDetail/v1/sale> 100 NotUsed Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NotUsed.
Values:
  • NotUsed
  • Reserved
  • Restaurant
  • GiftShop
  • MiniBar
  • Telephone
  • Other
  • Laundry
noShow false boolean 5 false Set to true to indicate no show. Otherwise, value defaults to false.
prestigiousPropertyCode false string 32 NonParticipant The lodging prestigious property code. For an empty or invalid value, this parameter defaults to NonParticipant.
Values:
  • NonParticipant
  • FiveHundredDollarLimit
  • OneThousandDollarLimit
  • OneThousandFiveHundredDollarLimit
roomAmount false double 12 0.00 The nightly rate for one room.
specialProgramCode false string 32 Default The lodging special program code. For an empty or invalid value, this parameter defaults to Default.
Values:
  • Default
  • Sale
  • NoShow
  • AdvanceDeposit
StoreCard
Field Required Data Type Max Length Default Value Description
Id false string 32 The ID of a StoreCard.
Password false string 32 The password of StoreCard.
SaleRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/v1/sale",
    "required": false
  },
  "autoRental": {
    "description": "The auto rental parameters to be passed in for an auto rental transaction. <a href='../help/kb/autorental.html'>more&raquo;</a>",
    "type": "POST_AutoRental/v1/sale",
    "required": false
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "commercialCardCustomerCode": {
    "description": "The commercial card customer code for the transaction. This is for Level II.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_SaleRequestConfiguration/v1/sale",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged. <a href='../help/kb/convenienceFeeAmount.html'>more&raquo;</a>",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": "Usd"
    },
    "required": false
  },
  "displayTransactionAmount": {
    "description": "Display the transaction amount during card read.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "ebtType": {
    "description": "EbtType may be FoodStamp or CashBenefit",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "FoodStamp",
        "CashBenefit"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "foodStampAmount": {
    "description": "If POS app sends FoodStampAmount, then replace OriginalAmount with FoodStampAmount for EBT FoodStamp transactions",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "getToken": {
    "description": "To retrieve Token in the transaction. <a href='../help/kb/GetToken.html'>more&raquo;</a>",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "OmniToken"
      ]
    },
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "healthcare": {
    "description": "The healthcare section that contains all applicable healthcare-qualified amounts. <a href='../help/kb/healthcare.html'>more&raquo;</a>",
    "type": "POST_Healthcare/v1/sale",
    "required": false
  },
  "invokeManualEntry": {
    "description": "Invoke manual entry card read.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isCscSupported": {
    "description": "Invokes prompt for cardholder to enter card security code for manual keyed card entry.",
    "type": "string",
    "allowableValues": {},
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "lodging": {
    "description": "The lodging parameters to be passed in for a lodging transaction. <a href='../help/kb/lodging.html'>more&raquo;</a>",
    "type": "POST_LodgingTransactionCompletion/v1/sale",
    "required": false
  },
  "networkTransactionID": {
    "description": "The card brand specific transaction ID that should be stored by the integrator.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "nonFinancialExpected": {
    "description": "Non Financial Card read Expected. Only supported on unattended devices.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "preRead": {
    "description": "Flag indicating desire to process sale as PreRead (i.e. - do ONLY Pre-Read operations, then expecting next endpoint call to be QuickChip) <a href='..\\help\\kb\\QuickChipConfiguration.html'>more&raquo;</a>.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "quickChip": {
    "description": "Flag indicating desire to process sale as QuickChip (i.e. - Pre-Read has been previously performed) <a href='..\\help\\kb\\QuickChipConfiguration.html'>more&raquo;</a>.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "recurringPaymentType": {
    "description": "Intent of why the credentials are being stored.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotUsed",
        "Recurring",
        "Installment",
        "CardHolderInitiated",
        "CredentialsOnFile"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "requestedCashbackAmount": {
    "description": "The requested cashback amount of the transaction. If the card used is cashback capable, this amount will be added to the total amount of the transaction. If the card is not cashback capable, the transaction will decline. More information on <a href='../help/kb/requestedCashbackAmount.html'>RequestedCashbackAmount</a> here.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "salesTaxAmount": {
    "description": "The amount of sales tax for the transaction. This is for Level II, submit amount for tax or 0.00 for tax-exempt.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "storeCard": {
    "description": "Information necessary to process a StoreCard transaction.",
    "type": "POST_StoreCard/v1/sale",
    "required": false
  },
  "submissionType": {
    "description": "Initial vs Subsequent Transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotUsed",
        "Initial",
        "Subsequent",
        "Resubmission",
        "ReAuthorization",
        "DelayedCharges",
        "NoShow"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": "0.00"
    },
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingState": {
    "description": "The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingState": {
    "description": "The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRental 
{
  "customerName": {
    "description": "Customer Name.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "agreementNumber": {
    "description": "Agreement number.",
    "type": "string",
    "paramValues": {
      "max": "14",
      "defaultValue": ""
    },
    "required": false
  },
  "vehicleClassCode": {
    "description": "Classification of rental vehicle",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unused",
        "Mini",
        "Subcompact",
        "Economy",
        "Compact",
        "Midsize",
        "Intermediate",
        "Standard",
        "Fullsize",
        "Luxury",
        "Premium",
        "Minivan",
        "Van12Passenger",
        "MovingVan",
        "Van15Passenger",
        "CargoVan",
        "Truck12Foot",
        "Truck20Foot",
        "Truck24Foot",
        "Truck26Foot",
        "Moped",
        "Stretch",
        "Regular",
        "Unique",
        "Exotic",
        "TruckSmallMedium",
        "TruckLarge",
        "SUVSmall",
        "SUVMedium",
        "SUVLarge",
        "SUVExotic",
        "FourWheelDrive",
        "Special",
        "Miscellaneous"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "noShowIndicator": {
    "description": "No show indicator. Indicates whether rental vehicle was reserved, but not actually rented.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotApplicable",
        "NoShow"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "adjustmentData": {
    "description": "Data related to any auto rental adjustments.",
    "type": "POST_AutoRentalAdjustmentData/v1/sale",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "pickupData": {
    "description": "Data related to autorental pickup.",
    "type": "POST_AutoRentalPickupData/v1/sale",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "returnData": {
    "description": "Data related to autorental return.",
    "type": "POST_AutoRentalReturnData/v1/sale",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "dailyRentalRate": {
    "description": "Rate charged per day Visa/MC � Daily rate required for Corp T&E rate III.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0"
    },
    "required": false
  },
  "weeklyRentalRate": {
    "description": "Rate charged per week Visa/MC � Weekly rate required for Corp T&E rate III.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0"
    },
    "required": false
  },
  "insuranceCharges": {
    "description": "If insurance is charged, the insurance amount should be provided.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "duration": {
    "description": "The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRentalAdjustmentData 
{
  "amount": {
    "description": "Adjustment amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "code": {
    "description": "Indicates if adjustment for mileage, fuel, vehicle damage, etc. was made to a rental agreement.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NoAdjustments",
        "MultipleAdjustments",
        "OneAdjustmentCardmemberNotified",
        "OneAdjustmentCardmemberNotNotified"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "extraChargesDetail": {
    "description": "Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NoExtraCharge.",
    "type": "Array",
    "items": {
      "type": "POST_AutoRentalExtraChargesDetail/v1/sale"
    },
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NoExtraCharge",
        "Gasoline",
        "ExtraMileage",
        "LateReturn",
        "OneWayServiceFee",
        "ParkingOrMovingViolation"
      ]
    },
    "paramValues": {
      "max": "100",
      "defaultValue": "NoExtraCharge"
    },
    "required": false
  }
}
AutoRentalPickupData 
{
  "city": {
    "description": "Auto rental pickup city.",
    "type": "string",
    "paramValues": {
      "max": "18",
      "defaultValue": ""
    },
    "required": false
  },
  "countryCode": {
    "description": "Country code where vehicle was picked up. For US, use 840.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "date": {
    "description": "return date in yyyy-MM-ddTHH:mm:ss format.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "location": {
    "description": "Name of business where vehicle was picked up.",
    "type": "string",
    "paramValues": {
      "max": "38",
      "defaultValue": ""
    },
    "required": false
  },
  "state": {
    "description": "Abbreviation of state, province, or other country subdivision where vehicle was picked up.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRentalReturnData 
{
  "city": {
    "description": "Auto rental return city.",
    "type": "string",
    "paramValues": {
      "max": "18",
      "defaultValue": ""
    },
    "required": false
  },
  "countryCode": {
    "description": "Country code where vehicle was returned. For US, use 840.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "date": {
    "description": "return date in yyyy-MM-ddTHH:mm:ss format.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "locationId": {
    "description": "Auto Rental location ID where vehicle was returned.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "state": {
    "description": "Auto rental return state.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "distance": {
    "description": "Numeric distance traveled during rental period.",
    "type": "int",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "distanceUnit": {
    "description": "Unit of measurement applicable to distance traveled.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "0 = Unused",
        "1 = Miles",
        "2 = Kilometers"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  }
}
SaleRequestConfiguration 
{
  "allowDebit": {
    "description": "Use this parameter to allow debit <a href='../help/kb/allowDebit.html'>more&raquo;</a>.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "allowedPaymentTypes": {
    "description": "Pass in either or both values. If a single value is passed then no AID option will be presented for cardholder to select and automatic AID selection will happen, assuming only one credit/debit AID is available on a card. In case, multiple credit AIDs or multiple debit AIDs are available on a card, then choice will be given to choose among the filtered list of credit/debit AIDs.<a href='../help/kb/allowPaymentTypes.html'>more&raquo;</a>",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Credit",
        "Debit"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "cashbackOptions": {
    "description": "Use this section to specify cashback options for each request <a href='../help/kb/cashbackOptions.html'>more&raquo;</a>.",
    "type": "POST_CashbackOptions/v1/sale",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "confirmOriginalAmount": {
    "description": "Use this parameter to confirm the sale original amount <a href='../help/kb/confirmOriginalAmount.html'>more&raquo;</a>.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isGiftSupported": {
    "description": "Use this parameter to allow Vantiv gift cards to be used.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Use this parameter to allow manual entry of card account numbers on the PIN pad.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "true"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  },
  "processUSMaestroDebitOffLinePinCvmAsDebit": {
    "description": "Use this parameter to allow Maestro Debit Aids to be processed as Debit if the CVM is Offline PIN",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "promptForSignature": {
    "description": "Specifies how the signature prompt should be handled for the request. If a value is not provided, UseThreshold will be used. See <a href='../help/kb/signaturePrompt.html'>Signature Prompt</a>.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Always",
        "Never",
        "UseThreshold",
        "None"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "UseThreshold"
    },
    "required": false
  },
  "provisionalAmount": {
    "description": "Override provisional amount used for QC transactions, which is $1.00 by default",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "1"
    },
    "required": false
  },
  "thresholdAmount": {
    "description": "Specifies the threshold value to use. If included, will override the value in the triPOS.config when promptForSignature is UseThreshold. See <a href='../help/kb/signaturePrompt.html'>Signature Prompt</a>.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "tipOptions": {
    "description": "If these tip options are sent in, they will override the tip options that are currently set in the triPOS.config. To disable tip, send this section up with empty values. To use the values from the triPOS.config, do not include this section in your request <a href='../help/kb/tipOptions.html'>more&raquo;</a>.",
    "type": "POST_TipOptions/v1/sale",
    "required": false
  },
  "userInputTimeout": {
    "description": "Specifies the user input timeout.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": "60000"
    },
    "required": false
  }
}
CashbackOptions 
{
  "manualEntry": {
    "description": "Configurable settings for allowing a cashback choice through manual entry.",
    "type": "POST_CashbackManualEntry/v1/sale",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "selectionAmounts": {
    "description": "The cashback amounts to display on the PIN pad's selection buttons (i.e. 5,10,20,50).",
    "type": "string",
    "paramValues": {
      "max": "64",
      "defaultValue": ""
    },
    "required": false
  }
}
CashbackManualEntry 
{
  "amountIncrement": {
    "description": "The PIN pad will only accept a cashback amount in the provided increment (i.e. Set to 5 to only allow cashback amounts in increments of $5.00).",
    "type": "int",
    "paramValues": {
      "max": "10",
      "defaultValue": "1"
    },
    "required": false
  },
  "maximumAmount": {
    "description": "The PIN pad will only accept a cashback amount that does not exceed the provided maximum.",
    "type": "int",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
TipOptions 
{
  "otherOption": {
    "description": "Other option to show to select tip.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Other",
        "None",
        "OtherNone",
        "NoneOther"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "tipSelections": {
    "description": "CSV tip amount selections.",
    "type": "string",
    "paramValues": {
      "max": "64",
      "defaultValue": ""
    },
    "required": false
  },
  "type": {
    "description": "Type of tip entry: Amount selection, Percentage selection, or Prompt for custom value entry. Note: The Prompt value overrides the otherOption and tipSelections, skipping directly to Tip Amount entry screen.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Amount",
        "Percentage",
        "Prompt"
      ]
    },
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
Healthcare 
{
  "clinic": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'clinic'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "dental": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'dental'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "prescription": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'prescription'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "total": {
    "description": "The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "vision": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'vision'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  }
}
LodgingTransactionCompletion 
{
  "agreementNumber": {
    "description": "The lodging agreement number.",
    "type": "string",
    "paramValues": {
      "max": "14",
      "defaultValue": ""
    },
    "required": false
  },
  "chargeType": {
    "description": "The lodging charge type. For an empty or invalid value, this parameter defaults to Default.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Restaurant",
        "GiftShop"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Default"
    },
    "required": false
  },
  "checkInDate": {
    "description": "The check-in date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "checkOutDate": {
    "description": "The check-out date for the lodging stay. Must be in the ISO 8601 format of YYYY-MM-DD.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "customerName": {
    "description": "The lodging customer name.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "duration": {
    "description": "The number of hotel stay days. Set to 1 for no show.",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "extraChargesDetail": {
    "description": "Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NotUsed.",
    "type": "Array",
    "items": {
      "type": "POST_LodgingExtraChargesDetail/v1/sale"
    },
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotUsed",
        "Reserved",
        "Restaurant",
        "GiftShop",
        "MiniBar",
        "Telephone",
        "Other",
        "Laundry"
      ]
    },
    "paramValues": {
      "max": "100",
      "defaultValue": "NotUsed"
    },
    "required": false
  },
  "noShow": {
    "description": "Set to true to indicate no show. Otherwise, value defaults to false.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "prestigiousPropertyCode": {
    "description": "The lodging prestigious property code. For an empty or invalid value, this parameter defaults to NonParticipant.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NonParticipant",
        "FiveHundredDollarLimit",
        "OneThousandDollarLimit",
        "OneThousandFiveHundredDollarLimit"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "NonParticipant"
    },
    "required": false
  },
  "roomAmount": {
    "description": "The nightly rate for one room.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "specialProgramCode": {
    "description": "The lodging special program code. For an empty or invalid value, this parameter defaults to Default.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Sale",
        "NoShow",
        "AdvanceDeposit"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Default"
    },
    "required": false
  }
}
StoreCard 
{
  "Id": {
    "description": "The ID of a StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "Password": {
    "description": "The password of StoreCard.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

SaleResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "approvedAmount": "double",
  "balanceAmount": "double",
  "balanceCurrencyCode": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "cashbackAmount": "double",
  "convenienceFeeAmount": "double",
  "currencyCode": "string",
  "debitSurchargeAmount": "double",
  "ebtType": "string",
  "emv": {
    "applicationIdentifier": "string",
    "applicationLabel": "string",
    "applicationPreferredName": "string",
    "applicationTransactionCounter": "string",
    "cryptogram": "string",
    "issuerCodeTableIndex": "string",
    "pinBypassed": "boolean",
    "tags": {
      "key": "string",
      "value": "string"
    }
  },
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "fsaCard": "string",
  "isApproved": "boolean",
  "isCardInserted": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "networkLabel": "string",
  "networkTransactionId": "string",
  "nonFinancialData": {
    "cardEntryMode": "string",
    "track1": "string",
    "track2": "string",
    "track3": "string"
  },
  "paymentType": "string",
  "pinVerified": "boolean",
  "quickChipMessage": "string",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "tipAmount": "double",
  "tokenId": "string",
  "tokenProvider": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
SaleResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double 10 The amount approved by the processor. This is the actual amount that will be charged or credited.
balanceAmount false double 13 The balance of the gift card.
balanceCurrencyCode false string 4 The balance currency code.
Values:
  • None
  • Usd
binValue false string 6 The BIN entry that matched the account number.
cardHolderName false string 80 The cardholder name.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
cashbackAmount false double 10 The cashback amount the cardholder wants.
convenienceFeeAmount false double 10 The convenience fee added to the transaction
currencyCode false string 4 The currency code used in the transaction.
Values:
  • None
  • Usd
debitSurchargeAmount false double 8 The surcharge amount that was added to the transaction.
ebtType false string 16 The type of the EBT card
Values:
  • None
  • FoodStamp
  • CashBenefit
emv false Emv The fields used on the receipt for an EMV transaction. Null if the transaction was not EMV.
entryMode false string 32 Description of how card was entered.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
fsaCard false string 32 Indicates whether the card used was a FSA card.
Note: Maybe = No BIN entry to determine if FSA.
Values:
  • NotApplicable
  • No
  • Yes
  • Maybe
isApproved false boolean 5 Set to true if the host approved the transaction.
isCardInserted false boolean 5 Indicates whether the EMV card was still inserted into the payment device when the transaction completed.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
networkLabel false string 30 Label that shows the network where the transaction was routed for authorization
networkTransactionId false string 40 The card brand specific transaction ID that should be stored by the integrator.
nonFinancialData false NonFinancialCard Non Financial data.
paymentType false string 16 Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
  • Ebt
pinVerified false boolean 5 True if the PIN was verified, false if not verified or undetermined.
quickChipMessage false string 500 The message unique to QuickChip pre-read functionality only.
signature false Signature The signature data.
statusCode false string 40 The status code for the transaction.
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
subTotalAmount false double 10 The original amount sent for the transaction.
terminalId false string 40 The ID of the terminal used during the transaction
tipAmount false double 12 The tip amount added to the transaction.
tokenId false string 100 The Token ID.
tokenProvider false string 32 The Token Provider.
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Emv
Field Required Data Type Max Length Default Value Description
applicationIdentifier false string 16 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 false string 16 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 false string 16 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.
applicationTransactionCounter false string 2 The application transaction counter.
cryptogram false string 60 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.
issuerCodeTableIndex false string 2 Indicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name.
pinBypassed false boolean 5 undefined
tags false Array<Tag> A name value collection of additional EMV tags that are required to appear on the receipt.
Tag
Field Required Data Type Max Length Default Value Description
key false string 10 undefined
value false string 64 undefined
NonFinancialCard
Field Required Data Type Max Length Default Value Description
cardEntryMode false string 32 Card entry mode
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
  • FSwipe
track1 false string 79 Track 1 of the non-financial card
track2 false string 40 Track 2 of the non-financial card
track3 false string 128 Track 3 of the non-financial card
Signature
Field Required Data Type Max Length Default Value Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string 32 The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string 50 Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
  • SignatureRequiredButPromptSuppressedByMerchant
  • SignatureNotRequiredByUnattendedPinPad
SaleResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved by the processor. This is the actual amount that will be charged or credited.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceAmount": {
    "description": "The balance of the gift card.",
    "type": "double",
    "paramValues": {
      "max": "13",
      "defaultValue": ""
    },
    "required": false
  },
  "balanceCurrencyCode": {
    "description": "The balance currency code.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderName": {
    "description": "The cardholder name.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "cashbackAmount": {
    "description": "The cashback amount the cardholder wants.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Usd"
      ]
    },
    "paramValues": {
      "max": "4",
      "defaultValue": ""
    },
    "required": false
  },
  "debitSurchargeAmount": {
    "description": "The surcharge amount that was added to the transaction.",
    "type": "double",
    "paramValues": {
      "max": "8",
      "defaultValue": ""
    },
    "required": false
  },
  "ebtType": {
    "description": "The type of the EBT card",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "FoodStamp",
        "CashBenefit"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "emv": {
    "description": "The fields used on the receipt for an EMV transaction. Null if the transaction was not EMV.",
    "type": "Emv",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "fsaCard": {
    "description": "Indicates whether the card used was a FSA card.<br />Note: Maybe = No BIN entry to determine if FSA.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotApplicable",
        "No",
        "Yes",
        "Maybe"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isCardInserted": {
    "description": "Indicates whether the EMV card was still inserted into the payment device when the transaction completed.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "networkLabel": {
    "description": "Label that shows the network where the transaction was routed for authorization",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "networkTransactionId": {
    "description": "The card brand specific transaction ID that should be stored by the integrator.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "nonFinancialData": {
    "description": "Non Financial data.",
    "type": "NonFinancialCard",
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift",
        "Ebt"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "quickChipMessage": {
    "description": "The message unique to QuickChip pre-read functionality only.",
    "type": "string",
    "paramValues": {
      "max": "500",
      "defaultValue": ""
    },
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "subTotalAmount": {
    "description": "The original amount sent for the transaction.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount added to the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenId": {
    "description": "The Token ID.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenProvider": {
    "description": "The Token Provider.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Emv 
{
  "applicationIdentifier": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "applicationLabel": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "applicationPreferredName": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "applicationTransactionCounter": {
    "description": "The application transaction counter.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "cryptogram": {
    "description": "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.",
    "type": "string",
    "paramValues": {
      "max": "60",
      "defaultValue": ""
    },
    "required": false
  },
  "issuerCodeTableIndex": {
    "description": "Indicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "pinBypassed": {
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "tags": {
    "description": "A name value collection of additional EMV tags that are required to appear on the receipt.",
    "type": "Array",
    "items": {
      "$ref": "Tag"
    },
    "required": false
  }
}
Tag 
{
  "key": {
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "value": {
    "type": "string",
    "paramValues": {
      "max": "64",
      "defaultValue": ""
    },
    "required": false
  }
}
NonFinancialCard 
{
  "cardEntryMode": {
    "description": "Card entry mode",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd",
        "FSwipe"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "track1": {
    "description": "Track 1 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "79",
      "defaultValue": ""
    },
    "required": false
  },
  "track2": {
    "description": "Track 2 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "track3": {
    "description": "Track 3 of the non-financial card",
    "type": "string",
    "paramValues": {
      "max": "128",
      "defaultValue": ""
    },
    "required": false
  }
}
Signature 
{
  "data": {
    "description": "The byte array of the signature in the format specified by Format.",
    "type": "Array",
    "items": {
      "type": "byte"
    },
    "required": false
  },
  "format": {
    "description": "The format of the signature.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PointsLittleEndian",
        "PointsBigEndian",
        "Ascii3Byte"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "Indicates why a signature is or is not present.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "SignatureRequired",
        "SignaturePresent",
        "SignatureRequiredCancelledByCardholder",
        "SignatureRequiredNotSupportedByPinPad",
        "SignatureRequiredPinPadError",
        "SignatureNotRequiredByThresholdAmount",
        "SignatureNotRequiredByPaymentType",
        "SignatureNotRequiredByTransactionType",
        "SignatureRequiredButPromptSuppressedByMerchant",
        "SignatureNotRequiredByUnattendedPinPad"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if action is forward and if the requestIdToForward is missing or is not a valid GUID.
400 Returned if client sends in all 5 of the healthcare values as positive values.
400 Returned if any healthcare field has a negative value.
400 Returned if healthcare Total field is less than sum of the other healthcare fields.
400 Returned if action is store and the customer swipes a healthcare card.
400 Returned if MarketCode is not HotelLodging but the request includes lodging parameters on a valid lodging request.
400 Returned if the lodging checkInDate or checkOutDate is not in the ISO 8601 format of YYYY-MM-DD on a valid lodging request.
400 Returned if the lodging roomAmount is less than 0.00 on a valid lodging request.
400 Returned if the lodging duration is less than 0 on a valid lodging request.
400 Returned if the cashbackOptions maximumAmount is either not provided, or is not an integer greater than zero.
400 Returned if the cashbackOptions amountIncrement is not an integer greater than zero. If it is not provided, it will default to 1.
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
404 Returned if action is store or forward and if the given requestIdToForward cannot be found in the database.
500 Returned if action is store or forward and if an error occurs while saving the sale to the database.
500 Returned if action is store or forward and if the stored message cannot be deserialized into the original stored object.
500 Returned if action is store or forward and if the stored message content is blank.
500 Returned if action is store or forward and if triPOS is unable to pull the stored record from the database
POST
/api/v1/sale/{paymentAccountId} Creates a new payment account sale based on the passed in amounts

Parameters

Parameter Parameter Type Data Type Description
paymentAccountId path string The payment account ID.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
PaymentAccountSaleRequest body POST_PaymentAccountSaleRequest/v1/sale/{paymentAccountId} undefined

Request Class

PaymentAccountSaleRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "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"
  },
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "healthcare": {
    "clinic": "double",
    "dental": "double",
    "prescription": "double",
    "total": "double",
    "vision": "double"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string",
  "tipAmount": "double"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "marketCode": "string"
}
PaymentAccountSaleRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use for the card sale.
transactionAmount true double 10 0.00 The total transaction amount. This is the amount of funds to move on the card
address false POST_Address/v1/sale/{paymentAccountId} The cardholder address information for the transaction.
clerkNumber false string 10 An optional clerk number for reference.
configuration false POST_RequestConfiguration/v1/sale/{payme ntAccountId} Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double 10 0.00 The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
healthcare false POST_Healthcare/v1/sale/{paymentAccountI d} The healthcare section that contains all applicable healthcare-qualified amounts. more�
referenceNumber false string 50 A user defined reference number.
shiftId false string 10 An optional shift id for reference.
ticketNumber false string 50 An optional ticket number.
tipAmount false double 12 0.00 The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
Address
Field Required Data Type Max Length Default Value Description
billingAddress1 false string 50 The street address used for billing purposes.
billingAddress2 false string 50 The street address used for billing purposes.
billingCity false string 40 The name of the city used for billing purposes.
billingEmail false string 80 The e-mail address used for billing purposes.
billingName false string 100 The name used for billing purposes.
billingPhone false string 20 The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string 20 The postal code used for billing purposes.
billingState false string 30 The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
shippingAddress1 false string 50 The street address used for shipping purposes.
shippingAddress2 false string 50 The street address used for shipping purposes.
shippingCity false string 40 The name of the city used for shipping purposes.
shippingEmail false string 80 The e-mail address used for shipping purposes.
shippingName false string 100 The name used for shipping purposes.
shippingPhone false string 20 The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string 20 The postal code used for shipping purposes.
shippingState false string 30 The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
RequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
Healthcare
Field Required Data Type Max Length Default Value Description
clinic false double 12 The total amount of healthcare-qualified goods that fall into the category of 'clinic'.
dental false double 12 The total amount of healthcare-qualified goods that fall into the category of 'dental'.
prescription false double 12 The total amount of healthcare-qualified goods that fall into the category of 'prescription'.
total false double 12 The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.
vision false double 12 The total amount of healthcare-qualified goods that fall into the category of 'vision'.
PaymentAccountSaleRequest 
{
  "laneId": {
    "description": "Specifies which lane to use for the card sale.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/v1/sale/{paymentAccountId}",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/v1/sale/{paymentAccountId}",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "healthcare": {
    "description": "The healthcare section that contains all applicable healthcare-qualified amounts. <a href='../help/kb/healthcare.html'>more&raquo;</a>",
    "type": "POST_Healthcare/v1/sale/{paymentAccountId}",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": "0.00"
    },
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingState": {
    "description": "The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingState": {
    "description": "The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  }
}
Healthcare 
{
  "clinic": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'clinic'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "dental": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'dental'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "prescription": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'prescription'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "total": {
    "description": "The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "vision": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'vision'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

PaymentAccountSaleResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "approvalNumber": "string",
  "approvedAmount": "double",
  "avsResponseCode": "string",
  "cardLogo": "string",
  "convenienceFeeAmount": "double",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "paymentAccountId": "string",
  "paymentAccountReferenceNumber": "string",
  "referenceNumber": "string",
  "statusCode": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "tipAmount": "double",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
PaymentAccountSaleResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double 10 The amount approved by the processor. This is the actual amount that will be charged or credited.
avsResponseCode false string 2 The AVS response code.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double 10 The convenience fee added to the transaction
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
paymentAccountId false string 50 The payment account ID.
paymentAccountReferenceNumber false string 50 The payment account reference number.
referenceNumber false string 50 The reference number.
statusCode false string 40 The status code for the transaction.
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
subTotalAmount false double 10 The original amount sent for the transaction.
terminalId false string 40 The ID of the terminal used during the transaction
tipAmount false double 12 The tip amount added to the transaction.
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
PaymentAccountSaleResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved by the processor. This is the actual amount that will be charged or credited.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "avsResponseCode": {
    "description": "The AVS response code.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentAccountId": {
    "description": "The payment account ID.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "paymentAccountReferenceNumber": {
    "description": "The payment account reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "The reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "subTotalAmount": {
    "description": "The original amount sent for the transaction.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount added to the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
POST
/api/v1/sale/token Creates a new card sale using a token based on the passed in amounts

Implementation Notes

See OmniToken documentation for more information.

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
TokenSaleRequest body POST_TokenSaleRequest/v1/sale/token undefined

Request Class

TokenSaleRequest 
{
  "cardLogo": "string",
  "laneId": "int",
  "tokenId": "string",
  "tokenProvider": "string",
  "transactionAmount": "double",
  "vaultId": "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"
  },
  "autoRental": {
    "customerName": "string",
    "agreementNumber": "string",
    "vehicleClassCode": "string",
    "noShowIndicator": "string",
    "adjustmentData": {
      "amount": "double",
      "code": "string",
      "extraChargesDetail": "Array<POST_AutoRentalExtraChargesDetail/v1/sale/token>"
    },
    "pickupData": {
      "city": "string",
      "countryCode": "string",
      "date": "string",
      "location": "string",
      "state": "string"
    },
    "returnData": {
      "city": "string",
      "countryCode": "string",
      "date": "string",
      "locationId": "string",
      "state": "string",
      "distance": "int",
      "distanceUnit": "string"
    },
    "dailyRentalRate": "double",
    "weeklyRentalRate": "double",
    "insuranceCharges": "double",
    "duration": "int"
  },
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "expirationMonth": "string",
  "expirationYear": "string",
  "healthcare": {
    "clinic": "double",
    "dental": "double",
    "prescription": "double",
    "total": "double",
    "vision": "double"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string",
  "tipAmount": "double"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "marketCode": "string"
}
TokenSaleRequest
Field Required Data Type Max Length Default Value Description
cardLogo true string 20 The card logo of the card that the token represents.
Values:
  • Visa
  • MasterCard
  • Amex
  • Discover
  • Diners
  • StoredValue
  • Other
  • JCB
  • CarteBlanche
  • Interac
laneId true int Specifies which lane to use for the card sale.
tokenId true string 100 The token ID used for the sale.
tokenProvider true string 32 The type of token ID used for the sale.
Values:
  • OmniToken
transactionAmount true double 10 0.00 The total transaction amount. This is the amount of funds to move on the card
vaultId true string 10 The Vault ID used to create the token.
address false POST_Address/v1/sale/token The cardholder address information for the transaction.
autoRental false POST_AutoRental/v1/sale/token The auto rental parameters to be passed in for an auto rental transaction. more�
clerkNumber false string 10 An optional clerk number for reference.
configuration false POST_RequestConfiguration/v1/sale/token Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double 10 0.00 The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
expirationMonth false string 2 The expiration month of the card the token represents. Although this is not required, it is recommended for fraud protection.
expirationYear false string 2 The expiration year of the card the token represents. Although this is not required, it is recommended for fraud protection.
healthcare false POST_Healthcare/v1/sale/token The healthcare section that contains all applicable healthcare-qualified amounts. more�
referenceNumber false string 50 A user defined reference number.
shiftId false string 10 An optional shift id for reference.
ticketNumber false string 50 An optional ticket number.
tipAmount false double 12 0.00 The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
Address
Field Required Data Type Max Length Default Value Description
billingAddress1 false string 50 The street address used for billing purposes.
billingAddress2 false string 50 The street address used for billing purposes.
billingCity false string 40 The name of the city used for billing purposes.
billingEmail false string 80 The e-mail address used for billing purposes.
billingName false string 100 The name used for billing purposes.
billingPhone false string 20 The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string 20 The postal code used for billing purposes.
billingState false string 30 The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
shippingAddress1 false string 50 The street address used for shipping purposes.
shippingAddress2 false string 50 The street address used for shipping purposes.
shippingCity false string 40 The name of the city used for shipping purposes.
shippingEmail false string 80 The e-mail address used for shipping purposes.
shippingName false string 100 The name used for shipping purposes.
shippingPhone false string 20 The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string 20 The postal code used for shipping purposes.
shippingState false string 30 The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
AutoRental
Field Required Data Type Max Length Default Value Description
customerName false string 100 Customer Name.
agreementNumber false string 14 Agreement number.
vehicleClassCode false string 32 Classification of rental vehicle
Values:
  • Unused
  • Mini
  • Subcompact
  • Economy
  • Compact
  • Midsize
  • Intermediate
  • Standard
  • Fullsize
  • Luxury
  • Premium
  • Minivan
  • Van12Passenger
  • MovingVan
  • Van15Passenger
  • CargoVan
  • Truck12Foot
  • Truck20Foot
  • Truck24Foot
  • Truck26Foot
  • Moped
  • Stretch
  • Regular
  • Unique
  • Exotic
  • TruckSmallMedium
  • TruckLarge
  • SUVSmall
  • SUVMedium
  • SUVLarge
  • SUVExotic
  • FourWheelDrive
  • Special
  • Miscellaneous
noShowIndicator false string 32 No show indicator. Indicates whether rental vehicle was reserved, but not actually rented.
Values:
  • NotApplicable
  • NoShow
adjustmentData false POST_AutoRentalAdjustmentData/v1/sale/to ken Data related to any auto rental adjustments.
pickupData false POST_AutoRentalPickupData/v1/sale/token Data related to autorental pickup.
returnData false POST_AutoRentalReturnData/v1/sale/token Data related to autorental return.
dailyRentalRate false double 10 0 Rate charged per day Visa/MC � Daily rate required for Corp T&E rate III.
weeklyRentalRate false double 10 0 Rate charged per week Visa/MC � Weekly rate required for Corp T&E rate III.
insuranceCharges false double 10 0.00 If insurance is charged, the insurance amount should be provided.
duration false int 2 The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.
AutoRentalAdjustmentData
Field Required Data Type Max Length Default Value Description
amount false double 10 0.00 Adjustment amount.
code false string 40 Indicates if adjustment for mileage, fuel, vehicle damage, etc. was made to a rental agreement.
Values:
  • NoAdjustments
  • MultipleAdjustments
  • OneAdjustmentCardmemberNotified
  • OneAdjustmentCardmemberNotNotified
extraChargesDetail false Array<POST_AutoRentalExtraChargesDetail/v1/sal e/token> 100 NoExtraCharge Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NoExtraCharge.
Values:
  • NoExtraCharge
  • Gasoline
  • ExtraMileage
  • LateReturn
  • OneWayServiceFee
  • ParkingOrMovingViolation
AutoRentalPickupData
Field Required Data Type Max Length Default Value Description
city false string 18 Auto rental pickup city.
countryCode false string 3 Country code where vehicle was picked up. For US, use 840.
date false string 19 return date in yyyy-MM-ddTHH:mm:ss format.
location false string 38 Name of business where vehicle was picked up.
state false string 3 Abbreviation of state, province, or other country subdivision where vehicle was picked up.
AutoRentalReturnData
Field Required Data Type Max Length Default Value Description
city false string 18 Auto rental return city.
countryCode false string 3 Country code where vehicle was returned. For US, use 840.
date false string 19 return date in yyyy-MM-ddTHH:mm:ss format.
locationId false string 10 Auto Rental location ID where vehicle was returned.
state false string 3 Auto rental return state.
distance false int 5 Numeric distance traveled during rental period.
distanceUnit false string 16 Unit of measurement applicable to distance traveled.
Values:
  • 0 = Unused
  • 1 = Miles
  • 2 = Kilometers
RequestConfiguration
Field Required Data Type Max Length Default Value Description
allowPartialApprovals false boolean 5 false If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean 5 false If set to true, enables duplicate checking logic for the transaction at the host.
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
Healthcare
Field Required Data Type Max Length Default Value Description
clinic false double 12 The total amount of healthcare-qualified goods that fall into the category of 'clinic'.
dental false double 12 The total amount of healthcare-qualified goods that fall into the category of 'dental'.
prescription false double 12 The total amount of healthcare-qualified goods that fall into the category of 'prescription'.
total false double 12 The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.
vision false double 12 The total amount of healthcare-qualified goods that fall into the category of 'vision'.
TokenSaleRequest 
{
  "cardLogo": {
    "description": "The card logo of the card that the token represents.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Visa",
        "MasterCard",
        "Amex",
        "Discover",
        "Diners",
        "StoredValue",
        "Other",
        "JCB",
        "CarteBlanche",
        "Interac"
      ]
    },
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": true
  },
  "laneId": {
    "description": "Specifies which lane to use for the card sale.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "tokenId": {
    "description": "The token ID used for the sale.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": true
  },
  "tokenProvider": {
    "description": "The type of token ID used for the sale.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "OmniToken"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": true
  },
  "vaultId": {
    "description": "The Vault ID used to create the token.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/v1/sale/token",
    "required": false
  },
  "autoRental": {
    "description": "The auto rental parameters to be passed in for an auto rental transaction. <a href='../help/kb/autorental.html'>more&raquo;</a>",
    "type": "POST_AutoRental/v1/sale/token",
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/v1/sale/token",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The expiration month of the card the token represents. Although this is not required, it is recommended for fraud protection.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The expiration year of the card the token represents. Although this is not required, it is recommended for fraud protection.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "healthcare": {
    "description": "The healthcare section that contains all applicable healthcare-qualified amounts. <a href='../help/kb/healthcare.html'>more&raquo;</a>",
    "type": "POST_Healthcare/v1/sale/token",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": "0.00"
    },
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "billingState": {
    "description": "The name of the state used for billing purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "shippingState": {
    "description": "The name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRental 
{
  "customerName": {
    "description": "Customer Name.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "agreementNumber": {
    "description": "Agreement number.",
    "type": "string",
    "paramValues": {
      "max": "14",
      "defaultValue": ""
    },
    "required": false
  },
  "vehicleClassCode": {
    "description": "Classification of rental vehicle",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unused",
        "Mini",
        "Subcompact",
        "Economy",
        "Compact",
        "Midsize",
        "Intermediate",
        "Standard",
        "Fullsize",
        "Luxury",
        "Premium",
        "Minivan",
        "Van12Passenger",
        "MovingVan",
        "Van15Passenger",
        "CargoVan",
        "Truck12Foot",
        "Truck20Foot",
        "Truck24Foot",
        "Truck26Foot",
        "Moped",
        "Stretch",
        "Regular",
        "Unique",
        "Exotic",
        "TruckSmallMedium",
        "TruckLarge",
        "SUVSmall",
        "SUVMedium",
        "SUVLarge",
        "SUVExotic",
        "FourWheelDrive",
        "Special",
        "Miscellaneous"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "noShowIndicator": {
    "description": "No show indicator. Indicates whether rental vehicle was reserved, but not actually rented.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotApplicable",
        "NoShow"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "adjustmentData": {
    "description": "Data related to any auto rental adjustments.",
    "type": "POST_AutoRentalAdjustmentData/v1/sale/token",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "pickupData": {
    "description": "Data related to autorental pickup.",
    "type": "POST_AutoRentalPickupData/v1/sale/token",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "returnData": {
    "description": "Data related to autorental return.",
    "type": "POST_AutoRentalReturnData/v1/sale/token",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "dailyRentalRate": {
    "description": "Rate charged per day Visa/MC � Daily rate required for Corp T&E rate III.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0"
    },
    "required": false
  },
  "weeklyRentalRate": {
    "description": "Rate charged per week Visa/MC � Weekly rate required for Corp T&E rate III.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0"
    },
    "required": false
  },
  "insuranceCharges": {
    "description": "If insurance is charged, the insurance amount should be provided.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "duration": {
    "description": "The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals.",
    "type": "int",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRentalAdjustmentData 
{
  "amount": {
    "description": "Adjustment amount.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": "0.00"
    },
    "required": false
  },
  "code": {
    "description": "Indicates if adjustment for mileage, fuel, vehicle damage, etc. was made to a rental agreement.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NoAdjustments",
        "MultipleAdjustments",
        "OneAdjustmentCardmemberNotified",
        "OneAdjustmentCardmemberNotNotified"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "extraChargesDetail": {
    "description": "Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NoExtraCharge.",
    "type": "Array",
    "items": {
      "type": "POST_AutoRentalExtraChargesDetail/v1/sale/token"
    },
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NoExtraCharge",
        "Gasoline",
        "ExtraMileage",
        "LateReturn",
        "OneWayServiceFee",
        "ParkingOrMovingViolation"
      ]
    },
    "paramValues": {
      "max": "100",
      "defaultValue": "NoExtraCharge"
    },
    "required": false
  }
}
AutoRentalPickupData 
{
  "city": {
    "description": "Auto rental pickup city.",
    "type": "string",
    "paramValues": {
      "max": "18",
      "defaultValue": ""
    },
    "required": false
  },
  "countryCode": {
    "description": "Country code where vehicle was picked up. For US, use 840.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "date": {
    "description": "return date in yyyy-MM-ddTHH:mm:ss format.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "location": {
    "description": "Name of business where vehicle was picked up.",
    "type": "string",
    "paramValues": {
      "max": "38",
      "defaultValue": ""
    },
    "required": false
  },
  "state": {
    "description": "Abbreviation of state, province, or other country subdivision where vehicle was picked up.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  }
}
AutoRentalReturnData 
{
  "city": {
    "description": "Auto rental return city.",
    "type": "string",
    "paramValues": {
      "max": "18",
      "defaultValue": ""
    },
    "required": false
  },
  "countryCode": {
    "description": "Country code where vehicle was returned. For US, use 840.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "date": {
    "description": "return date in yyyy-MM-ddTHH:mm:ss format.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "locationId": {
    "description": "Auto Rental location ID where vehicle was returned.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "state": {
    "description": "Auto rental return state.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "distance": {
    "description": "Numeric distance traveled during rental period.",
    "type": "int",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "distanceUnit": {
    "description": "Unit of measurement applicable to distance traveled.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "0 = Unused",
        "1 = Miles",
        "2 = Kilometers"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, enables duplicate checking logic for the transaction at the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  }
}
Healthcare 
{
  "clinic": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'clinic'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "dental": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'dental'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "prescription": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'prescription'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "total": {
    "description": "The total amount of healthcare-qualified goods. If any healthcare values are included, this value is required to be present.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "vision": {
    "description": "The total amount of healthcare-qualified goods that fall into the category of 'vision'.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

TokenSaleResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "approvedAmount": "double",
  "avsResponseCode": "string",
  "cardLogo": "string",
  "convenienceFeeAmount": "double",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "referenceNumber": "string",
  "statusCode": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "tipAmount": "double",
  "tokenId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
TokenSaleResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double 10 The amount approved by the processor. This is the actual amount that will be charged or credited.
avsResponseCode false string 2 The AVS response code.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double 10 The convenience fee added to the transaction
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
referenceNumber false string 50 The reference number.
statusCode false string 40 The status code for the transaction.
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
subTotalAmount false double 10 The original amount sent for the transaction.
terminalId false string 40 The ID of the terminal used during the transaction
tipAmount false double 12 The tip amount added to the transaction.
tokenId false string 100 The token ID.
totalAmount false double 12 The total amount of the transaction.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
TokenSaleResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved by the processor. This is the actual amount that will be charged or credited.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "avsResponseCode": {
    "description": "The AVS response code.",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "referenceNumber": {
    "description": "The reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "subTotalAmount": {
    "description": "The original amount sent for the transaction.",
    "type": "double",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount added to the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenId": {
    "description": "The token ID.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
POST
/api/v1/scrollingDisplay Displays an item on an area of the PIN pad screen that scrolls as items are added.

Implementation Notes

Use the scrolling display endpoint to repeatedly add items to a scroll area of the PIN pad screen while displaying the subtotal, tax, and total of the transaction. This endpoint returns an HTTP status code of 200 if the text was successfully displayed on the PIN pad. See scrolling display documentation fore more information.

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
ScrollingDisplayRequest body POST_ScrollingDisplayRequest/v1/scrollingDisplay undefined

Request Class

ScrollingDisplayRequest 
{
  "laneId": "int",
  "lineItem": "string",
  "subtotal": "string",
  "tax": "string",
  "total": "string"
}
ScrollingDisplayRequest
Field Required Data Type Max Length Default Value Description
laneId true int The lane ID.
lineItem true string 256 The new text line to be added in the scrolling area of the PIN pad screen. It typically includes a description and the price of an individual item (i.e. Cookies... $3.99).
subtotal true string 16 The new subtotal of all the scanned items including the new line item.
tax true string 16 The tax value of the new subtotal.
total true string 12 The value of the new subtotal and tax.
ScrollingDisplayRequest 
{
  "laneId": {
    "description": "The lane ID.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "lineItem": {
    "description": "The new text line to be added in the scrolling area of the PIN pad screen. It typically includes a description and the price of an individual item (i.e. Cookies... $3.99).",
    "type": "string",
    "paramValues": {
      "max": "256",
      "defaultValue": ""
    },
    "required": true
  },
  "subtotal": {
    "description": "The new subtotal of all the scanned items including the new line item.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "tax": {
    "description": "The tax value of the new subtotal.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": true
  },
  "total": {
    "description": "The value of the new subtotal and tax.",
    "type": "string",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": true
  }
}

Response Class

DisplayResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  }
}
DisplayResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
DisplayResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if parameter values are missing or invalid.
GET
/api/v1/selection The list of links for the selection endpoints including only lanes with a pinpad capable of selection entry

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

SelectionDiscoveryResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  }
}
SelectionDiscoveryResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
SelectionDiscoveryResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
GET
/api/v1/selection/{laneId} Displays the specified selection form

Implementation Notes

Use the selection endpoint to get cardholder selections via the pinpad. See selection documentation for more information.

Parameters

Parameter Parameter Type Data Type Description
form query string The selection form to display. more�
header query string The header text to display to the cardholder. This is only used for the YesNoTextArea or MultiOptionTextArea form.
subHeader query string The subheader text to display to the cardholder. This is only used for the YesNoTextArea or MultiOptionTextArea form.
text query string The text to display to the cardholder. For the MultiOption form, this is the prompt text. For the YesNoTextArea form, this is the text for the text area. Use | (pipe) for newline.
multiLineText query string The list of individual lines of text to be displayed on the PIN pad. Separate each text with a pipe '|' (e.g. multiLineText=promptLine1|promptLine2). For the MultiOption form, this is the prompt text.
options query string The selection options to provide to the cardholder. Separate each option with a pipe '|' (e.g. options=one|two|three). This is only used with the MultiOption and MultiOptionTextArea forms.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

SelectionResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "selectionIndex": "int"
}
SelectionResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
selectionIndex false int 10 For the YesNoTextArea form, selectionIndex will be 0 when the cardholder selects No and 1 when the cardholder selects Yes. For the MultiOption form, selectionIndex is the zero-based index of the option that the cardholder selected. The first option specified will be considered option 0.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
SelectionResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "selectionIndex": {
    "description": "For the YesNoTextArea form, selectionIndex will be 0 when the cardholder selects No and 1 when the cardholder selects Yes. For the MultiOption form, selectionIndex is the zero-based index of the option that the cardholder selected. The first option specified will be considered option 0.",
    "type": "int",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 Returned if either the 'text' or 'options' parameter is empty when the form is 'MultiOption' or if the 'options' parameter is empty when the form is MultiOptionTextArea.
400 Returned if the 'form' parameter is empty or invalid.
500 Returned if the cardholder doesn't respond within the specified amount of time.
GET
/api/v1/signature The list of links for the signature endpoints including only lanes with a pinpad capable of signature entry

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

SignatureResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  }
}
SignatureResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
SignatureResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
GET
/api/v1/signature/{laneId} Displays the specified signature form

Implementation Notes

Use the signature endpoint to get a cardholder signature via the pinpad. See signature documentation for more information.

Parameters

Parameter Parameter Type Data Type Description
laneId path int The lane ID.
header query string The header text to display to the cardholder.
subHeader query string The subheader text to display to the cardholder.
text query string The text to display to the cardholder.
form query string The signature form to display. Options are 'simple' and 'contract'. more �
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

GetLaneSignatureResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "laneId": "int",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  }
}
GetLaneSignatureResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
laneId false int The lane ID.
signature false Signature Signature data returned from the pinpad.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
Signature
Field Required Data Type Max Length Default Value Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string 32 The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string 50 Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
  • SignatureRequiredButPromptSuppressedByMerchant
  • SignatureNotRequiredByUnattendedPinPad
GetLaneSignatureResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "laneId": {
    "description": "The lane ID.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "signature": {
    "description": "Signature data returned from the pinpad.",
    "type": "Signature",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
Signature 
{
  "data": {
    "description": "The byte array of the signature in the format specified by Format.",
    "type": "Array",
    "items": {
      "type": "byte"
    },
    "required": false
  },
  "format": {
    "description": "The format of the signature.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PointsLittleEndian",
        "PointsBigEndian",
        "Ascii3Byte"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "Indicates why a signature is or is not present.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "SignatureRequired",
        "SignaturePresent",
        "SignatureRequiredCancelledByCardholder",
        "SignatureRequiredNotSupportedByPinPad",
        "SignatureRequiredPinPadError",
        "SignatureNotRequiredByThresholdAmount",
        "SignatureNotRequiredByPaymentType",
        "SignatureNotRequiredByTransactionType",
        "SignatureRequiredButPromptSuppressedByMerchant",
        "SignatureNotRequiredByUnattendedPinPad"
      ]
    },
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}
GET
/api/v1/status Return a list of the triPOS status endpoints

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

StatusResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  }
}
StatusResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
StatusResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken are not provided in the HTTP request header or in the config file.
GET
/api/v1/status/host Get host status

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

HostStatusResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "hostStatus": "string",
  "merchantId": "string",
  "transactionDateTime": "string"
}
HostStatusResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
hostStatus false string 32 The status of the connection between triPOS and the host.
Values:
  • Online
  • HostUnreachable
  • Offline
merchantId false string 50 The merchant ID.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
HostStatusResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "hostStatus": {
    "description": "The status of the connection between triPOS and the host.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Online",
        "HostUnreachable",
        "Offline"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
GET
/api/v1/status/lane/{laneId} Returns the current status of the given lane

Parameters

Parameter Parameter Type Data Type Description
laneId path int The lane ID.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

LaneStatusResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "laneStatus": "string"
}
LaneStatusResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
laneStatus false string 32 The status of the lane.
Values:
  • NotInUse
  • Pipeline
  • PinPad
  • Host
  • ShuttingDown
  • Initializing
  • PromptingForCardInput
  • PromptingToConfirmAmount
  • PromptingToConfirmCashBack
  • PromptingForCashBackAmount
  • PromptingToConfirmTipAmount
  • PromptingToConfirmTotalAmount
  • PromptingForPinEntry
  • PromptingFinishPreProcessing
  • PromptingProcessing
  • PromptingToRemoveCard
  • PromptingForQuickChipPreRead
  • CompletingQuickChipPreRead
  • PromptingToConfirmConvenienceFeeAmount
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
LaneStatusResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "laneStatus": {
    "description": "The status of the lane.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "NotInUse",
        "Pipeline",
        "PinPad",
        "Host",
        "ShuttingDown",
        "Initializing",
        "PromptingForCardInput",
        "PromptingToConfirmAmount",
        "PromptingToConfirmCashBack",
        "PromptingForCashBackAmount",
        "PromptingToConfirmTipAmount",
        "PromptingToConfirmTotalAmount",
        "PromptingForPinEntry",
        "PromptingFinishPreProcessing",
        "PromptingProcessing",
        "PromptingToRemoveCard",
        "PromptingForQuickChipPreRead",
        "CompletingQuickChipPreRead",
        "PromptingToConfirmConvenienceFeeAmount"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
GET
/api/v1/status/triPOS/{echo} Echos the text passed to triPOS. A successful echo indicates that triPOS is running and responding to requests

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

TriPosStatusResponse 
{
  "_type": "string",
  "echo": "string"
}
TriPosStatusResponse
Field Required Data Type Max Length Default Value Description
_type false string 100 The type of object held in the result.
echo false string 256 Provided text to be echoed back in the response.
TriPosStatusResponse 
{
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "echo": {
    "description": "Provided text to be echoed back in the response.",
    "type": "string",
    "paramValues": {
      "max": "256",
      "defaultValue": ""
    },
    "required": false
  }
}
GET
/api/v1/storedtransactions Retrieve all the stored transactions from the database.

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

GetStoredTransactionsResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "storedTransactions": {
    "createdDate": "Date",
    "response": "string",
    "state": "string",
    "totalAmount": "double",
    "tpRequestId": {},
    "transactionId": "string",
    "transactionType": "string"
  }
}
GetStoredTransactionsResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
storedTransactions false Array<StoredTransaction> List of transactions stored in the database
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
StoredTransaction
Field Required Data Type Max Length Default Value Description
createdDate false Date 27 The date the transaction was stored.
response false string The response from the host after forwarding the transaction.
state false string 16 The state of the transaction.
Values:
  • Stored
  • Processing
  • Processed
  • Error
  • Deleted
totalAmount false double 12 The total amount of the transaction.
tpRequestId false Guid 32 The request Id.
transactionId false string 19 transaction Id from the host after forwarding the transaction.
transactionType false string 32 The transaction type.
Values:
  • Unknown
  • CardRead
  • Authorization
  • Capture
  • IncrementalAuthorization
  • Sale
  • ForcePost
  • Refund
  • SaleAdjustment
  • RefundAdjustment
  • Reversal
  • PartialReversal
  • SystemReversal
  • CreateToken
  • CreatePaymetricTokenByTransId
  • CreatePaymetricToken
  • UpdateToken
  • DeleteToken
  • BinQuery
  • Echo
  • Activate
  • BalanceInquiry
  • Reload
  • Unload
  • BalanceTransfer
  • Close
  • AuthorizationCompletion
  • Report
  • Void
  • TransactionUpdate
  • EbtVoucher
Guid
Field Required Data Type Max Length Default Value Description
GetStoredTransactionsResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "storedTransactions": {
    "description": "List of transactions stored in the database",
    "type": "Array",
    "items": {
      "$ref": "StoredTransaction"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
StoredTransaction 
{
  "createdDate": {
    "description": "The date the transaction was stored.",
    "type": "Date",
    "paramValues": {
      "max": "27",
      "defaultValue": ""
    },
    "required": false
  },
  "response": {
    "description": "The response from the host after forwarding the transaction.",
    "type": "string",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "state": {
    "description": "The state of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Stored",
        "Processing",
        "Processed",
        "Error",
        "Deleted"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "tpRequestId": {
    "description": "The request Id.",
    "type": "Guid",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "transaction Id from the host after forwarding the transaction.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionType": {
    "description": "The transaction type.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "CardRead",
        "Authorization",
        "Capture",
        "IncrementalAuthorization",
        "Sale",
        "ForcePost",
        "Refund",
        "SaleAdjustment",
        "RefundAdjustment",
        "Reversal",
        "PartialReversal",
        "SystemReversal",
        "CreateToken",
        "CreatePaymetricTokenByTransId",
        "CreatePaymetricToken",
        "UpdateToken",
        "DeleteToken",
        "BinQuery",
        "Echo",
        "Activate",
        "BalanceInquiry",
        "Reload",
        "Unload",
        "BalanceTransfer",
        "Close",
        "AuthorizationCompletion",
        "Report",
        "Void",
        "TransactionUpdate",
        "EbtVoucher"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}
Guid 
{}
DELETE
/api/v1/storedtransactions/{requestIDToDelete} Marks the given stored transaction for deletion

Parameters

Parameter Parameter Type Data Type Description
requestIDToDelete path string The request ID of the stored transaction
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
DeleteStoredTransactionRequest body DELETE_DeleteStoredTransactionRequest/v1/storedtransactions/{requestIDToDelete} undefined

Request Class

DeleteStoredTransactionRequest 
{}
DeleteStoredTransactionRequest
Field Required Data Type Max Length Default Value Description
DeleteStoredTransactionRequest 
{}

Response Class

DeleteStoredTransactionResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "storedTransaction": {
    "createdDate": "Date",
    "response": "string",
    "state": "string",
    "totalAmount": "double",
    "tpRequestId": {},
    "transactionId": "string",
    "transactionType": "string"
  }
}
DeleteStoredTransactionResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
storedTransaction false StoredTransaction Stored transaction marked for deletion
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
StoredTransaction
Field Required Data Type Max Length Default Value Description
createdDate false Date 27 The date the transaction was stored.
response false string The response from the host after forwarding the transaction.
state false string 16 The state of the transaction.
Values:
  • Stored
  • Processing
  • Processed
  • Error
  • Deleted
totalAmount false double 12 The total amount of the transaction.
tpRequestId false Guid 32 The request Id.
transactionId false string 19 transaction Id from the host after forwarding the transaction.
transactionType false string 32 The transaction type.
Values:
  • Unknown
  • CardRead
  • Authorization
  • Capture
  • IncrementalAuthorization
  • Sale
  • ForcePost
  • Refund
  • SaleAdjustment
  • RefundAdjustment
  • Reversal
  • PartialReversal
  • SystemReversal
  • CreateToken
  • CreatePaymetricTokenByTransId
  • CreatePaymetricToken
  • UpdateToken
  • DeleteToken
  • BinQuery
  • Echo
  • Activate
  • BalanceInquiry
  • Reload
  • Unload
  • BalanceTransfer
  • Close
  • AuthorizationCompletion
  • Report
  • Void
  • TransactionUpdate
  • EbtVoucher
Guid
Field Required Data Type Max Length Default Value Description
DeleteStoredTransactionResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "storedTransaction": {
    "description": "Stored transaction marked for deletion",
    "type": "StoredTransaction",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
StoredTransaction 
{
  "createdDate": {
    "description": "The date the transaction was stored.",
    "type": "Date",
    "paramValues": {
      "max": "27",
      "defaultValue": ""
    },
    "required": false
  },
  "response": {
    "description": "The response from the host after forwarding the transaction.",
    "type": "string",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "state": {
    "description": "The state of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Stored",
        "Processing",
        "Processed",
        "Error",
        "Deleted"
      ]
    },
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "paramValues": {
      "max": "12",
      "defaultValue": ""
    },
    "required": false
  },
  "tpRequestId": {
    "description": "The request Id.",
    "type": "Guid",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "transaction Id from the host after forwarding the transaction.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionType": {
    "description": "The transaction type.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "CardRead",
        "Authorization",
        "Capture",
        "IncrementalAuthorization",
        "Sale",
        "ForcePost",
        "Refund",
        "SaleAdjustment",
        "RefundAdjustment",
        "Reversal",
        "PartialReversal",
        "SystemReversal",
        "CreateToken",
        "CreatePaymetricTokenByTransId",
        "CreatePaymetricToken",
        "UpdateToken",
        "DeleteToken",
        "BinQuery",
        "Echo",
        "Activate",
        "BalanceInquiry",
        "Reload",
        "Unload",
        "BalanceTransfer",
        "Close",
        "AuthorizationCompletion",
        "Report",
        "Void",
        "TransactionUpdate",
        "EbtVoucher"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  }
}
Guid 
{}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
404 The stored transaction could not be found. No action taken, tripos returns an HTTP status code of 404.
POST
/api/v1/token/omni Creates a Omni token based on a card swipe

Implementation Notes

This endpoint is for swipe capable omni token creation.

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
CreateOmniTokenRequest body POST_CreateOmniTokenRequest/v1/token/omni undefined

Request Class

CreateOmniTokenRequest 
{
  "laneId": "int",
  "invokeManualEntry": "boolean",
  "isCscSupported": "string",
  "vaultId": "string"
}
CreateOmniTokenRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
invokeManualEntry false boolean 5 false Invokes manual card entry.
isCscSupported false string 5 false Invokes prompt for cardholder to enter card security code for manual keyed card entry.
vaultId false string 10 The Vault ID with Omni.
CreateOmniTokenRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "invokeManualEntry": {
    "description": "Invokes manual card entry.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "isCscSupported": {
    "description": "Invokes prompt for cardholder to enter card security code for manual keyed card entry.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  },
  "vaultId": {
    "description": "The Vault ID with Omni.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

CreateOmniTokenResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isOffline": "boolean",
  "merchantId": "string",
  "tokenId": "string",
  "tokenProvider": "string",
  "transactionDateTime": "string"
}
CreateOmniTokenResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
binValue false string 6 The card bin value. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest.
cardHolderName false string 80 The card holder name on the card. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest. If the card is keyed for a CreateOmniTokenRequest this value will be empty.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
entryMode false string 32 Description of how card was entered. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The merchant ID used to process the transaction.
tokenId false string 100 The Token ID.
tokenProvider false string 32 The Token Provider.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
CreateOmniTokenResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The card bin value. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderName": {
    "description": "The card holder name on the card. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest. If the card is keyed for a CreateOmniTokenRequest this value will be empty.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenId": {
    "description": "The Token ID.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenProvider": {
    "description": "The Token Provider.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
500 The token could not be created with the card used.
POST
/api/v1/token/omni/{transactionId} Creates a Omni token based on a previous transaction ID

Parameters

Parameter Parameter Type Data Type Description
transactionId path string The ID of a previous transaction.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
CreateOmniTokenWithTransIdRequest body POST_CreateOmniTokenWithTransIdRequest/v1/token/omni/{transactionId} undefined

Request Class

CreateOmniTokenWithTransIdRequest 
{
  "laneId": "int",
  "vaultId": "string"
}
CreateOmniTokenWithTransIdRequest
Field Required Data Type Max Length Default Value Description
laneId true int The lane ID.
vaultId false string 10 The Vault ID with Omni.
CreateOmniTokenWithTransIdRequest 
{
  "laneId": {
    "description": "The lane ID.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "vaultId": {
    "description": "The Vault ID with Omni.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  }
}

Response Class

CreateOmniTokenResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isOffline": "boolean",
  "merchantId": "string",
  "tokenId": "string",
  "tokenProvider": "string",
  "transactionDateTime": "string"
}
CreateOmniTokenResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
binValue false string 6 The card bin value. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest.
cardHolderName false string 80 The card holder name on the card. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest. If the card is keyed for a CreateOmniTokenRequest this value will be empty.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
entryMode false string 32 Description of how card was entered. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The merchant ID used to process the transaction.
tokenId false string 100 The Token ID.
tokenProvider false string 32 The Token Provider.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
CreateOmniTokenResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The card bin value. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderName": {
    "description": "The card holder name on the card. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest. If the card is keyed for a CreateOmniTokenRequest this value will be empty.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenId": {
    "description": "The Token ID.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenProvider": {
    "description": "The Token Provider.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
500 The token could not be created with the transaction ID given.
POST
/api/v1/token/paymetric Creates a Paymetric token based on a card swipe

Implementation Notes

This endpoint is for swipe capable paymetric token creation.

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
CreatePaymetricTokenRequest body POST_CreatePaymetricTokenRequest/v1/token/paymetric undefined

Request Class

CreatePaymetricTokenRequest 
{
  "laneId": "int",
  "vaultId": "string",
  "invokeManualEntry": "boolean",
  "isCscSupported": "string"
}
CreatePaymetricTokenRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
vaultId true string 10 The Vault ID with Paymetric.
invokeManualEntry false boolean 5 Invokes manual card entry.
isCscSupported false string 5 false Invokes prompt for cardholder to enter card security code for manual keyed card entry.
CreatePaymetricTokenRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "vaultId": {
    "description": "The Vault ID with Paymetric.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  },
  "invokeManualEntry": {
    "description": " Invokes manual card entry.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isCscSupported": {
    "description": "Invokes prompt for cardholder to enter card security code for manual keyed card entry.",
    "type": "string",
    "paramValues": {
      "max": "5",
      "defaultValue": "false"
    },
    "required": false
  }
}

Response Class

CreatePaymetricTokenResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isOffline": "boolean",
  "merchantId": "string",
  "tokenId": "string",
  "tokenProvider": "string",
  "transactionDateTime": "string"
}
CreatePaymetricTokenResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
binValue false string 6 The card bin value. This value is only provided for a CreatePaymetricTokenRequest NOT for a CreatePaymetricTokenWithTransIdRequest.
cardHolderName false string 80 The card holder name on the card. This value is only provided for a CreatePaymetricTokenRequest NOT for a CreatePaymetricTokenWithTransIdRequest. If the card is keyed for a CreatePaymetricTokenRequest this value will be empty.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
entryMode false string 32 Description of how card was entered. This value is only provided for a CreatePaymetricTokenRequest NOT for a CreatePaymetricTokenWithTransIdRequest.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The merchant ID used to process the transaction.
tokenId false string 100 The Token ID.
tokenProvider false string 32 The Token Provider.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
CreatePaymetricTokenResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The card bin value. This value is only provided for a CreatePaymetricTokenRequest NOT for a CreatePaymetricTokenWithTransIdRequest.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderName": {
    "description": "The card holder name on the card. This value is only provided for a CreatePaymetricTokenRequest NOT for a CreatePaymetricTokenWithTransIdRequest. If the card is keyed for a CreatePaymetricTokenRequest this value will be empty.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered. This value is only provided for a CreatePaymetricTokenRequest NOT for a CreatePaymetricTokenWithTransIdRequest.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenId": {
    "description": "The Token ID.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenProvider": {
    "description": "The Token Provider.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
500 The token could not be created with the card used.
POST
/api/v1/token/paymetric/{transactionId} Creates a Paymetric token based on a previous transaction ID

Parameters

Parameter Parameter Type Data Type Description
transactionId path string The ID of a previous transaction.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
CreatePaymetricTokenWithTransIdRequest body POST_CreatePaymetricTokenWithTransIdRequest/v1/token/paymetric/{transactionId} undefined

Request Class

CreatePaymetricTokenWithTransIdRequest 
{
  "laneId": "int",
  "vaultId": "string"
}
CreatePaymetricTokenWithTransIdRequest
Field Required Data Type Max Length Default Value Description
laneId true int The lane ID.
vaultId true string 10 The Vault ID with Paymetric.
CreatePaymetricTokenWithTransIdRequest 
{
  "laneId": {
    "description": "The lane ID.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "vaultId": {
    "description": "The Vault ID with Paymetric.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": true
  }
}

Response Class

CreatePaymetricTokenResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isOffline": "boolean",
  "merchantId": "string",
  "tokenId": "string",
  "tokenProvider": "string",
  "transactionDateTime": "string"
}
CreatePaymetricTokenResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The card account number.
binValue false string 6 The card bin value. This value is only provided for a CreatePaymetricTokenRequest NOT for a CreatePaymetricTokenWithTransIdRequest.
cardHolderName false string 80 The card holder name on the card. This value is only provided for a CreatePaymetricTokenRequest NOT for a CreatePaymetricTokenWithTransIdRequest. If the card is keyed for a CreatePaymetricTokenRequest this value will be empty.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
entryMode false string 32 Description of how card was entered. This value is only provided for a CreatePaymetricTokenRequest NOT for a CreatePaymetricTokenWithTransIdRequest.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessIcc
  • ContactlessMsd
expirationMonth false string 2 The card's expiration month
expirationYear false string 2 The card's expiration year
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The merchant ID used to process the transaction.
tokenId false string 100 The Token ID.
tokenProvider false string 32 The Token Provider.
transactionDateTime false string 35 Transaction date/time in ISO8601 format
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
CreatePaymetricTokenResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "binValue": {
    "description": "The card bin value. This value is only provided for a CreatePaymetricTokenRequest NOT for a CreatePaymetricTokenWithTransIdRequest.",
    "type": "string",
    "paramValues": {
      "max": "6",
      "defaultValue": ""
    },
    "required": false
  },
  "cardHolderName": {
    "description": "The card holder name on the card. This value is only provided for a CreatePaymetricTokenRequest NOT for a CreatePaymetricTokenWithTransIdRequest. If the card is keyed for a CreatePaymetricTokenRequest this value will be empty.",
    "type": "string",
    "paramValues": {
      "max": "80",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered. This value is only provided for a CreatePaymetricTokenRequest NOT for a CreatePaymetricTokenWithTransIdRequest.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessIcc",
        "ContactlessMsd"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "paramValues": {
      "max": "2",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenId": {
    "description": "The Token ID.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "tokenProvider": {
    "description": "The Token Provider.",
    "type": "string",
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.
500 The token could not be created with the transaction ID given.
POST
/api/v1/void/{transactionId} Voids the previous transaction with the passed in transaction ID

Parameters

Parameter Parameter Type Data Type Description
transactionId path string The ID of a previous transaction.
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.
VoidRequest body POST_VoidRequest/v1/void/{transactionId} undefined

Request Class

VoidRequest 
{
  "laneId": "int",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "marketCode": "string"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
TransactionIdRequestConfiguration 
{
  "marketCode": "string"
}
VoidRequest
Field Required Data Type Max Length Default Value Description
laneId true int Specifies which lane to use.
cardHolderPresentCode false string 32 Defines 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.
Values:
  • Default
  • Unknown
  • Present
  • NotPresent
  • MailOrder
  • PhoneOrder
  • StandingAuth
  • ECommerce
clerkNumber false string 10 An optional clerk number for reference.
configuration false POST_TransactionIdRequestConfiguration/v 1/void/{transactionId} Any value included in this section will override the corresponding value set in the triPOS.config
referenceNumber false string 50 A user defined reference number.
shiftId false string 10 An optional shift id for reference.
ticketNumber false string 50 An optional ticket number.
TransactionIdRequestConfiguration
Field Required Data Type Max Length Default Value Description
marketCode false string 32 Retail The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
VoidRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines 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.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "Unknown",
        "Present",
        "NotPresent",
        "MailOrder",
        "PhoneOrder",
        "StandingAuth",
        "ECommerce"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_TransactionIdRequestConfiguration/v1/void/{transactionId}",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  }
}
TransactionIdRequestConfiguration 
{
  "marketCode": {
    "description": "The market code of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": "Retail"
    },
    "required": false
  }
}

Response Class

VoidResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "expressResponseCode": "string",
    "expressResponseMessage": "string",
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "logs": "Array<string>",
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string",
    "rawResponse": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "cardLogo": "string",
  "isApproved": "boolean",
  "isOffline": "boolean",
  "merchantId": "string",
  "statusCode": "string",
  "terminalId": "string",
  "transactionDateTime": "string",
  "transactionId": "string"
}
VoidResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_processor false Processor Response information from the processor.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string 19 The Account Number returned by the host
approvalNumber false string 30 Approval number from the processor. Depending on card type and processor an approval number might not be returned.
cardLogo false string 20 The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other
isApproved false boolean 5 Set to true if the host approved the transaction.
isOffline false boolean 5 A boolean value indicating whether triPOS is disconnected from the host.
merchantId false string 50 The Merchant used to process the transaction.
statusCode false string 40 The status code for the transaction.
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
terminalId false string 40 The ID of the terminal used during the transaction
transactionDateTime false string 35 Transaction date/time in ISO8601 format
transactionId false string 19 The transaction ID from the processor
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Max Length Default Value Description
expressResponseCode false string 10 The response code received from Express.
expressResponseMessage false string 100 The response message received from Express.
hostResponseCode false string 3 The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
hostResponseMessage false string 150 The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
logs false Array<string> A list of messages pertaining processing the transaction.
processorLogs false Array<string> [DEPRECATED] Use logs.
processorRawResponse false string 4096 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string 50 [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean 5 [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean 5 [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string 32 [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
processorResponseMessage false string 16 [DEPRECATED] Use expressResponseMessage.
rawResponse false string 4096 The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
VoidResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_processor": {
    "description": "Response information from the processor.",
    "type": "Processor",
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "accountNumber": {
    "description": "The Account Number returned by the host",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "paramValues": {
      "max": "30",
      "defaultValue": ""
    },
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other",
    "type": "string",
    "paramValues": {
      "max": "20",
      "defaultValue": ""
    },
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the host approved the transaction.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "isOffline": {
    "description": "A boolean value indicating whether triPOS is disconnected from the host.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "merchantId": {
    "description": "The Merchant used to process the transaction.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "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"
      ]
    },
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "paramValues": {
      "max": "40",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "paramValues": {
      "max": "35",
      "defaultValue": ""
    },
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "paramValues": {
      "max": "19",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseCode": {
    "description": "The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "3",
      "defaultValue": ""
    },
    "required": false
  },
  "hostResponseMessage": {
    "description": "The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.",
    "type": "string",
    "paramValues": {
      "max": "150",
      "defaultValue": ""
    },
    "required": false
  },
  "logs": {
    "description": "A list of messages pertaining processing the transaction.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorLogs": {
    "description": "[DEPRECATED] Use logs.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "[DEPRECATED] Use rawResponse.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "paramValues": {
      "max": "50",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData",
        "ApprovedExceptCashback"
      ]
    },
    "paramValues": {
      "max": "32",
      "defaultValue": ""
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "paramValues": {
      "max": "16",
      "defaultValue": ""
    },
    "required": false
  },
  "rawResponse": {
    "description": "The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
401 Returned if the AcceptorId, AccountId, AccountToken and TerminalId (config file only) are not provided in the HTTP request header or in the config file.

/api/versions

GET
/api/versions Returns the available versions of the triPOS API

Parameters

Parameter Parameter Type Data Type Description
tp-application-id header string The ID of the business application.
tp-application-name header string The name of the business application.
tp-application-version header string The version of the business application.
tp-authorization header string The authorization header.
tp-express-acceptor-id header string The Express acceptorId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-id header string The Express accountId. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-express-account-token header string The Express accountToken. If all three Express credentials are specified in the request headers, triPOS will use these credentials instead of the credentials in the triPOS.config for that request only.
tp-request-id header string A unique ID for this request. This value should be a UUID or GUID. more�
tp-return-logs header boolean Set to true to have logs populated in the response.

Response Class

ApiVersionsResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  }
}
ApiVersionsResponse
Field Required Data Type Max Length Default Value Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 5 Indicates if there are errors.
_links false Array<ApiLink> A list of resource links
_logs false Array<string> A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
_type false string 100 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 An error message targeted at the developer of the integrated business application.
errorType false string 1000 Code associated with the error if it exists.
exceptionMessage false string 4096 The body of the exception message.
exceptionTypeFullName false string 100 The full name of the exception.
exceptionTypeShortName false string 100 The short name of the exception.
userMessage false string 4096 An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Max Length Default Value Description
href false string 2048 A target (a URI)
method false string 10 The HTTP method to access the HREF target
rel false string 2048 The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Max Length Default Value Description
developerMessage false string 4096 A warning message targeted at the developer of the integrated business application.
userMessage false string 4096 A warning message targeted at the end user of the integrated business application.
ApiVersionsResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "paramValues": {
      "max": "5",
      "defaultValue": ""
    },
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "paramValues": {
      "max": "",
      "defaultValue": ""
    },
    "required": false
  },
  "_logs": {
    "description": "A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "paramValues": {
      "max": "1000",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "paramValues": {
      "max": "100",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "paramValues": {
      "max": "10",
      "defaultValue": ""
    },
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "paramValues": {
      "max": "2048",
      "defaultValue": ""
    },
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A warning message targeted at the developer of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  },
  "userMessage": {
    "description": "A warning message targeted at the end user of the integrated business application.",
    "type": "string",
    "paramValues": {
      "max": "4096",
      "defaultValue": ""
    },
    "required": false
  }
}