This page deals with the objects you will get back from Songbird during the 'payments.validated' event.

Info

Badges indicate payment brand specific objects. For example if you see an object with the badge

Status

colour	Green
title	Apple Pay

you know that this object will only be present in an Apple Pay transaction.

Table of Contents

Object Definition

The response object will be the Payload field within the JWT response.

Field	Type	Description	Required
ActionCode	AN(30)	The resulting state of the transaction. Possible values: SUCCESS - The transaction resulted in success for the payment type used. For example, with a CCA transaction this would indicate the user has successfully completed authentication. NOACTION - The API calls to Centinel API were completed and there is no further actionable items to complete. This can indicate that the card holder is not enrolled in 3-D Secure or it could indicate a validation error was encountered at Centinel Core. It is recommended that the rest of the response is reviewed to determine what has occurred. FAILURE - The transaction resulted in an error. For example, with a CCA transaction this would indicate that the user failed authentication or an error was encountered while processing the transaction. ERROR - A service level error was encountered. These are generally reserved for connectivity or API authentication issues. For example if your JWT was incorrectly signed, or Cardinal services are currently unreachable.	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		N
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

Required

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

colour	Green
title	Processor Module

An object used to pass back transaction details from the Cardinal Cruise to the merchant.

Field	Type	Description
ProcessorOrderId	AN(50)	The OrderId returned back from the Processor
ProcessorTransactionId	AN(50)	The Transaction Identifier returned back from the Processor.
ReasonCode	AN(255)	Third party error number. A non-zero value represents the error encountered while attempting the process the message request.
ReasonDescription	AN(255)	The third party description for the associated ReasonCode

Payment

Field	Type	Description
BillingAddress	Address	Consumers billing address. This field may not be present in every payment brand.
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.
ProcessorTransactionId	AN(255)	The Transaction Identifier returned back from the Processor.
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.
OrderNumber	AN(255)	Order Number or transaction identifier from the Merchant website.
ShippingAddress	Address	Consumers shipping address. This field may not be present in every payment brand.
Type	AN(50)	The payment type of this transaction. Possible Values: CCA - Cardinal Consumer Authentication Paypal Wallet VisaCheckout ApplePay DiscoverWallet
ReasonDescription	AN(255)	Third party error description for the associated ReasonCode.

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

colour	Green
title	Apple Pay

Field	Type	Description	Required
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.
DeviceManufacturerIdentifier	AN	Hex-encoded device manufacturer identifier.
PaymentDataType	AN	Either `3DSecure` or, if using Apple Pay in China, `EMV`.

CCA

Status

colour	Green
title	CCA

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:

Y = Yes- Bank is participating in 3D Secure protocol and will return the ACSUrl
N = No - Bank is not participating in 3D Secure protocol
U = Unavailable - The DS or ACS is not available for authentication at the time of the request
B = Bypass- Merchant authentication rule is triggered to bypass authentication in this use case

NOTE: If the Enrolled value is NOT Y, then the Consumer is NOT eligible for Authentication.

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.

MasterCard	Visa	Amex	JCB	Diners Club	Elo	CB (Visa)	CB (Mastercard)
02	05	05	05	05	05	05	02
01	06	06	06	06	06	06	01
00	07	07	07	07	07	07	00

N

PAResStatus

AN(1)

Transaction status result identifier.

Possible Values:

Y – Successful Authentication
N – Failed Authentication
U – Unable to Complete Authentication
A – Successful Attempts Transaction

N

SignatureVerification

AN(1)

Transaction Signature status identifier.

Possible Values:

Y - Indicates that the signature of the PARes has been validated successfully and the message contents can be trusted.
N - Indicates that the PARes could not be validated. This result could be for a variety of reasons; tampering, certificate expiration, etc., and the result should not be trusted.

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.

N

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:
0 - Non-SecureCode transaction, bypassed by the Merchant
1 - Merchant-Only SecureCode transaction
2 - Fully authenticated SecureCode transaction

NOTE: This field is only returned for MasterCard transactions

ACSTransactionId

AN(36)

Unique transaction identifier assigned by the ACS to identify a single transaction.

C

ThreeDSServerTransactionId

AN(36)

Unique transaction identifier assigned by the 3DS Server to identify a single transaction.

C

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

The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow.

Example File:AuthorizationPayload-JSON File

C

CavvAlgorithm

(Cartes Bancaires Only)

CBN(1)

Identifies the algorithm used by the ACS to calculate the
Authentication Value and is derived from the "CB-AVALGO"

O

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 authentication is not supported at this time.

C

Paypal

Status

colour	Green
title	PayPal Express Checkout

Status

colour	Green
title	V.Zero

Field	Type	Description	Required
Enrolled	AN(1)	Status of Authentication eligibility. Possible Values: Y = Yes- Paypal is available and the response will contain the ACS url U = No - Paypal is unavailable.
PAResStatus	AN(1)	Transaction status result identifier. Possible Values: Y – Successful Authentication U – Unable to Complete Authentication	N
SignatureVerification	AN(1)	Transaction Signature status identifier. Possible Values: Y - Indicates that the signature of the data returned was verified and can be trusted. N - Indicates that the signature of the data returned could not be verified and cannot be trusted.	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: Confirmed - Customer provided a billing address that has been confirmed by PayPal. Unconfirmed - Customer provided an unconfirmed address. None - No status.	N
ShippingAddressStatus	AN(50)	PayPal Consumer Shipping Address Status Possible Values: Confirmed - Customer provided a shipping address that matches a billing address on record with PayPal and that billing address has been verified by AVS. Unconfirmed - Customer provided an unconfirmed address. None - No status.	N
UserStatus	AN(20)	PayPal Consumer Status Possible Values: Verified - Consumer has been verified by PayPal Unverified - Consumer has not been verified by PayPal	N
UserId	AN(130)	Payer Id assigned to the Consumer by PayPal.	N

Visa Checkout

Status

colour	Green
title	Visa Checkout

Field	Type	Description
Enrolled	AN(1)	Status of Authentication eligibility. Possible Values: Y = Yes- Visa Checkout is available and the response will contain the ACS url U = No - Visa Checkout is unavailable.
PAResStatus	AN(1)	Transaction status result identifier. Possible Values: Y - Successful Authentication U - Unable to Complete Authentication
SignatureVerification	AN(1)	Transaction status result identifier. Possible Values: Y - Indicates that the signature of the data returned was verified and can be trusted. U - Indicates that the signature of the data returned could not be verified and cannot be trusted.
UserEmail	AN(255)	Email address of the Consumer used at Visa Checkout.
BillingFullName	AN(128)	Name associated with the billing address.
ShippingFullName	AN(128)	Name associated with the shipping address.
UserFirstName	AN(64)	First name of the person associated with the Visa Checkout account.
UserLastName	AN(64)	Last name of the person associated with the Visa Checkout account.
BillingAddressStatus	AN(50)	Visa Checkout Consumer Billing Address Status Possible Values: Confirmed - Customer provided a billing address that has been confirmed by Visa Checkout. Unconfirmed - Customer provided an unconfirmed address. None - No status.
ShippingAddressStatus	AN(50)	Visa Checkout Consumer Shipping Address Status Possible Values: Confirmed - Customer provided a shipping address that matches a billing address on record with Visa Checkout and that billing address has been verified by AVS. Unconfirmed - Customer provided an unconfirmed address. None - No status.
UserStatus	AN(20)	Visa Checkout Consumer Shipping Address Status Possible Values: Verified - Consumer has been verified by Visa Checkout Unverified - Consumer has not been verified by Visa Checkout
UserId	AN(130)	Payer Id assigned to the consumer by Visa Checkout

Shared Objects

Include Page

	Shared Objects
	Shared Objects

Versions Compared

Old Version 19

New Version 20

Key

Object Definition

Authorization

AuthorizationProcessor

Payment

ExtendedData Extensions

Apple Pay

CCA

Paypal

Visa Checkout

Shared Objects

Page Comparison

Versions Compared

Old Version 19

New Version 20

Key

Object Definition

Authorization

AuthorizationProcessor

Payment

ExtendedData Extensions

Apple Pay

CCA

Paypal

Visa Checkout

Shared Objects