Object Definition
The response object will be the Payload field within the JWT response.
Field | Type | Description | RequiredInclusion |
---|---|---|---|
ActionCode | AN(30) | The resulting state of the transaction. Possible values:
| Y |
Authorization | Authorization Object | Authorization object. Please see the specification below. | N |
AuthorizationProcessor | AuthorizationProcessor Object | N | |
Consumer | Consumer Object | Consumer object containing BillingAddress, ShippingAddress, and Account | N |
ErrorNumber | AN(255) | Application error number. A non-zero value represents the error encountered while attempting the process the message request. | Y |
ErrorDescription | AN(255) | Application error description for the associated error number. | Y |
Payment | Payment Object | NC | |
Validated | boolean | This value represents whether transaction was successfully or not. | Y |
Token | Token Object | The token details associated with this transaction | N |
Authorization
An object to pass the merchants intent to have Cardinal Cruise automatically authorize a Payeezy tokenization request. This should be passed on the start request.
Field | Type | Description | RequiredInclusion |
---|---|---|---|
AuthorizeAccount | Bool | A flag to indicate that an authorization should be automatically run. This flag is currently only used for Payeezy tokenization. | N |
AuthorizationProcessor
Status | ||||
---|---|---|---|---|
|
An object used to pass back transaction details from the Cardinal Cruise to the merchant.
Field | Type | Description | Inclusion |
---|---|---|---|
ProcessorOrderId | AN(50) | The OrderId returned back from the Processor | Y |
ProcessorTransactionId | AN(50) | The Transaction Identifier returned back from the Processor. | Y |
ReasonCode | AN(255) | Third party error number. A non-zero value represents the error encountered while attempting the process the message request. | N |
ReasonDescription | AN(255) | The third thrid party description for the associated ReasonCode | N |
Payment
Field | Type | Description | Inclusion |
---|---|---|---|
BillingAddress | Address | Consumers billing address. This field may not be present in every payment brand. | N |
ExtendedData | Payment Extension Object | This will contain an extension object that corresponds to the Payment Type of this transaction. Refer to the Payment object Type field for what extension type this field is. | N |
ProcessorTransactionId | AN(255) | The Transaction Identifier returned back from the Processor. | N |
OrderId | AN(255) | Centinel generated order identifier. Used to link multiple actions (authorize, capture, refund, etc) on a single order to a single identifier. Mod-10 compliant and unique BIN range to CardinalCommerce services. | Y |
OrderNumber | AN(255) | Order Number or transaction identifier from the Merchant website. | Y |
ShippingAddress | Address | Consumers shipping address. This field may not be present in every payment brand. | N |
Type | AN(50) | The payment type of this transaction. Possible Values:
| Y |
ReasonDescription | AN(255) | Third party error description for the associated ReasonCode. | N |
ExtendedData Extensions
Extensions allow for the passing of additional information thats specific to a payment brand type. The order object extensions are specifically used in the ExtendedData field of the Payment Object. The ExtendedData object type can be determined by using the Payment.Type field above. For example if Payment.Type = 'CCA' then the ExtendedData object will be the CCA object. If Payment.Type = 'VisaCheckout' the ExtendedData object will be the Visa Checkout extension.
Apple Pay
Status | ||||
---|---|---|---|---|
|
Field | Type | Description | RequiredInclusion |
---|---|---|---|
CAVV | AN(40) | Cardholder Authentication Verification Value (CAVV) Authentication Verification Value (AVV) Universal Cardholder Authentication Field (UCAF). Mastercard Only This value should be appended to the authorization message signifying that the transaction has been successfully authenticated. This value will be encoded according to the merchants configuration in either Base64 encoding or Hex encoding. A Base64 encoding merchant configuration will produce values of 28 or 32 characters. A Hex encoding merchant configuration will produce values of 40 or 48 characters. The value when decoded will either be 20 bytes for CAVV or 20 or 24 bytes if the value is AAV (MasterCard UCAF). | N |
ECIFlag | AN(40) | Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the gateway/processor. | N |
DeviceManufacturerIdentifier | AN | Hex-encoded device manufacturer identifier. | N |
PaymentDataType | AN | Either 3DSecure or, if using Apple Pay in China, EMV . | N |
CCA
Status | ||||
---|---|---|---|---|
|
Supported Brands Include: Visa, Mastercard, American Express, JCB, Diners Club, Elo, Cartes Bancaires (Co-branded)
Field | Type | Description | Required | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Enrolled | AN(1) | Status of Authentication eligibility. Possible Values:
NOTE: If the Enrolled value is NOT Y, then the Consumer is NOT eligible for Authenticationeligible for Authentication. | C Returned only in Cruise Standard integrations. | ||||||||||||||||||||||||||||||||
CAVV | AN(40) | Cardholder Authentication Verification Value (CAVV) Authentication Verification Value (AVV) Universal Cardholder Authentication Field (UCAF). Mastercard Only This value should be appended to the authorization message signifying that the transaction has been successfully authenticated. This value will be encoded according to the merchants configuration in either Base64 encoding or Hex encoding. A Base64 encoding merchant configuration will produce values of 28 or 32 characters. A Hex encoding merchant configuration will produce values of 40 or 48 characters. The value when decoded will either be 20 bytes for CAVV or 20 or 24 bytes if the value is AAV (MasterCard UCAF). | N | ||||||||||||||||||||||||||||||||
ECIFlag | AN(40) | Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the gateway/processor.
| N | ||||||||||||||||||||||||||||||||
PAResStatus | AN(1) | Transaction status result identifier. Possible Values:
| N | ||||||||||||||||||||||||||||||||
SignatureVerification | AN(1) | Transaction Signature status identifier. Possible Values:
| N | ||||||||||||||||||||||||||||||||
XID | AN(40) | Transaction identifier resulting from authentication processing. NOTE: Gateway/Processor API specification may require this value to be appended to the authorization message. This value will be encoded according to the merchants configuration in either Base64 encoding or Hex encoding. A Base64 encoding merchant configuration will produce values of 28 characters. A Hex encoding merchant configuration will produce values of 40 characters. | NC Returned only on AMEX transactions. | ||||||||||||||||||||||||||||||||
UCAFIndicator | AN(1) | Universal Cardholder Authentication Field (UCAF) Indicator value provided by the issuer. The UCAF is Mastercard specific and does not apply to other Card Brands. Possible Values: NOTE: This field is only returned for MasterCard transactions | N | ||||||||||||||||||||||||||||||||
ACSTransactionId | AN(36) | Unique transaction identifier assigned by the ACS to identify a single transaction. | C Returned only in Cruise Standard integrations. | ||||||||||||||||||||||||||||||||
ThreeDSServerTransactionId | AN(36) | Unique transaction identifier assigned by the 3DS Server to identify a single transaction. | C Returned only in Cruise Standard integrations. | ||||||||||||||||||||||||||||||||
DSTransactionId | AN(36) | Unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. NOTE: Required for Mastercard Identity Check transaction in Authorization | C | AuthorizationPayload (Cartes Bancaires Only) | Base64 Encoded Returned only in Cruise Standard integrations. | ||||||||||||||||||||||||||||||
AuthorizationPayload | Base64 encoded | The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow. Example File: AuthorizationPayload-JSON File | C Returned only when CardType is CB | ||||||||||||||||||||||||||||||||
CavvAlgorithm (Cartes Bancaires Only) | CBN(1) | Identifies the algorithm used by the ACS to calculate the the Authentication Value and is derived from the the "CB-AVALGO"O | C Returned only when CardType is CB | ||||||||||||||||||||||||||||||||
ChallengeCancel | N(2) | An indicator as to why the transaction was canceled. Possible Values: 01 - Cardholder selected 'Cancel' 02 - Reserved for future EMVCo use (values invalid until defined by EMVCo). 03 - Transaction Timed Out—Decoupled Authentication 04 - Transaction timed out at ACS—other timeouts 05 - Transaction Timed out at ACS - First CReq not received by ACS 06 - Transaction Error 07 - Unknown 08 = Transaction Timed Out at SDK NOTE: Only present when the Consumer cancels the challenge. Decoupled authenticationAuthentication is not supported at this time. | C |
Paypal
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Field | Type | Description | RequiredInclusion |
---|---|---|---|
Enrolled | AN(1) | Status of Authentication eligibility. Possible Values:
| N |
PAResStatus | AN(1) | Transaction status result identifier. Possible Values:
| N |
SignatureVerification | AN(1) | Transaction Signature status identifier. Possible Values:
| N |
UserEmail | AN(255) | Email address of the Consumer used at PayPal. | N |
BillingFullName | AN(128) | Name associated with the billing address. | N |
ShippingFullName | AN(128) | Name associated with the shipping address. | N |
UserFirstName | AN(64) | First name of the person associated with the PayPal account | N |
UserLastName | AN(64) | Last name of the person associated with the PayPal account | N |
BillingAddressStatus | AN(50) | PayPal Consumer Billing Address Status Possible Values:
| N |
ShippingAddressStatus | AN(50) | PayPal Consumer Shipping Address Status Possible Values:
| N |
UserStatus | AN(20) | PayPal Consumer Status Possible Values:
| N |
UserId | AN(130) | Payer Id assigned to the Consumer by PayPal. | N |
Visa Checkout
Status | ||||
---|---|---|---|---|
|
Field | Type | Description | Inclusion |
---|---|---|---|
Enrolled | AN(1) | Status of Authentication eligibility. Possible Values:
| N |
PAResStatus | AN(1) | Transaction status result identifier. Possible Values:
| N |
SignatureVerification | AN(1) | Transaction status result identifier. Possible Values:
| N |
UserEmail | AN(255) | Email address of the Consumer used at Visa Checkout. | N |
BillingFullName | AN(128) | Name associated with the billing address. | N |
ShippingFullName | AN(128) | Name associated with the shipping address. | N |
UserFirstName | AN(64) | First name of the person associated with the Visa Checkout account. | N |
UserLastName | AN(64) | Last name of the person associated with the Visa Checkout account. | N |
BillingAddressStatus | AN(50) | Visa Checkout Consumer Billing Address Status Possible Values:
| C |
ShippingAddressStatus | AN(50) | Visa Checkout Consumer Shipping Address Status Possible Values:
| C |
UserStatus | AN(20) | Visa Checkout Consumer Shipping Address Status Possible Values:
| Y |
UserId | AN(130) | Payer Id assigned to the consumer by Visa Checkout | N |
Shared Objects
Include Page | ||||
---|---|---|---|---|
|