/api

GET
/api 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-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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
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-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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
POST
/api/v1/authorization Creates a new card authorization based on the passed in parameters.

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-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/api/v1/authorization undefined

Request Class

AuthorizationRequest 
{
  "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",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string",
  "tipAmount": "double"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}
AuthorizationRequest
Field Required Data Type Description
laneId true int Specifies which lane to use.
transactionAmount true double The total transaction amount. This is the amount of funds to move on the card
address false POST_Address/api/v1/authorization The cardholder address information for the transaction.
cardHolderPresentCode false string Defines whether the card holder 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 An optional clerk number for reference.
configuration false POST_RequestConfiguration/api/v1/authorization Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
tipAmount false double The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
Address
Field Required Data Type Description
billingAddress1 false string The street address used for billing purposes.
billingAddress2 false string The street address used for billing purposes.
billingCity false string The name of the city used for billing purposes.
billingEmail false string The e-mail address used for billing purposes.
billingName false string The name used for billing purposes.
billingPhone false string The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string The postal code used for billing purposes.
billingState false string 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 The street address used for shipping purposes.
shippingAddress2 false string The street address used for shipping purposes.
shippingCity false string The name of the city used for shipping purposes.
shippingEmail false string The e-mail address used for shipping purposes.
shippingName false string The name used for shipping purposes.
shippingPhone false string The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string The postal code used for shipping purposes.
shippingState false string 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 Description
allowPartialApprovals false boolean If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for the transaction.
currencyCode false string The currency code of the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
marketCode false string The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
AuthorizationRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/api/v1/authorization",
    "required": false
  },
  "cardHolderPresentCode": {
    "description": "Defines whether the card holder 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"
      ]
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/api/v1/authorization",
    "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",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.",
    "type": "double",
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "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",
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "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",
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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"
      ]
    },
    "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",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "convenienceFeeAmount": "double",
  "currencyCode": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "merchantId": "string",
  "paymentType": "string",
  "pinVerified": "boolean",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "tipAmount": "double",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
AuthorizationResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string The card account number.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double The amount approved by the processor. This is the actual amount that will be charged or credited.
binValue false string The BIN entry that matched the account number.
cardHolderName false string The card holder name.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double The convenience fee added to the transaction
currencyCode false string The currency code used in the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
entryMode false string Description of how card was entered.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessMsd
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentType false string Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
pinVerified false boolean True if the PIN was verified, false if not verified or undetermined.
signature false Signature The signature data.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
subTotalAmount false double The original amount sent for the transaction.
terminalId false string The ID of the terminal used during the transaction
tipAmount false double The tip amount added to the transaction.
totalAmount false double The total amount of the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Signature
Field Required Data Type Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved by the processor. This is the actual amount that will be charged or credited.",
    "type": "double",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardHolderName": {
    "description": "The card holder name.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessMsd"
      ]
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift"
      ]
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "subTotalAmount": {
    "description": "The original amount sent for the transaction.",
    "type": "double",
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount added to the transaction.",
    "type": "double",
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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"
      ]
    },
    "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"
      ]
    },
    "required": false
  }
}
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-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/api/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",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string",
  "tipAmount": "double"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}
PaymentAccountAuthorizationRequest
Field Required Data Type Description
laneId true int Specifies which lane to use for the card sale.
transactionAmount true double The total transaction amount. This is the amount of funds to move on the card
address false POST_Address/api/v1/authorization/{paymentAccountId} The cardholder address information for the transaction.
clerkNumber false string An optional clerk number for reference.
configuration false POST_RequestConfiguration/api/v1/authorization/{paymentAccountId} Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
tipAmount false double The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
Address
Field Required Data Type Description
billingAddress1 false string The street address used for billing purposes.
billingAddress2 false string The street address used for billing purposes.
billingCity false string The name of the city used for billing purposes.
billingEmail false string The e-mail address used for billing purposes.
billingName false string The name used for billing purposes.
billingPhone false string The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string The postal code used for billing purposes.
billingState false string 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 The street address used for shipping purposes.
shippingAddress2 false string The street address used for shipping purposes.
shippingCity false string The name of the city used for shipping purposes.
shippingEmail false string The e-mail address used for shipping purposes.
shippingName false string The name used for shipping purposes.
shippingPhone false string The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string The postal code used for shipping purposes.
shippingState false string 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 Description
allowPartialApprovals false boolean If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for the transaction.
currencyCode false string The currency code of the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
marketCode false string The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
PaymentAccountAuthorizationRequest 
{
  "laneId": {
    "description": "Specifies which lane to use for the card sale.",
    "type": "int",
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/api/v1/authorization/{paymentAccountId}",
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/api/v1/authorization/{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",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.",
    "type": "double",
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "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",
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "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",
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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"
      ]
    },
    "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",
  "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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double The amount approved by the processor. This is the actual amount that will be charged or credited.
avsResponseCode false string The AVS response code.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double The convenience fee added to the transaction
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentAccountId false string The payment account ID.
paymentAccountReferenceNumber false string The payment account reference number.
referenceNumber false string The reference number.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
subTotalAmount false double The original amount sent for the transaction.
terminalId false string The ID of the terminal used during the transaction
tipAmount false double The tip amount added to the transaction.
totalAmount false double The total amount of the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved by the processor. This is the actual amount that will be charged or credited.",
    "type": "double",
    "required": false
  },
  "avsResponseCode": {
    "description": "The AVS response code.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountId": {
    "description": "The payment account ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountReferenceNumber": {
    "description": "The payment account reference number.",
    "type": "string",
    "required": false
  },
  "referenceNumber": {
    "description": "The reference number.",
    "type": "string",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "subTotalAmount": {
    "description": "The original amount sent for the transaction.",
    "type": "double",
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount added to the transaction.",
    "type": "double",
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
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-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/api/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"
  },
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string",
  "tipAmount": "double"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}
AuthorizationCompletionRequest
Field Required Data Type Description
laneId true int Specifies which lane to use.
transactionAmount true double The total transaction amount. This is the amount of funds to move on the card
address false POST_Address/api/v1/authorization/{transactionId}/completion The cardholder address information for the transaction.
cardHolderPresentCode false string Defines whether the card holder 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 An optional clerk number for reference.
configuration false POST_RequestConfiguration/api/v1/authorization/{transactionId}/completion Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
tipAmount false double The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
Address
Field Required Data Type Description
billingAddress1 false string The street address used for billing purposes.
billingAddress2 false string The street address used for billing purposes.
billingCity false string The name of the city used for billing purposes.
billingEmail false string The e-mail address used for billing purposes.
billingName false string The name used for billing purposes.
billingPhone false string The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string The postal code used for billing purposes.
billingState false string 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 The street address used for shipping purposes.
shippingAddress2 false string The street address used for shipping purposes.
shippingCity false string The name of the city used for shipping purposes.
shippingEmail false string The e-mail address used for shipping purposes.
shippingName false string The name used for shipping purposes.
shippingPhone false string The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string The postal code used for shipping purposes.
shippingState false string 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 Description
allowPartialApprovals false boolean If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for the transaction.
currencyCode false string The currency code of the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
marketCode false string The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
AuthorizationCompletionRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/api/v1/authorization/{transactionId}/completion",
    "required": false
  },
  "cardHolderPresentCode": {
    "description": "Defines whether the card holder 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"
      ]
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/api/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",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.",
    "type": "double",
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "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",
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "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",
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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"
      ]
    },
    "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",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "convenienceFeeAmount": "double",
  "currencyCode": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "merchantId": "string",
  "paymentType": "string",
  "pinVerified": "boolean",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "tipAmount": "double",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
AuthorizationCompletionResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string The card account number.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double The amount approved by the processor. This is the actual amount that will be charged or credited.
binValue false string The BIN entry that matched the account number.
cardHolderName false string The card holder name.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double The convenience fee added to the transaction
currencyCode false string The currency code used in the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
entryMode false string Description of how card was entered.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessMsd
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentType false string Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
pinVerified false boolean True if the PIN was verified, false if not verified or undetermined.
signature false Signature The signature data.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
subTotalAmount false double The original amount sent for the transaction.
terminalId false string The ID of the terminal used during the transaction
tipAmount false double The tip amount added to the transaction.
totalAmount false double The total amount of the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Signature
Field Required Data Type Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved by the processor. This is the actual amount that will be charged or credited.",
    "type": "double",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardHolderName": {
    "description": "The card holder name.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessMsd"
      ]
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift"
      ]
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "subTotalAmount": {
    "description": "The original amount sent for the transaction.",
    "type": "double",
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount added to the transaction.",
    "type": "double",
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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"
      ]
    },
    "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"
      ]
    },
    "required": false
  }
}
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-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/api/v1/balance undefined

Request Class

BalanceRequest 
{
  "laneId": "int",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}
BalanceRequest
Field Required Data Type Description
laneId true int Specifies which lane to use.
cardHolderPresentCode false string Defines whether the card holder 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 An optional clerk number for reference.
configuration false POST_RequestConfiguration/api/v1/balance Any value included in this section will override the corresponding value set in the triPOS.config
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
RequestConfiguration
Field Required Data Type Description
allowPartialApprovals false boolean If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for the transaction.
currencyCode false string The currency code of the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
marketCode false string The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
BalanceRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines whether the card holder 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"
      ]
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/api/v1/balance",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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"
      ]
    },
    "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",
  "merchantId": "string",
  "paymentType": "string",
  "statusCode": "string",
  "terminalId": "string",
  "transactionDateTime": "string",
  "transactionId": "string"
}
BalanceResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string The card account number.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
balanceAmount false double The balance of the gift card.
balanceCurrencyCode false string The balance currency code.
binValue false string The BIN entry that matched the account number.
cardLogo false string The card logo (e.g. Visa, Mastercard, etc).
entryMode false string Description of how card was entered: Keyed, Swiped, Chip.
expirationMonth false string The card's expiration month. NOTE: Not all cards that support balance inquiry will have an expiration date.
expirationYear false string The card's expiration year. NOTE: Not all cards that support balance inquiry will have an expiration date.
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentType false string Description of how card payment type: None, Credit, Debit.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "required": false
  },
  "balanceAmount": {
    "description": "The balance of the gift card.",
    "type": "double",
    "required": false
  },
  "balanceCurrencyCode": {
    "description": "The balance currency code.",
    "type": "string",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo (e.g. Visa, Mastercard, etc).",
    "type": "string",
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered: Keyed, Swiped, Chip.",
    "type": "string",
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month. NOTE: Not all cards that support balance inquiry will have an expiration date.",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year. NOTE: Not all cards that support balance inquiry will have an expiration date.",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentType": {
    "description": "Description of how card payment type: None, Credit, Debit.",
    "type": "string",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
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-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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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-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",
  "pinPadIdleMessage": "string",
  "testMode": "string"
}
GetApplicationConfigurationResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
binFileName false string Location of BIN files to be loaded from disk
pinPadIdleMessage false string Message to display on the PIN pad when it is idle.
testMode false string Set to 'true' to be in Test/Certification mode or 'false' for Production mode.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "pinPadIdleMessage": {
    "description": "Message to display on the PIN pad when it is idle.",
    "type": "string",
    "required": false
  },
  "testMode": {
    "description": "Set to 'true' to be in Test/Certification mode or 'false' for Production mode.",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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-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/api/v1/configuration/application undefined

Request Class

UpdateApplicationConfigurationRequest 
{
  "pinPadIdleMessage": "string",
  "testMode": "string",
  "binFileName": "string"
}
UpdateApplicationConfigurationRequest
Field Required Data Type Description
pinPadIdleMessage true string Message to display on the PIN pad when it is idle.
testMode true string Set to 'true' to be in Test/Certification mode or 'false' for Production mode.
binFileName false string Location of BIN files to be loaded from disk
UpdateApplicationConfigurationRequest 
{
  "pinPadIdleMessage": {
    "description": "Message to display on the PIN pad when it is idle.",
    "type": "string",
    "required": true
  },
  "testMode": {
    "description": "Set to 'true' to be in Test/Certification mode or 'false' for Production mode.",
    "type": "string",
    "required": true
  },
  "binFileName": {
    "description": "Location of BIN files to be loaded from disk",
    "type": "string",
    "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",
  "pinPadIdleMessage": "string",
  "testMode": "string"
}
UpdateApplicationConfigurationResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
applicationUpdated false boolean Success message for application settings update.
binFileName false string Location of BIN files to be loaded from disk
pinPadIdleMessage false string Message to display on the PIN pad when it is idle.
testMode false string Set to 'true' to be in Test/Certification mode or 'false' for Production mode.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "binFileName": {
    "description": "Location of BIN files to be loaded from disk",
    "type": "string",
    "required": false
  },
  "pinPadIdleMessage": {
    "description": "Message to display on the PIN pad when it is idle.",
    "type": "string",
    "required": false
  },
  "testMode": {
    "description": "Set to 'true' to be in Test/Certification mode or 'false' for Production mode.",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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-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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
autoReversalRetryLimit false int The number of times to automatically retry a reversal after a system failure
driver false string Driver value of Host settings
Values:
  • Null
  • Express
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "driver": {
    "description": "Driver value of Host settings",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "Express"
      ]
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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-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/api/v1/configuration/host undefined

Request Class

UpdateHostConfigurationRequest 
{
  "autoReversalRetryLimit": "int",
  "driver": "string"
}
UpdateHostConfigurationRequest
Field Required Data Type Description
autoReversalRetryLimit true int 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 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",
    "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"
      ]
    },
    "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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
autoReversalRetryLimit false int The number of times to automatically retry a reversal after a failure
driver false string Set to either 'Express' or 'Null'. Use Null to test without any connection to express.
Values:
  • Null
  • Express
hostUpdated false boolean Success value for updating host settings.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "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"
      ]
    },
    "required": false
  },
  "hostUpdated": {
    "description": "Success value for updating host settings.",
    "type": "boolean",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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-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",
    "initializeOnStartup": "string",
    "ip": {
      "address": "string",
      "port": "string"
    },
    "isContactlessMsdEntryAllowed": "string",
    "isManualEntryAllowed": "string",
    "laneId": "int",
    "terminalId": "string",
    "terminalType": "string"
  },
  "serialLanes": {
    "_errors": "Array<ApiError>",
    "_hasErrors": "boolean",
    "_links": "Array<ApiLink>",
    "_logs": "Array<string>",
    "_type": "string",
    "_warnings": "Array<ApiWarning>",
    "description": "string",
    "driver": "string",
    "initializeOnStartup": "string",
    "isContactlessMsdEntryAllowed": "string",
    "isManualEntryAllowed": "string",
    "laneId": "int",
    "serial": {
      "baudRate": "string",
      "comPort": "string",
      "dataBits": "string",
      "handshake": "string",
      "parity": "string",
      "stopBits": "string"
    },
    "terminalId": "string",
    "terminalType": "string"
  }
}
GetLanesConfigurationResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 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 Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
IpLane
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string Description for lane setting.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
initializeOnStartup false string Whether this lane should be initialized on stat up.
ip false Ip IP device properties.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
laneId false int Lane ID for lane setting.
terminalId false string Terminal ID of PIN pad.
terminalType false string terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
Ip
Field Required Data Type Description
address true string IP address of PIN pad if not connected via serial device.
port false string IP port of PIN pad if not connected via serial device.
SerialLane
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string Description for lane setting.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
initializeOnStartup false string Whether this lane should be initialized on stat up.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
laneId false int Lane ID for lane setting.
serial false Serial Serial device properties.
terminalId false string Terminal ID of PIN pad.
terminalType false string terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
Serial
Field Required Data Type Description
baudRate true string Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string If the PIN pad is connected via serial device, the data bit setting.
handshake true string If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • RequestToSend
  • XonXoff
parity true string If the PIN pad is connected via serial device, the parity setting.
stopBits true string 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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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"
    },
    "required": false
  },
  "serialLanes": {
    "description": "List of serial lanes.",
    "type": "Array",
    "items": {
      "$ref": "SerialLane"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "ip": {
    "description": "IP device properties.",
    "type": "Ip",
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Whether or not manual entry of card account numbers on the PIN pad is allowed.",
    "type": "string",
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  }
}
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Whether or not manual entry of card account numbers on the PIN pad is allowed.",
    "type": "string",
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "required": false
  },
  "serial": {
    "description": "Serial device properties.",
    "type": "Serial",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "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"
      ]
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "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",
        "RequestToSend",
        "XonXoff"
      ]
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "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"
      ]
    },
    "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-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",
    "initializeOnStartup": "string",
    "ip": {
      "address": "string",
      "port": "string"
    },
    "isContactlessMsdEntryAllowed": "string",
    "isManualEntryAllowed": "string",
    "laneId": "int",
    "terminalId": "string",
    "terminalType": "string"
  },
  "serialLanes": {
    "_errors": "Array<ApiError>",
    "_hasErrors": "boolean",
    "_links": "Array<ApiLink>",
    "_logs": "Array<string>",
    "_type": "string",
    "_warnings": "Array<ApiWarning>",
    "description": "string",
    "driver": "string",
    "initializeOnStartup": "string",
    "isContactlessMsdEntryAllowed": "string",
    "isManualEntryAllowed": "string",
    "laneId": "int",
    "serial": {
      "baudRate": "string",
      "comPort": "string",
      "dataBits": "string",
      "handshake": "string",
      "parity": "string",
      "stopBits": "string"
    },
    "terminalId": "string",
    "terminalType": "string"
  }
}
GetIpLanesConfigurationResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 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 Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
IpLane
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string Description for lane setting.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
initializeOnStartup false string Whether this lane should be initialized on stat up.
ip false Ip IP device properties.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
laneId false int Lane ID for lane setting.
terminalId false string Terminal ID of PIN pad.
terminalType false string terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
Ip
Field Required Data Type Description
address true string IP address of PIN pad if not connected via serial device.
port false string IP port of PIN pad if not connected via serial device.
SerialLane
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string Description for lane setting.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
initializeOnStartup false string Whether this lane should be initialized on stat up.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
laneId false int Lane ID for lane setting.
serial false Serial Serial device properties.
terminalId false string Terminal ID of PIN pad.
terminalType false string terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
Serial
Field Required Data Type Description
baudRate true string Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string If the PIN pad is connected via serial device, the data bit setting.
handshake true string If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • RequestToSend
  • XonXoff
parity true string If the PIN pad is connected via serial device, the parity setting.
stopBits true string 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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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"
    },
    "required": false
  },
  "serialLanes": {
    "description": "List of serial lanes.",
    "type": "Array",
    "items": {
      "$ref": "SerialLane"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "ip": {
    "description": "IP device properties.",
    "type": "Ip",
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Whether or not manual entry of card account numbers on the PIN pad is allowed.",
    "type": "string",
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  }
}
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Whether or not manual entry of card account numbers on the PIN pad is allowed.",
    "type": "string",
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "required": false
  },
  "serial": {
    "description": "Serial device properties.",
    "type": "Serial",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "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"
      ]
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "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",
        "RequestToSend",
        "XonXoff"
      ]
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "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"
      ]
    },
    "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-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/api/v1/configuration/lanes/ip undefined

Request Class

CreateIpLaneRequest 
{
  "driver": "string",
  "ip": {
    "address": "string",
    "port": "string"
  },
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneId": "int",
  "terminalId": "string",
  "terminalType": "string",
  "description": "string",
  "initializeOnStartup": "string"
}
CreateIpLaneRequest
Field Required Data Type Description
driver true string Pin pad driver type
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
ip true POST_Ip/api/v1/configuration/lanes/ip Collection of IP device properties
isContactlessMsdEntryAllowed true string Set to true to allow contactless entry.
isManualEntryAllowed true string 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 Terminal ID.
terminalType true string The terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
description false string Description of lane.
initializeOnStartup false string Set to true for this lane to be initialized on startup.
Ip
Field Required Data Type Description
address true string IP address of PIN pad if not connected via serial device.
port false string IP port of PIN pad if not connected via serial device.
CreateIpLaneRequest 
{
  "driver": {
    "description": "Pin pad driver type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": true
  },
  "ip": {
    "description": "Collection of IP device properties",
    "type": "POST_Ip/api/v1/configuration/lanes/ip",
    "required": true
  },
  "isContactlessMsdEntryAllowed": {
    "description": "Set to true to allow contactless entry.",
    "type": "string",
    "required": true
  },
  "isManualEntryAllowed": {
    "description": "Set to true to allow manual entry of card account numbers on the PIN pad.",
    "type": "string",
    "required": true
  },
  "laneId": {
    "description": "The desired lane ID. The lane ID should be a maximum of six digits long.",
    "type": "int",
    "allowableValues": {},
    "required": true
  },
  "terminalId": {
    "description": "Terminal ID.",
    "type": "string",
    "required": true
  },
  "terminalType": {
    "description": "The terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "required": true
  },
  "description": {
    "description": "Description of lane.",
    "type": "string",
    "required": false
  },
  "initializeOnStartup": {
    "description": "Set to true for this lane to be initialized on startup.",
    "type": "string",
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  }
}

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",
  "initializeOnStartup": "string",
  "ip": {
    "address": "string",
    "port": "string"
  },
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneCreated": "boolean",
  "laneId": "int",
  "terminalId": "string",
  "terminalType": "string"
}
CreateIpLaneResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string Description for lane setting.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
initializeOnStartup false string Whether this lane should be initialized on stat up.
ip false Ip IP device properties.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
laneCreated false boolean True if lane was created successfully and false otherwise.
laneId false int Lane ID for lane setting.
terminalId false string Terminal ID of PIN pad.
terminalType false string terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Ip
Field Required Data Type Description
address true string IP address of PIN pad if not connected via serial device.
port false string IP port of PIN pad if not connected via serial device.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "ip": {
    "description": "IP device properties.",
    "type": "Ip",
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Whether or not manual entry of card account numbers on the PIN pad is allowed.",
    "type": "string",
    "required": false
  },
  "laneCreated": {
    "description": "True if lane was created successfully and false otherwise.",
    "type": "boolean",
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  }
}
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-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/api/v1/configuration/lanes/ip/{laneId} undefined

Request Class

DeleteLaneRequest 
{}
DeleteLaneRequest
Field Required Data Type 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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
laneDeleted false boolean True if lane was deleted false otherwise.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
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-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",
  "initializeOnStartup": "string",
  "ip": {
    "address": "string",
    "port": "string"
  },
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneId": "int",
  "terminalId": "string",
  "terminalType": "string"
}
GetIpLaneResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string Description for lane setting.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
initializeOnStartup false string Whether this lane should be initialized on stat up.
ip false Ip IP device properties.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
laneId false int Lane ID for lane setting.
terminalId false string Terminal ID of PIN pad.
terminalType false string terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Ip
Field Required Data Type Description
address true string IP address of PIN pad if not connected via serial device.
port false string IP port of PIN pad if not connected via serial device.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "ip": {
    "description": "IP device properties.",
    "type": "Ip",
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Whether or not manual entry of card account numbers on the PIN pad is allowed.",
    "type": "string",
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  }
}
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-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/api/v1/configuration/lanes/ip/{laneId} undefined

Request Class

UpdateIpLaneRequest 
{
  "driver": "string",
  "ip": {
    "address": "string",
    "port": "string"
  },
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneId": "int",
  "terminalId": "string",
  "terminalType": "string",
  "description": "string",
  "initializeOnStartup": "string"
}
UpdateIpLaneRequest
Field Required Data Type Description
driver true string Pin pad driver type
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
ip true PUT_Ip/api/v1/configuration/lanes/ip/{laneId} Collection of IP device properties
isContactlessMsdEntryAllowed true string Set to true to allow contactless entry.
isManualEntryAllowed true string 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 Terminal ID.
terminalType true string The terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
description false string Description of lane.
initializeOnStartup false string Set to true for this lane to be initialized on startup.
Ip
Field Required Data Type Description
address true string IP address of PIN pad if not connected via serial device.
port false string IP port of PIN pad if not connected via serial device.
UpdateIpLaneRequest 
{
  "driver": {
    "description": "Pin pad driver type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": true
  },
  "ip": {
    "description": "Collection of IP device properties",
    "type": "PUT_Ip/api/v1/configuration/lanes/ip/{laneId}",
    "required": true
  },
  "isContactlessMsdEntryAllowed": {
    "description": "Set to true to allow contactless entry.",
    "type": "string",
    "required": true
  },
  "isManualEntryAllowed": {
    "description": "Set to true to allow manual entry of card account numbers on the PIN pad.",
    "type": "string",
    "required": true
  },
  "laneId": {
    "description": "The desired lane ID. The lane ID should be a maximum of six digits long.",
    "type": "int",
    "allowableValues": {},
    "required": true
  },
  "terminalId": {
    "description": "Terminal ID.",
    "type": "string",
    "required": true
  },
  "terminalType": {
    "description": "The terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "required": true
  },
  "description": {
    "description": "Description of lane.",
    "type": "string",
    "required": false
  },
  "initializeOnStartup": {
    "description": "Set to true for this lane to be initialized on startup.",
    "type": "string",
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  }
}

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",
  "initializeOnStartup": "string",
  "ip": {
    "address": "string",
    "port": "string"
  },
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneId": "int",
  "laneUpdated": "boolean",
  "terminalId": "string",
  "terminalType": "string"
}
UpdateIpLaneResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string Description for lane setting.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
initializeOnStartup false string Whether this lane should be initialized on stat up.
ip false Ip IP device properties.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
laneId false int Lane ID for lane setting.
laneUpdated false boolean True if lane was updated successfully and false otherwise.
terminalId false string Terminal ID of PIN pad.
terminalType false string terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Ip
Field Required Data Type Description
address true string IP address of PIN pad if not connected via serial device.
port false string IP port of PIN pad if not connected via serial device.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "ip": {
    "description": "IP device properties.",
    "type": "Ip",
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Whether or not manual entry of card account numbers on the PIN pad is allowed.",
    "type": "string",
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "required": false
  },
  "laneUpdated": {
    "description": "True if lane was updated successfully and false otherwise.",
    "type": "boolean",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  }
}
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-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",
    "initializeOnStartup": "string",
    "ip": {
      "address": "string",
      "port": "string"
    },
    "isContactlessMsdEntryAllowed": "string",
    "isManualEntryAllowed": "string",
    "laneId": "int",
    "terminalId": "string",
    "terminalType": "string"
  },
  "serialLanes": {
    "_errors": "Array<ApiError>",
    "_hasErrors": "boolean",
    "_links": "Array<ApiLink>",
    "_logs": "Array<string>",
    "_type": "string",
    "_warnings": "Array<ApiWarning>",
    "description": "string",
    "driver": "string",
    "initializeOnStartup": "string",
    "isContactlessMsdEntryAllowed": "string",
    "isManualEntryAllowed": "string",
    "laneId": "int",
    "serial": {
      "baudRate": "string",
      "comPort": "string",
      "dataBits": "string",
      "handshake": "string",
      "parity": "string",
      "stopBits": "string"
    },
    "terminalId": "string",
    "terminalType": "string"
  }
}
GetSerialLanesConfigurationResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 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 Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
IpLane
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string Description for lane setting.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
initializeOnStartup false string Whether this lane should be initialized on stat up.
ip false Ip IP device properties.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
laneId false int Lane ID for lane setting.
terminalId false string Terminal ID of PIN pad.
terminalType false string terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
Ip
Field Required Data Type Description
address true string IP address of PIN pad if not connected via serial device.
port false string IP port of PIN pad if not connected via serial device.
SerialLane
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string Description for lane setting.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
initializeOnStartup false string Whether this lane should be initialized on stat up.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
laneId false int Lane ID for lane setting.
serial false Serial Serial device properties.
terminalId false string Terminal ID of PIN pad.
terminalType false string terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
Serial
Field Required Data Type Description
baudRate true string Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string If the PIN pad is connected via serial device, the data bit setting.
handshake true string If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • RequestToSend
  • XonXoff
parity true string If the PIN pad is connected via serial device, the parity setting.
stopBits true string 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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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"
    },
    "required": false
  },
  "serialLanes": {
    "description": "List of serial lanes.",
    "type": "Array",
    "items": {
      "$ref": "SerialLane"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "ip": {
    "description": "IP device properties.",
    "type": "Ip",
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Whether or not manual entry of card account numbers on the PIN pad is allowed.",
    "type": "string",
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "required": false
  }
}
Ip 
{
  "address": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "required": true
  },
  "port": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  }
}
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Whether or not manual entry of card account numbers on the PIN pad is allowed.",
    "type": "string",
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "required": false
  },
  "serial": {
    "description": "Serial device properties.",
    "type": "Serial",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "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"
      ]
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "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",
        "RequestToSend",
        "XonXoff"
      ]
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "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"
      ]
    },
    "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-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/api/v1/configuration/lanes/serial undefined

Request Class

CreateSerialLaneRequest 
{
  "driver": "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",
  "initializeOnStartup": "string"
}
CreateSerialLaneRequest
Field Required Data Type Description
driver true string Pin pad driver type
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
isContactlessMsdEntryAllowed true string Set to true to allow contactless entry.
isManualEntryAllowed true string 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/api/v1/configuration/lanes/serial Collection of Serial device properties
terminalId true string Terminal ID.
terminalType true string The terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
description false string Description of lane.
initializeOnStartup false string Set to true for this lane to be initialized on startup.
Serial
Field Required Data Type Description
baudRate true string Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string If the PIN pad is connected via serial device, the data bit setting.
handshake true string If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • RequestToSend
  • XonXoff
parity true string If the PIN pad is connected via serial device, the parity setting.
stopBits true string If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
Values:
  • None
  • One
  • OnePointFive
  • Two
CreateSerialLaneRequest 
{
  "driver": {
    "description": "Pin pad driver type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": true
  },
  "isContactlessMsdEntryAllowed": {
    "description": "Set to true to allow contactless entry.",
    "type": "string",
    "required": true
  },
  "isManualEntryAllowed": {
    "description": "Set to true to allow manual entry of card account numbers on the PIN pad.",
    "type": "string",
    "required": true
  },
  "laneId": {
    "description": "The desired lane ID. The lane ID should be a maximum of six digits long.",
    "type": "int",
    "allowableValues": {},
    "required": true
  },
  "serial": {
    "description": "Collection of Serial device properties",
    "type": "POST_Serial/api/v1/configuration/lanes/serial",
    "required": true
  },
  "terminalId": {
    "description": "Terminal ID.",
    "type": "string",
    "required": true
  },
  "terminalType": {
    "description": "The terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "required": true
  },
  "description": {
    "description": "Description of lane.",
    "type": "string",
    "required": false
  },
  "initializeOnStartup": {
    "description": "Set to true for this lane to be initialized on startup.",
    "type": "string",
    "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"
      ]
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "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",
        "RequestToSend",
        "XonXoff"
      ]
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "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"
      ]
    },
    "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",
  "initializeOnStartup": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneCreated": "boolean",
  "laneId": "int",
  "serial": {
    "baudRate": "string",
    "comPort": "string",
    "dataBits": "string",
    "handshake": "string",
    "parity": "string",
    "stopBits": "string"
  },
  "terminalId": "string",
  "terminalType": "string"
}
CreateSerialLaneResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string Description for lane setting.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
initializeOnStartup false string Whether this lane should be initialized on stat up.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
laneCreated false boolean True if lane was created successfully and false otherwise.
laneId false int Lane ID for lane setting.
serial false Serial Serial device properties.
terminalId false string Terminal ID of PIN pad.
terminalType false string terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Serial
Field Required Data Type Description
baudRate true string Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string If the PIN pad is connected via serial device, the data bit setting.
handshake true string If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • RequestToSend
  • XonXoff
parity true string If the PIN pad is connected via serial device, the parity setting.
stopBits true string If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
Values:
  • None
  • One
  • OnePointFive
  • Two
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Whether or not manual entry of card account numbers on the PIN pad is allowed.",
    "type": "string",
    "required": false
  },
  "laneCreated": {
    "description": "True if lane was created successfully and false otherwise.",
    "type": "boolean",
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "required": false
  },
  "serial": {
    "description": "Serial device properties.",
    "type": "Serial",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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"
      ]
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "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",
        "RequestToSend",
        "XonXoff"
      ]
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "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"
      ]
    },
    "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-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/api/v1/configuration/lanes/serial/{laneId} undefined

Request Class

DeleteLaneRequest 
{}
DeleteLaneRequest
Field Required Data Type 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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
laneDeleted false boolean True if lane was deleted false otherwise.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
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-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",
  "initializeOnStartup": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneId": "int",
  "serial": {
    "baudRate": "string",
    "comPort": "string",
    "dataBits": "string",
    "handshake": "string",
    "parity": "string",
    "stopBits": "string"
  },
  "terminalId": "string",
  "terminalType": "string"
}
GetSerialLaneResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string Description for lane setting.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
initializeOnStartup false string Whether this lane should be initialized on stat up.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
laneId false int Lane ID for lane setting.
serial false Serial Serial device properties.
terminalId false string Terminal ID of PIN pad.
terminalType false string terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Serial
Field Required Data Type Description
baudRate true string Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string If the PIN pad is connected via serial device, the data bit setting.
handshake true string If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • RequestToSend
  • XonXoff
parity true string If the PIN pad is connected via serial device, the parity setting.
stopBits true string If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
Values:
  • None
  • One
  • OnePointFive
  • Two
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Whether or not manual entry of card account numbers on the PIN pad is allowed.",
    "type": "string",
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "required": false
  },
  "serial": {
    "description": "Serial device properties.",
    "type": "Serial",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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"
      ]
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "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",
        "RequestToSend",
        "XonXoff"
      ]
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "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"
      ]
    },
    "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-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/api/v1/configuration/lanes/serial/{laneId} undefined

Request Class

UpdateSerialLaneRequest 
{
  "driver": "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",
  "initializeOnStartup": "string"
}
UpdateSerialLaneRequest
Field Required Data Type Description
driver true string Pin pad driver type
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
isContactlessMsdEntryAllowed true string Set to true to allow contactless entry.
isManualEntryAllowed true string 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/api/v1/configuration/lanes/serial/{laneId} Collection of Serial device properties
terminalId true string Terminal ID.
terminalType true string The terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
description false string Description of lane.
initializeOnStartup false string Set to true for this lane to be initialized on startup.
Serial
Field Required Data Type Description
baudRate true string Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string If the PIN pad is connected via serial device, the data bit setting.
handshake true string If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • RequestToSend
  • XonXoff
parity true string If the PIN pad is connected via serial device, the parity setting.
stopBits true string If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
Values:
  • None
  • One
  • OnePointFive
  • Two
UpdateSerialLaneRequest 
{
  "driver": {
    "description": "Pin pad driver type",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": true
  },
  "isContactlessMsdEntryAllowed": {
    "description": "Set to true to allow contactless entry.",
    "type": "string",
    "required": true
  },
  "isManualEntryAllowed": {
    "description": "Set to true to allow manual entry of card account numbers on the PIN pad.",
    "type": "string",
    "required": true
  },
  "laneId": {
    "description": "The desired lane ID. The lane ID should be a maximum of six digits long.",
    "type": "int",
    "allowableValues": {},
    "required": true
  },
  "serial": {
    "description": "Collection of Serial device properties",
    "type": "PUT_Serial/api/v1/configuration/lanes/serial/{laneId}",
    "required": true
  },
  "terminalId": {
    "description": "Terminal ID.",
    "type": "string",
    "required": true
  },
  "terminalType": {
    "description": "The terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "required": true
  },
  "description": {
    "description": "Description of lane.",
    "type": "string",
    "required": false
  },
  "initializeOnStartup": {
    "description": "Set to true for this lane to be initialized on startup.",
    "type": "string",
    "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"
      ]
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "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",
        "RequestToSend",
        "XonXoff"
      ]
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "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"
      ]
    },
    "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",
  "initializeOnStartup": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneId": "int",
  "laneUpdated": "boolean",
  "serial": {
    "baudRate": "string",
    "comPort": "string",
    "dataBits": "string",
    "handshake": "string",
    "parity": "string",
    "stopBits": "string"
  },
  "terminalId": "string",
  "terminalType": "string"
}
UpdateSerialLaneResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
description false string Description for lane setting.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
Values:
  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
initializeOnStartup false string Whether this lane should be initialized on stat up.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
laneId false int Lane ID for lane setting.
laneUpdated false boolean True if lane was updated successfully and false otherwise.
serial false Serial Serial device properties.
terminalId false string Terminal ID of PIN pad.
terminalType false string terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.
Values:
  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Serial
Field Required Data Type Description
baudRate true string Baud rate of serial communications.
Values:
  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
comPort true string Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits true string If the PIN pad is connected via serial device, the data bit setting.
handshake true string If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
Values:
  • None
  • RequestToSend
  • XonXoff
parity true string If the PIN pad is connected via serial device, the parity setting.
stopBits true string If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
Values:
  • None
  • One
  • OnePointFive
  • Two
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Null",
        "VeriFoneXpi",
        "VeriFoneFormAgent",
        "VeriFoneFormAgentXpi",
        "Virtual",
        "IngenicoRba",
        "DebitNull",
        "GiftNull"
      ]
    },
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "isManualEntryAllowed": {
    "description": "Whether or not manual entry of card account numbers on the PIN pad is allowed.",
    "type": "string",
    "required": false
  },
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "int",
    "required": false
  },
  "laneUpdated": {
    "description": "True if lane was updated successfully and false otherwise.",
    "type": "boolean",
    "required": false
  },
  "serial": {
    "description": "Serial device properties.",
    "type": "Serial",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "PointOfSale",
        "ECommerce",
        "Moto",
        "FuelPump",
        "Atm",
        "Voice"
      ]
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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"
      ]
    },
    "required": true
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "required": true
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "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",
        "RequestToSend",
        "XonXoff"
      ]
    },
    "required": true
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "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"
      ]
    },
    "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-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"
  },
  "listeningPort": "string"
}
GetServerConfigurationResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
listeningPort false string Listening port information of server settings.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "listeningPort": {
    "description": "Listening port information of server settings.",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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-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/api/v1/configuration/server undefined

Request Class

UpdateServerConfigurationRequest 
{
  "listeningPort": "string"
}
UpdateServerConfigurationRequest
Field Required Data Type Description
listeningPort false string Listening port information of server settings.
UpdateServerConfigurationRequest 
{
  "listeningPort": {
    "description": "Listening port information of server settings.",
    "type": "string",
    "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"
  },
  "listeningPort": "string",
  "serverSettingsUpdated": "boolean"
}
UpdateServerConfigurationResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
listeningPort false string Listening port information of server settings.
serverSettingsUpdated false boolean Success value for updating server settings.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "listeningPort": {
    "description": "Listening port information of server settings.",
    "type": "string",
    "required": false
  },
  "serverSettingsUpdated": {
    "description": "Success value for updating server settings.",
    "type": "boolean",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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-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 
{
  "_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",
  "confirmOriginalAmount": "boolean",
  "creditAvsEntryCondition": "string",
  "creditSaleSignatureThresholdAmount": "double",
  "currencyCode": "string",
  "debitSurcharge": "double",
  "isCashBackAllowed": "boolean",
  "isConvenienceFeeAllowed": "boolean",
  "isDebitSupported": "boolean",
  "isGiftSupported": "boolean",
  "isTipAllowed": "boolean",
  "marketCode": "string",
  "maximumCashbackAmount": "int",
  "signatureFormat": "string",
  "tipSelections": "string"
}
GetTransactionConfigurationResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
allowPartialApprovals false boolean If set to true, partial approvals are allowed.
cashBackIncrement false string Increments you want customers to be able to get back. Common values include, 1, 5, 10 and 20.
cashBackSelections false string Enter whole numbers separated by commas for the cashback amounts to select from.
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for all transactions. This can be overridden on a per request basis.
confirmOriginalAmount false boolean If set to true, the original transaction amount will be confirmed after card information is obtained.
creditAvsEntryCondition false string Set when AVS entry (billing postal code entry) should be prompted for credit transactions: 'Always', 'Never' or 'Keyed'.
Values:
  • Always
  • Never
  • Keyed
creditSaleSignatureThresholdAmount false double Leave as 0 or empty to always require a signature for credit sale, otherwise set to the amount that must be surpassed before asking for a signature, such as 25.00
currencyCode false string The currency code that will be used for all transactions. Can be Usd for United States dollar, Cad for Canadian Dollar, or Eur for Euro. This can be overridden on a per request basis.
Values:
  • None
  • Cad
  • Usd
  • Eur
debitSurcharge false double 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'
isCashBackAllowed false boolean Set to true to allow cashback.
isConvenienceFeeAllowed false boolean Set to true to allow convenience fees to be added.
isDebitSupported false boolean 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.
isGiftSupported false boolean 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 false boolean Set to true to allow tips to be added.
marketCode false string The market code specific to the type of transaction being submitted. This global value can be set, but it can be overridden by a lane configuration value or a request value. AutoRental, DirectMarketing, ECommerce, FoodRestaurant, HotelLodging, Petroleum, Retail, QSR
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
maximumCashbackAmount false int The maximum cashback amount you want to allow cardholders to get back
signatureFormat false string The format which signature data should come back as. PointsLittleEndian, PointsBigEndian, Ascii3Byte
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
tipSelections false string Enter decimal numbers for tip amounts. Add percent sign after the number to display calculated percentages (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
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
GetTransactionConfigurationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "cashBackIncrement": {
    "description": "Increments you want customers to be able to get back. Common values include, 1, 5, 10 and 20.",
    "type": "string",
    "required": false
  },
  "cashBackSelections": {
    "description": "Enter whole numbers separated by commas for the cashback amounts to select from.",
    "type": "string",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for all transactions. This can be overridden on a per request basis.",
    "type": "boolean",
    "required": false
  },
  "confirmOriginalAmount": {
    "description": "If set to true, the original transaction amount will be confirmed after card information is obtained.",
    "type": "boolean",
    "required": false
  },
  "creditAvsEntryCondition": {
    "description": "Set when AVS entry (billing postal code entry) should be prompted for credit transactions: 'Always', 'Never' or 'Keyed'.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Always",
        "Never",
        "Keyed"
      ]
    },
    "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 surpassed before asking for a signature, such as 25.00",
    "type": "double",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code that will be used for all transactions. Can be Usd for United States dollar, Cad for Canadian Dollar, or Eur for Euro. This can be overridden on a per request basis.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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",
    "required": false
  },
  "isCashBackAllowed": {
    "description": "Set to true to allow cashback.",
    "type": "boolean",
    "required": false
  },
  "isConvenienceFeeAllowed": {
    "description": "Set to true to allow convenience fees to be added.",
    "type": "boolean",
    "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",
    "required": false
  },
  "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",
    "required": false
  },
  "isTipAllowed": {
    "description": "Set to true to allow tips to be added.",
    "type": "boolean",
    "required": false
  },
  "marketCode": {
    "description": "The market code specific to the type of transaction being submitted. This global value can be set, but it can be overridden by a lane configuration value or a request value. AutoRental, DirectMarketing, ECommerce, FoodRestaurant, HotelLodging, Petroleum, Retail, QSR",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "required": false
  },
  "maximumCashbackAmount": {
    "description": "The maximum cashback amount you want to allow cardholders to get back",
    "type": "int",
    "required": false
  },
  "signatureFormat": {
    "description": "The format which signature data should come back as. PointsLittleEndian, PointsBigEndian, Ascii3Byte",
    "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 calculated percentages (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",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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-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/api/v1/configuration/transaction undefined

Request Class

UpdateTransactionConfigurationRequest 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "confirmOriginalAmount": "boolean",
  "creditAvsEntryCondition": "string",
  "creditSaleSignatureThresholdAmount": "double",
  "currencyCode": "string",
  "debitSurcharge": "double",
  "isCashBackAllowed": "boolean",
  "isConvenienceFeeAllowed": "boolean",
  "isDebitSupported": "boolean",
  "isGiftSupported": "boolean",
  "isTipAllowed": "boolean",
  "marketCode": "string",
  "signatureFormat": "string",
  "cashBackIncrement": "int",
  "cashbackSelections": "Array<int>",
  "decimalTipSelections": "Array<double>",
  "maximumCashbackAmount": "int",
  "noneTipSelection": "boolean",
  "otherCashbackSelection": "boolean",
  "percentTipSelections": "Array<double>"
}
UpdateTransactionConfigurationRequest
Field Required Data Type Description
allowPartialApprovals true boolean If set to true, partial approvals are allowed.
checkForDuplicateTransactions true boolean If set to true, disables duplicate checking for all transactions. This can be overridden on a per request basis.
confirmOriginalAmount true boolean If set to true, the original transaction amount will be confirmed after card information is obtained.
creditAvsEntryCondition true string Set when AVS entry (billing postal code entry) should be prompted for credit transactions: 'Always', 'Never' or 'Keyed'.
Values:
  • Always
  • Never
  • Keyed
creditSaleSignatureThresholdAmount true double Leave as 0 or empty to always require a signature for credit sale, otherwise set to the amount that must be surpassed before asking for a signature, such as 25.00
currencyCode true string The currency code that will be used for all transactions. Can be Usd for United States dollar, Cad for Canadian Dollar, or Eur for Euro. This can be overridden on a per request basis.
Values:
  • None
  • Cad
  • Usd
  • Eur
debitSurcharge true double 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'
isCashBackAllowed true boolean Set to true to allow cashback.
isConvenienceFeeAllowed true boolean Set to true to allow convenience fees to be added.
isDebitSupported true boolean 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.
isGiftSupported true boolean 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 Set to true to allow tips to be added.
marketCode true string The market code specific to the type of transaction being submitted. This global value can be set, but it can be overridden by a lane configuration value or a request value.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
signatureFormat true string The format which signature data should come back as.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
cashBackIncrement false int Increments you want customers to be able to get back. Common values include, 1, 5, 10 and 20.
cashbackSelections false Array<int> Enter whole numbers separated by commas for the cashback amounts to select from.
decimalTipSelections false Array<double> Enter decimal numbers for tip amounts. If percent values were provided for tip amounts then these values will be ignored.
maximumCashbackAmount false int The maximum cashback amount you want to allow cardholders to get back
noneTipSelection false boolean Enter true to show "None" on the PIN pad during tip selection. If false is entered "Other" will be shown instead.
otherCashbackSelection false boolean 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.
UpdateTransactionConfigurationRequest 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed.",
    "type": "boolean",
    "allowableValues": {},
    "required": true
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for all transactions. This can be overridden on a per request basis.",
    "type": "boolean",
    "allowableValues": {},
    "required": true
  },
  "confirmOriginalAmount": {
    "description": "If set to true, the original transaction amount will be confirmed after card information is obtained.",
    "type": "boolean",
    "allowableValues": {},
    "required": true
  },
  "creditAvsEntryCondition": {
    "description": "Set when AVS entry (billing postal code entry) should be prompted for credit transactions: 'Always', 'Never' or 'Keyed'.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Always",
        "Never",
        "Keyed"
      ]
    },
    "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 surpassed before asking for a signature, such as 25.00",
    "type": "double",
    "allowableValues": {},
    "required": true
  },
  "currencyCode": {
    "description": "The currency code that will be used for all transactions. Can be Usd for United States dollar, Cad for Canadian Dollar, or Eur for Euro. This can be overridden on a per request basis.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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": {},
    "required": true
  },
  "isCashBackAllowed": {
    "description": "Set to true to allow cashback.",
    "type": "boolean",
    "allowableValues": {},
    "required": true
  },
  "isConvenienceFeeAllowed": {
    "description": "Set to true to allow convenience fees to be added.",
    "type": "boolean",
    "allowableValues": {},
    "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": {},
    "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": {},
    "required": true
  },
  "isTipAllowed": {
    "description": "Set to true to allow tips to be added.",
    "type": "boolean",
    "allowableValues": {},
    "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 by a lane configuration value or a request value. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "required": true
  },
  "signatureFormat": {
    "description": "The format which signature data should come back as.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "PointsLittleEndian",
        "PointsBigEndian",
        "Ascii3Byte"
      ]
    },
    "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": {},
    "required": false
  },
  "cashbackSelections": {
    "description": "Enter whole numbers separated by commas for the cashback amounts to select from.",
    "type": "Array",
    "items": {
      "type": "int"
    },
    "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"
    },
    "required": false
  },
  "maximumCashbackAmount": {
    "description": "The maximum cashback amount you want to allow cardholders to get back",
    "type": "int",
    "allowableValues": {},
    "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",
    "required": false
  },
  "otherCashbackSelection": {
    "description": "Enter true if you would like \"Other\" option to show up on cashback selection screen.",
    "type": "boolean",
    "allowableValues": {},
    "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"
    },
    "required": false
  }
}

Response Class

UpdateTransactionConfigurationResponse 
{
  "_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",
  "confirmOriginalAmount": "boolean",
  "creditAvsEntryCondition": "string",
  "creditSaleSignatureThresholdAmount": "double",
  "currencyCode": "string",
  "debitSurcharge": "double",
  "isCashBackAllowed": "boolean",
  "isConvenienceFeeAllowed": "boolean",
  "isDebitSupported": "boolean",
  "isGiftSupported": "boolean",
  "isTipAllowed": "boolean",
  "marketCode": "string",
  "maximumCashbackAmount": "int",
  "signatureFormat": "string",
  "tipSelections": "string",
  "transactionUpdated": "boolean"
}
UpdateTransactionConfigurationResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
allowPartialApprovals false boolean If set to true, partial approvals are allowed.
cashBackIncrement false string Increments you want customers to be able to get back. Common values include, 1, 5, 10 and 20.
cashBackSelections false string Enter whole numbers separated by commas for the cashback amounts to select from.
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for all transactions. This can be overridden on a per request basis.
confirmOriginalAmount false boolean If set to true, the original transaction amount will be confirmed after card information is obtained.
creditAvsEntryCondition false string Set when AVS entry (billing postal code entry) should be prompted for credit transactions: 'Always', 'Never' or 'Keyed'.
Values:
  • Always
  • Never
  • Keyed
creditSaleSignatureThresholdAmount false double Leave as 0 or empty to always require a signature for credit sale, otherwise set to the amount that must be surpassed before asking for a signature, such as 25.00
currencyCode false string The currency code that will be used for all transactions. Can be Usd for United States dollar, Cad for Canadian Dollar, or Eur for Euro. This can be overridden on a per request basis.
Values:
  • None
  • Cad
  • Usd
  • Eur
debitSurcharge false double 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'
isCashBackAllowed false boolean Set to true to allow cashback.
isConvenienceFeeAllowed false boolean Set to true to allow convenience fees to be added.
isDebitSupported false boolean 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.
isGiftSupported false boolean 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 false boolean Set to true to allow tips to be added.
marketCode false string The market code specific to the type of transaction being submitted. This global value can be set, but it can be overridden by a lane configuration value or a request value. AutoRental, DirectMarketing, ECommerce, FoodRestaurant, HotelLodging, Petroleum, Retail, QSR
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
maximumCashbackAmount false int The maximum cashback amount you want to allow cardholders to get back
signatureFormat false string The format which signature data should come back as. PointsLittleEndian, PointsBigEndian, Ascii3Byte
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
tipSelections false string Enter decimal numbers for tip amounts. Add percent sign after the number to display calculated percentages (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 True is transaction settings were updated successfully and false otherwise.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
UpdateTransactionConfigurationResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "cashBackIncrement": {
    "description": "Increments you want customers to be able to get back. Common values include, 1, 5, 10 and 20.",
    "type": "string",
    "required": false
  },
  "cashBackSelections": {
    "description": "Enter whole numbers separated by commas for the cashback amounts to select from.",
    "type": "string",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for all transactions. This can be overridden on a per request basis.",
    "type": "boolean",
    "required": false
  },
  "confirmOriginalAmount": {
    "description": "If set to true, the original transaction amount will be confirmed after card information is obtained.",
    "type": "boolean",
    "required": false
  },
  "creditAvsEntryCondition": {
    "description": "Set when AVS entry (billing postal code entry) should be prompted for credit transactions: 'Always', 'Never' or 'Keyed'.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Always",
        "Never",
        "Keyed"
      ]
    },
    "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 surpassed before asking for a signature, such as 25.00",
    "type": "double",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code that will be used for all transactions. Can be Usd for United States dollar, Cad for Canadian Dollar, or Eur for Euro. This can be overridden on a per request basis.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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",
    "required": false
  },
  "isCashBackAllowed": {
    "description": "Set to true to allow cashback.",
    "type": "boolean",
    "required": false
  },
  "isConvenienceFeeAllowed": {
    "description": "Set to true to allow convenience fees to be added.",
    "type": "boolean",
    "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",
    "required": false
  },
  "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",
    "required": false
  },
  "isTipAllowed": {
    "description": "Set to true to allow tips to be added.",
    "type": "boolean",
    "required": false
  },
  "marketCode": {
    "description": "The market code specific to the type of transaction being submitted. This global value can be set, but it can be overridden by a lane configuration value or a request value. AutoRental, DirectMarketing, ECommerce, FoodRestaurant, HotelLodging, Petroleum, Retail, QSR",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Default",
        "AutoRental",
        "DirectMarketing",
        "ECommerce",
        "FoodRestaurant",
        "HotelLodging",
        "Petroleum",
        "Retail",
        "Qsr"
      ]
    },
    "required": false
  },
  "maximumCashbackAmount": {
    "description": "The maximum cashback amount you want to allow cardholders to get back",
    "type": "int",
    "required": false
  },
  "signatureFormat": {
    "description": "The format which signature data should come back as. PointsLittleEndian, PointsBigEndian, Ascii3Byte",
    "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 calculated percentages (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",
    "required": false
  },
  "transactionUpdated": {
    "description": "True is transaction settings were updated successfully and false otherwise.",
    "type": "boolean",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
POST
/api/v1/credit [Deprecated] Use /api/v1/refund instead.

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-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/api/v1/credit undefined

Request Class

RefundRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}
RefundRequest
Field Required Data Type Description
laneId true int Specifies which lane to use.
transactionAmount true double The total transaction amount. This is the amount of funds to move on the card
cardHolderPresentCode false string Defines whether the card holder 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 An optional clerk number for reference.
configuration false POST_RequestConfiguration/api/v1/credit Any value included in this section will override the corresponding value set in the triPOS.config
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
RequestConfiguration
Field Required Data Type Description
allowPartialApprovals false boolean If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for the transaction.
currencyCode false string The currency code of the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
marketCode false string The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
RefundRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines whether the card holder 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"
      ]
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/api/v1/credit",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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"
      ]
    },
    "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",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "currencyCode": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "merchantId": "string",
  "paymentType": "string",
  "pinVerified": "boolean",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
RefundResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string The card account number.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
binValue false string The BIN entry that matched the account number.
cardHolderName false string The card holder name.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
currencyCode false string The currency code used in the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
entryMode false string Description of how card was entered.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessMsd
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentType false string Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
pinVerified false boolean True if the PIN was verified, false if not verified or undetermined.
signature false Signature The signature data.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction
totalAmount false double The total amount of the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Signature
Field Required Data Type Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardHolderName": {
    "description": "The card holder name.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessMsd"
      ]
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift"
      ]
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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"
      ]
    },
    "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"
      ]
    },
    "required": false
  }
}
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-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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
POST
/api/v1/force/credit Creates a new credit card force based on the passed in amounts.

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-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/api/v1/force/credit undefined

Request Class

ForceCreditRequest 
{
  "approvalNumber": "string",
  "laneId": "int",
  "transactionAmount": "double",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}
ForceCreditRequest
Field Required Data Type Description
approvalNumber true string The approval number of a voice authorization
laneId true int Specifies which lane to use.
transactionAmount true double The total transaction amount. This is the amount of funds to move on the card
cardHolderPresentCode false string Defines whether the card holder 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 An optional clerk number for reference.
configuration false POST_RequestConfiguration/api/v1/force/credit Any value included in this section will override the corresponding value set in the triPOS.config
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
RequestConfiguration
Field Required Data Type Description
allowPartialApprovals false boolean If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for the transaction.
currencyCode false string The currency code of the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
marketCode false string The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
ForceCreditRequest 
{
  "approvalNumber": {
    "description": "The approval number of a voice authorization",
    "type": "string",
    "required": true
  },
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines whether the card holder 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"
      ]
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/api/v1/force/credit",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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"
      ]
    },
    "required": false
  }
}

Response Class

ForceCreditResponse 
{
  "_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",
  "currencyCode": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "merchantId": "string",
  "paymentType": "string",
  "pinVerified": "boolean",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ForceCreditResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string The card account number.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
binValue false string The BIN entry that matched the account number.
cardHolderName false string The card holder name.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
currencyCode false string The currency code used in the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
entryMode false string Description of how card was entered.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessMsd
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentType false string Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
pinVerified false boolean True if the PIN was verified, false if not verified or undetermined.
signature false Signature The signature data.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction
totalAmount false double The total amount of the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Signature
Field Required Data Type Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
ForceCreditResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardHolderName": {
    "description": "The card holder name.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessMsd"
      ]
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift"
      ]
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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"
      ]
    },
    "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"
      ]
    },
    "required": false
  }
}
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-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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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-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/api/v1/gift/activate undefined

Request Class

ActivateGiftRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}
ActivateGiftRequest
Field Required Data Type Description
laneId true int Specifies which lane to use.
transactionAmount true double The total transaction amount. This is the amount of funds to move on the card
cardHolderPresentCode false string Defines whether the card holder 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 An optional clerk number for reference.
configuration false POST_RequestConfiguration/api/v1/gift/activate Any value included in this section will override the corresponding value set in the triPOS.config
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
RequestConfiguration
Field Required Data Type Description
allowPartialApprovals false boolean If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for the transaction.
currencyCode false string The currency code of the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
marketCode false string The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
ActivateGiftRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines whether the card holder 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"
      ]
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/api/v1/gift/activate",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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"
      ]
    },
    "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",
  "balanceAmount": "double",
  "balanceCurrencyCode": "string",
  "binValue": "string",
  "cardLogo": "string",
  "entryMode": "string",
  "isApproved": "boolean",
  "merchantId": "string",
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ActivateGiftResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string The card account number.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
balanceAmount false double The balance of the gift card.
balanceCurrencyCode false string The balance currency code.
binValue false string The BIN entry that matched the account number.
cardLogo false string The card logo (e.g. Visa, Mastercard, etc).
entryMode false string Description of how card was entered: Keyed, Swiped, Chip.
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction
totalAmount false double The total amount of the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "required": false
  },
  "balanceAmount": {
    "description": "The balance of the gift card.",
    "type": "double",
    "required": false
  },
  "balanceCurrencyCode": {
    "description": "The balance currency code.",
    "type": "string",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo (e.g. Visa, Mastercard, etc).",
    "type": "string",
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered: Keyed, Swiped, Chip.",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
POST
/api/v1/passthrough Accepts a request that is forwarded directly to the configured processor.

Parameters

Parameter Parameter Type Data Type Description
PassthroughRequest body POST_PassthroughRequest/api/v1/passthrough undefined

Request Class

PassthroughRequest 
{
  "rawXml": "string"
}
PassthroughRequest
Field Required Data Type Description
rawXml true string
PassthroughRequest 
{
  "rawXml": {
    "type": "string",
    "required": true
  }
}
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-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/api/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"
}
CreatePaymentAccountCreditRequest
Field Required Data Type Description
laneId true int The lane ID.
paymentAccountReferenceNumber true string The payment account reference number
address false POST_Address/api/v1/paymentAccount The cardholder address information for the transaction.
expirationMonth false string The expiration month.
expirationYear false string The expiration year.
Address
Field Required Data Type Description
billingAddress1 false string The street address used for billing purposes.
billingAddress2 false string The street address used for billing purposes.
billingCity false string The name of the city used for billing purposes.
billingEmail false string The e-mail address used for billing purposes.
billingName false string The name used for billing purposes.
billingPhone false string The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string The postal code used for billing purposes.
billingState false string 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 The street address used for shipping purposes.
shippingAddress2 false string The street address used for shipping purposes.
shippingCity false string The name of the city used for shipping purposes.
shippingEmail false string The e-mail address used for shipping purposes.
shippingName false string The name used for shipping purposes.
shippingPhone false string The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string The postal code used for shipping purposes.
shippingState false string 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",
    "required": true
  },
  "paymentAccountReferenceNumber": {
    "description": "The payment account reference number",
    "type": "string",
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/api/v1/paymentAccount",
    "required": false
  },
  "expirationMonth": {
    "description": "The expiration month.",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The expiration year.",
    "type": "string",
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "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",
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "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",
    "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"
  },
  "approvalNumber": "string",
  "binValue": "string",
  "cardLogo": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "merchantId": "string",
  "paymentAccountId": "string",
  "paymentAccountReferenceNumber": "string",
  "statusCode": "string",
  "terminalId": "string",
  "transactionDateTime": "string",
  "transactionId": "string"
}
CreatePaymentAccountCreditResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
binValue false string The BIN entry that matched the account number.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentAccountId false string the payment account ID.
paymentAccountReferenceNumber false string the payment account reference number.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountId": {
    "description": "the payment account ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountReferenceNumber": {
    "description": "the payment account reference number.",
    "type": "string",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction.",
    "type": "string",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
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-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/api/v1/paymentAccount/{paymentAccountId} undefined

Request Class

UpdatePaymentAccountCreditRequest 
{
  "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",
  "laneId": "int",
  "updateCardData": "boolean"
}
UpdatePaymentAccountCreditRequest
Field Required Data Type Description
paymentAccountReferenceNumber true string The payment account reference number
address false PUT_Address/api/v1/paymentAccount/{paymentAccountId} The cardholder address information for the transaction.
expirationMonth false string The expiration month.
expirationYear false string The expiration year.
laneId false int The Lane ID.
updateCardData false boolean The value that is passed in for UpdateCardData. Should be true or false.
Address
Field Required Data Type Description
billingAddress1 false string The street address used for billing purposes.
billingAddress2 false string The street address used for billing purposes.
billingCity false string The name of the city used for billing purposes.
billingEmail false string The e-mail address used for billing purposes.
billingName false string The name used for billing purposes.
billingPhone false string The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string The postal code used for billing purposes.
billingState false string 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 The street address used for shipping purposes.
shippingAddress2 false string The street address used for shipping purposes.
shippingCity false string The name of the city used for shipping purposes.
shippingEmail false string The e-mail address used for shipping purposes.
shippingName false string The name used for shipping purposes.
shippingPhone false string The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string The postal code used for shipping purposes.
shippingState false string 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",
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "PUT_Address/api/v1/paymentAccount/{paymentAccountId}",
    "required": false
  },
  "expirationMonth": {
    "description": "The expiration month.",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The expiration year.",
    "type": "string",
    "required": false
  },
  "laneId": {
    "description": "The Lane ID.",
    "type": "int",
    "required": false
  },
  "updateCardData": {
    "description": "The value that is passed in for UpdateCardData. Should be true or false.",
    "type": "boolean",
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "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",
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "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",
    "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"
  },
  "approvalNumber": "string",
  "binValue": "string",
  "cardLogo": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "merchantId": "string",
  "paymentAccountId": "string",
  "paymentAccountReferenceNumber": "string",
  "statusCode": "string",
  "terminalId": "string",
  "transactionDateTime": "string",
  "transactionId": "string"
}
UpdatePaymentAccountCreditResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
binValue false string The BIN entry that matched the account number.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentAccountId false string the payment account ID.
paymentAccountReferenceNumber false string the payment account reference number.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountId": {
    "description": "the payment account ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountReferenceNumber": {
    "description": "the payment account reference number.",
    "type": "string",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction.",
    "type": "string",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
DELETE
/api/v1/paymentAccount/{paymentAccountId} [BETA] 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
laneId body int The lane ID.
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-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.

Request Class

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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
merchantId false string The merchant ID.
paymentAccountId false string The payment account ID that was deleted.
terminalId false string The ID of the terminal used during the transaction
transactionDateTime false string Transaction date/time in ISO8601 format
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountId": {
    "description": "The payment account ID that was deleted.",
    "type": "string",
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
404 The payment account ID could not be found. Payment account not deleted.
PUT
/api/v1/paymentAccount/{paymentAccountId}/credit [Deprecated] Use /api/v1/paymentAccount/{paymentAccountId} instead.

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-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/api/v1/paymentAccount/{paymentAccountId}/credit undefined

Request Class

UpdatePaymentAccountCreditRequest 
{
  "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",
  "laneId": "int",
  "updateCardData": "boolean"
}
UpdatePaymentAccountCreditRequest
Field Required Data Type Description
paymentAccountReferenceNumber true string The payment account reference number
address false PUT_Address/api/v1/paymentAccount/{paymentAccountId}/credit The cardholder address information for the transaction.
expirationMonth false string The expiration month.
expirationYear false string The expiration year.
laneId false int The Lane ID.
updateCardData false boolean The value that is passed in for UpdateCardData. Should be true or false.
Address
Field Required Data Type Description
billingAddress1 false string The street address used for billing purposes.
billingAddress2 false string The street address used for billing purposes.
billingCity false string The name of the city used for billing purposes.
billingEmail false string The e-mail address used for billing purposes.
billingName false string The name used for billing purposes.
billingPhone false string The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string The postal code used for billing purposes.
billingState false string 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 The street address used for shipping purposes.
shippingAddress2 false string The street address used for shipping purposes.
shippingCity false string The name of the city used for shipping purposes.
shippingEmail false string The e-mail address used for shipping purposes.
shippingName false string The name used for shipping purposes.
shippingPhone false string The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string The postal code used for shipping purposes.
shippingState false string 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",
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "PUT_Address/api/v1/paymentAccount/{paymentAccountId}/credit",
    "required": false
  },
  "expirationMonth": {
    "description": "The expiration month.",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The expiration year.",
    "type": "string",
    "required": false
  },
  "laneId": {
    "description": "The Lane ID.",
    "type": "int",
    "required": false
  },
  "updateCardData": {
    "description": "The value that is passed in for UpdateCardData. Should be true or false.",
    "type": "boolean",
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "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",
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "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",
    "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"
  },
  "approvalNumber": "string",
  "binValue": "string",
  "cardLogo": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "merchantId": "string",
  "paymentAccountId": "string",
  "paymentAccountReferenceNumber": "string",
  "statusCode": "string",
  "terminalId": "string",
  "transactionDateTime": "string",
  "transactionId": "string"
}
UpdatePaymentAccountCreditResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
binValue false string The BIN entry that matched the account number.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentAccountId false string the payment account ID.
paymentAccountReferenceNumber false string the payment account reference number.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountId": {
    "description": "the payment account ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountReferenceNumber": {
    "description": "the payment account reference number.",
    "type": "string",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction.",
    "type": "string",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
POST
/api/v1/paymentAccount/credit [Deprecated] Use /api/v1/paymentAccount instead.

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-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/api/v1/paymentAccount/credit 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"
}
CreatePaymentAccountCreditRequest
Field Required Data Type Description
laneId true int The lane ID.
paymentAccountReferenceNumber true string The payment account reference number
address false POST_Address/api/v1/paymentAccount/credit The cardholder address information for the transaction.
expirationMonth false string The expiration month.
expirationYear false string The expiration year.
Address
Field Required Data Type Description
billingAddress1 false string The street address used for billing purposes.
billingAddress2 false string The street address used for billing purposes.
billingCity false string The name of the city used for billing purposes.
billingEmail false string The e-mail address used for billing purposes.
billingName false string The name used for billing purposes.
billingPhone false string The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string The postal code used for billing purposes.
billingState false string 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 The street address used for shipping purposes.
shippingAddress2 false string The street address used for shipping purposes.
shippingCity false string The name of the city used for shipping purposes.
shippingEmail false string The e-mail address used for shipping purposes.
shippingName false string The name used for shipping purposes.
shippingPhone false string The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string The postal code used for shipping purposes.
shippingState false string 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",
    "required": true
  },
  "paymentAccountReferenceNumber": {
    "description": "The payment account reference number",
    "type": "string",
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/api/v1/paymentAccount/credit",
    "required": false
  },
  "expirationMonth": {
    "description": "The expiration month.",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The expiration year.",
    "type": "string",
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "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",
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "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",
    "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"
  },
  "approvalNumber": "string",
  "binValue": "string",
  "cardLogo": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "merchantId": "string",
  "paymentAccountId": "string",
  "paymentAccountReferenceNumber": "string",
  "statusCode": "string",
  "terminalId": "string",
  "transactionDateTime": "string",
  "transactionId": "string"
}
CreatePaymentAccountCreditResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
binValue false string The BIN entry that matched the account number.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentAccountId false string the payment account ID.
paymentAccountReferenceNumber false string the payment account reference number.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountId": {
    "description": "the payment account ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountReferenceNumber": {
    "description": "the payment account reference number.",
    "type": "string",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction.",
    "type": "string",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
GET
/api/v1/pinpad/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-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",
    "expirationMonth": "string",
    "expirationYear": "string"
  },
  "nonFinancialCard": {
    "track1": "string",
    "track2": "string"
  }
}
CardResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
cardType false string 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 Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
FinancialCard
Field Required Data Type Description
accountNumber false string The card account number.
binValue false string The BIN entry that matched the account number.
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
NonFinancialCard
Field Required Data Type Description
track1 false string Track 1 of the non-financial card
track2 false string Track 2 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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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"
      ]
    },
    "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",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
FinancialCard 
{
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  }
}
NonFinancialCard 
{
  "track1": {
    "description": "Track 1 of the non-financial card",
    "type": "string",
    "required": false
  },
  "track2": {
    "description": "Track 2 of the non-financial card",
    "type": "string",
    "required": false
  }
}
GET
/api/v1/pinpad/card/{laneId} Get card info

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-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",
    "expirationMonth": "string",
    "expirationYear": "string"
  },
  "nonFinancialCard": {
    "track1": "string",
    "track2": "string"
  }
}
CardResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
cardType false string 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 Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
FinancialCard
Field Required Data Type Description
accountNumber false string The card account number.
binValue false string The BIN entry that matched the account number.
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
NonFinancialCard
Field Required Data Type Description
track1 false string Track 1 of the non-financial card
track2 false string Track 2 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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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"
      ]
    },
    "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",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
FinancialCard 
{
  "accountNumber": {
    "description": "The card account number.",
    "type": "string",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  }
}
NonFinancialCard 
{
  "track1": {
    "description": "Track 1 of the non-financial card",
    "type": "string",
    "required": false
  },
  "track2": {
    "description": "Track 2 of the non-financial card",
    "type": "string",
    "required": false
  }
}
GET
/api/v1/pinpad/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-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",
  "expirationMonth": "string",
  "expirationYear": "string"
}
FinancialCardResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string The card account number.
binValue false string The BIN entry that matched the account number.
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
GET
/api/v1/pinpad/card/financial/{laneId} Get financial card info.

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-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",
  "expirationMonth": "string",
  "expirationYear": "string"
}
FinancialCardResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string The card account number.
binValue false string The BIN entry that matched the account number.
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
GET
/api/v1/pinpad/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-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"
  },
  "track1": "string",
  "track2": "string"
}
NonFinancialCardResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
track1 false string Track 1 of the non-financial card
track2 false string Track 2 of the non-financial card
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "track1": {
    "description": "Track 1 of the non-financial card",
    "type": "string",
    "required": false
  },
  "track2": {
    "description": "Track 2 of the non-financial card",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
GET
/api/v1/pinpad/card/nonfinancial/{laneId} Get non-financial card info.

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-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"
  },
  "track1": "string",
  "track2": "string"
}
NonFinancialCardResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
track1 false string Track 1 of the non-financial card
track2 false string Track 2 of the non-financial card
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "track1": {
    "description": "Track 1 of the non-financial card",
    "type": "string",
    "required": false
  },
  "track2": {
    "description": "Track 2 of the non-financial card",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
GET
/api/v1/pinPadSelectionPrompt Displays a custom PIN pad prompt with custom selection options.

Parameters

Parameter Parameter Type Data Type Description
laneId query string The lane ID.
promptText query string The text to display to the cardholder.
options query string The options to provide to the cardholder. Separate each option with a pipe "|" (e.g. options=one|two|three)
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-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

PinPadSelectionResponse 
{
  "_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"
}
PinPadSelectionResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
selectionIndex false int The zero-based index of the option that the cardholder selected. The first option you pass in will be considered option 0.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
PinPadSelectionResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "selectionIndex": {
    "description": "The zero-based index of the option that the cardholder selected. The first option you pass in will be considered option 0.",
    "type": "int",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
POST
/api/v1/refund Creates a new card refund based on the passed in parameters.

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-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/api/v1/refund undefined

Request Class

RefundRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}
RefundRequest
Field Required Data Type Description
laneId true int Specifies which lane to use.
transactionAmount true double The total transaction amount. This is the amount of funds to move on the card
cardHolderPresentCode false string Defines whether the card holder 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 An optional clerk number for reference.
configuration false POST_RequestConfiguration/api/v1/refund Any value included in this section will override the corresponding value set in the triPOS.config
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
RequestConfiguration
Field Required Data Type Description
allowPartialApprovals false boolean If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for the transaction.
currencyCode false string The currency code of the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
marketCode false string The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
RefundRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines whether the card holder 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"
      ]
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/api/v1/refund",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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"
      ]
    },
    "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",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "currencyCode": "string",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "merchantId": "string",
  "paymentType": "string",
  "pinVerified": "boolean",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
RefundResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string The card account number.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
binValue false string The BIN entry that matched the account number.
cardHolderName false string The card holder name.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
currencyCode false string The currency code used in the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
entryMode false string Description of how card was entered.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessMsd
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentType false string Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
pinVerified false boolean True if the PIN was verified, false if not verified or undetermined.
signature false Signature The signature data.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction
totalAmount false double The total amount of the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Signature
Field Required Data Type Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardHolderName": {
    "description": "The card holder name.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessMsd"
      ]
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift"
      ]
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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"
      ]
    },
    "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"
      ]
    },
    "required": false
  }
}
POST
/api/v1/refund/{paymentAccountId} [BETA] 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-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/api/v1/refund/{paymentAccountId} undefined

Request Class

PaymentAccountRefundRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}
PaymentAccountRefundRequest
Field Required Data Type Description
laneId true int Specifies which lane to use for the card sale.
transactionAmount true double The total transaction amount. This is the amount of funds to move on the card
clerkNumber false string An optional clerk number for reference.
configuration false POST_RequestConfiguration/api/v1/refund/{paymentAccountId} Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
RequestConfiguration
Field Required Data Type Description
allowPartialApprovals false boolean If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for the transaction.
currencyCode false string The currency code of the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
marketCode false string 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",
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "required": true
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/api/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",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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"
      ]
    },
    "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",
  "merchantId": "string",
  "paymentAccountId": "string",
  "paymentAccountReferenceNumber": "string",
  "referenceNumber": "string",
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
PaymentAccountRefundResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double The convenience fee added to the transaction
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentAccountId false string The payment account ID.
paymentAccountReferenceNumber false string The payment account reference number.
referenceNumber false string The reference number.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction
totalAmount false double The total amount of the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountId": {
    "description": "The payment account ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountReferenceNumber": {
    "description": "The payment account reference number.",
    "type": "string",
    "required": false
  },
  "referenceNumber": {
    "description": "The reference number.",
    "type": "string",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
POST
/api/v1/return/{transactionId}/{paymentType} Creates a new card return based on the passed in parameters.

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-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/api/v1/return/{transactionId}/{paymentType} undefined

Request Class

ReturnRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}
ReturnRequest
Field Required Data Type Description
laneId true int Specifies which lane to use.
transactionAmount true double The total transaction amount. This is the amount of funds to move on the card
cardHolderPresentCode false string Defines whether the card holder 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 An optional clerk number for reference.
configuration false POST_RequestConfiguration/api/v1/return/{transactionId}/{paymentType} Any value included in this section will override the corresponding value set in the triPOS.config
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
RequestConfiguration
Field Required Data Type Description
allowPartialApprovals false boolean If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for the transaction.
currencyCode false string The currency code of the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
marketCode false string The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
ReturnRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines whether the card holder 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"
      ]
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/api/v1/return/{transactionId}/{paymentType}",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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"
      ]
    },
    "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",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "currencyCode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "merchantId": "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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string The card account number.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
binValue false string The BIN entry that matched the account number.
cardHolderName false string The card holder name.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
currencyCode false string The currency code used in the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentType false string Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
pinVerified false boolean True if the PIN was verified, false if not verified or undetermined.
signature false Signature The signature data.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction
totalAmount false double The total amount of the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Signature
Field Required Data Type Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardHolderName": {
    "description": "The card holder name.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift"
      ]
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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"
      ]
    },
    "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"
      ]
    },
    "required": false
  }
}
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.
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-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/api/v1/reversal/{transactionId}/{paymentType} undefined

Request Class

ReversalRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "marketCode": "string"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
TransactionIdRequestConfiguration 
{
  "marketCode": "string"
}
ReversalRequest
Field Required Data Type Description
laneId true int Specifies which lane to use.
transactionAmount true double The original transaction amount.
cardHolderPresentCode false string Defines whether the card holder 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 An optional clerk number for reference.
configuration false POST_TransactionIdRequestConfiguration/api/v1/reversal/{transactionId}/{paymentType} Any value included in this section will override the corresponding value set in the triPOS.config
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
TransactionIdRequestConfiguration
Field Required Data Type Description
marketCode false string The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
ReversalRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "required": true
  },
  "transactionAmount": {
    "description": "The original transaction amount. ",
    "type": "double",
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines whether the card holder 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"
      ]
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_TransactionIdRequestConfiguration/api/v1/reversal/{transactionId}/{paymentType}",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "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"
      ]
    },
    "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"
  },
  "approvalNumber": "string",
  "cardLogo": "string",
  "isApproved": "boolean",
  "merchantId": "string",
  "paymentType": "string",
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ReversalResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentType false string Original card payment type: Credit, Debit, Gift, EBT
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction
totalAmount false double The total amount of the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentType": {
    "description": "Original card payment type: Credit, Debit, Gift, EBT",
    "type": "string",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
POST
/api/v1/sale Creates a new card sale based on the passed in amounts.

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-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/api/v1/sale undefined

Request Class

SaleRequest 
{
  "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",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string",
  "tipAmount": "double"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}
SaleRequest
Field Required Data Type Description
laneId true int Specifies which lane to use.
transactionAmount true double The total transaction amount. This is the amount of funds to move on the card
address false POST_Address/api/v1/sale The cardholder address information for the transaction.
cardHolderPresentCode false string Defines whether the card holder 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 An optional clerk number for reference.
configuration false POST_RequestConfiguration/api/v1/sale Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
tipAmount false double The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
Address
Field Required Data Type Description
billingAddress1 false string The street address used for billing purposes.
billingAddress2 false string The street address used for billing purposes.
billingCity false string The name of the city used for billing purposes.
billingEmail false string The e-mail address used for billing purposes.
billingName false string The name used for billing purposes.
billingPhone false string The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string The postal code used for billing purposes.
billingState false string 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 The street address used for shipping purposes.
shippingAddress2 false string The street address used for shipping purposes.
shippingCity false string The name of the city used for shipping purposes.
shippingEmail false string The e-mail address used for shipping purposes.
shippingName false string The name used for shipping purposes.
shippingPhone false string The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string The postal code used for shipping purposes.
shippingState false string 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 Description
allowPartialApprovals false boolean If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for the transaction.
currencyCode false string The currency code of the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
marketCode false string The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
SaleRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/api/v1/sale",
    "required": false
  },
  "cardHolderPresentCode": {
    "description": "Defines whether the card holder 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"
      ]
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/api/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",
    "type": "double",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.",
    "type": "double",
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "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",
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "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",
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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"
      ]
    },
    "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",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "cashbackAmount": "double",
  "convenienceFeeAmount": "double",
  "currencyCode": "string",
  "debitSurchargeAmount": "double",
  "entryMode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "merchantId": "string",
  "paymentType": "string",
  "pinVerified": "boolean",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "tipAmount": "double",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
SaleResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string The card account number.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double The amount approved by the processor. This is the actual amount that will be charged or credited.
binValue false string The BIN entry that matched the account number.
cardHolderName false string The card holder name.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
cashbackAmount false double The cashback amount the card holder wants.
convenienceFeeAmount false double The convenience fee added to the transaction
currencyCode false string The currency code used in the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
debitSurchargeAmount false double The surcharge amount that was added to the transaction.
entryMode false string Description of how card was entered.
Values:
  • Unknown
  • Swiped
  • Keyed
  • ContactIcc
  • ContactlessMsd
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentType false string Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
pinVerified false boolean True if the PIN was verified, false if not verified or undetermined.
signature false Signature The signature data.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
subTotalAmount false double The original amount sent for the transaction.
terminalId false string The ID of the terminal used during the transaction
tipAmount false double The tip amount added to the transaction.
totalAmount false double The total amount of the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Signature
Field Required Data Type Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved by the processor. This is the actual amount that will be charged or credited.",
    "type": "double",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardHolderName": {
    "description": "The card holder name.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "cashbackAmount": {
    "description": "The cashback amount the card holder wants.",
    "type": "double",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "required": false
  },
  "debitSurchargeAmount": {
    "description": "The surcharge amount that was added to the transaction.",
    "type": "double",
    "required": false
  },
  "entryMode": {
    "description": "Description of how card was entered.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Swiped",
        "Keyed",
        "ContactIcc",
        "ContactlessMsd"
      ]
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift"
      ]
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "subTotalAmount": {
    "description": "The original amount sent for the transaction.",
    "type": "double",
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount added to the transaction.",
    "type": "double",
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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"
      ]
    },
    "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"
      ]
    },
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
400 If action is forward, triPOS returns an HTTP status code of 400 if the requestIdToForward is missing or is not a valid GUID.
404 If action is store or forward, triPOS returns an HTTP status code of 404 if the given requestIdToForward cannot be found in the database.
500 If action is store or forward, triPOS returns an HTTP status code of 500 if the stored message cannot be deserialized into the original stored object.
500 If action is store or forward, triPOS returns an HTTP status code of 500 if the stored message content is blank.
500 If action is store or forward, triPOS returns an HTTP status code of 500 if an error occurs while saving the sale to the database.
500 If action is store or forward, triPOS returns an HTTP status code of 500 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-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/api/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",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string",
  "tipAmount": "double"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}
PaymentAccountSaleRequest
Field Required Data Type Description
laneId true int Specifies which lane to use for the card sale.
transactionAmount true double The total transaction amount. This is the amount of funds to move on the card
address false POST_Address/api/v1/sale/{paymentAccountId} The cardholder address information for the transaction.
clerkNumber false string An optional clerk number for reference.
configuration false POST_RequestConfiguration/api/v1/sale/{paymentAccountId} Any value included in this section will override the corresponding value set in the triPOS.config
convenienceFeeAmount false double The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
tipAmount false double The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.
Address
Field Required Data Type Description
billingAddress1 false string The street address used for billing purposes.
billingAddress2 false string The street address used for billing purposes.
billingCity false string The name of the city used for billing purposes.
billingEmail false string The e-mail address used for billing purposes.
billingName false string The name used for billing purposes.
billingPhone false string The phone number used for billing purposes. The recommended format is (800)555-1212.
billingPostalCode false string The postal code used for billing purposes.
billingState false string 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 The street address used for shipping purposes.
shippingAddress2 false string The street address used for shipping purposes.
shippingCity false string The name of the city used for shipping purposes.
shippingEmail false string The e-mail address used for shipping purposes.
shippingName false string The name used for shipping purposes.
shippingPhone false string The phone number used for shipping purposes. The recommended format is (800)555-1212
shippingPostalCode false string The postal code used for shipping purposes.
shippingState false string 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 Description
allowPartialApprovals false boolean If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for the transaction.
currencyCode false string The currency code of the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
marketCode false string The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
PaymentAccountSaleRequest 
{
  "laneId": {
    "description": "Specifies which lane to use for the card sale.",
    "type": "int",
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "required": true
  },
  "address": {
    "description": "The cardholder address information for the transaction.",
    "type": "POST_Address/api/v1/sale/{paymentAccountId}",
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/api/v1/sale/{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",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged.",
    "type": "double",
    "required": false
  }
}
Address 
{
  "billingAddress1": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingAddress2": {
    "description": "The street address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingCity": {
    "description": "The name of the city used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingEmail": {
    "description": "The e-mail address used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingName": {
    "description": "The name used for billing purposes.",
    "type": "string",
    "required": false
  },
  "billingPhone": {
    "description": "The phone number used for billing purposes. The recommended format is (800)555-1212.",
    "type": "string",
    "required": false
  },
  "billingPostalCode": {
    "description": "The postal code used for billing purposes.",
    "type": "string",
    "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",
    "required": false
  },
  "shippingAddress1": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingAddress2": {
    "description": "The street address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingCity": {
    "description": "The name of the city used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingEmail": {
    "description": "The e-mail address used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingName": {
    "description": "The name used for shipping purposes.",
    "type": "string",
    "required": false
  },
  "shippingPhone": {
    "description": "The phone number used for shipping purposes. The recommended format is (800)555-1212",
    "type": "string",
    "required": false
  },
  "shippingPostalCode": {
    "description": "The postal code used for shipping purposes.",
    "type": "string",
    "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",
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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"
      ]
    },
    "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",
  "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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
approvedAmount false double The amount approved by the processor. This is the actual amount that will be charged or credited.
avsResponseCode false string The AVS response code.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
convenienceFeeAmount false double The convenience fee added to the transaction
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentAccountId false string The payment account ID.
paymentAccountReferenceNumber false string The payment account reference number.
referenceNumber false string The reference number.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
subTotalAmount false double The original amount sent for the transaction.
terminalId false string The ID of the terminal used during the transaction
tipAmount false double The tip amount added to the transaction.
totalAmount false double The total amount of the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "approvedAmount": {
    "description": "The amount approved by the processor. This is the actual amount that will be charged or credited.",
    "type": "double",
    "required": false
  },
  "avsResponseCode": {
    "description": "The AVS response code.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "convenienceFeeAmount": {
    "description": "The convenience fee added to the transaction",
    "type": "double",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountId": {
    "description": "The payment account ID.",
    "type": "string",
    "required": false
  },
  "paymentAccountReferenceNumber": {
    "description": "The payment account reference number.",
    "type": "string",
    "required": false
  },
  "referenceNumber": {
    "description": "The reference number.",
    "type": "string",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "subTotalAmount": {
    "description": "The original amount sent for the transaction.",
    "type": "double",
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "tipAmount": {
    "description": "The tip amount added to the transaction.",
    "type": "double",
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
POST
/api/v1/sale/{transactionId}/return/{paymentType} [Deprecated] Use /api/v1/return/{transactionId}/{paymentType} instead.

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-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/api/v1/sale/{transactionId}/return/{paymentType} undefined

Request Class

ReturnRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
RequestConfiguration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}
ReturnRequest
Field Required Data Type Description
laneId true int Specifies which lane to use.
transactionAmount true double The total transaction amount. This is the amount of funds to move on the card
cardHolderPresentCode false string Defines whether the card holder 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 An optional clerk number for reference.
configuration false POST_RequestConfiguration/api/v1/sale/{transactionId}/return/{paymentType} Any value included in this section will override the corresponding value set in the triPOS.config
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
RequestConfiguration
Field Required Data Type Description
allowPartialApprovals false boolean If set to true, partial approvals are allowed
checkForDuplicateTransactions false boolean If set to true, disables duplicate checking for the transaction.
currencyCode false string The currency code of the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
marketCode false string The market code of the transaction.
Values:
  • Default
  • AutoRental
  • DirectMarketing
  • ECommerce
  • FoodRestaurant
  • HotelLodging
  • Petroleum
  • Retail
  • Qsr
ReturnRequest 
{
  "laneId": {
    "description": "Specifies which lane to use.",
    "type": "int",
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines whether the card holder 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"
      ]
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_RequestConfiguration/api/v1/sale/{transactionId}/return/{paymentType}",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "required": false
  }
}
RequestConfiguration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": false
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code of the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "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"
      ]
    },
    "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",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "currencyCode": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "isApproved": "boolean",
  "merchantId": "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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string The card account number.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
binValue false string The BIN entry that matched the account number.
cardHolderName false string The card holder name.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
currencyCode false string The currency code used in the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
paymentType false string Description of payment type utilized.
Values:
  • None
  • Credit
  • Debit
  • Gift
pinVerified false boolean True if the PIN was verified, false if not verified or undetermined.
signature false Signature The signature data.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction
totalAmount false double The total amount of the transaction.
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Signature
Field Required Data Type Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "approvalNumber": {
    "description": "Approval number from the processor. Depending on card type and processor an approval number might not be returned.",
    "type": "string",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "cardHolderName": {
    "description": "The card holder name.",
    "type": "string",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "currencyCode": {
    "description": "The currency code used in the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Cad",
        "Usd",
        "Eur"
      ]
    },
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "paymentType": {
    "description": "Description of payment type utilized.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Credit",
        "Debit",
        "Gift"
      ]
    },
    "required": false
  },
  "pinVerified": {
    "description": "True if the PIN was verified, false if not verified or undetermined.",
    "type": "boolean",
    "required": false
  },
  "signature": {
    "description": "The signature data.",
    "type": "Signature",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "totalAmount": {
    "description": "The total amount of the transaction.",
    "type": "double",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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"
      ]
    },
    "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"
      ]
    },
    "required": false
  }
}
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-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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
GET
/api/v1/signature/{laneId} Prompts the user to enter a signature on the pinpad and returns the result.

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-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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 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 Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
Signature
Field Required Data Type Description
data false Array<byte> The byte array of the signature in the format specified by Format.
format false string The format of the signature.
Values:
  • PointsLittleEndian
  • PointsBigEndian
  • Ascii3Byte
statusCode false string Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "required": false
  },
  "_warnings": {
    "description": "A list of warnings that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiWarning"
    },
    "required": false
  },
  "laneId": {
    "description": "The lane ID.",
    "type": "int",
    "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",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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"
      ]
    },
    "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"
      ]
    },
    "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-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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}
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-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"
}
HostStatusResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
hostStatus false string The status of the connection between triPOS and the host.
Values:
  • Online
  • HostUnreachable
  • Offline
merchantId false string The merchant ID.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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"
      ]
    },
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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-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 Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
laneStatus false string The status of the lane.
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "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-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 Description
_type false string The type of object held in the result.
echo false string Provided text to be echoed back in the response.
TriPosStatusResponse 
{
  "_type": {
    "description": "The type of object held in the result.",
    "type": "string",
    "required": false
  },
  "echo": {
    "description": "Provided text to be echoed back in the response.",
    "type": "string",
    "required": false
  }
}
POST
/api/v1/token/paymetric/{transactionId} [BETA] 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-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/api/v1/token/paymetric/{transactionId} undefined

Request Class

CreatePaymetricTokenRequest 
{
  "laneId": "int",
  "vaultId": "string"
}
CreatePaymetricTokenRequest
Field Required Data Type Description
laneId true int The lane ID.
vaultId true string The Vault ID with Paymetric.
CreatePaymetricTokenRequest 
{
  "laneId": {
    "description": "The lane ID.",
    "type": "int",
    "required": true
  },
  "vaultId": {
    "description": "The Vault ID with Paymetric.",
    "type": "string",
    "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",
  "cardLogo": "string",
  "expirationMonth": "string",
  "expirationYear": "string",
  "merchantId": "string",
  "tokenId": "string",
  "tokenProvider": "string",
  "transactionDateTime": "string"
}
CreatePaymetricTokenResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
accountNumber false string The card account number.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
expirationMonth false string The card's expiration month
expirationYear false string The card's expiration year
merchantId false string The merchant ID used to process the transaction.
tokenId false string The Token ID.
tokenProvider false string The Token Provider.
transactionDateTime false string Transaction date/time in ISO8601 format
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.",
    "type": "string",
    "required": false
  },
  "expirationMonth": {
    "description": "The card's expiration month",
    "type": "string",
    "required": false
  },
  "expirationYear": {
    "description": "The card's expiration year",
    "type": "string",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID used to process the transaction.",
    "type": "string",
    "required": false
  },
  "tokenId": {
    "description": "The Token ID.",
    "type": "string",
    "required": false
  },
  "tokenProvider": {
    "description": "The Token Provider.",
    "type": "string",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}

Error Status Codes

HTTP Status Reason
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-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/api/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 Description
laneId true int Specifies which lane to use.
cardHolderPresentCode false string Defines whether the card holder 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 An optional clerk number for reference.
configuration false POST_TransactionIdRequestConfiguration/api/v1/void/{transactionId} Any value included in this section will override the corresponding value set in the triPOS.config
referenceNumber false string A user defined reference number. This reference number is returned in the response
shiftId false string An optional shift id for reference.
ticketNumber false string An optional ticket number.
TransactionIdRequestConfiguration
Field Required Data Type Description
marketCode false string 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",
    "required": true
  },
  "cardHolderPresentCode": {
    "description": "Defines whether the card holder 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"
      ]
    },
    "required": false
  },
  "clerkNumber": {
    "description": "An optional clerk number for reference.",
    "type": "string",
    "required": false
  },
  "configuration": {
    "description": "Any value included in this section will override the corresponding value set in the triPOS.config",
    "type": "POST_TransactionIdRequestConfiguration/api/v1/void/{transactionId}",
    "required": false
  },
  "referenceNumber": {
    "description": "A user defined reference number. This reference number is returned in the response",
    "type": "string",
    "required": false
  },
  "shiftId": {
    "description": "An optional shift id for reference.",
    "type": "string",
    "required": false
  },
  "ticketNumber": {
    "description": "An optional ticket number.",
    "type": "string",
    "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"
      ]
    },
    "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"
  },
  "approvalNumber": "string",
  "cardLogo": "string",
  "isApproved": "boolean",
  "merchantId": "string",
  "statusCode": "string",
  "terminalId": "string",
  "transactionDateTime": "string",
  "transactionId": "string"
}
VoidResponse
Field Required Data Type Description
_errors false Array<ApiError> A list of errors that occurred.
_hasErrors false boolean 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 The type of object held in the result.
_warnings false Array<ApiWarning> A list of warnings that occurred.
approvalNumber false string Approval number from the processor. Depending on card type and processor an approval number might not be returned.
cardLogo false string The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other
isApproved false boolean Set to true if the overall transaction was approved (not declined by the card).
merchantId false string The merchant ID.
statusCode false string The status code for the transaction.
Values:
  • None
  • Success
  • Declined
  • Approved
  • FullyApproved
  • 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
terminalId false string The ID of the terminal used during the transaction
transactionDateTime false string Transaction date/time in ISO8601 format
transactionId false string The transaction ID from the processor
ApiError
Field Required Data Type Description
developerMessage false string An error message targeted at the developer of the integrated business application.
errorType false string Code associated with the error if it exists.
exceptionMessage false string The body of the exception message.
exceptionTypeFullName false string The full name of the exception.
exceptionTypeShortName false string The short name of the exception.
userMessage false string An error message targeted at the end user of the integrated business application.
ApiLink
Field Required Data Type Description
href false string A target (a URI)
method false string The HTTP method to access the HREF target
rel false string The relation aka. 'rel' (the name of the link)
Processor
Field Required Data Type Description
expressResponseCode false string The response code received from Express.
expressResponseMessage false string The response message received from Express.
hostResponseCode false string 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 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 [DEPRECATED] Use rawResponse.
processorReferenceNumber false string [DEPRECATED] Use the same reference number passed in the request.
processorRequestFailed false boolean [DEPRECATED] Use top level properties (e.g. hasErrors).
processorRequestWasApproved false boolean [DEPRECATED] Use top level properties (e.g isApproved).
processorResponseCode false string [DEPRECATED] Use expressResponseCode.
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string [DEPRECATED] Use expressResponseMessage.
rawResponse false string The raw processor response. In the case of Express, this is the raw XML returned by the Express platform.
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
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",
    "required": false
  },
  "_links": {
    "description": "A list of resource links",
    "type": "Array",
    "items": {
      "$ref": "ApiLink"
    },
    "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",
    "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",
    "required": false
  },
  "cardLogo": {
    "description": "The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall transaction was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "merchantId": {
    "description": "The merchant ID.",
    "type": "string",
    "required": false
  },
  "statusCode": {
    "description": "The status code for the transaction.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "Success",
        "Declined",
        "Approved",
        "FullyApproved",
        "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"
      ]
    },
    "required": false
  },
  "terminalId": {
    "description": "The ID of the terminal used during the transaction",
    "type": "string",
    "required": false
  },
  "transactionDateTime": {
    "description": "Transaction date/time in ISO8601 format",
    "type": "string",
    "required": false
  },
  "transactionId": {
    "description": "The transaction ID from the processor",
    "type": "string",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "An error message targeted at the developer of the integrated business application.",
    "type": "string",
    "required": false
  },
  "errorType": {
    "description": "Code associated with the error if it exists.",
    "type": "string",
    "required": false
  },
  "exceptionMessage": {
    "description": "The body of the exception message.",
    "type": "string",
    "required": false
  },
  "exceptionTypeFullName": {
    "description": "The full name of the exception.",
    "type": "string",
    "required": false
  },
  "exceptionTypeShortName": {
    "description": "The short name of the exception.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "An error message targeted at the end user of the integrated business application.",
    "type": "string",
    "required": false
  }
}
ApiLink 
{
  "href": {
    "description": "A target (a URI)",
    "type": "string",
    "required": false
  },
  "method": {
    "description": "The HTTP method to access the HREF target",
    "type": "string",
    "required": false
  },
  "rel": {
    "description": "The relation aka. 'rel' (the name of the link)",
    "type": "string",
    "required": false
  }
}
Processor 
{
  "expressResponseCode": {
    "description": "The response code received from Express.",
    "type": "string",
    "required": false
  },
  "expressResponseMessage": {
    "description": "The response message received from Express.",
    "type": "string",
    "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",
    "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",
    "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",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "[DEPRECATED] Use the same reference number passed in the request.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "[DEPRECATED] Use top level properties (e.g. hasErrors).",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "[DEPRECATED] Use top level properties (e.g isApproved).",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "[DEPRECATED] Use expressResponseCode.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "[DEPRECATED] Use expressResponseMessage.",
    "type": "string",
    "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",
    "required": false
  }
}
ApiWarning 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "type": "string",
    "required": false
  },
  "userMessage": {
    "description": "A userMessage of the error.",
    "type": "string",
    "required": false
  }
}