/api

GET
/api/v1/ Returns an array of links for accessing triPOS

Parameters

Parameter Parameter Type Data Type Description
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.

Response Class

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 A developerMessage of the error.
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 A userMessage of the error.
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": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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
  }
}
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"
  }
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
POST
/api/v1/authorization Creates a new card authorization based on the passed in parameters.

Parameters

Parameter Parameter Type Data Type Description
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.
AuthorizationRequest body POST_AuthorizationRequest/api/v1/authorization

Request Class

AuthorizationRequest
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 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_Configuration/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
emvFallbackReason false string The EMV fallback reason of the transaction.
Values:
  • None
  • ChipReaderError
  • ChipCardError
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.
Configuration
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 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 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",
    "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_Configuration/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
  },
  "emvFallbackReason": {
    "description": "The EMV fallback reason of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "ChipReaderError",
        "ChipCardError"
      ]
    },
    "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
  }
}
Configuration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": true
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": true
  },
  "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
  }
}
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",
  "emvFallbackReason": "string",
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string",
  "tipAmount": "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"
}
Configuration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}

Response Class

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.
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 (e.g. Visa, Mastercard, etc).
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: Keyed, Swiped, Chip.
isApproved false boolean Set to true if the overall sale was approved (not declined by the card).
paymentType false string Description of how card payment type: None, Credit, Debit.
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
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 A developerMessage of the error.
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 A userMessage of the error.
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
processorLogs false Array<string> A list of messages from the processor.
processorRawResponse false string The processor response. In the case of Express, this is the raw XML returned by the Express platform.
processorReferenceNumber false string Reference number of the transaction.
processorRequestFailed false boolean Set to true if the request to the processor has failed
processorRequestWasApproved false boolean Set to true if the sale was approved by the processor
processorResponseCode false string The response code received from the processor
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string A message sent from the processor
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.",
    "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 (e.g. Visa, Mastercard, etc).",
    "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: Keyed, Swiped, Chip.",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall sale was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "paymentType": {
    "description": "Description of how card payment type: None, Credit, Debit.",
    "type": "string",
    "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"
      ]
    },
    "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": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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 
{
  "processorLogs": {
    "description": "A list of messages from the processor.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "The processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "Reference number of the transaction.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "Set to true if the request to the processor has failed",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "Set to true if the sale was approved by the processor",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "The response code received from the processor",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "A message sent from the processor",
    "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
  }
}
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": {
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "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",
  "isApproved": "boolean",
  "paymentType": "string",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "tipAmount": "double",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
Processor 
{
  "processorLogs": "Array<string>",
  "processorRawResponse": "string",
  "processorReferenceNumber": "string",
  "processorRequestFailed": "boolean",
  "processorRequestWasApproved": "boolean",
  "processorResponseCode": "string",
  "processorResponseMessage": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
Signature 
{
  "data": "Array<byte>",
  "format": "string",
  "statusCode": "string"
}
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 transaction.
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.
AuthorizationCompletionRequest body POST_AuthorizationCompletionRequest/api/v1/authorization/{transactionId}/completion

Request Class

AuthorizationCompletionRequest
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
transactionId true string The ID of a previous transaction.
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_Configuration/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
emvFallbackReason false string The EMV fallback reason of the transaction.
Values:
  • None
  • ChipReaderError
  • ChipCardError
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.
Configuration
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 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 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
  },
  "transactionId": {
    "description": "The ID of a previous transaction.",
    "type": "string",
    "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_Configuration/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
  },
  "emvFallbackReason": {
    "description": "The EMV fallback reason of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "ChipReaderError",
        "ChipCardError"
      ]
    },
    "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
  }
}
Configuration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": true
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": true
  },
  "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
  }
}
AuthorizationCompletionRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "transactionId": "string",
  "address": {
    "billingAddress1": "string",
    "billingAddress2": "string",
    "billingCity": "string",
    "billingEmail": "string",
    "billingName": "string",
    "billingPhone": "string",
    "billingPostalCode": "string",
    "billingState": "string",
    "shippingAddress1": "string",
    "shippingAddress2": "string",
    "shippingCity": "string",
    "shippingEmail": "string",
    "shippingName": "string",
    "shippingPhone": "string",
    "shippingPostalCode": "string",
    "shippingState": "string"
  },
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "emvFallbackReason": "string",
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string",
  "tipAmount": "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"
}
Configuration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}

Response Class

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.
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 (e.g. Visa, Mastercard, etc).
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: Keyed, Swiped, Chip.
isApproved false boolean Set to true if the overall sale was approved (not declined by the card).
paymentType false string Description of how card payment type: None, Credit, Debit.
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
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 A developerMessage of the error.
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 A userMessage of the error.
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
processorLogs false Array<string> A list of messages from the processor.
processorRawResponse false string The processor response. In the case of Express, this is the raw XML returned by the Express platform.
processorReferenceNumber false string Reference number of the transaction.
processorRequestFailed false boolean Set to true if the request to the processor has failed
processorRequestWasApproved false boolean Set to true if the sale was approved by the processor
processorResponseCode false string The response code received from the processor
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string A message sent from the processor
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.",
    "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 (e.g. Visa, Mastercard, etc).",
    "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: Keyed, Swiped, Chip.",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall sale was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "paymentType": {
    "description": "Description of how card payment type: None, Credit, Debit.",
    "type": "string",
    "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"
      ]
    },
    "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": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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 
{
  "processorLogs": {
    "description": "A list of messages from the processor.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "The processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "Reference number of the transaction.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "Set to true if the request to the processor has failed",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "Set to true if the sale was approved by the processor",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "The response code received from the processor",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "A message sent from the processor",
    "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
  }
}
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": {
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "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",
  "isApproved": "boolean",
  "paymentType": "string",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "tipAmount": "double",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
Processor 
{
  "processorLogs": "Array<string>",
  "processorRawResponse": "string",
  "processorReferenceNumber": "string",
  "processorRequestFailed": "boolean",
  "processorRequestWasApproved": "boolean",
  "processorResponseCode": "string",
  "processorResponseMessage": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
Signature 
{
  "data": "Array<byte>",
  "format": "string",
  "statusCode": "string"
}
POST
/api/v1/balance Requests a balance for a credit or gift card.

Parameters

Parameter Parameter Type Data Type Description
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.
BalanceQueryRequest body POST_BalanceQueryRequest/api/v1/balance

Request Class

BalanceQueryRequest
Field Required Data Type Description
laneId true int Specifies which lane to use for the card sale.
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_Configuration/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.
Configuration
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 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
BalanceQueryRequest 
{
  "laneId": {
    "description": "Specifies which lane to use for the card sale.",
    "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_Configuration/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
  }
}
Configuration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": true
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": true
  },
  "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
  }
}
BalanceQueryRequest 
{
  "laneId": "int",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
Configuration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}

Response Class

BalanceQueryResponse
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.
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 sale was approved (not declined by the card).
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
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 A developerMessage of the error.
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 A userMessage of the error.
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
processorLogs false Array<string> A list of messages from the processor.
processorRawResponse false string The processor response. In the case of Express, this is the raw XML returned by the Express platform.
processorReferenceNumber false string Reference number of the transaction.
processorRequestFailed false boolean Set to true if the request to the processor has failed
processorRequestWasApproved false boolean Set to true if the sale was approved by the processor
processorResponseCode false string The response code received from the processor
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string A message sent from the processor
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
BalanceQueryResponse 
{
  "_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.",
    "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 sale was approved (not declined by the card).",
    "type": "boolean",
    "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"
      ]
    },
    "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": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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 
{
  "processorLogs": {
    "description": "A list of messages from the processor.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "The processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "Reference number of the transaction.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "Set to true if the request to the processor has failed",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "Set to true if the sale was approved by the processor",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "The response code received from the processor",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "A message sent from the processor",
    "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
  }
}
BalanceQueryResponse 
{
  "_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": {
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "balanceAmount": "double",
  "balanceCurrencyCode": "string",
  "binValue": "string",
  "cardLogo": "string",
  "entryMode": "string",
  "isApproved": "boolean",
  "paymentType": "string",
  "statusCode": "string",
  "terminalId": "string",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
Processor 
{
  "processorLogs": "Array<string>",
  "processorRawResponse": "string",
  "processorReferenceNumber": "string",
  "processorRequestFailed": "boolean",
  "processorRequestWasApproved": "boolean",
  "processorResponseCode": "string",
  "processorResponseMessage": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
POST
/api/v1/credit Creates a new card credit based on the passed in parameters.

Parameters

Parameter Parameter Type Data Type Description
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.
CreditRequest body POST_CreditRequest/api/v1/credit

Request Class

CreditRequest
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
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_Configuration/api/v1/credit Any value included in this section will override the corresponding value set in the triPOS.config
emvFallbackReason false string The EMV fallback reason of the transaction.
Values:
  • None
  • ChipReaderError
  • ChipCardError
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.
Configuration
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 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
CreditRequest 
{
  "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
  },
  "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_Configuration/api/v1/credit",
    "required": false
  },
  "emvFallbackReason": {
    "description": "The EMV fallback reason of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "ChipReaderError",
        "ChipCardError"
      ]
    },
    "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
  }
}
Configuration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": true
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": true
  },
  "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
  }
}
CreditRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "emvFallbackReason": "string",
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
Configuration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}

Response Class

CreditResponse
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.
binValue false string The BIN entry that matched the account number.
cardHolderName false string The card holder name.
cardLogo false string The card logo (e.g. Visa, Mastercard, etc).
currencyCode false string The currency code used in the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
entryMode false string Description of how card was entered: Keyed, Swiped, Chip.
isApproved false boolean Set to true if the overall sale was approved (not declined by the card).
paymentType false string Description of how card payment type: None, Credit, Debit.
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
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 A developerMessage of the error.
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 A userMessage of the error.
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
processorLogs false Array<string> A list of messages from the processor.
processorRawResponse false string The processor response. In the case of Express, this is the raw XML returned by the Express platform.
processorReferenceNumber false string Reference number of the transaction.
processorRequestFailed false boolean Set to true if the request to the processor has failed
processorRequestWasApproved false boolean Set to true if the sale was approved by the processor
processorResponseCode false string The response code received from the processor
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string A message sent from the processor
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
CreditResponse 
{
  "_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.",
    "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 (e.g. Visa, Mastercard, etc).",
    "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: Keyed, Swiped, Chip.",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall sale was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "paymentType": {
    "description": "Description of how card payment type: None, Credit, Debit.",
    "type": "string",
    "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"
      ]
    },
    "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": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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 
{
  "processorLogs": {
    "description": "A list of messages from the processor.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "The processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "Reference number of the transaction.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "Set to true if the request to the processor has failed",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "Set to true if the sale was approved by the processor",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "The response code received from the processor",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "A message sent from the processor",
    "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
  }
}
CreditResponse 
{
  "_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": {
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "currencyCode": "string",
  "entryMode": "string",
  "isApproved": "boolean",
  "paymentType": "string",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
Processor 
{
  "processorLogs": "Array<string>",
  "processorRawResponse": "string",
  "processorReferenceNumber": "string",
  "processorRequestFailed": "boolean",
  "processorRequestWasApproved": "boolean",
  "processorResponseCode": "string",
  "processorResponseMessage": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
Signature 
{
  "data": "Array<byte>",
  "format": "string",
  "statusCode": "string"
}
POST
/api/v1/creditCardForce Creates a new credit card force based on the passed in amounts.

Parameters

Parameter Parameter Type Data Type Description
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.
CreditCardForceRequest body POST_CreditCardForceRequest/api/v1/creditCardForce

Request Class

CreditCardForceRequest
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
approvalNumber false string The approval number of a voice authorization
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_Configuration/api/v1/creditCardForce 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.
Configuration
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 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
CreditCardForceRequest 
{
  "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
  },
  "approvalNumber": {
    "description": "The approval number of a voice authorization",
    "type": "string",
    "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_Configuration/api/v1/creditCardForce",
    "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
  }
}
Configuration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": true
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": true
  },
  "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
  }
}
CreditCardForceRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "approvalNumber": "string",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
Configuration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}

Response Class

CreditCardForceResponse
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.
binValue false string The BIN entry that matched the account number.
cardHolderName false string The card holder name.
cardLogo false string The card logo (e.g. Visa, Mastercard, etc).
currencyCode false string The currency code used in the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
entryMode false string Description of how card was entered: Keyed, Swiped, Chip.
isApproved false boolean Set to true if the overall sale was approved (not declined by the card).
paymentType false string Description of how card payment type: None, Credit, Debit.
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
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 A developerMessage of the error.
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 A userMessage of the error.
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
processorLogs false Array<string> A list of messages from the processor.
processorRawResponse false string The processor response. In the case of Express, this is the raw XML returned by the Express platform.
processorReferenceNumber false string Reference number of the transaction.
processorRequestFailed false boolean Set to true if the request to the processor has failed
processorRequestWasApproved false boolean Set to true if the sale was approved by the processor
processorResponseCode false string The response code received from the processor
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string A message sent from the processor
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
CreditCardForceResponse 
{
  "_errors": {
    "description": "A list of errors that occurred.",
    "type": "Array",
    "items": {
      "$ref": "ApiError"
    },
    "required": false
  },
  "_hasErrors": {
    "description": "Indicates if there are errors.",
    "type": "boolean",
    "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.",
    "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 (e.g. Visa, Mastercard, etc).",
    "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: Keyed, Swiped, Chip.",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall sale was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "paymentType": {
    "description": "Description of how card payment type: None, Credit, Debit.",
    "type": "string",
    "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"
      ]
    },
    "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": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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 
{
  "processorLogs": {
    "description": "A list of messages from the processor.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "The processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "Reference number of the transaction.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "Set to true if the request to the processor has failed",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "Set to true if the sale was approved by the processor",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "The response code received from the processor",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "A message sent from the processor",
    "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
  }
}
CreditCardForceResponse 
{
  "_errors": {
    "developerMessage": "string",
    "errorType": "string",
    "exceptionMessage": "string",
    "exceptionTypeFullName": "string",
    "exceptionTypeShortName": "string",
    "userMessage": "string"
  },
  "_hasErrors": "boolean",
  "_links": {
    "href": "string",
    "method": "string",
    "rel": "string"
  },
  "_logs": "Array<string>",
  "_processor": {
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "currencyCode": "string",
  "entryMode": "string",
  "isApproved": "boolean",
  "paymentType": "string",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
Processor 
{
  "processorLogs": "Array<string>",
  "processorRawResponse": "string",
  "processorReferenceNumber": "string",
  "processorRequestFailed": "boolean",
  "processorRequestWasApproved": "boolean",
  "processorResponseCode": "string",
  "processorResponseMessage": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
Signature 
{
  "data": "Array<byte>",
  "format": "string",
  "statusCode": "string"
}
POST
/api/v1/giftCardActivate Activates the given gift card with the specified amount.

Parameters

Parameter Parameter Type Data Type Description
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.
GiftCardActivateRequest body POST_GiftCardActivateRequest/api/v1/giftCardActivate

Request Class

GiftCardActivateRequest
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
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_Configuration/api/v1/giftCardActivate 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.
Configuration
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 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
GiftCardActivateRequest 
{
  "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
  },
  "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_Configuration/api/v1/giftCardActivate",
    "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
  }
}
Configuration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": true
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": true
  },
  "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
  }
}
GiftCardActivateRequest 
{
  "laneId": "int",
  "transactionAmount": "double",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
Configuration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}

Response Class

GiftCardActivateResponse
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.
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 sale was approved (not declined by the card).
paymentType false string Description of how card payment type: None, Credit, Debit.
signatureStatusCode false string Indicates why a signature is or is not present.
Values:
  • Unknown
  • SignatureRequired
  • SignaturePresent
  • SignatureRequiredCancelledByCardholder
  • SignatureRequiredNotSupportedByPinPad
  • SignatureRequiredPinPadError
  • SignatureNotRequiredByThresholdAmount
  • SignatureNotRequiredByPaymentType
  • SignatureNotRequiredByTransactionType
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
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 A developerMessage of the error.
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 A userMessage of the error.
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
processorLogs false Array<string> A list of messages from the processor.
processorRawResponse false string The processor response. In the case of Express, this is the raw XML returned by the Express platform.
processorReferenceNumber false string Reference number of the transaction.
processorRequestFailed false boolean Set to true if the request to the processor has failed
processorRequestWasApproved false boolean Set to true if the sale was approved by the processor
processorResponseCode false string The response code received from the processor
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string A message sent from the processor
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
GiftCardActivateResponse 
{
  "_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.",
    "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 sale was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "paymentType": {
    "description": "Description of how card payment type: None, Credit, Debit.",
    "type": "string",
    "required": false
  },
  "signatureStatusCode": {
    "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
  },
  "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"
      ]
    },
    "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": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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 
{
  "processorLogs": {
    "description": "A list of messages from the processor.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "The processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "Reference number of the transaction.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "Set to true if the request to the processor has failed",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "Set to true if the sale was approved by the processor",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "The response code received from the processor",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "A message sent from the processor",
    "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
  }
}
GiftCardActivateResponse 
{
  "_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": {
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "balanceAmount": "double",
  "balanceCurrencyCode": "string",
  "binValue": "string",
  "cardLogo": "string",
  "entryMode": "string",
  "isApproved": "boolean",
  "paymentType": "string",
  "signatureStatusCode": "string",
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
Processor 
{
  "processorLogs": "Array<string>",
  "processorRawResponse": "string",
  "processorReferenceNumber": "string",
  "processorRequestFailed": "boolean",
  "processorRequestWasApproved": "boolean",
  "processorResponseCode": "string",
  "processorResponseMessage": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
GET
/api/v1/lanes Retrieve all lanes settings.

Parameters

Parameter Parameter Type Data Type Description
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.

Response Class

GetLanesResponse
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.
lanes false Array<Lane> The response of the lane config get lanes request.
ApiError
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
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 A userMessage of the error.
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.
Lane
Field Required Data Type Description
laneId false string Lane ID for lane setting.
description false string Description for lane setting.
initializeOnStartup false string Whether this lane should be initialized on stat up.
terminalType false string terminal type: Unknown = 0, PointOfSale = 1, ECommerce = 2, Moto = 3, FuelPump = 4, Atm = 5.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
comPort false string Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits false string If the PIN pad is connected via serial device, the data bit setting.
parity false string If the PIN pad is connected via serial device, the parity setting.
stopBits false string If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
handshake false string If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
baudRate false string Baud rate of serial communications. Valid values are: 75, 110, 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
ipAddress false string IP address of PIN pad if not connected via serial device.
ipPort false string IP port of PIN pad if not connected via serial device.
terminalId false string Terminal ID of PIN pad.
GetLanesResponse 
{
  "_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
  },
  "lanes": {
    "description": "The response of the lane config get lanes request.",
    "type": "Array",
    "items": {
      "$ref": "Lane"
    },
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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
  }
}
Lane 
{
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "string",
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown = 0, PointOfSale = 1, ECommerce = 2, Moto = 3, FuelPump = 4, Atm = 5.",
    "type": "string",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "required": false
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "required": false
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "required": false
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "required": false
  },
  "stopBits": {
    "description": "If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.  ",
    "type": "string",
    "required": false
  },
  "handshake": {
    "description": "If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.",
    "type": "string",
    "required": false
  },
  "baudRate": {
    "description": "Baud rate of serial communications. Valid values are: 75, 110, 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200.",
    "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
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "ipAddress": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  },
  "ipPort": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  }
}
GetLanesResponse 
{
  "_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"
  },
  "lanes": {
    "laneId": "string",
    "description": "string",
    "initializeOnStartup": "string",
    "terminalType": "string",
    "driver": "string",
    "comPort": "string",
    "dataBits": "string",
    "parity": "string",
    "stopBits": "string",
    "handshake": "string",
    "baudRate": "string",
    "isManualEntryAllowed": "string",
    "isContactlessMsdEntryAllowed": "string",
    "ipAddress": "string",
    "ipPort": "string",
    "terminalId": "string"
  }
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
Lane 
{
  "laneId": "string",
  "description": "string",
  "initializeOnStartup": "string",
  "terminalType": "string",
  "driver": "string",
  "comPort": "string",
  "dataBits": "string",
  "parity": "string",
  "stopBits": "string",
  "handshake": "string",
  "baudRate": "string",
  "isManualEntryAllowed": "string",
  "isContactlessMsdEntryAllowed": "string",
  "ipAddress": "string",
  "ipPort": "string",
  "terminalId": "string"
}
POST
/api/v1/lanes Creates a lane config based on the given data.

Implementation Notes

If PIN pad is connected via serial device then the additional fields are required: 'comPort', 'dataBits', 'parity', 'stopBits', 'handshake' and 'baudRate'. If PIN pad is not connected via serial device then the the following fields are required: 'ipAddress' and 'ipPort'.

Parameters

Parameter Parameter Type Data Type Description
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.
CreateLaneRequest body POST_CreateLaneRequest/api/v1/lanes

Request Class

CreateLaneRequest
Field Required Data Type Description
driver true string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent
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 string The desired lane ID.
terminalId true string Terminal ID.
terminalType true string The terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm
baudRate false string Baud rate of serial communications. Valid values are: 75, 110, 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200.
comPort false string If the PIN pad is not connected via IP, name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits false string If the PIN pad is connected via serial device, the data bit setting.
description false string Description of lane.
handshake false string If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
initializeOnStartup false string Set to true for this lane to be initialized on startup.
ipAddress false string IP address that is used if not connected to serial device
ipPort false string Port associated to IpAddress
parity false string If the PIN pad is connected via serial device, the parity setting.
stopBits false string If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
CreateLaneRequest 
{
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent",
    "type": "string",
    "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.",
    "type": "string",
    "required": true
  },
  "terminalId": {
    "description": "Terminal ID.",
    "type": "string",
    "required": true
  },
  "terminalType": {
    "description": "The terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm",
    "type": "string",
    "required": true
  },
  "baudRate": {
    "description": "Baud rate of serial communications. Valid values are: 75, 110, 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200.",
    "type": "string",
    "required": false
  },
  "comPort": {
    "description": "If the PIN pad is not connected via IP, name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "required": false
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "required": false
  },
  "description": {
    "description": "Description of lane.",
    "type": "string",
    "required": false
  },
  "handshake": {
    "description": "If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.",
    "type": "string",
    "required": false
  },
  "initializeOnStartup": {
    "description": "Set to true for this lane to be initialized on startup.",
    "type": "string",
    "required": false
  },
  "ipAddress": {
    "description": "IP address that is used if not connected to serial device",
    "type": "string",
    "required": false
  },
  "ipPort": {
    "description": "Port associated to IpAddress",
    "type": "string",
    "required": false
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "required": false
  },
  "stopBits": {
    "description": "If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.",
    "type": "string",
    "required": false
  }
}
CreateLaneRequest 
{
  "driver": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneId": "string",
  "terminalId": "string",
  "terminalType": "string",
  "baudRate": "string",
  "comPort": "string",
  "dataBits": "string",
  "description": "string",
  "handshake": "string",
  "initializeOnStartup": "string",
  "ipAddress": "string",
  "ipPort": "string",
  "parity": "string",
  "stopBits": "string"
}

Response Class

CreateLaneResponse
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.
laneCreated false boolean True if lane was created successfully and false otherwise.
ApiError
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
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 A userMessage of the error.
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.
CreateLaneResponse 
{
  "_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
  },
  "laneCreated": {
    "description": "True if lane was created successfully and false otherwise.",
    "type": "boolean",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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
  }
}
CreateLaneResponse 
{
  "_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"
  },
  "laneCreated": "boolean"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
DELETE
/api/v1/lanes/{laneId} Delete lanes settings for lane with laneId.

Parameters

Parameter Parameter Type Data Type Description
laneId path string The desired lane ID.
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.
DeleteLaneRequest body DELETE_DeleteLaneRequest/api/v1/lanes/{laneId}

Request Class

DeleteLaneRequest
Field Required Data Type Description
laneId true int The desired lane ID.
DeleteLaneRequest 
{
  "laneId": {
    "description": "The desired lane ID.",
    "type": "int",
    "required": true
  }
}
DeleteLaneRequest 
{
  "laneId": "int"
}

Response Class

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 A developerMessage of the error.
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 A userMessage of the error.
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": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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
  }
}
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"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
GET
/api/v1/lanes/{laneId} Retrieve specific lane settings.

Parameters

Parameter Parameter Type Data Type Description
laneId path string The desired lane ID.
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.

Response Class

GetLaneResponse
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.
lane false Lane The response of the lane config get lanes request.
ApiError
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
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 A userMessage of the error.
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.
Lane
Field Required Data Type Description
laneId false string Lane ID for lane setting.
description false string Description for lane setting.
initializeOnStartup false string Whether this lane should be initialized on stat up.
terminalType false string terminal type: Unknown = 0, PointOfSale = 1, ECommerce = 2, Moto = 3, FuelPump = 4, Atm = 5.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
comPort false string Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits false string If the PIN pad is connected via serial device, the data bit setting.
parity false string If the PIN pad is connected via serial device, the parity setting.
stopBits false string If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
handshake false string If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
baudRate false string Baud rate of serial communications. Valid values are: 75, 110, 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
ipAddress false string IP address of PIN pad if not connected via serial device.
ipPort false string IP port of PIN pad if not connected via serial device.
terminalId false string Terminal ID of PIN pad.
GetLaneResponse 
{
  "_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
  },
  "lane": {
    "description": "The response of the lane config get lanes request.",
    "type": "Lane",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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
  }
}
Lane 
{
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "string",
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown = 0, PointOfSale = 1, ECommerce = 2, Moto = 3, FuelPump = 4, Atm = 5.",
    "type": "string",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "required": false
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "required": false
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "required": false
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "required": false
  },
  "stopBits": {
    "description": "If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.  ",
    "type": "string",
    "required": false
  },
  "handshake": {
    "description": "If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.",
    "type": "string",
    "required": false
  },
  "baudRate": {
    "description": "Baud rate of serial communications. Valid values are: 75, 110, 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200.",
    "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
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "ipAddress": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  },
  "ipPort": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  }
}
GetLaneResponse 
{
  "_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"
  },
  "lane": {
    "laneId": "string",
    "description": "string",
    "initializeOnStartup": "string",
    "terminalType": "string",
    "driver": "string",
    "comPort": "string",
    "dataBits": "string",
    "parity": "string",
    "stopBits": "string",
    "handshake": "string",
    "baudRate": "string",
    "isManualEntryAllowed": "string",
    "isContactlessMsdEntryAllowed": "string",
    "ipAddress": "string",
    "ipPort": "string",
    "terminalId": "string"
  }
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
Lane 
{
  "laneId": "string",
  "description": "string",
  "initializeOnStartup": "string",
  "terminalType": "string",
  "driver": "string",
  "comPort": "string",
  "dataBits": "string",
  "parity": "string",
  "stopBits": "string",
  "handshake": "string",
  "baudRate": "string",
  "isManualEntryAllowed": "string",
  "isContactlessMsdEntryAllowed": "string",
  "ipAddress": "string",
  "ipPort": "string",
  "terminalId": "string"
}
PUT
/api/v1/lanes/{laneId} Updates lanes settings.

Parameters

Parameter Parameter Type Data Type Description
laneId path string The desired lane ID.
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.
UpdateLaneRequest body PUT_UpdateLaneRequest/api/v1/lanes/{laneId}

Request Class

UpdateLaneRequest
Field Required Data Type Description
driver true string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent
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 string The desired lane ID.
terminalId true string Terminal ID.
terminalType true string The terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm
baudRate false string Baud rate of serial communications. Valid values are: 75, 110, 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200.
comPort false string If the PIN pad is not connected via IP, name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits false string If the PIN pad is connected via serial device, the data bit setting.
description false string Description of lane.
handshake false string If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
initializeOnStartup false string Set to true for this lane to be initialized on startup.
ipAddress false string IP address that is used if not connected to serial device
ipPort false string Port associated to IpAddress
parity false string If the PIN pad is connected via serial device, the parity setting.
stopBits false string If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
UpdateLaneRequest 
{
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent",
    "type": "string",
    "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.",
    "type": "string",
    "required": true
  },
  "terminalId": {
    "description": "Terminal ID.",
    "type": "string",
    "required": true
  },
  "terminalType": {
    "description": "The terminal type: Unknown, PointOfSale, ECommerce, Moto, FuelPump, Atm",
    "type": "string",
    "required": true
  },
  "baudRate": {
    "description": "Baud rate of serial communications. Valid values are: 75, 110, 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200.",
    "type": "string",
    "required": false
  },
  "comPort": {
    "description": "If the PIN pad is not connected via IP, name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "required": false
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "required": false
  },
  "description": {
    "description": "Description of lane.",
    "type": "string",
    "required": false
  },
  "handshake": {
    "description": "If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.",
    "type": "string",
    "required": false
  },
  "initializeOnStartup": {
    "description": "Set to true for this lane to be initialized on startup.",
    "type": "string",
    "required": false
  },
  "ipAddress": {
    "description": "IP address that is used if not connected to serial device",
    "type": "string",
    "required": false
  },
  "ipPort": {
    "description": "Port associated to IpAddress",
    "type": "string",
    "required": false
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "required": false
  },
  "stopBits": {
    "description": "If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.",
    "type": "string",
    "required": false
  }
}
UpdateLaneRequest 
{
  "driver": "string",
  "isContactlessMsdEntryAllowed": "string",
  "isManualEntryAllowed": "string",
  "laneId": "string",
  "terminalId": "string",
  "terminalType": "string",
  "baudRate": "string",
  "comPort": "string",
  "dataBits": "string",
  "description": "string",
  "handshake": "string",
  "initializeOnStartup": "string",
  "ipAddress": "string",
  "ipPort": "string",
  "parity": "string",
  "stopBits": "string"
}

Response Class

UpdateLaneResponse
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.
lane false Lane The response of the lane config get lanes request.
laneUpdated false boolean True if lane was updated successfully and false otherwise.
ApiError
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
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 A userMessage of the error.
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.
Lane
Field Required Data Type Description
laneId false string Lane ID for lane setting.
description false string Description for lane setting.
initializeOnStartup false string Whether this lane should be initialized on stat up.
terminalType false string terminal type: Unknown = 0, PointOfSale = 1, ECommerce = 2, Moto = 3, FuelPump = 4, Atm = 5.
driver false string Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .
comPort false string Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
dataBits false string If the PIN pad is connected via serial device, the data bit setting.
parity false string If the PIN pad is connected via serial device, the parity setting.
stopBits false string If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.
handshake false string If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.
baudRate false string Baud rate of serial communications. Valid values are: 75, 110, 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200.
isManualEntryAllowed false string Whether or not manual entry of card account numbers on the PIN pad is allowed.
isContactlessMsdEntryAllowed false string whether or not contactless entry is allowed.
ipAddress false string IP address of PIN pad if not connected via serial device.
ipPort false string IP port of PIN pad if not connected via serial device.
terminalId false string Terminal ID of PIN pad.
UpdateLaneResponse 
{
  "_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
  },
  "lane": {
    "description": "The response of the lane config get lanes request.",
    "type": "Lane",
    "required": false
  },
  "laneUpdated": {
    "description": "True if lane was updated successfully and false otherwise.",
    "type": "boolean",
    "required": false
  }
}
ApiError 
{
  "developerMessage": {
    "description": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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
  }
}
Lane 
{
  "laneId": {
    "description": "Lane ID for lane setting.",
    "type": "string",
    "required": false
  },
  "description": {
    "description": "Description for lane setting.",
    "type": "string",
    "required": false
  },
  "initializeOnStartup": {
    "description": "Whether this lane should be initialized on stat up.",
    "type": "string",
    "required": false
  },
  "terminalType": {
    "description": "terminal type: Unknown = 0, PointOfSale = 1, ECommerce = 2, Moto = 3, FuelPump = 4, Atm = 5.",
    "type": "string",
    "required": false
  },
  "driver": {
    "description": "Driver values can be: Null, VeriFoneXpi, VeriFoneFormAgent .",
    "type": "string",
    "required": false
  },
  "comPort": {
    "description": "Name of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).",
    "type": "string",
    "required": false
  },
  "dataBits": {
    "description": "If the PIN pad is connected via serial device, the data bit setting.",
    "type": "string",
    "required": false
  },
  "parity": {
    "description": "If the PIN pad is connected via serial device, the parity setting.",
    "type": "string",
    "required": false
  },
  "stopBits": {
    "description": "If the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.  ",
    "type": "string",
    "required": false
  },
  "handshake": {
    "description": "If the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.",
    "type": "string",
    "required": false
  },
  "baudRate": {
    "description": "Baud rate of serial communications. Valid values are: 75, 110, 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200.",
    "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
  },
  "isContactlessMsdEntryAllowed": {
    "description": "whether or not contactless entry is allowed.",
    "type": "string",
    "required": false
  },
  "ipAddress": {
    "description": "IP address of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  },
  "ipPort": {
    "description": "IP port of PIN pad if not connected via serial device.",
    "type": "string",
    "required": false
  },
  "terminalId": {
    "description": "Terminal ID of PIN pad.",
    "type": "string",
    "required": false
  }
}
UpdateLaneResponse 
{
  "_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"
  },
  "lane": {
    "laneId": "string",
    "description": "string",
    "initializeOnStartup": "string",
    "terminalType": "string",
    "driver": "string",
    "comPort": "string",
    "dataBits": "string",
    "parity": "string",
    "stopBits": "string",
    "handshake": "string",
    "baudRate": "string",
    "isManualEntryAllowed": "string",
    "isContactlessMsdEntryAllowed": "string",
    "ipAddress": "string",
    "ipPort": "string",
    "terminalId": "string"
  },
  "laneUpdated": "boolean"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
Lane 
{
  "laneId": "string",
  "description": "string",
  "initializeOnStartup": "string",
  "terminalType": "string",
  "driver": "string",
  "comPort": "string",
  "dataBits": "string",
  "parity": "string",
  "stopBits": "string",
  "handshake": "string",
  "baudRate": "string",
  "isManualEntryAllowed": "string",
  "isContactlessMsdEntryAllowed": "string",
  "ipAddress": "string",
  "ipPort": "string",
  "terminalId": "string"
}
GET
/api/v1/lanes/{laneId}/status Returns the current status of the given lane.

Parameters

Parameter Parameter Type Data Type Description
laneId path string The desired lane ID.
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.

Response Class

GetLaneStatusResponse
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 A developerMessage of the error.
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 A userMessage of the error.
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.
GetLaneStatusResponse 
{
  "_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": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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
  }
}
GetLaneStatusResponse 
{
  "_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"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
POST
/api/v1/passthrough Accepts a request that is forwarded directly to the configured processor.

Parameters

Parameter Parameter Type Data Type Description
CreatePassthroughRequest body POST_CreatePassthroughRequest/api/v1/passthrough

Request Class

CreatePassthroughRequest
Field Required Data Type Description
rawXml true string
CreatePassthroughRequest 
{
  "rawXml": {
    "type": "string",
    "required": true
  }
}
CreatePassthroughRequest 
{
  "rawXml": "string"
}
PUT
/api/v1/paymentAccount/{paymentAccountId}/credit 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-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.
UpdatePaymentAccountRequest body PUT_UpdatePaymentAccountRequest/api/v1/paymentAccount/{paymentAccountId}/credit

Request Class

UpdatePaymentAccountRequest
Field Required Data Type Description
paymentAccountId true string The payment account ID to update.
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 LaneId. This may or may not be used depending on whether or not the card data is being updated.
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.
UpdatePaymentAccountRequest 
{
  "paymentAccountId": {
    "description": "The payment account ID to update.",
    "type": "string",
    "required": true
  },
  "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 LaneId. This may or may not be used depending on whether or not the card data is being updated.",
    "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
  }
}
UpdatePaymentAccountRequest 
{
  "paymentAccountId": "string",
  "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"
}
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"
}

Response Class

UpdatePaymentAccountResponse
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.
binValue false string The BIN entry that matched the account number.
isApproved false boolean Set to true if the overall sale was approved (not declined by the card).
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
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 A developerMessage of the error.
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 A userMessage of the error.
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
processorLogs false Array<string> A list of messages from the processor.
processorRawResponse false string The processor response. In the case of Express, this is the raw XML returned by the Express platform.
processorReferenceNumber false string Reference number of the transaction.
processorRequestFailed false boolean Set to true if the request to the processor has failed
processorRequestWasApproved false boolean Set to true if the sale was approved by the processor
processorResponseCode false string The response code received from the processor
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string A message sent from the processor
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
UpdatePaymentAccountResponse 
{
  "_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.",
    "type": "string",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall sale was approved (not declined by the card).",
    "type": "boolean",
    "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"
      ]
    },
    "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": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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 
{
  "processorLogs": {
    "description": "A list of messages from the processor.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "The processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "Reference number of the transaction.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "Set to true if the request to the processor has failed",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "Set to true if the sale was approved by the processor",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "The response code received from the processor",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "A message sent from the processor",
    "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
  }
}
UpdatePaymentAccountResponse 
{
  "_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": {
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "approvalNumber": "string",
  "binValue": "string",
  "isApproved": "boolean",
  "paymentAccountId": "string",
  "paymentAccountReferenceNumber": "string",
  "statusCode": "string",
  "terminalId": "string",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
Processor 
{
  "processorLogs": "Array<string>",
  "processorRawResponse": "string",
  "processorReferenceNumber": "string",
  "processorRequestFailed": "boolean",
  "processorRequestWasApproved": "boolean",
  "processorResponseCode": "string",
  "processorResponseMessage": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
POST
/api/v1/paymentAccount/credit Creates a card account token based on the given data.

Parameters

Parameter Parameter Type Data Type Description
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.
CreatePaymentAccountRequest body POST_CreatePaymentAccountRequest/api/v1/paymentAccount/credit

Request Class

CreatePaymentAccountRequest
Field Required Data Type Description
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.
laneId false int The lane ID. This may or may not be used depending on the payment account type.
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.
CreatePaymentAccountRequest 
{
  "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
  },
  "laneId": {
    "description": "The lane ID. This may or may not be used depending on the payment account type.",
    "type": "int",
    "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
  }
}
CreatePaymentAccountRequest 
{
  "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"
}
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"
}

Response Class

CreatePaymentAccountResponse
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.
binValue false string The BIN entry that matched the account number.
isApproved false boolean Set to true if the overall sale was approved (not declined by the card).
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
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 A developerMessage of the error.
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 A userMessage of the error.
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
processorLogs false Array<string> A list of messages from the processor.
processorRawResponse false string The processor response. In the case of Express, this is the raw XML returned by the Express platform.
processorReferenceNumber false string Reference number of the transaction.
processorRequestFailed false boolean Set to true if the request to the processor has failed
processorRequestWasApproved false boolean Set to true if the sale was approved by the processor
processorResponseCode false string The response code received from the processor
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string A message sent from the processor
ApiWarning
Field Required Data Type Description
developerMessage false string A developerMessage of the error.
userMessage false string A userMessage of the error.
CreatePaymentAccountResponse 
{
  "_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.",
    "type": "string",
    "required": false
  },
  "binValue": {
    "description": "The BIN entry that matched the account number.",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall sale was approved (not declined by the card).",
    "type": "boolean",
    "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"
      ]
    },
    "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": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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 
{
  "processorLogs": {
    "description": "A list of messages from the processor.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "The processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "Reference number of the transaction.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "Set to true if the request to the processor has failed",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "Set to true if the sale was approved by the processor",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "The response code received from the processor",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "A message sent from the processor",
    "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
  }
}
CreatePaymentAccountResponse 
{
  "_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": {
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "approvalNumber": "string",
  "binValue": "string",
  "isApproved": "boolean",
  "paymentAccountId": "string",
  "paymentAccountReferenceNumber": "string",
  "statusCode": "string",
  "terminalId": "string",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
Processor 
{
  "processorLogs": "Array<string>",
  "processorRawResponse": "string",
  "processorReferenceNumber": "string",
  "processorRequestFailed": "boolean",
  "processorRequestWasApproved": "boolean",
  "processorResponseCode": "string",
  "processorResponseMessage": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
POST
/api/v1/sale Creates a new card sale based on the passed in amounts.

Parameters

Parameter Parameter Type Data Type Description
tp-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.
SaleRequest body POST_SaleRequest/api/v1/sale

Request Class

SaleRequest
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 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
cashbackAmount false double The default amount of cashback. This amount is added to the TotalAmount before the cardholder is charged.
clerkNumber false string An optional clerk number for reference.
configuration false POST_Configuration/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
emvFallbackReason false string The EMV fallback reason of the transaction.
Values:
  • None
  • ChipReaderError
  • ChipCardError
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.
Configuration
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 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 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",
    "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
  },
  "cashbackAmount": {
    "description": "The default amount of cashback. This amount is added to the TotalAmount before the cardholder is charged.",
    "type": "double",
    "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_Configuration/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
  },
  "emvFallbackReason": {
    "description": "The EMV fallback reason of the transaction. ",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "None",
        "ChipReaderError",
        "ChipCardError"
      ]
    },
    "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
  }
}
Configuration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": true
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": true
  },
  "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
  }
}
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",
  "cashbackAmount": "double",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "convenienceFeeAmount": "double",
  "emvFallbackReason": "string",
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string",
  "tipAmount": "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"
}
Configuration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}

Response Class

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.
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 (e.g. Visa, Mastercard, etc).
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: Keyed, Swiped, Chip.
isApproved false boolean Set to true if the overall sale was approved (not declined by the card).
paymentType false string Description of how card payment type: None, Credit, Debit.
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
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 A developerMessage of the error.
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 A userMessage of the error.
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
processorLogs false Array<string> A list of messages from the processor.
processorRawResponse false string The processor response. In the case of Express, this is the raw XML returned by the Express platform.
processorReferenceNumber false string Reference number of the transaction.
processorRequestFailed false boolean Set to true if the request to the processor has failed
processorRequestWasApproved false boolean Set to true if the sale was approved by the processor
processorResponseCode false string The response code received from the processor
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string A message sent from the processor
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.",
    "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 (e.g. Visa, Mastercard, etc).",
    "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: Keyed, Swiped, Chip.",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall sale was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "paymentType": {
    "description": "Description of how card payment type: None, Credit, Debit.",
    "type": "string",
    "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"
      ]
    },
    "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": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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 
{
  "processorLogs": {
    "description": "A list of messages from the processor.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "The processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "Reference number of the transaction.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "Set to true if the request to the processor has failed",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "Set to true if the sale was approved by the processor",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "The response code received from the processor",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "A message sent from the processor",
    "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
  }
}
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": {
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "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",
  "isApproved": "boolean",
  "paymentType": "string",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "subTotalAmount": "double",
  "terminalId": "string",
  "tipAmount": "double",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
Processor 
{
  "processorLogs": "Array<string>",
  "processorRawResponse": "string",
  "processorReferenceNumber": "string",
  "processorRequestFailed": "boolean",
  "processorRequestWasApproved": "boolean",
  "processorResponseCode": "string",
  "processorResponseMessage": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
Signature 
{
  "data": "Array<byte>",
  "format": "string",
  "statusCode": "string"
}
POST
/api/v1/sale/{transactionId}/return/{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-return-logs header boolean Set to true to have logs populated in the response.
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 version.
tp-authorization header string The authorization header.
ReturnRequest body POST_ReturnRequest/api/v1/sale/{transactionId}/return/{paymentType}

Request Class

ReturnRequest
Field Required Data Type Description
laneId true int Specifies which lane to use for the card sale.
paymentType true string The original payment type.
Values:
  • Credit
  • Debit
  • Gift
transactionAmount true double The total transaction amount. This is the amount of funds to move on the card
transactionId true string The ID of a previous 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_Configuration/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.
Configuration
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 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 for the card sale.",
    "type": "int",
    "required": true
  },
  "paymentType": {
    "description": "The original payment type.",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Credit",
        "Debit",
        "Gift"
      ]
    },
    "required": true
  },
  "transactionAmount": {
    "description": "The total transaction amount. This is the amount of funds to move on the card",
    "type": "double",
    "required": true
  },
  "transactionId": {
    "description": "The ID of a previous transaction.",
    "type": "string",
    "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_Configuration/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
  }
}
Configuration 
{
  "allowPartialApprovals": {
    "description": "If set to true, partial approvals are allowed",
    "type": "boolean",
    "required": true
  },
  "checkForDuplicateTransactions": {
    "description": "If set to true, disables duplicate checking for the transaction.",
    "type": "boolean",
    "required": true
  },
  "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
  }
}
ReturnRequest 
{
  "laneId": "int",
  "paymentType": "string",
  "transactionAmount": "double",
  "transactionId": "string",
  "cardHolderPresentCode": "string",
  "clerkNumber": "string",
  "configuration": {
    "allowPartialApprovals": "boolean",
    "checkForDuplicateTransactions": "boolean",
    "currencyCode": "string",
    "marketCode": "string"
  },
  "referenceNumber": "string",
  "shiftId": "string",
  "ticketNumber": "string"
}
Configuration 
{
  "allowPartialApprovals": "boolean",
  "checkForDuplicateTransactions": "boolean",
  "currencyCode": "string",
  "marketCode": "string"
}

Response Class

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.
binValue false string The BIN entry that matched the account number.
cardHolderName false string The card holder name.
cardLogo false string The card logo (e.g. Visa, Mastercard, etc).
currencyCode false string The currency code used in the transaction.
Values:
  • None
  • Cad
  • Usd
  • Eur
entryMode false string Description of how card was entered: Keyed, Swiped, Chip.
isApproved false boolean Set to true if the overall sale was approved (not declined by the card).
paymentType false string Description of how card payment type: None, Credit, Debit.
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
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 A developerMessage of the error.
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 A userMessage of the error.
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
processorLogs false Array<string> A list of messages from the processor.
processorRawResponse false string The processor response. In the case of Express, this is the raw XML returned by the Express platform.
processorReferenceNumber false string Reference number of the transaction.
processorRequestFailed false boolean Set to true if the request to the processor has failed
processorRequestWasApproved false boolean Set to true if the sale was approved by the processor
processorResponseCode false string The response code received from the processor
Values:
  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
processorResponseMessage false string A message sent from the processor
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.",
    "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 (e.g. Visa, Mastercard, etc).",
    "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: Keyed, Swiped, Chip.",
    "type": "string",
    "required": false
  },
  "isApproved": {
    "description": "Set to true if the overall sale was approved (not declined by the card).",
    "type": "boolean",
    "required": false
  },
  "paymentType": {
    "description": "Description of how card payment type: None, Credit, Debit.",
    "type": "string",
    "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"
      ]
    },
    "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": "A developerMessage of the error.",
    "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": "A userMessage of the error.",
    "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 
{
  "processorLogs": {
    "description": "A list of messages from the processor.",
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": false
  },
  "processorRawResponse": {
    "description": "The processor response. In the case of Express, this is the raw XML returned by the Express platform.",
    "type": "string",
    "required": false
  },
  "processorReferenceNumber": {
    "description": "Reference number of the transaction.",
    "type": "string",
    "required": false
  },
  "processorRequestFailed": {
    "description": "Set to true if the request to the processor has failed",
    "type": "boolean",
    "required": false
  },
  "processorRequestWasApproved": {
    "description": "Set to true if the sale was approved by the processor",
    "type": "boolean",
    "required": false
  },
  "processorResponseCode": {
    "description": "The response code received from the processor",
    "type": "string",
    "allowableValues": {
      "valueType": "LIST",
      "values": [
        "Unknown",
        "Approved",
        "PartialApproval",
        "Decline",
        "ExpiredCard",
        "Duplicate",
        "PickUpCard",
        "ReferralCallIssuer",
        "InvalidData"
      ]
    },
    "required": false
  },
  "processorResponseMessage": {
    "description": "A message sent from the processor",
    "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
  }
}
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": {
    "processorLogs": "Array<string>",
    "processorRawResponse": "string",
    "processorReferenceNumber": "string",
    "processorRequestFailed": "boolean",
    "processorRequestWasApproved": "boolean",
    "processorResponseCode": "string",
    "processorResponseMessage": "string"
  },
  "_type": "string",
  "_warnings": {
    "developerMessage": "string",
    "userMessage": "string"
  },
  "accountNumber": "string",
  "approvalNumber": "string",
  "binValue": "string",
  "cardHolderName": "string",
  "cardLogo": "string",
  "currencyCode": "string",
  "entryMode": "string",
  "isApproved": "boolean",
  "paymentType": "string",
  "signature": {
    "data": "Array<byte>",
    "format": "string",
    "statusCode": "string"
  },
  "statusCode": "string",
  "terminalId": "string",
  "totalAmount": "double",
  "transactionDateTime": "string",
  "transactionId": "string"
}
ApiError 
{
  "developerMessage": "string",
  "errorType": "string",
  "exceptionMessage": "string",
  "exceptionTypeFullName": "string",
  "exceptionTypeShortName": "string",
  "userMessage": "string"
}
ApiLink 
{
  "href": "string",
  "method": "string",
  "rel": "string"
}
Processor 
{
  "processorLogs": "Array<string>",
  "processorRawResponse": "string",
  "processorReferenceNumber": "string",
  "processorRequestFailed": "boolean",
  "processorRequestWasApproved": "boolean",
  "processorResponseCode": "string",
  "processorResponseMessage": "string"
}
ApiWarning 
{
  "developerMessage": "string",
  "userMessage": "string"
}
Signature 
{
  "data": "Array<byte>",
  "format": "string",
  "statusCode": "string"
}

/postman

GET
/postman
POST
/postman

Parameters

Parameter Parameter Type Data Type Description
Postman body POST_Postman/postman

Request Class

Postman
Field Required Data Type Description
label true Array<string>
exportSession true boolean
ssid true string
sspid true string
ssopt true string
Postman 
{
  "label": {
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": true
  },
  "exportSession": {
    "type": "boolean",
    "required": true
  },
  "ssid": {
    "type": "string",
    "required": true
  },
  "sspid": {
    "type": "string",
    "required": true
  },
  "ssopt": {
    "type": "string",
    "required": true
  }
}
Postman 
{
  "label": "Array<string>",
  "exportSession": "boolean",
  "ssid": "string",
  "sspid": "string",
  "ssopt": "string"
}
PUT
/postman

Parameters

Parameter Parameter Type Data Type Description
Postman body PUT_Postman/postman

Request Class

Postman
Field Required Data Type Description
label true Array<string>
exportSession true boolean
ssid true string
sspid true string
ssopt true string
Postman 
{
  "label": {
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": true
  },
  "exportSession": {
    "type": "boolean",
    "required": true
  },
  "ssid": {
    "type": "string",
    "required": true
  },
  "sspid": {
    "type": "string",
    "required": true
  },
  "ssopt": {
    "type": "string",
    "required": true
  }
}
Postman 
{
  "label": "Array<string>",
  "exportSession": "boolean",
  "ssid": "string",
  "sspid": "string",
  "ssopt": "string"
}
DELETE
/postman

Parameters

Parameter Parameter Type Data Type Description
Postman body DELETE_Postman/postman

Request Class

Postman
Field Required Data Type Description
label true Array<string>
exportSession true boolean
ssid true string
sspid true string
ssopt true string
Postman 
{
  "label": {
    "type": "Array",
    "items": {
      "type": "string"
    },
    "required": true
  },
  "exportSession": {
    "type": "boolean",
    "required": true
  },
  "ssid": {
    "type": "string",
    "required": true
  },
  "sspid": {
    "type": "string",
    "required": true
  },
  "ssopt": {
    "type": "string",
    "required": true
  }
}
Postman 
{
  "label": "Array<string>",
  "exportSession": "boolean",
  "ssid": "string",
  "sspid": "string",
  "ssopt": "string"
}