3D Secure Options

Key Value Required Notes
channel String browser or app or merchant-initiated
type 3DSecureReequestType when channel is ‘merchant-initiated’  
session 3DSecureSessionInfo when channel is ‘browser’  
payment 3DSecurePaymentInfo when creating a Transaction  
account 3DSecureAccountInfo  
delivery 3DSecureDeliveryInfo when payment.type = goods-services  

3DSecure Request Type

JSON TYPE: String

Value Notes
recurring  
instalment  
add-card  
maintain-card  
account-verification  
delayed-shipment  
top-up  
mail  
phone  
other  

3DSecure Session Info

Key Value Required Notes
accept-header String  
challenge-window-size 3DSecureChallengeWindowSize when channel is ‘browser’  
element String when channel is ‘browser’ DOM selector for mounting challenge window
authentication 3DSecureSessionAuthenticationInfo when channel is ‘browser’  

3DSecure Challenge Window Size

JSON TYPE: String

Value Notes
small 250 x 400
medium 390 x 400
large 500 x 600
large-wide 600 x 400
fullscreen  

3DSecure Session Authentication Info

Key Value Required Notes
method 3DSecureAuthenticationMethod  
data [String](#string   Reserved for future authentication schemes which can provide proof of auth
timestamp Time when available  

3DSecure Authentication Method

JSON TYPE: String

Value Notes
guest The customer is not logged in
credentials Customer logged into the merchant site with credentials ex: username/password
federated Customer logged into the site with a federated identity, ex: Facebook or Google Login
issuer  
third-party  
fido  
signed-fido  
src  

3DSecure Payment Info

Key Value Required Notes
type 3DSecurePaymentType    
amount Integer when performed on Account object  
currency String when performed on Account object  
precision Integer when performed on Account object must match ISO3166-1 exponent
subscription 3DSecureSubscriptionInfo when the purchase is a recurring subscription  
gift-card 3DSecureGiftCardInfo when gift cards are purchased  

3DSecure Payment Type

JSON TYPE: String

Value Notes
goods-services  
check  
account-funding  
quasi-cash  
prepaid-activation  

3DSecure Subscription Info

Key Value Required Notes
identifier String Unique string for tracking the subscription
expiration Date on initialization Date after which the subscription will need to be reauthenticated
minimum-frequency Integer on initialization Value is in days, ex: 28 for a monthly subscription
maximum-amount Integer on initialization The maximum amount you will charge under the subscription if the initail charge is less than the recurring amount
currency String if initiating subscription on Account creation the currency of the subscription

3DSecure Gift Card Info

Key Value Required Notes
quantity Integer The number of gift cards in the order
amount Float The total amount being applied to the gift cards
currency Currency The currency the gift cards will be denominated in

3DSecure Account Info

Key Value Required Notes
status String new or existing or guest
created Date   If ommitted, Profile creation date used
last-updated Date   If ommited, most recent updated info from Profile is used
password-last-updated Date   * required when authentication type is ‘credentials’

3DSecure Delivery Info

Key Value Required Notes
method 3DSecureDeliveryMethod  
destination 3DSecureDeliveryDestinatioin  
email-address-id UUID   * if different from primary email on order
availabilty-date Date   * required when items ship at a later date

3DSecure Delivery Method

JSON TYPE: String

Value Notes
electronic  
same-day  
overnight  
two-or-more-days  

3DSecure Delivery Destination

JSON TYPE: String

Value Notes
billing-address The items are shipping to the billing address
verified-address The items are shipping to another verified address
other-address Items are shipping to an unknown/new address
store Items are shipping to store
digital Items are being delivered digitally
tickets Travel or Event Tickets that are not shipped
other