Parameters
| Parameter | Parameter Type | Data Type | Description |
|---|---|---|---|
| CardReturnRequest | body | POST_CardReturnRequest/api/v1/cardReturn |
Request Class
CardReturnRequest
CardTransactionWithTransactionId
| Field | Required | Data Type | Description |
|---|---|---|---|
| returnLogs | false | boolean | Set to true to have logs populated in the response. |
| laneId | true | int | Specifies which lane to use for the card sale. |
| transaction | false | POST_CardTransactionWithTransactionId/api/v1/cardReturn | Used to transmit information about the transaction, such as the amount to run the transaction for. |
| Field | Required | Data Type | Description |
|---|---|---|---|
| referenceNumber | false | string | A user defined reference number. This reference number is returned in the response |
| transactionAmount | false | double | The total transaction amount. This is the amount of funds to move on the card |
| transactionId | false | string | The ID of a previous transaction. |
CardReturnRequest
{
"returnLogs": {
"description": "Set to true to have logs populated in the response.",
"type": "boolean",
"required": false
},
"laneId": {
"description": "Specifies which lane to use for the card sale.",
"type": "int",
"required": true
},
"transaction": {
"description": "Used to transmit information about the transaction, such as the amount to run the transaction for.",
"type": "POST_CardTransactionWithTransactionId/api/v1/cardReturn",
"required": false
}
}
CardTransactionWithTransactionId
{
"referenceNumber": {
"description": "A user defined reference number. This reference number is returned in the response",
"type": "string",
"required": false
},
"transactionAmount": {
"description": "The total transaction amount. This is the amount of funds to move on the card",
"type": "double",
"required": false
},
"transactionId": {
"description": "The ID of a previous transaction.",
"type": "string",
"required": false
}
}
CardReturnRequest
{
"returnLogs": "boolean",
"laneId": "int",
"transaction": {
"referenceNumber": "string",
"transactionAmount": "double",
"transactionId": "string"
}
}
CardTransactionWithTransactionId
{
"referenceNumber": "string",
"transactionAmount": "double",
"transactionId": "string"
}
Response Class
CardReturnResponse
ApiError
CardReturnReceipt
Link
Signature
| Field | Required | Data Type | Description |
|---|---|---|---|
| errors | false | Array<ApiError> | A list of errors that occurred. |
| hasErrors | false | boolean | Indicates if there are errors. |
| 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. |
| result | false | CardReturnReceipt | The receipt of the card response. This element will always be returned, but may not be populated in certain cases. |
| Field | Required | Data Type | Description |
|---|---|---|---|
| description | false | string | A description of the error. |
| errorCode | 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. |
| Field | Required | Data Type | Description |
|---|---|---|---|
| links | false | Array<Link> | A list of resource links |
| approvalNumber | false | string | Approval number from the processor. |
| isApproved | false | boolean | Set to true if the overall sale was approved (not declined by the card). |
| 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 | int |
The response code received from the processor
Values:
|
| processorResponseCodeDescription | false | string |
The response code received from the processor
Values:
|
| processorResponseMessage | false | string | A message sent from the processor |
| statusCode | false | int |
The integer equivalent of the status for the transaction.
Values:
|
| statusCodeDescription | false | string |
The plain-text status of the transaction.
Values:
|
| 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 |
| accountNumber | false | string | The card account number. |
| 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 | int |
The currency code used in the transaction.
Values:
|
| currencyCodeDescription | false | string |
The currency code used in the transaction.
Values:
|
| entryMode | false | string | Description of how card was entered: Keyed, Swiped, Chip. |
| paymentType | false | string | Description of how card payment type: None, Credit, Debit. |
| signature | false | Signature | The signature data if a signature was requested. |
| signatureStatusCode | false | int |
Indicates why a signature is or is not present.
Values:
|
| signatureStatusCodeDescription | false | string |
A description of why a signature is or is not present.
Values:
|
| totalAmount | false | double | The total amount of the transaction. |
| 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) |
| 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:
|
CardReturnResponse
{
"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
},
"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
},
"result": {
"description": "The receipt of the card response. This element will always be returned, but may not be populated in certain cases.",
"type": "CardReturnReceipt",
"required": false
}
}
ApiError
{
"description": {
"description": "A description of the error.",
"type": "string",
"required": false
},
"errorCode": {
"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
}
}
CardReturnReceipt
{
"links": {
"description": "A list of resource links",
"type": "Array",
"items": {
"$ref": "Link"
},
"required": false
},
"approvalNumber": {
"description": "Approval number from the processor.",
"type": "string",
"required": false
},
"isApproved": {
"description": "Set to true if the overall sale was approved (not declined by the card).",
"type": "boolean",
"required": false
},
"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": "int",
"allowableValues": {
"valueType": "LIST",
"values": [
"0 = Unknown",
"1 = Approved",
"2 = PartialApproval",
"3 = Decline",
"4 = ExpiredCard",
"5 = Duplicate",
"6 = PickUpCard",
"7 = ReferralCallIssuer",
"8 = InvalidData"
]
},
"required": false
},
"processorResponseCodeDescription": {
"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
},
"statusCode": {
"description": "The integer equivalent of the status for the transaction.",
"type": "int",
"allowableValues": {
"valueType": "LIST",
"values": [
"0 = None",
"1 = Success",
"2 = Declined",
"3 = Approved",
"4 = FullyApproved",
"5 = Restart",
"6 = Failed",
"7 = HostError",
"8 = Timeout",
"9 = FailedVerification",
"10 = CardError",
"11 = UnknownCard",
"12 = UnsupportedCard",
"13 = DeviceError",
"14 = Cancelled",
"15 = ChipError",
"16 = PinPadError",
"17 = PinPadTimeout",
"18 = InvalidLane"
]
},
"required": false
},
"statusCodeDescription": {
"description": "The plain-text status of 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"
]
},
"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
},
"accountNumber": {
"description": "The card account number.",
"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": "int",
"allowableValues": {
"valueType": "LIST",
"values": [
"0 = None",
"124 = Cad",
"840 = Usd",
"978 = Eur"
]
},
"required": false
},
"currencyCodeDescription": {
"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
},
"paymentType": {
"description": "Description of how card payment type: None, Credit, Debit.",
"type": "string",
"required": false
},
"signature": {
"description": "The signature data if a signature was requested.",
"type": "Signature",
"required": false
},
"signatureStatusCode": {
"description": "Indicates why a signature is or is not present.",
"type": "int",
"allowableValues": {
"valueType": "LIST",
"values": [
"0 = Unknown",
"1 = SignatureRequired",
"2 = SignaturePresent",
"100 = SignatureRequiredCancelledByCardholder",
"101 = SignatureRequiredNotSupportedByPinPad",
"102 = SignatureRequiredPinPadError",
"200 = SignatureNotRequiredByThresholdAmount",
"201 = SignatureNotRequiredByPaymentType",
"202 = SignatureNotRequiredByTransactionType"
]
},
"required": false
},
"signatureStatusCodeDescription": {
"description": "A description of 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
},
"totalAmount": {
"description": "The total amount of the transaction.",
"type": "double",
"required": false
}
}
Link
{
"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
}
}
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
}
}
CardReturnResponse
{
"errors": {
"description": "string",
"errorCode": "string",
"exceptionMessage": "string",
"exceptionTypeFullName": "string",
"exceptionTypeShortName": "string"
},
"hasErrors": "boolean",
"logs": "Array<string>",
"type": "string",
"result": {
"links": {
"href": "string",
"method": "string",
"rel": "string"
},
"approvalNumber": "string",
"isApproved": "boolean",
"processorLogs": "Array<string>",
"processorRawResponse": "string",
"processorReferenceNumber": "string",
"processorRequestFailed": "boolean",
"processorRequestWasApproved": "boolean",
"processorResponseCode": "int",
"processorResponseCodeDescription": "string",
"processorResponseMessage": "string",
"statusCode": "int",
"statusCodeDescription": "string",
"terminalId": "string",
"transactionDateTime": "string",
"transactionId": "string",
"accountNumber": "string",
"binValue": "string",
"cardHolderName": "string",
"cardLogo": "string",
"currencyCode": "int",
"currencyCodeDescription": "string",
"entryMode": "string",
"paymentType": "string",
"signature": {
"data": "Array<byte>",
"format": "string"
},
"signatureStatusCode": "int",
"signatureStatusCodeDescription": "string",
"totalAmount": "double"
}
}
ApiError
{
"description": "string",
"errorCode": "string",
"exceptionMessage": "string",
"exceptionTypeFullName": "string",
"exceptionTypeShortName": "string"
}
CardReturnReceipt
{
"links": {
"href": "string",
"method": "string",
"rel": "string"
},
"approvalNumber": "string",
"isApproved": "boolean",
"processorLogs": "Array<string>",
"processorRawResponse": "string",
"processorReferenceNumber": "string",
"processorRequestFailed": "boolean",
"processorRequestWasApproved": "boolean",
"processorResponseCode": "int",
"processorResponseCodeDescription": "string",
"processorResponseMessage": "string",
"statusCode": "int",
"statusCodeDescription": "string",
"terminalId": "string",
"transactionDateTime": "string",
"transactionId": "string",
"accountNumber": "string",
"binValue": "string",
"cardHolderName": "string",
"cardLogo": "string",
"currencyCode": "int",
"currencyCodeDescription": "string",
"entryMode": "string",
"paymentType": "string",
"signature": {
"data": "Array<byte>",
"format": "string"
},
"signatureStatusCode": "int",
"signatureStatusCodeDescription": "string",
"totalAmount": "double"
}
Link
{
"href": "string",
"method": "string",
"rel": "string"
}
Signature
{
"data": "Array<byte>",
"format": "string"
}
Parameters
| Parameter | Parameter Type | Data Type | Description |
|---|---|---|---|
| CardSaleRequest | body | POST_CardSaleRequest/api/v1/cardSale |
Request Class
CardSaleRequest
CardSaleTransaction
Address
| Field | Required | Data Type | Description |
|---|---|---|---|
| returnLogs | false | boolean | Set to true to have logs populated in the response. |
| laneId | true | int | Specifies which lane to use for the card sale. |
| transaction | false | POST_CardSaleTransaction/api/v1/cardSale | Used to transmit information about the transaction, such as the amount to run the transaction for. |
| Field | Required | Data Type | Description |
|---|---|---|---|
| referenceNumber | false | string | A user defined reference number. This reference number is returned in the response |
| transactionAmount | false | double | The total transaction amount. This is the amount of funds to move on the card |
| address | false | POST_Address/api/v1/cardSale | The address information |
| convenienceFeeAmount | false | double | The convenience fee amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged |
| currencyCode | false | int |
The currency code of the transaction.
Values:
|
| marketCode | false | int |
The market code of the transaction.
Values:
|
| tipAmount | false | double | The tip amount of the transaction. This amount is added to the TotalAmount before the cardholder is charged. |
| cashbackAmount | false | double | The default amount of cashback. This amount is added to the TotalAmount before the cardholder is charged. |
| 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. |
CardSaleRequest
{
"returnLogs": {
"description": "Set to true to have logs populated in the response.",
"type": "boolean",
"required": false
},
"laneId": {
"description": "Specifies which lane to use for the card sale.",
"type": "int",
"required": true
},
"transaction": {
"description": "Used to transmit information about the transaction, such as the amount to run the transaction for.",
"type": "POST_CardSaleTransaction/api/v1/cardSale",
"required": false
}
}
CardSaleTransaction
{
"referenceNumber": {
"description": "A user defined reference number. This reference number is returned in the response",
"type": "string",
"required": false
},
"transactionAmount": {
"description": "The total transaction amount. This is the amount of funds to move on the card",
"type": "double",
"required": false
},
"address": {
"description": "The address information",
"type": "POST_Address/api/v1/cardSale",
"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
},
"currencyCode": {
"description": "The currency code of the transaction.",
"type": "int",
"allowableValues": {
"valueType": "LIST",
"values": [
"0 = None",
"124 = Cad",
"840 = Usd",
"978 = Eur"
]
},
"required": false
},
"marketCode": {
"description": "The market code of the transaction. ",
"type": "int",
"allowableValues": {
"valueType": "LIST",
"values": [
"0 = Default",
"1 = AutoRental",
"2 = DirectMarketing",
"3 = ECommerce",
"4 = FoodRestaurant",
"5 = HotelLodging",
"6 = Petroleum",
"7 = Retail",
"8 = Qsr"
]
},
"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
},
"cashbackAmount": {
"description": "The default amount of cashback. 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
}
}
CardSaleRequest
{
"returnLogs": "boolean",
"laneId": "int",
"transaction": {
"referenceNumber": "string",
"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"
},
"convenienceFeeAmount": "double",
"currencyCode": "int",
"marketCode": "int",
"tipAmount": "double",
"cashbackAmount": "double"
}
}
CardSaleTransaction
{
"referenceNumber": "string",
"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"
},
"convenienceFeeAmount": "double",
"currencyCode": "int",
"marketCode": "int",
"tipAmount": "double",
"cashbackAmount": "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"
}
Response Class
CardSaleResponse
ApiError
CardSaleReceipt
Link
Signature
| Field | Required | Data Type | Description |
|---|---|---|---|
| errors | false | Array<ApiError> | A list of errors that occurred. |
| hasErrors | false | boolean | Indicates if there are errors. |
| 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. |
| result | false | CardSaleReceipt | The receipt of the card response. This element will always be returned, but may not be populated in certain cases. |
| Field | Required | Data Type | Description |
|---|---|---|---|
| description | false | string | A description of the error. |
| errorCode | 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. |
| Field | Required | Data Type | Description |
|---|---|---|---|
| links | false | Array<Link> | A list of resource links |
| approvalNumber | false | string | Approval number from the processor. |
| isApproved | false | boolean | Set to true if the overall sale was approved (not declined by the card). |
| 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 | int |
The response code received from the processor
Values:
|
| processorResponseCodeDescription | false | string |
The response code received from the processor
Values:
|
| processorResponseMessage | false | string | A message sent from the processor |
| statusCode | false | int |
The integer equivalent of the status for the transaction.
Values:
|
| statusCodeDescription | false | string |
The plain-text status of the transaction.
Values:
|
| 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 |
| accountNumber | false | string | The card account number. |
| 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 | int |
The currency code used in the transaction.
Values:
|
| currencyCodeDescription | false | string |
The currency code used in the transaction.
Values:
|
| entryMode | false | string | Description of how card was entered: Keyed, Swiped, Chip. |
| paymentType | false | string | Description of how card payment type: None, Credit, Debit. |
| signature | false | Signature | The signature data if a signature was requested. |
| signatureStatusCode | false | int |
Indicates why a signature is or is not present.
Values:
|
| signatureStatusCodeDescription | false | string |
A description of why a signature is or is not present.
Values:
|
| totalAmount | false | double | The total amount of the transaction. |
| approvedAmount | false | double | The amount approved by the processor. This is the actual amount that will be charged or credited. |
| convenienceFeeAmount | false | double | The convenience fee added to the transaction |
| signatureThresholdAmount | false | double | The amount that total amount must surpass before asking for a signature on credit transactions |
| subTotalAmount | false | double | The original amount sent for the transaction. |
| tipAmount | false | double | The tip amount added to the transaction. |
| cashbackAmount | false | double | The cashback amount the card holder wants. |
| debitSurchargeAmount | false | double | The surcharge amount that was added to the transaction. |
| 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) |
| 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:
|
CardSaleResponse
{
"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
},
"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
},
"result": {
"description": "The receipt of the card response. This element will always be returned, but may not be populated in certain cases.",
"type": "CardSaleReceipt",
"required": false
}
}
ApiError
{
"description": {
"description": "A description of the error.",
"type": "string",
"required": false
},
"errorCode": {
"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
}
}
CardSaleReceipt
{
"links": {
"description": "A list of resource links",
"type": "Array",
"items": {
"$ref": "Link"
},
"required": false
},
"approvalNumber": {
"description": "Approval number from the processor.",
"type": "string",
"required": false
},
"isApproved": {
"description": "Set to true if the overall sale was approved (not declined by the card).",
"type": "boolean",
"required": false
},
"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": "int",
"allowableValues": {
"valueType": "LIST",
"values": [
"0 = Unknown",
"1 = Approved",
"2 = PartialApproval",
"3 = Decline",
"4 = ExpiredCard",
"5 = Duplicate",
"6 = PickUpCard",
"7 = ReferralCallIssuer",
"8 = InvalidData"
]
},
"required": false
},
"processorResponseCodeDescription": {
"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
},
"statusCode": {
"description": "The integer equivalent of the status for the transaction.",
"type": "int",
"allowableValues": {
"valueType": "LIST",
"values": [
"0 = None",
"1 = Success",
"2 = Declined",
"3 = Approved",
"4 = FullyApproved",
"5 = Restart",
"6 = Failed",
"7 = HostError",
"8 = Timeout",
"9 = FailedVerification",
"10 = CardError",
"11 = UnknownCard",
"12 = UnsupportedCard",
"13 = DeviceError",
"14 = Cancelled",
"15 = ChipError",
"16 = PinPadError",
"17 = PinPadTimeout",
"18 = InvalidLane"
]
},
"required": false
},
"statusCodeDescription": {
"description": "The plain-text status of 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"
]
},
"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
},
"accountNumber": {
"description": "The card account number.",
"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": "int",
"allowableValues": {
"valueType": "LIST",
"values": [
"0 = None",
"124 = Cad",
"840 = Usd",
"978 = Eur"
]
},
"required": false
},
"currencyCodeDescription": {
"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
},
"paymentType": {
"description": "Description of how card payment type: None, Credit, Debit.",
"type": "string",
"required": false
},
"signature": {
"description": "The signature data if a signature was requested.",
"type": "Signature",
"required": false
},
"signatureStatusCode": {
"description": "Indicates why a signature is or is not present.",
"type": "int",
"allowableValues": {
"valueType": "LIST",
"values": [
"0 = Unknown",
"1 = SignatureRequired",
"2 = SignaturePresent",
"100 = SignatureRequiredCancelledByCardholder",
"101 = SignatureRequiredNotSupportedByPinPad",
"102 = SignatureRequiredPinPadError",
"200 = SignatureNotRequiredByThresholdAmount",
"201 = SignatureNotRequiredByPaymentType",
"202 = SignatureNotRequiredByTransactionType"
]
},
"required": false
},
"signatureStatusCodeDescription": {
"description": "A description of 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
},
"totalAmount": {
"description": "The total amount of the transaction.",
"type": "double",
"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
},
"convenienceFeeAmount": {
"description": "The convenience fee added to the transaction",
"type": "double",
"required": false
},
"signatureThresholdAmount": {
"description": "The amount that total amount must surpass before asking for a signature on credit transactions",
"type": "double",
"required": false
},
"subTotalAmount": {
"description": "The original amount sent for the transaction.",
"type": "double",
"required": false
},
"tipAmount": {
"description": "The tip amount added to the transaction.",
"type": "double",
"required": false
},
"cashbackAmount": {
"description": "The cashback amount the card holder wants.",
"type": "double",
"required": false
},
"debitSurchargeAmount": {
"description": "The surcharge amount that was added to the transaction.",
"type": "double",
"required": false
}
}
Link
{
"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
}
}
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
}
}
CardSaleResponse
{
"errors": {
"description": "string",
"errorCode": "string",
"exceptionMessage": "string",
"exceptionTypeFullName": "string",
"exceptionTypeShortName": "string"
},
"hasErrors": "boolean",
"logs": "Array<string>",
"type": "string",
"result": {
"links": {
"href": "string",
"method": "string",
"rel": "string"
},
"approvalNumber": "string",
"isApproved": "boolean",
"processorLogs": "Array<string>",
"processorRawResponse": "string",
"processorReferenceNumber": "string",
"processorRequestFailed": "boolean",
"processorRequestWasApproved": "boolean",
"processorResponseCode": "int",
"processorResponseCodeDescription": "string",
"processorResponseMessage": "string",
"statusCode": "int",
"statusCodeDescription": "string",
"terminalId": "string",
"transactionDateTime": "string",
"transactionId": "string",
"accountNumber": "string",
"binValue": "string",
"cardHolderName": "string",
"cardLogo": "string",
"currencyCode": "int",
"currencyCodeDescription": "string",
"entryMode": "string",
"paymentType": "string",
"signature": {
"data": "Array<byte>",
"format": "string"
},
"signatureStatusCode": "int",
"signatureStatusCodeDescription": "string",
"totalAmount": "double",
"approvedAmount": "double",
"convenienceFeeAmount": "double",
"signatureThresholdAmount": "double",
"subTotalAmount": "double",
"tipAmount": "double",
"cashbackAmount": "double",
"debitSurchargeAmount": "double"
}
}
ApiError
{
"description": "string",
"errorCode": "string",
"exceptionMessage": "string",
"exceptionTypeFullName": "string",
"exceptionTypeShortName": "string"
}
CardSaleReceipt
{
"links": {
"href": "string",
"method": "string",
"rel": "string"
},
"approvalNumber": "string",
"isApproved": "boolean",
"processorLogs": "Array<string>",
"processorRawResponse": "string",
"processorReferenceNumber": "string",
"processorRequestFailed": "boolean",
"processorRequestWasApproved": "boolean",
"processorResponseCode": "int",
"processorResponseCodeDescription": "string",
"processorResponseMessage": "string",
"statusCode": "int",
"statusCodeDescription": "string",
"terminalId": "string",
"transactionDateTime": "string",
"transactionId": "string",
"accountNumber": "string",
"binValue": "string",
"cardHolderName": "string",
"cardLogo": "string",
"currencyCode": "int",
"currencyCodeDescription": "string",
"entryMode": "string",
"paymentType": "string",
"signature": {
"data": "Array<byte>",
"format": "string"
},
"signatureStatusCode": "int",
"signatureStatusCodeDescription": "string",
"totalAmount": "double",
"approvedAmount": "double",
"convenienceFeeAmount": "double",
"signatureThresholdAmount": "double",
"subTotalAmount": "double",
"tipAmount": "double",
"cashbackAmount": "double",
"debitSurchargeAmount": "double"
}
Link
{
"href": "string",
"method": "string",
"rel": "string"
}
Signature
{
"data": "Array<byte>",
"format": "string"
}
Parameters
| Parameter | Parameter Type | Data Type | Description |
|---|---|---|---|
| PassthroughRequest | body | POST_PassthroughRequest/api/v1/passthrough |
Request Class
PassthroughRequest
| Field | Required | Data Type | Description |
|---|---|---|---|
| rawXml | true | string |
PassthroughRequest
{
"rawXml": {
"type": "string",
"required": true
}
}
PassthroughRequest
{
"rawXml": "string"
}