paysafe developer

Setup Function

The setup function creates and initializes the Paysafe Checkout in an overlay. It has the following parameters:

  • The Base64-encoded version of the single-use token API key used to authenticate with the Customer Vault REST API. Note that this key can only be used to generate single-use tokens for use with the Card Payments and Direct Debit APIs, and has no other API access rights, such as those required for taking payments. Consequently, this key can be exposed publicly in the user's browser.
  • An options object containing the environment to use (Test or Live), the payment amount, currency, and several parameters to personalize the payment form and customize its appearance.
  • A resultCallback function you provide to receive the Paysafe checkout instance, handle successful tokenization (by sending the token to your merchant server), or respond to any errors caused by a failed tokenization.
  • An optional closeCallback function you provide to handle the customer closing the payment overlay.

  • eventCallback - Invoked immediately after one or more events in Paysafe Checkout occur

The function signature is as follows:

paysafe.checkout.setup(apikey,options,resultsCallback,closeCallback, eventCallback);

Environment

The options object contains a string to select the environment to use for tokenization, either LIVE (the Paysafe Production environment) and TEST (the Paysafe Merchant Test or Sandbox environment).

Do not use real card numbers or other payment instrument details in the Merchant Test environment. It is not compliant with Payment Card Industry Data Security Standards (PCI-DSS), and does not protect cardholder/payee information. Any upload of real cardholder data is strictly prohibited, as described in the Terms of Use.

Test

paysafe.checkout.setup("my Merchant test Base 64 encoded single-use-token API key", {
    environment: "TEST"
  },
  function(instance, error, result) {...});

Live

paysafe.checkout.setup("my Production Base64 Encoded single-use-token API key", {
    environment: "LIVE"
  },
  function(instance, error, result) {...});

If you omit the environment object, by passing an empty or null value for this parameter, the Live environment will be used.

Setup Function and Objects

Here is a full list of the setup function parameters, the JavaScript objects used by the setup function, and the parameters they contain.

Parameter Required Type Description
apiKey true string The Base64-encoded version of the single-use token API key used to authenticate with the Customer Vault REST API.
options true object
resultCallback true function Callback function invoked with the result or error from the payment. Returns an instance for flow control.
closeCallback false function Callback function invoked when the modal overlay is closed.
eventCallback false function Callback function, which is invoked when certain events in Checkout occur - i.e saved cards modifications
{return} false any
options
amount true number

Payment amount in minor units to charge the customer's card. Use the correct minor units amount for the merchant account currency. For example, to process US $10.99, this value should be 1099. To process 1000 Japanese Yen, this value should be 1000. To process 10.139 Tunisian dinar, this value should be 10139.

Min = 1

Max = 999999999

When using 3DS 2 (i.e. useThreeDSecureVersion2= true), amount with value: "0" can be passed.
currency true string Three character code for the payment currency – for example, USD for US dollars.

companyName

length <= 60 chars

true string Merchant name for display on the payment form.

holderName

length <= 160 chars

false string Name of the card holder. This parameter is used to personalize the payment form and to associate the customer's name with the payment token.
environment false string

Environment to use for all tokenization and logging calls.

Possible values are:

  • LIVE – used for Production
  • TEST – used for the Merchant test or sandbox environment

imageUrl

length <= 2000 chars

false string

URL for the logo to display on the payment form. Must be a publicly accessible URL using the HTTPS protocol. The logo is resized for display.

Any browser supported format is permitted.

Paysafe recommends a size of 50 x 50 pixels or a 1:1 aspect ratio (for vector images) for best results. The size of the image container is 50 x 146 pixels. Any image bigger than this will be scaled down.
locale false string

Language locale for the checkout:

  • en_US
  • fr_CA

If omitted, defaults to en_US.
accounts false object

Information regarding merchant processing accounts for 3D Secure.

Add this object to support 3D Secure. If the customer's card supports 3D Secure, they may be shown an additional page from their card issuer within the overlay to authorize the payment. In the merchant Test environment, a simulator is used instead to simulate different 3DS responses.
3D Secure is supported only for Visa and Mastercard.
3D Secure 2 is supported only for Visa, Mastercard, and American Express.
billingAddress false object Billing address for Card and Direct Debit payments. Additional details of the Customer Vault BillingAddress object are given in the Customer Vault documentation. For Direct Debit, the billing address is used to populate the Checkout form when the currency and country match. For example, if the country is USA and the currency is USD, the billing address fields in the Direct Debit Checkout form are automatically populated.
shippingAddress false object

This is the shipping address object to include in order to take advantage of the PayPal Seller Protection policy.

Please consult PayPal documentation for field requirement constraints.

buttonColor false string

Hex color for the payment form buttons. For example,

buttonColor: "#ff0000",

buttonLabel

length <= 40 chars

false string The text displayed in the Pay button.
preferredPaymentMethod false string

The payment method selected when Paysafe Checkout is opened. Possible values are:

  • Cards
  • DirectDebit
  • Interac
  • PayPal

This is case-insensitive.
paymentMethodDetails false object These are additional parameters required for specific payment methods.
displayPaymentMethods false array

This determines which available payment methods will be displayed to the consumer. The values in the array are shown in the Checkout in the order they are passed. Possible values are:

  • Cards
  • DirectDebit
  • Interac
  • PayPal

This is case-insensitive.

If this parameter is not included, then all payment methods available for the consumer will be displayed in the Checkout.
hideAmount false boolean

Specifies whether to show the Order Total label.

If omitted, defaults to false.

threeDS false object This optional object contains parameters used for 3D Secure 2.
singleUseProfileToken false string Token is used to retrieve profile data which can provide saved payment methods. This is an alphanumeric string with length 16.
showSaveCardCheckboxes false boolean Flag is used to indicate if save card and set as default card check boxes should be shown.
accounts
CC true number

The ID of the merchant account to use for 3DS processing of the payment. For information about how to select the correct accountId, see Multiple Currencies.
billingAddress
country true string Country in which the address is located.
zip true string Zip or postal code for the address.
city false string City in which the address is located.
state false string This is the state/province/region in which the customer lives. This field is ignored with Direct Debit.
street false string First line of the customer's street address.
street2 false string Second line of the customer's street address. This field is ignored with Direct Debit.
useAsShippingAddress false boolean Indicates that this address will be used also as shipping address. Applies for 3D Secure 2.
shippingAddress
Please consult PayPal documentation for field requirement constraints.
recipientName false

string

PayPal length<=127

Other
length<=255

 This is the recipient's name.
street conditional

string

PayPal length<=100

Other
length<=50

This is the first line of the street address of the shipping address.

street is required for PayPal requests.
street2 false

string

PayPal length<=100

Other
length<=50

 This is the second line of the street address of the shipping address.
city false

string

PayPal length<=64

Other
length<=40

 This is the shipping address city.
country true

string

2-character ISO code

 This is the shipping address country.
zip true

string
length<=10

This is the shipping address zip or postal code.

Required for countries with postal code.

state false

string
length<=40

This is the shipping address state/province/region.

Required for PayPal for some countries. Please consult PayPal documentation for field requirement constraints.

shipMethod false string

This is the method of shipment. Applies for 3D Secure 2. Possible values are:

  • N – Next Day/Overnight
  • T – Two-Day Service
  • C – Lowest Cost
  • O – Other
  • S – Same Day
paymentMethodDetails
paypal false object These are additional parameters for PayPal.
paypal
shippingPreference false string

These are additional shipping preferences for PayPal. Possible values are:

  • NO_SHIPPING. Redacts the shipping address from the PayPal pages. Recommended for digital goods.
  • GET_FROM_FILE. Uses the customer-selected shipping address on PayPal pages.
  • SET_PROVIDED_ADDRESS. If available, uses the merchant-provided shipping address, which the customer cannot change on the PayPal pages. If the merchant does not provide an address, the customer can enter the address on PayPal pages.
threeDS
useThreeDSecureVersion2 false boolean

Specifies whether this instance of Paysafe Checkout should implement 3DS 2. If true and accountId is not configured for 3DS 2, an error will be returned in the callback.

If omitted, defaults to false.
authenticationPurpose false string

Indicates the type of Authentication request. This data element provides additional information to the ACS to determine the best approach for handing an authentication request. Possible values are:

  • PAYMENT_TRANSACTION
  • INSTALMENT_TRANSACTION

If omitted, defaults to PAYMENT_TRANSACTION.
maxAuthorizationsForInstalmentPayment conditional number

Indicates the maximum number of authorizations permitted for installment payments.

Min = 1

Max = 999

Required when authenticationPurpose = INSTALMENT_TRANSACTION.
billingCycle conditional object

Billing cycle information for recurring payments.

Required when authenticationPurpose = INSTALMENT_TRANSACTION.
electronicDelivery false object This is the electronic delivery information.
profile false object This is the customer profile.
messageCategory false string

This is the category of the message for a specific use case. Possible values are:

  • PAYMENT
  • NON_PAYMENT

If omitted, defaults to PAYMENT.
requestorChallengePreference false string

This indicates whether a challenge is requested for this transaction. Possible values are:

  • CHALLENGE_MANDATED
  • CHALLENGE_REQUESTED
  • NO_PREFERENCE
transactionIntent conditional string

This identifies the type of transaction being authenticated. This element is required only in certain markets, e.g., Brazil. Possible values are:

  • GOODS_OR_SERVICE_PURCHASE
  • CHECK_ACCEPTANCE
  • ACCOUNT_FUNDING
  • QUASI_CASH_TRANSACTION
  • PREPAID_ACTIVATION
initialPurchaseTime conditional string This is the date and time of the purchase. The ISO 8601 date format is expected i.e., YYYY-MM-DD-THH:MM:SSZ. Note: This element is required only if messageCategory=NON_PAYMENT and authenticationPurpose=INSTALMENT_TRANSACTION or RECURRING_TRANSACTION.
orderItemDetails false object These are the details of a previously made purchase or preorder.
purchasedGiftCardDetails false object These are the details of a previously made gift card purchase.
userAccountDetails false object These are the user account details from the merchant website.
billingCycle
endDate true string This is the date after which no further authorizations will be performed. The ISO 8601 date format is expected, i.e., YYYY-MM-DD.
frequency true number

This is the minimum number of days between authorizations.

Min = 1

Max = 999
electronicDelivery
isElectronicDelivery true boolean This indicates whether there is an electronic delivery for the product. The electronicDelivery object is optional; however, if the object is used, this element is required.
email false string

This is the email address to which the merchandise was delivered.

length <= 240 chars

profile
email false string

This is the email address of the customer.

length <= 255 chars

phone false string

This is the customer's primary phone.

length <= 40 chars

cellphone false string

This is the customer's cell phone.

length <= 40 chars

orderItemDetails
preOrderItemAvailabilityDate false string For a pre-ordered purchase, this is the date that the merchandise is expected to be available. The ISO 8601 date format is expected, i.e., YYYY-MM-DD.
preOrderPurchaseIndicator false string

This indicates whether the cardholder is placing an order for available merchandise or merchandise with a future availability or release date. Possible values are:

  • MERCHANDISE_AVAILABLE
  • FUTURE_AVAILABILITY
reorderItemsIndicator false string

This indicates whether the cardholder is reordering merchandise. Possible values are:

  • FIRST_TIME_ORDER
  • REORDER
shippingIndicator false string

This is the shipping method for the transaction. Possible values are:

  • SHIP_TO_BILLING_ADDRESS
  • SHIP_TO_VERIFIED_ADDRESS
  • SHIP_TO_DIFFERENT_ADDRESS
  • SHIP_TO_STORE
  • DIGITAL_GOODS
  • TRAVEL_AND_EVENT_TICKETS
  • OTHER
purchasedGiftCardDetails
amount false number

This is the amount of the gift card, in minor units.

Max = 99999999999
count false number

This is the total count of individual prepaid or gift cards or codes purchased.

Max = 99
currency false string Three character code for the currency of the gift card – for example, USD for US dollars.
userAccountDetails
createdDate false string This is the date when the cardholder opened the account with the 3DS Requestor. The ISO 8601 date format is expected, i.e., YYYY-MM-DD.
createdRange false string

This is the length of time between the cardholder opening the account with the 3DS Requestor and the API call of the current transaction. Possible values are:

  • DURING_TRANSACTION
  • NO_ACCOUNT
  • LESS_THAN_THIRTY_DAYS
  • THIRTY_TO_SIXTY_DAYS
  • MORE_THAN_SIXTY_DAYS
changedDate false string This is the date that the cardholder’s account with the 3DS Requestor was last changed. The ISO 8601 date format is expected, i.e., YYYY-MM-DD.
changedRange false string

This is the length of time between the most recent change to the cardholder’s account information and the API call of the current transaction. Possible values are:

  • MORE_THAN_SIXTY_DAYS
  • DURING_TRANSACTION
  • LESS_THAN_THIRTY_DAYS
  • THIRTY_TO_SIXTY_DAYS
passwordChangedDate false string This is the date when the cardholder’s account was reset or the password was changed. The ISO 8601 date format is expected, i.e., YYYY-MM-DD.
passwordChangedRange false string

This is the length of time between the most recent password change or cardholder account reset and the API call of the current transaction. Possible values are:

  • MORE_THAN_SIXTY_DAYS
  • NO_CHANGE
  • DURING_TRANSACTION
  • LESS_THAN_THIRTY_DAYS
  • THIRTY_TO_SIXTY_DAYS
totalPurchasesSixMonthCount false number

This is the total number of purchases from this cardholder account in the previous six months.

Max = 9999
addCardAttemptsForLastDay false number

This is the number of Add Card attempts in the last 24 hours.

Max = 999
transactionCountForPreviousDay false number

This is the number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

Max = 999
transactionCountForPreviousYear false number

This is the number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

Max = 999
suspiciousAccountActivity false boolean This indicates whether the 3DS Requestor has experienced suspicious activity, including previous fraud, on the cardholder account.
shippingDetailsUsage false object This is the shipping usage information.
paymentAccountDetails false object These are the details of the current payment account of the cardholder.
userLogin false object This is the cardholder login information.
priorThreeDSAuthentication false object This is the previous authentication information used with current merchant, cardholder, and card.
travelDetails false object These are the Amex-specific travel details.
shippingDetailsUsage
cardHolderNameMatch false boolean This indicates whether the cardholder name on the account is identical to the shipping name used for this transaction.
initialUsageDate false string This is the date when the shipping address for this transaction was first used with the 3DS Requestor. The ISO 8601 date format is expected, i.e., YYYY-MM-DD.
initialUsageRange false string

This is the length of time between the first use of this shipping address and the current transaction. Possible values are:

  • MORE_THAN_SIXTY_DAYS
  • CURRENT_TRANSACTION
  • LESS_THAN_THIRTY_DAYS
  • THIRTY_TO_SIXTY_DAYS
paymentAccountDetails
createdDate false string This is the date that the cardholder opened the account with the 3DS Requestor. The ISO 8601 date format is expected, i.e., YYYY-MM-DD.
createdRange false string

This indicates the length of time that the payment account was enrolled in the cardholder’s account with the 3DS Requestor. Possible values are:

  • MORE_THAN_SIXTY_DAYS
  • NO_ACCOUNT
  • DURING_TRANSACTION
  • LESS_THAN_THIRTY_DAYS
  • THIRTY_TO_SIXTY_DAYS
userLogin
data false string

This field is reserved for future iterations of 3D Secure 2.

length <= 2048 chars

authenticationMethod false string

This is the mechanism used by the cardholder to authenticate to the 3DS Requestor. Possible values are:

  • THIRD_PARTY_AUTHENTICATION
  • NO_LOGIN
  • INTERNAL_CREDENTIALS
  • FEDERATED_ID
  • ISSUER_CREDENTIALS
  • FIDO_AUTHENTICATOR
time false string This is the date and time of the cardholder authentication. The ISO 8601 date format is expected, i.e., YYYY-MM-DD-THH:MM:SSZ.
priorThreeDSAuthentication
data false string

This field is reserved for future iterations of 3D Secure 2.

length <= 2048 chars

method false string

This is the mechanism used previously by the cardholder to authenticate to the 3DS Requestor. Possible values are:

  • FRICTIONLESS_AUTHENTICATION
  • ACS_CHALLENGE
  • AVS_VERIFIED
  • OTHER_ISSUER_METHOD
id false string

This is a previous authentication ID for the cardholder.

length <= 36 chars

time false string This is the date and time of the cardholder authentication. The ISO 8601 date format is expected, i.e., YYYY-MM-DD-THH:MM:SSZ.
travelDetails
isAirTravel false boolean

This indicates whether the transaction is an air travel related purchase, e.g., a ticket purchase.

If omitted, defaults to false.
airlineCarrier conditional string

This is the selected airline carrier. Note: This element is required only if isAirTravel=true.

length <= 256 chars

departureDate conditional string This is the date of departure in the time zone of the departure location. The ISO 8601 date format is expected, i.e., YYYY-MM-DD. Note: This element is required only if isAirTravel=true.
destination conditional string

This is the airport code of the destination airport. Note: This element is required only if isAirTravel=true.

length <= 5 chars

origin conditional string

This is the airport code of the originating airport. Note: This element is required only if isAirTravel=true.

length <= 5 chars

passengerFirstName conditional string

This is the first name of the cardholder from the billing details. Note: This element is required only if isAirTravel=true.

length <= 99 chars

passengerLastName conditional string

This is the last name of the cardholder from the billing details. Note: This element is required only if isAirTravel=true.

length <= 99 chars

maskCvv

Default value: false

false boolean Masks the value of the CVV.

resultCallback

The result callback is invoked when a token is issued or a tokenization error occurs.

The signature is as follows:

Parameter Required Type Description
instance true object Paysafe Checkout instance.
error false object Object containing information for the error. This field is present if tokenization fails. The contents of this object are described below.
result false object

Result containing payment token. The contents of this object are described below.
{return} false undefined
instance
isOpen true function Checks if the overlay is still open.
close true function Closes the overlay without displaying result from payment.
showSuccessScreen true function Changes checkout layout to success screen.
showFailureScreen true function Changes checkout layout to failure screen.
error
code true string

Short error code identifying the error type.
displayMessage true string Provides an error message that can be displayed to users.
detailedMessage true string Provides a detailed error message that can be logged.
correlationId true string Unique ID that can be provided to the Paysafe Support team as a reference for investigation.
fieldErrors false array Details of any parameter value errors (optional). Currently only being supplied when a 9003 error is thrown.
fieldError
field true string Field name. Example: threeDS.userAccountDetails.userLogin.time.
message true string Error in the field.
result
token true string Payment token representing sensitive card and bank account details in case of successful tokenization. You will need to send this token securely to your server to make payment using the Card Payments, Direct Debit, or Alternate Payments API.
paymentMethod true string

The payment method used by the customer:

  • Cards
  • DirectDebit
  • Interac
  • PayPal
saveInstrument false boolean Flag representing if payment instrument should be saved.
setInstrumentAsDefault false boolean Flag representing if payment instrument should be set as default.

An example is shown below:

function(instance, error, result) {        
if (result.token) {

	// Successfully tokenized card, use result.token to process a payment
             
	console.log(result.token);

	// add AJAX code to send token to your merchant server

	instance.showSuccessScreen("Your goods are now purchased. Expect them to be delivered in next 5 business days.");         
} else {

	// tokenization failed

	instance.showFailureScreen("The payment was declined. Please, try again with the same or another payment method.");          
}

}

closeCallback

Invoked when the checkout overlay is closed by the customer. This function has the following signature:

Parameter Required Type Description
stage true string

Stage during which the checkout overlay is closed. Possible values are:

  • BeforePayment
  • DuringPayment
  • AfterPayment
{return} false any

Example usage:

function(stage) {
if (stage === "BeforePayment") {
	// No payment have been made
} else if (stage === "DuringPayment") {
	// Token have been issued, but the checkout overlay was closed from the user before instance flow control method was invoked
} else if (stage === "AfterPayment") {
	// Closed either via instance.close method or by the user from the success screen
}

eventCallback

Invoked immediately after one or more events in Paysafe Checkout occur:

Parameter Required Type Description
instance true object Checkout instance with flow control functions
isOpen true function Checks if the overlay is still open
close true function Closes the overlay without displaying result from payment
showSuccessScreen true function Change checkout layout to the success screen
showFailureScreen true function Change checkout layout to failure screen
event true object The event that occurred.
action true string[]

Action that is executed on the client-side.

Possible values:

Process only the actions, required by the current implementation need. Additional actions can be added in the future.
correlationId false string A unique ID that can be provided to the Paysafe Support team as a reference for an investigation.
paymentToken false string

the paymentToken of the payment type, on which the event is executed.

Some actions do not have associated paymentToken. Its value can be empty.

Example usage 

function(instance, event) {
    if (event.action.indexOf("setAsDefault") > -1) {
	    // Payment method saved as default
    }
	if (event.action.indexOf("expiryDateModified") > -1) {
	    // Payment method saved expiry date has changed
    }
	if (event.action.indexOf("deleted") > -1) {
	    //  Payment method deleted
    }
}

Setup Errors

Code
Display Message
Detailed Message
Description
9004 There was an error (9004), please contact our support. Callback should be function.
9012 There was an error (9012), please contact our support. Invalid number of arguments. Used when the supplied number of arguments is neither 3 nor 4.
9062 There was an error (9062), please contact our support. Paysafe Checkout already opened. Setup function has been invoked and Paysafe Checkout is already opened or is loading at the moment.

Errors Passed to resultCallback

Code
Display Message
Detailed Message
Description
9012 There was an error (9012), please contact our support. Invalid number of arguments. Used when the supplied number of arguments is neither 3 nor 4.
9013 There was an error (9013), please contact our support. Invalid apiKey parameter. Used when the supplied apiKey parameter is not a string, is in invalid format, or is not configured for Paysafe Checkout.
9014 There was an error (9014), please contact our support. Unhandled error occurred. Used when an error unhandled by the Paysafe Checkout SDK is thrown.
9015 There was an error (9015), please contact our support. Invalid options argument. Used when the supplied options parameter is not an object.
9017 There was an error (9017), please contact our support. Environment options is not a string or an object. Used when the supplied environment is not a string or an object.
9018 There was an error (9018), please contact our support. Environment doesn't match any of the predefined values (possible: TEST, LIVE; actual: ${environment}).
9043 There was an error (9043), please contact our support. HolderName should be valid. Used when the supplied holderName parameter is not a string.
9044 There was an error (9044), please contact our support.

billingAddress country should be valid country code.

 Used when the supplied billingAddress.country parameter is not a string.
9045 There was an error (9045), please contact our support. billingAddress zip should be valid zip code. Used when the supplied billingAddress.zip parameter is not a string.
9046 There was an error (9046), please contact our support. billingAddress state should be valid state. Used when the supplied billingAddress.state parameter is not a string.
9047 There was an error (9047), please contact our support. billingAddress city should be valid city. Used when the supplied billingAddress.city parameter is not a string.
9048 There was an error (9048), please contact our support. billingAddress street should be valid street. Used when the supplied billingAddress.street parameter is not a string.
9049 There was an error (9049), please contact our support. billingAddress street2 should be valid street. Used when the supplied billingAddress.street2 parameter is not a string.
9052 There was an error (9052), please contact our support. billingAddress should be object. Used when the supplied billingAddress parameter is not an object.
9053 There was an error (9053), please contact our support. Invalid companyName parameter. Used when the supplied companyName parameter is not a string.
9054 There was an error (9054), please contact our support. Invalid amount parameter. Used when an amount is not supplied, is not a number, is not positive, or is longer than 9 digits.
9055 There was an error (9055), please contact our support. Invalid currency parameter. Used when the supplied currency parameter is not a string.
9057 There was an error (9057), please contact our support. Invalid locale parameter. Used when the supplied locale parameter does not match the supported values.
9059 There was an error (9059), please contact our support. Accounts should be object. Used when the supplied accounts parameter is not an object.
9060 There was an error (9060), please contact our support. Close callback should be function. Used when the provided closeCallback is not a function.
9061 There was an error (9061), please contact our support. Invalid account ID for ${paymentMethod}. Used when the supplied accountId for a specific payment method is not a number or is not positive.
9062 There was an error (9062), please contact our support. Paysafe Checkout already opened. Setup function has been invoked and Paysafe Checkout is already opened or is loading at the moment.
9063 There was an error (9063), please contact our support. Invalid buttonColor parameter. Used when the supplied color is not a valid hex color, e.g., '#ee33ee'.
9064 There was an error (9064), please contact our support. Failed to initialize Paysafe Checkout iframe. Used when the checkout iframe has failed to initialize within 5 seconds – the reason could be that the server that serves the HTML for the iframe is not available at the moment.
9065 There was an error (9065), please contact our support. Invalid payment method: ${paymentMethod}.

Used when the supplied preferredPaymentMethod is not one of the following:

  • Cards
  • DirectDebit
  • Interac
  • PayPal
9073 There was an error (9073), please contact our support. Account not configured correctly. Used when account ID or account currency was incorrectly configured.
9094 There was an error (9094), please contact our support. Invalid displayPaymentMethods parameter.

Used for the following reasons:

  • displayPaymentMethods parameter is not valid array of strings.
  • The array is empty or more than 4 payment methods are passed.
  • One or more of the passed elements in the array are not valid payment methods:
    • Cards
    • DirectDebit
    • Interac
    • PayPal
9095 There was an error (9095), please contact our support. Duplicate entries in displayPaymentMethods parameter are not allowed. Used when duplicate payment methods are passed in the displayPaymentMethods parameter.
9096 There was an error (9096), please contact our support. Your account is not configured for the passed displayPaymentMethods. Supported payment methods: ${supportedPaymentMethods}. Used when one or more of the provided payment methods in the displayPaymentMethods parameter do not match the payment methods configured for the merchant.
9098 There was an error (9098), please contact our support. Event callback should be a function Used when the provided eventCallback is not a function.
9106 There was an error (9106), please contact our support. Invalid buttonLabel parameter. Used when the value provided for the buttonLabel parameter exceeds 40 characters.
9107 There was an error (9107), please contact our support. Invalid singleUseProfileToken parameter. Used when the supplied singleUseProfileToken is either invalid or expired.
9108 There was an error (9108), please contact our support. Invalid showSaveCardCheckboxes value. Used when the supplied showSaveCardCheckboxes is invalid.
9109 There was an error (9109), please contact our support. Invalid hideAmount value. Used when the value provided for hideAmount is invalid.
9110 There was an error (9110), please contact our support. Unable to initiate ThreeDs SDK. Used when the ThreeDs SDK has failed to load or the ThreeDs SDK start callback is invoked with unhandled error.
9111 There was an error (9111), please contact our support. Invalid merchant configuration setup. Used when the merchant configuration setup is invalid.
9112 There was an error (9112), please contact our support. Invalid threeDS useThreeDSecureVersion2 parameter. Used when the supplied useThreeDSecureVersion2 parameter is not a boolean.
9113 There was an error (9113), please contact our support. The accountId provided is not enabled for 3DS version 2. Used when the supplied accountId (accounts.CC) is not enabled for 3DS version 2.
9114 There was an error (9114), please contact our support. Unable to initiate ThreeDs SDK challenge. Used when the when ThreeDs SDK challenge callback is invoked with error.
9115 There was an error (9115), please contact our support. ShippingAddress should be an object. Used when the supplied shippingAddress parameter is not an object.
9116 There was an error (9116), please contact our support. ShippingAddress recipientName should be a valid recipient name. Used when the supplied shippingAddress.recipientName parameter is not a string.
9117 There was an error (9117), please contact our support. ShippingAddress street should be a valid street. Used when the supplied shippingAddress.street parameter is not a string.
9118 There was an error (9118), please contact our support. ShippingAddress street2 should be a valid street. Used when the supplied shippingAddress.street2 parameter is not a string.
9119 There was an error (9119), please contact our support. ShippingAddress city should be a valid city. Used when the supplied shippingAddress.city parameter is not a string.
9120 There was an error (9120), please contact our support. ShippingAddress state should be a valid state. Used when the supplied shippingAddress.state parameter is not a string.
9121 There was an error (9121), please contact our support. ShippingAddress country should be a valid country. Used when the supplied shippingAddress.country parameter is not a string.
9122 There was an error (9122), please contact our support. ShippingAddress zip should be a valid zip code. Used when the supplied shippingAddress.zip parameter is not a string.
9123 There was an error (9123), please contact our support. Invalid PayPal shipping preference parameter. Used when the supplied paypal.shippingPreference doesn't match the supported values.
9125 There was an error (9125), please contact our support. Unsupported card brand used: [...]. Used when the customer is using card brand not supported by the merchant 3D Secure 2 configuration.
9003 Invalid fields: ${fields}.

Invalid fields: ${fields}.

E.g., Invalid fields: threeDS.authenticationPurpose,threeDS.billingCycle.endDate.

One or more fields have invalid values. The error for invalid fields comes from the front-end validations or when the 3D Secure 2 API returns 5068 error.

The possible values are all 3D Secure 2 related fields, e.g. threeDS.billingCycle.endDate
9004 There was an error (9004), please contact our support. Callback should be function.
PREV NEXT
Did you find this page useful?