This site requires javascript to be enabled.

Results for

xxx

Create payment

POST https://{domainname}/v1/{merchantId}/payments

Payments

The payments REST services allow you to initiate a payment, retrieve the payment details or perform specific actions like refunding or requesting capture of a payment. A payment is identified by its paymentId. Some payment products allow a two step approach allowing you to control when the authorization takes place separate from when the funds are actually captured.

Request

You initiate a payment by posting all the required payment details. After you have done so one or more of the following things can take place:

  • Your payment request is rejected. This can happen for various reasons, but a detailed reason is always returned in the response to you. In some cases a payment object was created and you will find all the details in the response as well.
  • The data you submitted used to assess the risk of potential fraud. If this is deemed to great based on your configuration the transaction is either rejected or placed in a queue for your manual review. If the fraud risk is deemed to be within the acceptable set limits the processing is continued and one of the other possible outcomes listed here will be returned.
  • The data is sent to a third party for authorization
  • The consumer is required to authenticate themselves and a redirect to a third party is required, sometimes this also includes the actual authorization of the payment by the consumer while at the third party. The response will contain all the details required for you to redirect the consumer to the third party.
  • Payment instruction details are returned so you can provide the right instructions to your consumer on how to complete the payment.
  • The data is simply stored for future processing.

Please look at the flow diagram of each payment product that you would like to integrate to see what possible responses can be returned to you depending on the payment product.

The type of processing flow is also dependent on the individual configuration of your account(s). This will be chosen in conjunction with you to best match your business
Create payment supports idempotent requests

PayloadCreatePaymentRequest

Properties
Property Type Required Details
close

Description

Object containing the specific input details for bank transfer payments
  • SDK Object type
    BankTransferPaymentMethodSpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Your additional reference identifier for this transaction. Data supplied in this property will also be returned in our report files, allowing you to reconcile the incoming funds.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the specific input details for card payments
  • SDK Object type
    CardPaymentMethodSpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

In case you have been provided with a promotion code by an acquirer, you can use this property to flag the transaction as being part of a specific card payment product promotion.
close

Description

Determines the type of the authorization that will be used. Allowed values:
  • FINAL_AUTHORIZATION - The payment creation results in an authorization that is ready for capture. Final authorizations can't be reversed and need to be captured for the full amount within 7 days.
  • PRE_AUTHORIZATION - The payment creation results in a pre-authorization that is ready for capture. Pre-authorizations can be reversed and can be captured within 30 days. The capture amount can be lower than the authorized amount.
  • SALE - The payment creation results in an authorization that is already captured at the moment of approval.
Only used with some acquirers, ignored for acquirers that don't support this. In case the acquirer doesn't allow this to be specified the authorizationMode is 'unspecified', which behaves similar to a final authorization.
close

Description

Object containing card details. The card details will be ignored in case the property networkTokenData is present.
  • SDK Object type
    Card
close

Description

The complete credit/debit card number (also know as the PAN). The minimum input length is 12 digits.
The card number is always obfuscated in any of our responses
close

Description

The card holder's name on the card. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

Card Verification Value, a 3 or 4 digit code used as an additional security feature for card not present transactions.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Issue number on the card (if applicable)
close

Description

The first 2 digits of the card's PIN code. May be optionally submitted for South Korean cards (paymentProductIds 180, 181, 182, 183, 184, 185 and 186). Submitting this property may improve your authorization rate.
close

Description

Reference of the customer for the payment (purchase order #, etc.). Only used with some acquirers.
close
Deprecated: Use threeDSecure.externalCardholderAuthenticationData instead.

Description

Object containing 3D secure details.
  • SDK Object type
    ExternalCardholderAuthenticationData
close
Deprecated

Description

Identifier of the authenticated transaction at the ACS/Issuer.
close
Deprecated

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
close
Deprecated

Description

The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value.
close
Deprecated

Description

The algorithm, from your 3D Secure provider, used to generate the authentication CAVV.
close
Deprecated

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close
Deprecated

Description

Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION
  • 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
  • 1 = Authentication attempted (MasterCard)
  • 2 = Successful authentication (MasterCard)
  • 5 = Successful authentication (Visa, Diners Club, Amex)
  • 6 = Authentication attempted (Visa, Diners Club, Amex)
  • 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
  • (empty) = Not checked or not enrolled
close
Deprecated

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99.
close
Deprecated

Description

The 3-D Secure version used for the authentication. Possible values:
  • v1
  • v2
  • 1.0.2
  • 2.1.0
  • 2.2.0
close
Deprecated: No replacement

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close
Deprecated

Description

The 3D Secure authentication result from your 3D Secure provider.
close
Deprecated

Description

The transaction ID that is used for the 3D Authentication
close

Description

The unique scheme transactionId of the initial transaction that was performed with SCA. In case this is unknown a scheme transactionId of an earlier transaction part of the same sequence can be used as a fall-back.
Strongly advised to be submitted for any MerchantInitiated or recurring transaction (a subsequent one).
close

Description

Indicates if this transaction is of a one-off or a recurring type
  • true - This is recurring
  • false - This is one-off
close

Description

Indicates reason behind the merchant initiated transaction. These are industry specific.
Possible values:
  • delayedCharges - Delayed charges are performed to process a supplemental account charge after original services have been rendered and respective payment has been processed. This is typically used in hotel, cruise lines and vehicle rental environments to perform a supplemental payment after the original services are rendered.
  • noShow - Cardholders can use their cards to make a guaranteed reservation with certain merchant segments. A guaranteed reservation ensures that the reservation will be honored and allows a merchant to perform a No Show transaction to charge the cardholder a penalty according to the merchant’s cancellation policy. For merchants that accept token-based payment credentials to guarantee a reservation, it is necessary to perform a customer initiated (Account Verification) at the time of reservation to be able perform a No Show transaction later.
close

Description

Object holding data that describes a network token
  • SDK Object type
    SchemeTokenData
close

Description

The cardholder's name on the card
close

Description

The Token Cryptogram is a dynamic one-time use value that is used to verify the authenticity of the transaction and the integrity of the data used in the generation of the Token Cryptogram. Visa calls this the Token Authentication Verification Value (TAVV) cryptogram.
close

Description

The Electronic Commerce Indicator you got with the Token Cryptogram
close

Description

The network token. Note: This is called Payment Token in the EMVCo documentation
close

Description

The expiry date of the network token
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing data related to recurring
  • SDK Object type
    CardRecurrenceDetails
close

Description

Date in YYYYMMDD after which there will be no further charges. If no value is provided we will set a default value of five years after we processed the first recurring transaction.
close

Description

Minimum number of days between authorizations. If no value is provided we will set a default value of 30 days.
close

Description

  • first = This transaction is the first of a series of recurring transactions
  • recurring = This transaction is a subsequent transaction in a series of recurring transactions
  • last = This transaction is the last of a series of recurring transactions for payments that are processed by the WL Online Payment Acceptance platform

Note: For any first of a recurring the system will automatically create a token as you will need to use a token for any subsequent recurring transactions. In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response.
close
Deprecated: Use recurring.recurringPaymentSequenceIndicator instead

Description

  • first = This transaction is the first of a series of recurring transactions
  • recurring = This transaction is a subsequent transaction in a series of recurring transactions
  • last = This transaction is the last of a series of recurring transactions for payments that are processed by the WL Online Payment Acceptance platform

Note: For any first of a recurring the system will automatically create a token as you will need to use a token for any subsequent recurring transactions. In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response.
close

Description

Deprecated for Ogone: This flag is deprecated for the Ogone payment platform. Use CardPaymentMethodSpecificInput.authorizationMode instead. Value 'true' of this property is mapped to authorizationMode FINAL_AUTHORIZATION and value 'false' is mapped to authorizationMode SALE.
  • true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API
  • false = the payment does not require approval, and the funds will be captured automatically
close
Deprecated: Use threeDSecure.redirectionData.returnUrl instead.

Description

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.
Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.
URLs without a protocol will be rejected.
close
Deprecated: Use threeDSecure.skipAuthentication instead.

Description

  • true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring.
  • false = 3D Secure authentication will not be skipped for this transaction.
Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.
close

Description

  • true = Fraud scoring will be skipped for this transaction
  • false = Fraud scoring will not be skipped for this transaction
Note: This is only possible if your account in our system is setup for Fraud scoring and if your configuration in our system allows you to override it per transaction.
close

Description

Object containing specific data regarding 3-D Secure
  • SDK Object type
    ThreeDSecure
close

Description

Allows you to send in an authentication amount which can be greater or equal to the order amount. The currency code of the authentication amount should be the same as the currency code of the order amount. In case you don't provide an authentication amount we will use the order amount for the authentication automatically.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Indicates whether a transaction is performed in-app using an EMVco certified mobile SDK or inside a browser. Allowed values:
  • browser = Customer is using a browser to complete the checkout (default)
  • in-app = Customer is using an app with a 3-D Secure SDK to complete the checkout

Note: We will add support for the in-app flow in a future release.

close

Description

Dimensions of the challenge window that potentially will be displayed to the customer. The challenge content is formatted to appropriately render in this window to provide the best possible user experience.
Preconfigured sizes are width x height in pixels of the window displayed in the customer browser window. Possible values are:
  • 250x400 (default)
  • 390x400
  • 500x600
  • 600x400
  • full-screen
.
close

Description

Allows you to indicate if you want the customer to be challenged for extra security on this transaction. Possible values:
  • no-preference - You have no preference whether or not to challenge the customer (default)
  • no-challenge-requested - you prefer the cardholder not to be challenged
  • challenge-requested - you prefer the customer to be challenged
  • challenge-required - you require the customer to be challenged
close

Description

Type of strong customer authentication (SCA) exemption requested for this transaction. Possible values:
  • none - No exemption flagging is to be used of this transaction (Default).
  • automatic - Our systems will determine the best possible exemption based on the transaction parameters and the risk scores.
  • transaction-risk-analysis - You have determined that this transaction is of low risk and are willing to take the liability. Please note that your fraud rate needs to stay below thresholds to allow your use of this exemption.
  • low-value - The value of the transaction is below 30 EUR. Please note that the issuer will still require every 5th low-value transaction pithing 24 hours to be strongly authenticated. The issuer will also keep track of the cumulative amount authorized on the card. When this exceeds 100 EUR strong customer authentication is also required.
  • whitelist - You have been whitelisted by the customer at the issuer.
close

Description

Object containing 3D secure details.
  • SDK Object type
    ExternalCardholderAuthenticationData
close

Description

Identifier of the authenticated transaction at the ACS/Issuer.
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
close

Description

The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value.
close

Description

The algorithm, from your 3D Secure provider, used to generate the authentication CAVV.
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION
  • 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
  • 1 = Authentication attempted (MasterCard)
  • 2 = Successful authentication (MasterCard)
  • 5 = Successful authentication (Visa, Diners Club, Amex)
  • 6 = Authentication attempted (Visa, Diners Club, Amex)
  • 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
  • (empty) = Not checked or not enrolled
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99.
close

Description

The 3-D Secure version used for the authentication. Possible values:
  • v1
  • v2
  • 1.0.2
  • 2.1.0
  • 2.2.0
close
Deprecated: No replacement

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

The 3D Secure authentication result from your 3D Secure provider.
close

Description

The transaction ID that is used for the 3D Authentication
close

Description

Object containing data regarding the customer authentication that occurred prior to the current transaction
  • SDK Object type
    ThreeDSecureData
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
close

Description

Method of authentication used for this transaction. Possible values:
  • frictionless = The authentication went without a challenge
  • challenged = Cardholder was challenged
  • avs-verified = The authentication was verified by AVS
  • other = Another issuer method was used to authenticate this transaction
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

Object containing browser specific redirection related data
  • SDK Object type
    RedirectionData
close

Description

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.
Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.
URLs without a protocol will be rejected.
close

Description

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. The redirection flow for 3-D Secure uses the MyCheckout payment pages to display the following types of pages:
  • Redirection page - All redirection using a POST method will load a page in the browser of the customer that performs the actual redirection. This page contains a message to the customer explaining what is happening.
  • MethodURL page - Certain Issuers will use a specific flow in case of 3-D Secure version 2 to directly collect information from the customer browser. This page contains a spinner indicating that this process is going on in.
By specifying a specific variant you can force the use of another variant than the default. This allows you to test out the effect of certain changes to your MyCheckout payment pages in a controlled manner. Please note that you need to specify the ID instead of the name of the variant.
Note: In case you have defined a Dynamic 3D Secure rule that takes the variant into account this will only work if you explicitly specify the ID using this property.
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataInput
close

Description

Object containing rendering options of the device.
  • SDK Object type
    DeviceRenderOptions
close

Description

Lists all of the SDK Interface types that the device supports for displaying specific challenge user interfaces within the SDK.

  • native = The app supports only a native user interface
  • html = The app supports only an HTML user interface
  • both = Both Native and HTML user interfaces are supported by the app
close
Deprecated: Please use cardPaymentMethodSpecificInput.threeDSecure.sdkData.deviceRenderOptions.sdkUiTypes

Description

Lists all UI types that the device supports for displaying specific challenge user interfaces within the SDK.

  • text = Text interface
  • single-select = Select a single option
  • multi-select = Select multiple options
  • oob = Out of ounds
  • html-other = HTML Other (only valid when cardPaymentMethodSpecificInput.threeDSecure.sdkData.deviceRenderOptions.sdkInterface is set to html)
close

Description

Lists all UI types that the device supports for displaying specific challenge user interfaces within the SDK.

  • text = Text interface
  • single-select = Select a single option
  • multi-select = Select multiple options
  • oob = Out of ounds
  • html-other = HTML Other (only valid when cardPaymentMethodSpecificInput.threeDSecure.sdkData.deviceRenderOptions.sdkInterface is set to html)
close

Description

Universally unique ID created upon all installations and updates of your app on a c Device. This will be newly generated and stored by the 3DS SDK for each installation or update
close

Description

JWE Object containing data encrypted by the 3-D Secure SDK
close

Description

Public key component of the ephemeral key pair generated by the 3-D Secure SDK and used to establish session keys between the 3-D Secure SDK and ACS.
close

Description

Indicates maximum amount of time (in minutes) for all exchanges. Minimum amount of minutes is 5.
close

Description

Identifies the vendor and version for the 3-D Secure SDK that is integrated in your app, assigned by EMVCo when the 3-D Secure SDK is approved.
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify a single transaction.
close

Description

  • true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring.
  • false = 3D Secure authentication will not be skipped for this transaction.
Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.
close

Description

In case you performed your own risk analysis, you can send us the results. This will be used by us in case you submit the value automatic for the exemptionRequest property.
Possible values for this property are:
  • low = the risk-level of this transaction has been determined to be low
  • medium = the risk-level of this transaction has been determined to be medium
  • high = the risk-level of this transaction has been determined to be high
close

Description

ID of the token that holds previously stored card data. If both the token and card are provided, then the card takes precedence over the token.
close

Description

Indicates if this transaction should be tokenized
  • true - Tokenize the transaction.
  • false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.
close

Description

Indicates the channel via which the payment is created. Allowed values:
  • ECOMMERCE - The transaction is a regular E-Commerce transaction.
  • MAIL - The transaction is a Mail Order.
  • MOTO - The transaction is a Mail Order/Telephone Order.
  • TELEPHONE - The transaction is a Telephone Order.
Defaults to ECOMMERCE.
close
Deprecated: Use unscheduledCardOnFileSequenceIndicator instead.

Description

  • first = This transaction is the first of a series of unscheduled recurring transactions
  • subsequent = This transaction is a subsequent transaction in a series of unscheduled recurring transactions

Note: this property is not allowed if isRecurring is true.
close

Description

Indicates which party initiated the unscheduled recurring transaction. Allowed values:
  • merchantInitiated - Merchant Initiated Transaction.
  • cardholderInitiated - Cardholder Initiated Transaction.

Note: this property is not allowed if isRecurring is true.
close

Description

  • first = This transaction is the first of a series of unscheduled recurring transactions
  • subsequent = This transaction is a subsequent transaction in a series of unscheduled recurring transactions

Note: this property is not allowed if isRecurring is true.
close

Description

Object containing the specific input details for cash payments
  • SDK Object type
    CashPaymentMethodSpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close
Deprecated: No replacement

Description

Object that holds the specific data for Boleto Bancario in Brazil (payment product 1503)
  • SDK Object type
    CashPaymentProduct1503SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close
Deprecated: No replacement

Description

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.
Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.
URLs without a protocol will be rejected.
close

Description

Object that holds the specific data for Konbini in Japan (payment product 1504)
  • SDK Object type
    CashPaymentProduct1504SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.
Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.
URLs without a protocol will be rejected.
close

Description

Object that holds the specific data for e-Pay (payment product 1521).
  • SDK Object type
    CashPaymentProduct1521SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.
Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.
URLs without a protocol will be rejected.
close

Description

Object that holds the specific data for Tesco - Paysbuy Cash (payment product 1522).
  • SDK Object type
    CashPaymentProduct1522SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.
Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.
URLs without a protocol will be rejected.
close

Description

Object that holds the specific data for ATM Transfers Indonesia(payment product 1523).
  • SDK Object type
    CashPaymentProduct1523SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.
Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.
URLs without a protocol will be rejected.
close

Description

Object that holds the specific data for DragonPay (payment product 1524).
  • SDK Object type
    CashPaymentProduct1524SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.
Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.
URLs without a protocol will be rejected.
close

Description

Object that holds the specific data for 7-11 MOLPay Cash (payment product 1526).
  • SDK Object type
    CashPaymentProduct1526SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.
Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.
URLs without a protocol will be rejected.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the specific input details for direct debit payments
  • SDK Object type
    NonSepaDirectDebitPaymentMethodSpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Direct Debit payment collection date
Format: YYYYMMDD
close

Description

Descriptor intended to identify the transaction on the customer's bank statement
close

Description

Indicates if this transaction is of a one-off or a recurring type
  • true - This is recurring
  • false - This is one-off
close

Description

Object containing UK Direct Debit specific details
  • SDK Object type
    NonSepaDirectDebitPaymentProduct705SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Core reference number for the direct debit instruction in UK
close

Description

Object containing account holder name and bank account information
  • SDK Object type
    BankAccountBban
close

Description

Name of the account holder
close

Description

Bank account number
close

Description

Bank code
close

Description

Name of the bank
close

Description

Branch code
close

Description

Bank check digit
close

Description

ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
close

Description

  • first-payment - First payment direct debit
  • nth-payment - Direct Debit (n-th payment)
  • re-presented - Re-presented direct debit (after failed attempt)
  • final-payment - Final payment direct debit
  • new-or-reinstated - (zero N) New or reinstated direct debit instruction
  • cancellation - (zero C) Cancellation of direct debit instruction
  • conversion-of-paper-DDI-to-electronic-DDI - (zero S) Conversion of paper DDI to electronic DDI (only used once, when migrating from traditional direct debit to AUDDIS
close

Description

Object containing ACH specific details
  • SDK Object type
    NonSepaDirectDebitPaymentProduct730SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing account holder name and bank account information
  • SDK Object type
    BankAccountBban
close

Description

Name of the account holder
close

Description

Bank account number
close

Description

Bank code
close

Description

Name of the bank
close

Description

Branch code
close

Description

Bank check digit
close

Description

ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

  • first = This transaction is the first of a series of recurring transactions
  • recurring = This transaction is a subsequent transaction in a series of recurring transactions
  • last = This transaction is the last transaction of a series of recurring transactions
close

Description

  • true - The payment requires approval before the funds will be captured using the Approve payment or Capture payment API.
  • false - The payment does not require approval, and the funds will be captured automatically.
close

Description

ID of the stored token that contains the bank account details to be debited
close

Description

Indicates if this transaction should be tokenized
  • true - Tokenize the transaction
  • false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.
close

Description

Object containing the specific input details for e-invoice payments.
  • SDK Object type
    EInvoicePaymentMethodSpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Indicates that the customer has read and accepted the terms and conditions of the product before proceeding with the payment. This must be done before the payment can continue. An URL to the terms and conditions can be retrieved with Get payment product.
close

Description

Object that holds the specific data for AfterPay Installments (payment product 9000).
  • SDK Object type
    EInvoicePaymentProduct9000SpecificInput
close

Description

Object containing the bank account details of the customer.
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
close

Description

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
close

Description

The ID of the installment plan selected by the customer. Installment plans can be retrieved with Get payment product.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

  • true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API
  • false = the payment does not require approval, and the funds will be captured automatically
close

Description

Object containing the specific input details for invoice payments
  • SDK Object type
    InvoicePaymentMethodSpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Your (additional) reference identifier for this transaction. Data supplied in this property will also be returned in our report files, allowing you to reconcile the incoming funds.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the specific input details for mobile payments.

Mobile payments produce the required payment data in encrypted form.

  • For Apple Pay, the encrypted payment data is the PKPayment.token.paymentData object passed as a string (with all quotation marks escaped).
  • For Google Pay, the encrypted payment data can be found in property paymentMethodData.tokenizationData.token of the PaymentData.toJson() result.
  • SDK Object type
    MobilePaymentMethodSpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Determines the type of the authorization that will be used. Allowed values:
  • FINAL_AUTHORIZATION - The payment creation results in an authorization that is ready for capture. Final authorizations can't be reversed and need to be captured for the full amount within 7 days.
  • PRE_AUTHORIZATION - The payment creation results in a pre-authorization that is ready for capture. Pre-authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the authorized amount.
  • SALE - The payment creation results in an authorization that is already captured at the moment of approval.
Only used with some acquirers, ingnored for acquirers that don't support this. In case the acquirer doesn't allow this to be specified the authorizationMode is 'unspecified', which behaves similar to a final authorization.
close

Description

Reference of the customer for the payment (purchase order #, etc.). Only used with some acquirers.
close

Description

The payment data if you do the decryption of the encrypted payment data yourself.
  • SDK Object type
    DecryptedPaymentData
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close
Deprecated: Use paymentMethod instead

Description

The type of payment credential which the customer used.
  • For Google Pay, maps to the paymentMethodDetails.authMethod property in the encrypted payment data.
.
close

Description

Card holder's name on the card.
  • For Apple Pay, maps to the cardholderName property in the encrypted payment data.
  • For Google Pay this is not available in the encrypted payment data, and can be omitted.
close

Description

The 3D secure online payment cryptogram.
  • For Apple Pay, maps to the paymentData.onlinePaymentCryptogram property in the encrypted payment data.
  • For Google Pay, maps to the paymentMethodDetails.cryptogram property in the encrypted payment data.
Not allowed for Google Pay if the authMethod in the response of Google is PAN_ONLY.
close

Description

The device specific PAN.
  • For Apple Pay, maps to the applicationPrimaryAccountNumber property in the encrypted payment data.
  • For Google Pay, maps to the paymentMethodDetails.dpan property in the encrypted payment data.
Not allowed for Google Pay if the authMethod in the response of Google is PAN_ONLY.
close

Description

The eci is Electronic Commerce Indicator.
  • For Apple Pay, maps to the paymentData.eciIndicator property in the encrypted payment data.
  • For Google Pay, maps to the paymentMethodDetails.eciIndicator property in the encrypted payment data.
close

Description

Expiry date of the card
Format: MMYY.
  • For Apple Pay, maps to the applicationExpirationDate property in the encrypted payment data. This property is formatted as YYMMDD, so this needs to be converted to get a correctly formatted expiry date.
  • For Google Pay, maps to the paymentMethodDetails.expirationMonth and paymentMethodDetails.expirationYear properties in the encrypted payment data. These need to be combined to get a correctly formatted expiry date.
close

Description

The non-device specific complete credit/debit card number (also know as the PAN).
  • For Apple Pay this is not available in the encrypted payment data, and must be omitted.
  • For Google Pay, maps to the paymentMethodDetails.pan property in the encrypted payment data.
Not allowed for Google Pay if the authMethod in the response of Google is CRYPTOGRAM_3DS.
close

Description

  • In case Google provides in the response as authMethod: CRYPTOGRAM_3DS send in as value of this property TOKENIZED_CARD.
  • In case Google provides in the response as authMethod: PAN_ONLY send in as value of this property CARD.
For Apple Pay this is not available in the encrypted payment data, and must be omitted.
close

Description

The payment data if we will do the decryption of the encrypted payment data.

Typically you'd use encryptedCustomerInput in the root of the create payment request to provide the encrypted payment data instead.

  • For Apple Pay, the encrypted payment data is the PKPayment.token.paymentData object passed as a string (with all quotation marks escaped).
  • For Google Pay, the encrypted payment data can be found in property paymentMethodData.tokenizationData.token of the PaymentData.toJson() result.
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing information specific to Google Pay
  • SDK Object type
    MobilePaymentProduct320SpecificInput
close

Description

The card holder's name on the card.
The encrypted payment data can be found in property paymentMethodData.tokenizationData.info.billingAddress.name of the PaymentData.toJson() result.
close

Description

Object containing specific data regarding 3-D Secure
  • SDK Object type
    GPayThreeDSecure
close

Description

Dimensions of the challenge window that potentially will be displayed to the customer. The challenge content is formatted to appropriately render in this window to provide the best possible user experience.
Preconfigured sizes are width x height in pixels of the window displayed in the customer browser window. Possible values are:
  • 250x400 (default)
  • 390x400
  • 500x600
  • 600x400
  • full-screen
.
close

Description

Allows you to indicate if you want the customer to be challenged for extra security on this transaction. Possible values:
  • no-preference - You have no preference whether or not to challenge the customer (default)
  • no-challenge-requested - you prefer the cardholder not to be challenged
  • challenge-requested - you prefer the customer to be challenged
  • challenge-required - you require the customer to be challenged
close

Description

Type of strong customer authentication (SCA) exemption requested for this transaction. Possible values:
  • none - No exemption flagging is to be used of this transaction (Default).
  • automatic - Our systems will determine the best possible exemption based on the transaction parameters and the risk scores.
  • transaction-risk-analysis - You have determined that this transaction is of low risk and are willing to take the liability. Please note that your fraud rate needs to stay below thresholds to allow your use of this exemption.
  • low-value - The value of the transaction is below 30 EUR. Please note that the issuer will still require every 5th low-value transaction pithing 24 hours to be strongly authenticated. The issuer will also keep track of the cumulative amount authorized on the card. When this exceeds 100 EUR strong customer authentication is also required.
  • whitelist - You have been whitelisted by the customer at the issuer.
close

Description

Object containing browser specific redirection related data
  • SDK Object type
    RedirectionData
close

Description

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.
Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.
URLs without a protocol will be rejected.
close

Description

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. The redirection flow for 3-D Secure uses the MyCheckout payment pages to display the following types of pages:
  • Redirection page - All redirection using a POST method will load a page in the browser of the customer that performs the actual redirection. This page contains a message to the customer explaining what is happening.
  • MethodURL page - Certain Issuers will use a specific flow in case of 3-D Secure version 2 to directly collect information from the customer browser. This page contains a spinner indicating that this process is going on in.
By specifying a specific variant you can force the use of another variant than the default. This allows you to test out the effect of certain changes to your MyCheckout payment pages in a controlled manner. Please note that you need to specify the ID instead of the name of the variant.
Note: In case you have defined a Dynamic 3D Secure rule that takes the variant into account this will only work if you explicitly specify the ID using this property.
close

Description

  • true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring.
  • false = 3D Secure authentication will not be skipped for this transaction.
Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

  • true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API
  • false = the payment does not require approval, and the funds will be captured automatically
close

Description

  • true = Fraud scoring will be skipped for this transaction
  • false = Fraud scoring will not be skipped for this transaction
Note: This is only possible if your account in our system is setup for Fraud scoring and if your configuration in our system allows you to override it per transaction.
close

Description

Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal
  • SDK Object type
    RedirectPaymentMethodSpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

This sets the maximum amount of minutes a customer has to complete the payment at the bank. After this period has expired it is impossible for the customer to make a payment and in case no payment has been made the transaction will be marked as unsuccessful and expired by the bank. Setting the expirationPeriod is convenient if you want to maximise the time a customer has to complete the payment. Please note that it is normal for a customer to take up to 5 minutes to complete a payment. Setting this value below 10 minutes is not advised.
You can set this value in minutes with a maximum value of 60 minutes. If no input is provided the default value of 60 is used for the transaction.
This value can be set for the following payment products
  • 809 - iDeal
  • 402 - e-Przelewy
  • 836 - Sofort
  • 863 - WeChat Pay
  • 869 - China UnionPay
close

Description

  • true
  • false
close

Description

Object containing specific input required for UPI (Payment product ID 4101)
  • SDK Object type
    RedirectPaymentProduct4101SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

The merchant name as shown to the customer in some payment applications.
close

Description

The value of this property must be 'vpa', 'desktopQRCode', or 'urlIntent'.
close

Description

The Virtual Payment Address (VPA) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

Object containing specific input required for Dutch iDeal payments (Payment product ID 809)
  • SDK Object type
    RedirectPaymentProduct809SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close
Deprecated: Use redirectPaymentMethodSpecificInput.expirationPeriod instead

Description

This sets the maximum amount of minutes a customer has to complete the payment at the bank. After this period has expired it is impossible for the customer to make a payment and in case no payment has been made the transaction will be marked as unsuccessful and expired by the bank. Setting the expirationPeriod is convenient if you want to maximise the time a customer has to complete the payment. Please note that it is normal for a customer to take up to 5 minutes to complete a payment. Setting this value below 10 minutes is not advised.
You can set this value in minutes with a maximum value of 60 minutes. If no input is provided the default value of 60 is used for the transaction.
close

Description

ID of the issuing bank of the customer. A list of available issuerIDs can be obtained by using the retrieve payment product directory API.
close

Description

Object containing specific input required for German giropay payments (Payment product ID 816)
  • SDK Object type
    RedirectPaymentProduct816SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the bank account details of the customer
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
close

Description

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
close

Description

Object containing specific input required for PayPal payments (Payment product ID 840)
  • SDK Object type
    RedirectPaymentProduct840SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

For payments processed by the Worldline Ogone Payment Platform, indicates whether to allow the customer to select an address on the PayPal website.
  • true = Address can be selected at PayPal
  • false = No address can be selected at PayPal
close
Deprecated: use order.references.descriptor instead.

Description

A free text string that you can send to PayPal. With a special agreement between PayPal and you, PayPal uses the data in that property, for custom services they offer to you.
close

Description

Deprecated: If your PayPal payments are processed by Worldline's Ogone Payment Platform, please use the property addressSelectionAtPayPal instead.

Indicates whether to use PayPal Express Checkout for payments processed by Worldline's GlobalCollect Payment Platform.
  • true = PayPal Express Checkout
  • false = Regular PayPal payment
For payments processed by Worldline's Ogone Payment Platform, please see the addressSelectionAtPayPal property for more information.
close

Description

Object containing specific input required for AliPay payments (Payment product ID 861)
  • SDK Object type
    RedirectPaymentProduct861SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

This indicates that a customer is on a mobile device and it is used to distinguish whether a customer should be redirected to AliPay Desktop or Mobile. Alternatively, if you cannot determine whether a customer is on a mobile device or not, a customer can be redirected to AliPay Mobile if the property CreatePaymentRequest.order.customer.device.userAgent is supplied.
close

Description

Object containing specific input required for We Chat Pay payments (Payment product ID 863)
  • SDK Object type
    RedirectPaymentProduct863SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

The type of integration with WeChat. Possible values:
  • desktopQRCode - used on desktops, the customer opens the WeChat app by scanning a QR code.
  • urlIntent - used in mobile apps or on mobile web pages, the customer opens the WeChat app using a URL intent.
  • nativeInApp - used in mobile apps that use the WeChat Pay SDK.
  • javaScriptAPI - used for WeChat official accounts. Requires the QQ browser to function.
  • miniProgram - used for Mini Programs.
close

Description

An openId of a customer.
close

Description

Object containing specific input required for China UnionPay payments (Payment product ID 869)
  • SDK Object type
    RedirectPaymentProduct869SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

ID of the issuing bank of the customer. A list of available issuerIDs can be obtained by using the retrieve payment product directory API.
close

Description

The name as described on the Resident Identity Card of the People's Republic of China.
close

Description

The identification number as described on the Resident Identity Card of the People's Republic of China.
close

Description

Object containing specific input required for Indian Net Banking payments (Payment product ID 882)
  • SDK Object type
    RedirectPaymentProduct882SpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

ID of the issuing bank of the customer. A list of available issuerIDs can be obtained by using the retrieve payment product directory API.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

  • first = This transaction is the first of a series of recurring transactions
  • recurring = This transaction is a subsequent transaction in a series of recurring transactions

Note: For any first of a recurring the system will automatically create a token as you will need to use a token for any subsequent recurring transactions. In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response.
close

Description

Object containing browser specific redirection related data
  • SDK Object type
    RedirectionData
close

Description

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.
Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.
URLs without a protocol will be rejected.
close

Description

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. All redirection using a POST method will load a page in the browser of the consumer that performs the actual redirection. This page contains a message to the consumer explaining what is happening. By specifying a specific variant you can force the use of another variant than the default. This allows you to test out the effect of certain changes to your MyCheckout payment pages in a controlled manner. Please note that you need to specify the ID instead of the name of the variant.
close

Description

  • true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API
  • false = the payment does not require approval, and the funds will be captured automatically

Note: This property is supported by the Ogone Payment Platform for all redirect payment methods and only for PayPal in GlobalCollect Payment Platform.
close
Deprecated: Use redirectionData.returnUrl instead

Description

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process.
Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first.
URLs without a protocol will be rejected.
close

Description

ID of the token
close

Description

Indicates if this transaction should be tokenized
  • true - Tokenize the transaction. Note: a challenged redirected PayPal payment on the GlobalCollect platform can't be tokenized in this way. In this case, use the 'Create a token from payment' functionality after your customer succesfully completes the redirection.
  • false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.
close

Description

Object containing the specific input details for SEPA direct debit payments
  • SDK Object type
    SepaDirectDebitPaymentMethodSpecificInput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Changed date for direct debit collection. Only relevant for legacy SEPA Direct Debit.
Format: YYYYMMDD
close

Description

Description of the transaction that will appear on the customer bank statement to aid the customer in recognizing the transaction. Only relevant for legacy SEPA Direct Debit.
close

Description

Indicates if this transaction is of a one-off or a recurring type. Only relevant for legacy SEPA Direct Debit.
  • true - This is recurring
  • false - This is one-off
close

Description

Object containing information specific to SEPA Direct Debit
  • SDK Object type
    SepaDirectDebitPaymentProduct771SpecificInput
close

Description

The unique reference of the existing mandate to use in this payment.
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing information to create a SEPA Direct Debit mandate.
  • SDK Object type
    CreateMandateWithReturnUrl
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

An alias for the mandate. This can be used to visually represent the mandate.
Do not include any unobfuscated sensitive data in the alias.
Default value if not provided is the obfuscated IBAN of the customer.
close

Description

Customer object containing customer specific inputs
  • SDK Object type
    MandateCustomer
close

Description

Object containing IBAN information
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
close

Description

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
close

Description

Name of company, as a customer
close

Description

Object containing contact details like email address and phone number
  • SDK Object type
    MandateContactDetails
close

Description

Email address of the customer
close

Description

Object containing billing address details
  • SDK Object type
    MandateAddress
close

Description

City
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number
close

Description

Streetname
close

Description

Zip code
close

Description

Object containing personal information of the customer
  • SDK Object type
    MandatePersonalInformation
close

Description

Object containing the name details of the customer
  • SDK Object type
    MandatePersonalName
close

Description

Given name(s) or first name(s) of the customer
close

Description

Surname(s) or last name(s) of the customer
close

Description

Object containing the title of the customer (Mr, Miss or Mrs)
close

Description

The unique identifier of a customer
close

Description

The language code of the customer, one of de, en, es, fr, it, nl, si, sk, sv.
close

Description

Specifies whether the mandate is for one-off or recurring payments. Possible values are:
  • UNIQUE
  • RECURRING
close

Description

Return URL to use if the mandate signing requires redirection.
close

Description

Specifies whether the mandate is unsigned or singed by SMS. Possible values are:
  • UNSIGNED
  • SMS
close

Description

The unique identifier of the mandate
close
Deprecated: Use existingUniqueMandateReference or mandate.uniqueMandateReference instead

Description

A mandate ID to create a mandate under if the information to create a mandate has been supplied. Otherwise refers to the mandate to retrieve and use in the payment.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Only relevant for legacy SEPA Direct Debit.
  • first = This transaction is the first of a series of recurring transactions
  • recurring = This transaction is a subsequent transaction in a series of recurring transactions
  • last = This transaction is the last transaction of a series of recurring transactions
close

Description

  • true - The payment requires approval before the funds will be captured using the Approve payment or Capture payment API.
  • false - The payment does not require approval, and the funds will be captured automatically.
close

Description

ID of the token that holds previously stored SEPA Direct Debit account and mandate data. Only relevant for legacy SEPA Direct Debit.
close

Description

Indicates if this transaction should be tokenized. Only relevant for legacy SEPA Direct Debit.
  • true - Tokenize the transaction
  • false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.
close

Description

Data that was encrypted client side containing all customer entered data elements like card data.
Note: Because this data can only be submitted once to our system and contains encrypted card data you should not store it. As the data was captured within the context of a client session you also need to submit it to us before the session has expired.
close

Description

Object containing additional data that will be used to assess the risk of fraud
  • SDK Object type
    FraudFields
close
Deprecated: For risk assessments there is no replacement. For other calls, please use order.shipping.addressIndicator to indicate that the billing and shipping address are identical.

Description

Indicates that invoice and shipping addresses are equal.
close

Description

Additional black list input
close
Deprecated: This should be the same as order.customer.billingAddress

Description

The address that belongs to the owner of the card
  • SDK Object type
    Address
close
Deprecated

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close
Deprecated

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close
Deprecated

Description

ISO 3166-1 alpha-2 country code
close
Deprecated

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close
Deprecated

Description

Full name of the state or province
close
Deprecated

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close
Deprecated

Description

Streetname
close
Deprecated

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

The IP Address of the customer that is making the payment. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close
Deprecated: Use order.customer.device.defaultFormFill instead

Description

Degree of default form fill, with the following possible values:
  • automatically - All fields filled automatically
  • automatically-but-modified - All fields filled automatically, but some fields were modified manually
  • manually - All fields were entered manually
close
Deprecated: No replacement

Description

Indicates that the device fingerprint has been used while processing the order.
close
Deprecated: Use order.customer.device.deviceFingerprintTransactionId instead

Description

One must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
close

Description

One of the following gift card types:
  • celebrate-fall - Celebrate Fall
  • grandparents-day - Grandparent's Day
  • independence-day - Independence Day
  • anniversary - Anniversary
  • birthday - Birthday
  • congratulations - Congratulations
  • april-fools-day - April Fool's Day
  • easter - Easter
  • fathers-day - Father's Day
  • graduation - Graduation
  • holiday - Holiday
  • seasons-greetings - Season's Greetings
  • passover - Passover
  • kwanzaa - Kwanzaa
  • halloween - Halloween
  • mothers-day - Mother's Day
  • new-years-day - New Year's Day
  • bosses-day - Bosses' Day
  • st-patricks-day - St. Patrick's Day
  • sweetest-day - Sweetest Day
  • christmas - Christmas
  • baby-shower - Baby Shower
  • thanksgiving - Thanksgiving
  • other - Other
  • valentines-day - Valentine's Day
  • wedding - Wedding
  • secretarys-day - Secretary's Day
  • chinese-new-year - Chinese New Year
  • hanukkah - Hanukkah
close

Description

Gift message
close
Deprecated: Use order.customer.account.hasForgottenPassword instead

Description

Specifies if the customer (initially) had forgotten their password
  • true - The customer has forgotten their password
  • false - The customer has not forgotten their password
close
Deprecated: Use order.customer.account.hasPassword instead

Description

Specifies if the customer entered a password to gain access to an account registered with the you
  • true - The customer has used a password to gain access
  • false - The customer has not used a password to gain access
close
Deprecated: Use order.customer.isPreviousCustomer instead

Description

Specifies if the customer has a history of online shopping with the merchant
  • true - The customer is a known returning customer
  • false - The customer is new/unknown customer
close

Description

Timezone in which the order was placed. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close
Deprecated: Use order.shipping.comments instead

Description

Comments included during shipping
close
Deprecated: Use order.shipping.trackingNumber instead

Description

Shipment tracking number
close
Deprecated: No replacement

Description

Details on how the order is shipped to the customer
  • SDK Object type
    FraudFieldsShippingDetails
close
Deprecated: No replacement

Description

Details regarding the shipping method
close
Deprecated: No replacement

Description

Shipping method speed indicator
close
Deprecated: No replacement

Description

Shipping method type indicator
close

Description

Array of up to 16 userData properties, each with a max length of 256 characters, that can be used for fraudscreening
close
Deprecated: Use merchant.websiteUrl instead

Description

The website from which the purchase was made
close

Description

Object containing information on you, the merchant
  • SDK Object type
    Merchant
close

Description

In case your account has been setup with multiple configurations you can use this property to identify the one you would like to use for the transaction. Note that you can only submit preconfigured values in combination with the Worldline Online Payments Acceptance platform. In case no value is supplied a default value of 0 will be submitted to the Worldline Online Payments Acceptance platform. The Worldline Online Payments Acceptance platform internally refers to this as a PosId.
close

Description

URL to find contact or support details to contact in case of questions.
close

Description

Object containing seller details
  • SDK Object type
    Seller
close

Description

Object containing the seller address details
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

This property is specific to Visa Argentina. Channelcode according to Prisma. Please contact the acquirer to get the full list you need to use.
close

Description

Description of the seller
close

Description

Seller ID assigned by the Merchant Aggregator
close

Description

The sellers geocode
close

Description

The sellers identifier
close

Description

Invoice number of the payment
close

Description

Indicates if the retailer is considered foreign or domestic when compared to the location of the marketplace. Possible values:
  • true - The retailer is considered foreign because they are located in a different country than the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the marketplace is within the EEA and UK (and Gibraltar), but the retailer is located outside of the EEA and UK (and Gibraltar)
  • false - The retailer is considered domestic because they are located in the same country as the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the retailer is also located within the EEA and UK (and Gibraltar).
close

Description

Merchant category code
close

Description

Name of the seller
close

Description

Main Phone Number
close

Description

Seller type. Possible values:
  • passport
  • dni
  • arg-identity-card
  • civic-notebook
  • enrollment-book
  • cuil
  • cuit
  • general-register
  • election-title
  • cpf
  • cnpj
  • ssn
  • citizen-ship
  • col-identity-card
  • alien-registration
close

Description

The website from which the purchase was made. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

Order object containing order related data
Please note that this object is required to be able to submit the amount.
  • SDK Object type
    Order
close

Description

Object containing additional input on the order
  • SDK Object type
    AdditionalOrderInput
close

Description

Object containing specific data regarding the recipient of an account funding transaction
  • SDK Object type
    AccountFundingRecipient
close

Description

Should be populated with the value of the corresponding accountNumberType of the recipient.
close

Description

Defines the account number type of the recipient. Possible values are:
  • cash = Mode of payment is cash to the recipient.
  • walletId = Digital wallet ID.
  • routingNumber = Routing Transit Number is a code used by financial institutions to identify other financial institutions.
  • iban = International Bank Account Number, is a standard international numbering system for identifying bank accounts.
  • bicNumber = Bank Identification Code is a number that is used to identify a specific bank.
  • giftCard = Gift card is a type of prepaid card that contains a specific amount of money that can be used at participating stores and marketplaces.
close

Description

Object containing the address details of the recipient of an account funding transaction.
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
close

Description

Streetname
close

Description

Zip Code
close

Description

The date of birth of the recipient
Format: YYYYMMDD
close

Description

Object containing the name details of the recipient of an account funding transaction.
  • SDK Object type
    AfrName
close

Description

Given name(s) or first name(s) of the recipient of an account funding transaction.
close

Description

Surname(s) or last name(s) of the customer
close

Description

Either partialPan or accountnumber is required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
close

Description

Object that holds airline specific data
  • SDK Object type
    AirlineData
close

Description

Numeric code identifying the agent
close

Description

Airline numeric code
close

Description

Date of the Flight
Format: YYYYMMDD
close

Description

Object that holds the data on the individual legs of the ticket
close
  • SDK Object type
    AirlineFlightLeg
close

Description

Reservation Booking Designator
close

Description

Arrival airport/city code
close

Description

The arrival time in the local time zone
Format: HH:MM
close

Description

IATA carrier code
close

Description

Identifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage
close

Description

The coupon number associated with this leg of the trip. A ticket can contain several legs of travel, and each leg of travel requires a separate coupon
close

Description

Date of the leg
Format: YYYYMMDD
close

Description

The departure time in the local time at the departure airport
Format: HH:MM
close

Description

An endorsement can be an agency-added notation or a mandatory government required notation, such as value-added tax. A restriction is a limitation based on the type of fare, such as a ticket with a 3-day minimum stay
close

Description

New ticket number that is issued when a ticket is exchanged
close

Description

Fare of this leg
close

Description

Fare Basis/Ticket Designator
close

Description

Fee for this leg of the trip
close

Description

The flight number assigned by the airline carrier with no leading spaces
Should be a numeric string
close

Description

Sequence number of the flight leg
close

Description

Origin airport/city code
close

Description

PassengerClass if this leg
close
Deprecated: Use passengerClass instead

Description

ServiceClass of this leg (this property is used for fraud screening on the Ogone Payment Platform).

Possible values are:

  • economy
  • premium-economy
  • business
  • first
close

Description

Possible values are:
  • permitted = Stopover permitted
  • non-permitted = Stopover not permitted
close

Description

Taxes for this leg of the trip
close

Description

Airline tracing number
close

Description

  • true = The ticket is an E-Ticket
  • false = the ticket is not an E-Ticket
close
Deprecated: Use order.customer.accountType instead

Description

  • true = a registered known customer
  • false = unknown customer
close

Description

  • true - Restricted, the ticket is non-refundable
  • false - No restrictions, the ticket is (partially) refundable
close

Description

  • true - The payer is the ticket holder
  • false - The payer is not the ticket holder
close

Description

This is the date of issue recorded in the airline system In a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date.
Format: YYYYMMDD
close

Description

Your ID of the customer in the context of the airline data
close

Description

Name of the airline
close

Description

Total number of passengers in the party. If the the property numberInParty is not present, then the number of passengers will be used on the WL Online Payment Acceptance Platform.
close

Description

Name of passenger
close

Description

Object that holds the data on the individual passengers (this object is used for fraud screening on the Ogone Payment Platform)
close
  • SDK Object type
    AirlinePassenger
close

Description

First name of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
close

Description

Surname of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
close

Description

Surname prefix of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
close

Description

Title of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
close

Description

Place of issue
For sales in the US the last two characters (pos 14-15) must be the US state code.
close

Description

Passenger name record
close

Description

IATA point of sale name
close

Description

city code of the point of sale
close

Description

Possible values:
  • e-ticket
  • city-ticket-office
  • airport-ticket-office
  • ticket-by-mail
  • ticket-on-departure
close

Description

The ticket or document number. On the Ogone Payment Platform and the GlobalCollect Payment Platform it contains:
  • Airline code: 3-digit airline code number
  • Form code: A maximum of 3 digits indicating the type of document, the source of issue and the number of coupons it contains
  • Serial number: A maximum of 8 digits allocated on a sequential basis, provided that the total number of digits allocated to the form code and serial number shall not exceed ten
  • TICKETNUMBER can be replaced with PNR if the ticket number is unavailable
close

Description

Total fare for all legs on the ticket, excluding taxes and fees. If multiple tickets are purchased, this is the total fare for all tickets
close

Description

Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets
close

Description

Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets
close

Description

Name of the travel agency issuing the ticket. For direct airline integration, leave this property blank on the Ogone Payment Platform.
close

Description

Object containing data related to installments which can be used for card payments and only with some acquirers. In case you send in the details of this object, only the combination of card products and acquirers that do support installments will be shown on the MyCheckout hosted payment pages.
  • SDK Object type
    Installments
close

Description

The amount that will be paid per installment. The total amount of amountOfMoneyPerInstallment x numberOfInstallments can not be higher than the total amount of this transaction, although we will not validate that.
For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), this property is not used as the value is decided by the issuer.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Object containing the total amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

The frequency in which the installments will be collected from the customer. The possible values are:
  • daily
  • weekly
  • monthly (default)
  • quarterly

For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), only the value monthly is valid.
close

Description

The code for the installment plan. The possible values are:
  • 43 No-interest, 3 month Installmentplan
  • 46No-interest, 6 month Installmentplan
  • 49No-interest, 9 month Installmentplan
  • 52No-interest, 12 month Installmentplan
close

Description

The interest rate paid for installments expressed in percentage. So for example 5.75 means 5.75%
For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), this property is not used as the value is decided by the issuer.
close

Description

The number of installments in which this transaction will be paid, which can be used for card payments at supported acquirers, or with specific payment products. Only used with some acquirers. In case you send in the details of this object, only the payment products (or combination of card products and acquirers) that support installments will be shown on the MyCheckout hosted payment pages. If this property is not provided the customer will not see details on the installment plan in a HostedCheckout.
For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), there is a maximum of 12 installments.
close
Deprecated: Use order.shoppingCart.amountBreakdown instead

Description

Object that holds Level3 summary data
  • SDK Object type
    Level3SummaryData
close
Deprecated: Use order.shoppingCart.amountBreakdown with type DISCOUNT instead

Description

Discount on the entire transaction, with the last 2 digits are implied decimal places
close
Deprecated: Use order.shoppingCart.amountBreakdown with type DUTY instead

Description

Duty on the entire transaction, with the last 2 digits are implied decimal places
close
Deprecated: Use order.shoppingCart.amountBreakdown with type SHIPPING instead

Description

Shippingcost on the entire transaction, with the last 2 digits are implied decimal places
close
Deprecated: No replacement

Description

Object containing specific data regarding the recipient of a loan in the UK
  • SDK Object type
    LoanRecipient
close
Deprecated: No replacement

Description

Should be filled with the last 10 digits of the bank account number of the recipient of the loan.
close
Deprecated: No replacement

Description

The date of birth of the customer of the recipient of the loan.
Format: YYYYMMDD
close
Deprecated: No replacement

Description

Should be filled with the first 6 and last 4 digits of the PAN number of the recipient of the loan.
close
Deprecated: No replacement

Description

Surname of the recipient of the loan.
close
Deprecated: No replacement

Description

Zip code of the recipient of the loan
close

Description

Object that holds lodging specific data
  • SDK Object type
    LodgingData
close

Description

Object that holds lodging related charges
close
  • SDK Object type
    LodgingCharge
close

Description

Amount of additional charges associated with the stay of the guest.
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
close

Description

Currency for Charge amount. The code should be in 3 letter ISO format.
close

Description

Type of additional charges associated with the stay of the guest. Allowed values:
  • lodging
  • telephone
  • restaurant
  • minibar
  • giftshop
  • laundry
  • transport
  • gratuity
  • conferenceRoom
  • audiovisual
  • banquet
  • internet
  • earlyDeparture
  • roomService
  • loungeBar
  • other
close

Description

The date the guest checks into (or plans to check in to) the facility.
Format: YYYYMMDD
close

Description

The date the guest checks out of (or plans to check out of) the facility.
Format: YYYYMMDD
close

Description

The Lodging Folio Number assigned to the itemized statement of charges and credits associated with this lodging stay, which can be any combination of characters and numerals defined by the Merchant or authorized Third Party Processor.
close

Description

Indicates whether the room reservation is confirmed.
  • true - The room reservation is confirmed
  • false - The room reservation is not confirmed
close

Description

Defines whether or not the facility conforms to the requirements of the Hotel and Motel Fire Safety Act of 1990, or similar legislation.
  • true - The facility conform to the requirements
  • false - The facility doesn't conform to the requirements
close

Description

Indicate if this the customer is a no show case. In such case, the lodging property can charge a no show fee.
  • true - The customer is a no show
  • false - Not applicable
close

Description

Indicated the preference of the customer for a smoking or non-smoking room.
  • true - A smoking room is preferred
  • false - A non-smoking room is preferred
close

Description

The total number of adult guests staying (or planning to stay) at the facility (i.e., all booked rooms)
close

Description

The number of nights for the lodging stay
close

Description

The number of rooms rented for the lodging stay
close

Description

Code that corresponds to the category of lodging charges detailed in this message. Allowed values:
  • lodging - (Default) Submitted charges are for lodging
  • noShow - Submitted charges are for the failure of the guest(s) to check in for reserved a room
  • advancedDeposit - Submitted charges are for an Advanced Deposit to reserve one or more rooms
If no value is submitted the default value lodging is used.
close

Description

The international customer service phone number of the facility
close

Description

The local phone number of the facility in an international phone number format
close

Description

Name of the person or business entity charged for the reservation and/or lodging stay
close

Description

Object that holds lodging related room data
close
  • SDK Object type
    LodgingRoom
close

Description

Daily room rate exclusive of any taxes and fees
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
close

Description

Currency for Daily room rate. The code should be in 3 letter ISO format
close

Description

Daily room tax
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
close

Description

Currency for Daily room tax. The code should be in 3 letter ISO format
close

Description

Number of nights charged at the rate in the dailyRoomRate property
close

Description

Location of the room within the facility, e.g. Park or Garden etc.
close

Description

Room number
close

Description

Size of bed, e.g., king, queen, double.
close

Description

Describes the type of room, e.g., standard, deluxe, suite.
close
Deprecated: Use installments.numberOfInstallments instead.

Description

The number of installments in which this transaction will be paid, which can be used for card payments. Only used with some acquirers. In case you send in the details of this object, only the combination of card products and acquirers that do support installments will be shown on the MyCheckout hosted payment pages.
close

Description

Date and time of order
Format: YYYYMMDDHH24MISS
close

Description

Object that holds the purchase and usage type indicators
  • SDK Object type
    OrderTypeInformation
close

Description

Identifies the funding type being authenticated. Possible values are:
  • personToPerson = When it is person to person funding (P2P)
  • agentCashOut = When fund is being paid out to final recipient in Cash by company's agent.
  • businessToConsumer = When fund is being transferred from business to consumer (B2C)
  • businessToBusiness = When fund is being transferred from business to business (B2B)
  • prefundingStagedWallet = When funding is being used to load the funds into the wallet account.
  • storedValueDigitalWallet = When funding is being used to load the funds into a stored value digital wallet.
  • fundingGiftCardForPersonalUse = When funding a gift card for personal use.
  • fundingGiftCardForSomeoneElse = When funding a gift card for someone else.
close

Description

Possible values are:
  • physical
  • digital
close

Description

Identifies the type of transaction being authenticated. Possible values are:
  • purchase = The purpose of the transaction is to purchase goods or services (Default)
  • check-acceptance = The purpose of the transaction is to accept a 'check'/'cheque'
  • account-funding = The purpose of the transaction is to fund an account
  • quasi-cash = The purpose of the transaction is to buy a quasi cash type product that is representative of actual cash such as money orders, traveler's checks, foreign currency, lottery tickets or casino gaming chips
  • prepaid-activation-or-load = The purpose of the transaction is to activate or load a prepaid card
close

Description

Possible values are:
  • private
  • commercial
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Object containing the details of the customer
  • SDK Object type
    Customer
close

Description

Object containing data related to the account the customer has with you
  • SDK Object type
    CustomerAccount
close

Description

Object containing data on the authentication used by the customer to access their account
  • SDK Object type
    CustomerAccountAuthentication
close

Description

Data that documents and supports a specific authentication process submitted using the order.customer.account.authentication.method property. The data submitted using this property will be used by the issuer to validate the used authentication method.
For example, if the order.customer.account.authentication.method is:
  • federated-id, then this element can carry information about the provider of the federated ID and related information.
  • fido-authentication, then this element can carry the FIDO attestation data (including the signature).
  • fido-authentication-with-signed-assurance-data, then this element can carry FIDO Attestation data with the FIDO assurance data signed.
  • src-assurance-data, then this element can carry the SRC assurance data
close

Description

Authentication used by the customer on your website or app
Possible values :
  • guest = no login occurred, customer is 'logged in' as guest
  • merchant-credentials = the customer logged in using credentials that are specific to you
  • federated-id = the customer logged in using a federated ID
  • issuer-credentials = the customer logged in using credentials from the card issuer (of the card used in this transaction)
  • third-party-authentication = the customer logged in using third-party authentication
  • fido-authentication = the customer logged in using a FIDO authenticator
  • fido-authentication-with-signed-assurance-data = the customer logged in using a FIDO authenticator which also provides signed assurance data
  • src-assurance-data = the customer authenticated themselves during a Secure Remote Commerce session
close

Description

Timestamp (YYYYMMDDHHmm) of the authentication of the customer to their account with you
close

Description

The last date (YYYYMMDD) on which the customer made changes to their account with you. These are changes to billing & shipping address details, new payment account (tokens), or new users(s) added.
close

Description

true = the customer made changes to their account during this checkout

false = the customer didn't change anything to their account during this checkout/n

The changes ment here are changes to billing & shipping address details, new payment account (tokens), or new users(s) added.

close

Description

The date (YYYYMMDD) on which the customer created their account with you
close

Description

Specifies if you have experienced suspicious activity on the account of the customer

true = you have experienced suspicious activity (including previous fraud) on the customer account used for this transaction

false = you have experienced no suspicious activity (including previous fraud) on the customer account used for this transaction

close

Description

Specifies if the customer (initially) had forgotten their password
  • true - The customer has forgotten their password
  • false - The customer has not forgotten their password
close

Description

Specifies if the customer entered a password to gain access to an account registered with the you
  • true - The customer has used a password to gain access
  • false - The customer has not used a password to gain access
close

Description

The last date (YYYYMMDD) on which the customer changed their password for the account used in this transaction
close

Description

Indicates if the password of an account is changed during this checkout

true = the customer made changes to their password of the account used during this checkout

alse = the customer didn't change anything to their password of the account used during this checkout

close

Description

Object containing information on the payment account data on file (tokens)
  • SDK Object type
    PaymentAccountOnFile
close

Description

The date (YYYYMMDD) when the payment account on file was first created.

In case a token is used for the transaction we will use the creation date of the token in our system in case you leave this property empty.

close

Description

Number of attempts made to add new card to the customer account in the last 24 hours
close

Description

Indicates the type of account. For example, for a multi-account card product.
  • not-applicable = the card used doesn't support multiple card products
  • credit = the card used is a credit card
  • debit = the card used is a debit card
close

Description

Object containing data on the purchase history of the customer with you
  • SDK Object type
    CustomerPaymentActivity
close

Description

Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 24 hours
close

Description

Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 12 months
close

Description

Number of successful purchases made by this customer with you in the last 6 months
close

Description

Type of the customer account that is used to place this order. Can have one of the following values:
  • none - The account that was used to place the order with is a guest account or no account was used at all
  • created - The customer account was created during this transaction
  • existing - The customer account was an already existing account prior to this transaction
close

Description

Object containing billing address details
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing company information
  • SDK Object type
    CompanyInformation
close

Description

Name of company, as a customer
close

Description

Local VAT number of the company
close

Description

Object containing contact details like email address and phone number
  • SDK Object type
    ContactDetails
close

Description

Email address of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

Preference for the type of email message markup
  • plain-text
  • html
close

Description

Fax number of the customer
close

Description

International version of the mobile phone number of the customer including the leading + (i.e. +16127779311).
close

Description

Phone number of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

International version of the work phone number of the customer including the leading + (i.e. +31235671500)
close

Description

Object containing information on the device and browser of the customer
  • SDK Object type
    CustomerDevice
close

Description

The accept-header of the customer client from the HTTP Headers.
close

Description

Object containing information regarding the browser of the customer
  • SDK Object type
    BrowserData
close

Description

ColorDepth in bits. Value is returned from the screen.colorDepth property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser".

close

Description

The innerHeight of the frame in case you are capturing your payments in a frame. We will use this to validate if the height provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.
close

Description

The innerWidth of the frame in case you are capturing your payments in a frame. We will use this to validate if the width provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.
close

Description

true =Java is enabled in the browser

false = Java is not enabled in the browser

Value is returned from the navigator.javaEnabled property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser".

close

Description

true = JavaScript is enabled in the browser

false = JavaScript is not enabled in the browser

Note: Required in future 3-D Secure version 2.2.

close

Description

Height of the screen in pixels. Value is returned from the screen.height property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser".

close

Description

Width of the screen in pixels. Value is returned from the screen.width property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser".

close

Description

Degree of default form fill, with the following possible values:
  • automatically - All fields filled automatically
  • automatically-but-modified - All fields filled automatically, but some fields were modified manually
  • manually - All fields were entered manually
close

Description

One must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
close

Description

The IP address of the customer client from the HTTP Headers.
close

Description

Locale of the client device/browser. Returned in the browser from the navigator.language property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

close

Description

Offset in minutes of timezone of the client versus the UTC. Value is returned by the JavaScript getTimezoneOffset() Method.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

close

Description

User-Agent of the client device/browser from the HTTP Headers.

As a fall-back we will use the userAgent that might be included in the encryptedCustomerInput, but this is captured client side using JavaScript and might be different.

close

Description

The fiscal registration number of the customer or the tax registration number of the company in case of a business customer. Please find below specifics per country:
  • Argentina - Consumer (DNI) with a length of 7 or 8 digits
  • Argentina - Company (CUIT) with a length of 11 digits
  • Brazil - Consumer (CPF) with a length of 11 digits
  • Brazil - Company (CNPJ) with a length of 14 digits
  • Chile - Consumer (RUT) with a length of 9 digits
  • Colombia - Consumer (NIT) with a length of 8, 9 or 10 digits
  • Denmark - Consumer (CPR-nummer or personnummer) with a length of 10 digits
  • Dominican Republic - Consumer (RNC) with a length of 11 digits
  • Finland - Consumer (Finnish: henkilötunnus (abbreviated as HETU)) with a length of 11 characters
  • India - Consumer (PAN) with a length of 10 characters
  • Mexico - Consumer (RFC) with a length of 13 digits
  • Mexico - Company (RFC) with a length of 12 digits
  • Norway - Consumer (fødselsnummer) with a length of 11 digits
  • Peru - Consumer (RUC) with a length of 11 digits
  • Sweden - Consumer (personnummer) with a length of 10 or 12 digits
  • Uruguay - Consumer (CI) with a length of 8 digits
  • Uruguay - Consumer (NIE) with a length of 9 digits
  • Uruguay - Company (RUT) with a length of 12 digits
close

Description

Indicates if the payer is a company or an individual
  • true = This is a company
  • false = This is an individual
close

Description

Specifies if the customer has a history of online shopping with the merchant
  • true - The customer is a known returning customer
  • false - The customer is new/unknown customer
close

Description

The locale that the customer should be addressed in (for 3rd parties). Note that some 3rd party providers only support the languageCode part of the locale, in those cases we will only use part of the locale provided.
close

Description

Your identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform.
close

Description

Object containing personal information like name, date of birth and gender.
  • SDK Object type
    PersonalInformation
close

Description

The date of birth of the customer
Format: YYYYMMDD
close

Description

The gender of the customer, possible values are:
  • male
  • female
  • unknown or empty
close

Description

Object containing identification documents information
  • SDK Object type
    PersonalIdentification
close

Description

ISO 3166-1 alpha-2 country code of the country that issued the identification document
close

Description

Indicates the type of identification
  • nationalIdentification = The provided idValue is a national identification number.
  • passportNumber = The provided idValue is a passport number.
  • driverLicense = The provided idValue is driving License of the individual.
  • companyRegistrationNumber = The provided idValue is a company identifier. It verifies its legal existence as an incorporated entity.
  • socialSecurityNumber =n The provided idValue is a social security number, issued to an individual by the individual's government.
  • alienRegistrationNumber = The provided idValue is an alien registration number, provided by immigration services of a country.
  • lawEnforcementIdentification = The provided idValue is an alien registration number, provided by immigration services of a country.
  • militaryIdentification = The provided idValue is an identification issued to military personnel of a country.
close

Description

The value of the identification
close

Description

Object containing the name details of the customer
  • SDK Object type
    PersonalName
close

Description

Given name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

Surname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

Middle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

Title of customer
close
Deprecated: Use order.shipping.address instead

Description

Object containing shipping address details
  • SDK Object type
    AddressPersonal
close
Deprecated

Description

Additional address information
close
Deprecated

Description

City
close
Deprecated

Description

ISO 3166-1 alpha-2 country code
close
Deprecated

Description

House number
close
Deprecated

Description

Object that holds the name elements
  • SDK Object type
    PersonalName
close
Deprecated

Description

Given name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close
Deprecated

Description

Surname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close
Deprecated

Description

Middle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close
Deprecated

Description

Title of customer
close
Deprecated

Description

Full name of the state or province
close
Deprecated

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close
Deprecated

Description

Streetname
close
Deprecated

Description

Zip code
close
Deprecated: Use companyInformation.vatNumber instead

Description

Local VAT number of the company
close
Deprecated: Use shoppingCart.items instead

Description

Shopping cart data
close
Deprecated
  • SDK Object type
    LineItem
close
Deprecated

Description

Object containing amount and ISO currency code attributes
Note: make sure you submit the amount and currency code for each line item
  • SDK Object type
    AmountOfMoney
close
Deprecated

Description

Amount in cents and always having 2 decimals
close
Deprecated

Description

Three-letter ISO currency code representing the currency for the amount
close
Deprecated

Description

Object containing the line items of the invoice or shopping cart. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
  • SDK Object type
    LineItemInvoiceData
close
Deprecated

Description

Shopping cart item description
close
Deprecated

Description

Line number for printed invoice or order of items in the cart
Should be a numeric string
close
Deprecated

Description

Page number for printed invoice
Should be a numeric string
close
Deprecated

Description

Quantity of the item
close
Deprecated

Description

Price per item
close
Deprecated: Use orderLineDetails instead

Description

Object containing additional information that when supplied can have a beneficial effect on the discountrates
  • SDK Object type
    LineItemLevel3InterchangeInformation
close
Deprecated

Description

Discount on the line item, with the last two digits are implied decimal places
close
Deprecated

Description

Total amount for the line item
close
Deprecated

Description

Product or UPC Code, left justified
Note: Must not be all spaces or all zeros
close
Deprecated

Description

The price of one unit of the product, the value should be zero or greater
close
Deprecated

Description

Code used to classify items that are purchased
Note: Must not be all spaces or all zeros
close
Deprecated

Description

Quantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros
close
Deprecated

Description

Tax on the line item, with the last two digits are implied decimal places
close
Deprecated

Description

Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
close
Deprecated

Description

Object containing additional information that when supplied can have a beneficial effect on the discountrates
  • SDK Object type
    OrderLineDetails
close
Deprecated

Description

Discount on the line item, with the last two digits implied as decimal places
close
Deprecated

Description

The Google product category ID for the item.
close
Deprecated

Description

Total amount for the line item
close
Deprecated

Description

The category of the product (i.e. home appliance). This property can be used for fraud screening on the Ogone Platform.
close
Deprecated

Description

Product or UPC Code, left justified
Note: Must not be all spaces or all zeros
close
Deprecated

Description

The name of the product. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close
Deprecated

Description

The price of one unit of the product, the value should be zero or greater
close
Deprecated

Description

Product SKU number
close
Deprecated

Description

Code used to classify items that are purchased
Note: Must not be all spaces or all zeros
close
Deprecated

Description

Quantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros
close
Deprecated

Description

Tax on the line item, with the last two digits implied as decimal places
close
Deprecated

Description

Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
close

Description

Object that holds all reference properties that are linked to this transaction
  • SDK Object type
    OrderReferences
close

Description

Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor. The maximum allowed length varies per card acquirer:
  • AIB - 22 characters
  • American Express - 25 characters
  • Atos Origin BNP - 15 characters
  • Barclays - 25 characters
  • Catella - 22 characters
  • CBA - 20 characters
  • Elavon - 25 characters
  • First Data - 25 characters
  • INICIS (INIPAY) - 22-30 characters
  • JCB - 25 characters
  • Merchant Solutions - 22-25 characters
  • Payvision (EU & HK) - 25 characters
  • SEB Euroline - 22 characters
  • Sub1 Argentina - 15 characters
  • Wells Fargo - 25 characters
Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers will start to truncate. We currently also only allow per API call overrides for AIB and Barclays
For alternative payment products the maximum allowed length varies per payment product:
  • 402 e-Przelewy - 30 characters
  • 404 INICIS - 80 characters
  • 802 Nordea ePayment Finland - 234 characters
  • 809 iDeal - 32 characters
  • 836 SOFORT - 42 characters
  • 840 PayPal - 127 characters
  • 841 WebMoney - 175 characters
  • 849 Yandex - 64 characters
  • 861 Alipay - 256 characters
  • 863 WeChat Pay - 32 characters
  • 880 BOKU - 20 characters
  • 8580 Qiwi - 255 characters
  • 1504 Konbini - 80 characters
All other payment products don't support a descriptor.
close

Description

Object containing additional invoice data
  • SDK Object type
    OrderInvoiceData
close

Description

Additional data for printed invoices
close

Description

Date and time on invoice
Format: YYYYMMDDHH24MISS
close

Description

Your invoice number (on printed invoice) that is also returned in our report files
close

Description

Array of 3 text qualifiers, each with a max length of 10 characters
close

Description

Your order identifier
Note: This does not need to have a unique value for each transaction. This allows your to link multiple transactions to the same logical order in your system.
close

Description

Note that the maximum length of this field for transactions processed on the GlobalCollect platform is 30.
Note that the maximum length of this field for transactions processed on the WL Online Payment Acceptance Platform platform is 50.
Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

Provides an additional means of reconciliation, this is the MerchantId used at the provider
close
Deprecated: Use merchant.seller instead

Description

Object containing seller details
  • SDK Object type
    Seller
close
Deprecated

Description

Object containing the seller address details
  • SDK Object type
    Address
close
Deprecated

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close
Deprecated

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close
Deprecated

Description

ISO 3166-1 alpha-2 country code
close
Deprecated

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close
Deprecated

Description

Full name of the state or province
close
Deprecated

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close
Deprecated

Description

Streetname
close
Deprecated

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close
Deprecated

Description

This property is specific to Visa Argentina. Channelcode according to Prisma. Please contact the acquirer to get the full list you need to use.
close
Deprecated

Description

Description of the seller
close
Deprecated

Description

Seller ID assigned by the Merchant Aggregator
close
Deprecated

Description

The sellers geocode
close
Deprecated

Description

The sellers identifier
close
Deprecated

Description

Invoice number of the payment
close
Deprecated

Description

Indicates if the retailer is considered foreign or domestic when compared to the location of the marketplace. Possible values:
  • true - The retailer is considered foreign because they are located in a different country than the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the marketplace is within the EEA and UK (and Gibraltar), but the retailer is located outside of the EEA and UK (and Gibraltar)
  • false - The retailer is considered domestic because they are located in the same country as the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the retailer is also located within the EEA and UK (and Gibraltar).
close
Deprecated

Description

Merchant category code
close
Deprecated

Description

Name of the seller
close
Deprecated

Description

Main Phone Number
close
Deprecated

Description

Seller type. Possible values:
  • passport
  • dni
  • arg-identity-card
  • civic-notebook
  • enrollment-book
  • cuil
  • cuit
  • general-register
  • election-title
  • cpf
  • cnpj
  • ssn
  • citizen-ship
  • col-identity-card
  • alien-registration
close

Description

Object containing information regarding shipping / delivery
  • SDK Object type
    Shipping
close

Description

Object containing address information
  • SDK Object type
    AddressPersonal
close

Description

Additional address information
close

Description

City
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number
close

Description

Object that holds the name elements
  • SDK Object type
    PersonalName
close

Description

Given name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

Surname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

Middle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

Title of customer
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
close

Description

Indicates shipping method chosen for the transaction. Possible values:
  • same-as-billing = the shipping address is the same as the billing address
  • another-verified-address-on-file-with-merchant = the address used for shipping is another verified address of the customer that is on file with you
  • different-than-billing = shipping address is different from the billing address
  • ship-to-store = goods are shipped to a store (shipping address = store address)
  • digital-goods = electronic delivery of digital goods
  • travel-and-event-tickets-not-shipped = travel and/or event tickets that are not shipped
  • other = other means of delivery
close

Description

Comments included during shipping
close

Description

Email address linked to the shipping
close

Description

Date (YYYYMMDD) when the shipping details for this transaction were first used.
close

Description

Indicator if this shipping address is used for the first time to ship an order

true = the shipping details are used for the first time with this transaction

false = the shipping details have been used for other transactions in the past

close

Description

Shipment tracking number
close

Description

Indicates the merchandise delivery timeframe. Possible values:
  • electronic = For electronic delivery (services or digital goods)
  • same-day = For same day deliveries
  • overnight = For overnight deliveries
  • 2-day-or-more = For two day or more delivery time for payments that are processed by the GlobalCollect platform
  • 2-day-or-more = For two day or more delivery time for payments that are processed by the Ogone platform
  • priority = For prioritized deliveries for payments that are processed by the WL Online Payment Acceptance platform
  • ground = For deliveries via ground for payments that are processed by the WL Online Payment Acceptance platform
  • to-store = For deliveries to a store for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Shopping cart data, including items and specific amounts.
  • SDK Object type
    ShoppingCart
close

Description

Determines the type of the amount.
close
  • SDK Object type
    AmountBreakdown
close

Description

Amount in cents and always having 2 decimals
close

Description

Type of the amount. Each type is only allowed to be provided once. Allowed values:
  • AIRPORT_TAX - The amount of tax paid for the airport, with the last 2 digits implied as decimal places.
  • CONSUMPTION_TAX - The amount of consumption tax paid by the customer, with the last 2 digits implied as decimal places.
  • DISCOUNT - Discount on the entire transaction, with the last 2 digits implied as decimal places.
  • DUTY - Duty on the entire transaction, with the last 2 digits implied as decimal places.
  • HANDLING - Handling cost on the entire transaction, with the last 2 digits implied as decimal places.
  • SHIPPING - Shipping cost on the entire transaction, with the last 2 digits implied as decimal places.
  • TAX - Total tax paid on the entire transaction, with the last 2 digits implied as decimal places.
  • VAT - Total amount of VAT paid on the transaction, with the last 2 digits implied as decimal places.
  • BASE_AMOUNT - Order amount excluding all taxes, discount & shipping costs, with the last 2 digits implied as decimal places. Note: BASE_AMOUNT is only supported by the GlobalCollect and Ogone Payment Platforms.
close

Description

Object containing information on purchased gift card(s)
  • SDK Object type
    GiftCardPurchase
close

Description

Object containing information on an amount of money
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Number of gift cards that are purchased through this transaction
close

Description

The customer is pre-ordering one or more items
close

Description

Shopping cart data
close
  • SDK Object type
    LineItem
close

Description

Object containing amount and ISO currency code attributes
Note: make sure you submit the amount and currency code for each line item
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Object containing the line items of the invoice or shopping cart. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
  • SDK Object type
    LineItemInvoiceData
close

Description

Shopping cart item description
close

Description

Line number for printed invoice or order of items in the cart
Should be a numeric string
close

Description

Page number for printed invoice
Should be a numeric string
close

Description

Quantity of the item
close

Description

Price per item
close
Deprecated: Use orderLineDetails instead

Description

Object containing additional information that when supplied can have a beneficial effect on the discountrates
  • SDK Object type
    LineItemLevel3InterchangeInformation
close
Deprecated

Description

Discount on the line item, with the last two digits are implied decimal places
close
Deprecated

Description

Total amount for the line item
close
Deprecated

Description

Product or UPC Code, left justified
Note: Must not be all spaces or all zeros
close
Deprecated

Description

The price of one unit of the product, the value should be zero or greater
close
Deprecated

Description

Code used to classify items that are purchased
Note: Must not be all spaces or all zeros
close
Deprecated

Description

Quantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros
close
Deprecated

Description

Tax on the line item, with the last two digits are implied decimal places
close
Deprecated

Description

Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
close

Description

Object containing additional information that when supplied can have a beneficial effect on the discountrates
  • SDK Object type
    OrderLineDetails
close

Description

Discount on the line item, with the last two digits implied as decimal places
close

Description

The Google product category ID for the item.
close

Description

Total amount for the line item
close

Description

The category of the product (i.e. home appliance). This property can be used for fraud screening on the Ogone Platform.
close

Description

Product or UPC Code, left justified
Note: Must not be all spaces or all zeros
close

Description

The name of the product. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

The price of one unit of the product, the value should be zero or greater
close

Description

Product SKU number
close

Description

Code used to classify items that are purchased
Note: Must not be all spaces or all zeros
close

Description

Quantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros
close

Description

Tax on the line item, with the last two digits implied as decimal places
close

Description

Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
close

Description

Date (YYYYMMDD) when the preordered item becomes available
close

Description

Indicates whether the cardholder is reordering previously purchased item(s)

true = the customer is re-ordering at least one of the items again

false = this is the first time the customer is ordering these items

Request example

SDK: .NET

This scenario you will probably use the most

  • Card card = new Card();
    card.CardNumber = "4567350000427977";
    card.CardholderName = "Wile E. Coyote";
    card.Cvv = "123";
    card.ExpiryDate = "1299";
    
    AmountOfMoney authenticationAmount = new AmountOfMoney();
    authenticationAmount.Amount = 2980L;
    authenticationAmount.CurrencyCode = "EUR";
    
    RedirectionData redirectionData = new RedirectionData();
    redirectionData.ReturnUrl = "https://hostname.myownwebsite.url";
    
    ThreeDSecure threeDSecure = new ThreeDSecure();
    threeDSecure.AuthenticationAmount = authenticationAmount;
    threeDSecure.AuthenticationFlow = "browser";
    threeDSecure.ChallengeCanvasSize = "600x400";
    threeDSecure.ChallengeIndicator = "challenge-requested";
    threeDSecure.ExemptionRequest = "none";
    threeDSecure.RedirectionData = redirectionData;
    threeDSecure.SkipAuthentication = false;
    
    CardPaymentMethodSpecificInput cardPaymentMethodSpecificInput = new CardPaymentMethodSpecificInput();
    cardPaymentMethodSpecificInput.Card = card;
    cardPaymentMethodSpecificInput.IsRecurring = false;
    cardPaymentMethodSpecificInput.MerchantInitiatedReasonIndicator = "delayedCharges";
    cardPaymentMethodSpecificInput.PaymentProductId = 1;
    cardPaymentMethodSpecificInput.ThreeDSecure = threeDSecure;
    cardPaymentMethodSpecificInput.TransactionChannel = "ECOMMERCE";
    
    AmountOfMoney amountOfMoney = new AmountOfMoney();
    amountOfMoney.Amount = 2980L;
    amountOfMoney.CurrencyCode = "EUR";
    
    Address billingAddress = new Address();
    billingAddress.AdditionalInfo = "b";
    billingAddress.City = "Monument Valley";
    billingAddress.CountryCode = "US";
    billingAddress.HouseNumber = "13";
    billingAddress.State = "Utah";
    billingAddress.Street = "Desertroad";
    billingAddress.Zip = "84536";
    
    CompanyInformation companyInformation = new CompanyInformation();
    companyInformation.Name = "Acme Labs";
    companyInformation.VatNumber = "1234AB5678CD";
    
    ContactDetails contactDetails = new ContactDetails();
    contactDetails.EmailAddress = "wile.e.coyote@acmelabs.com";
    contactDetails.FaxNumber = "+1234567891";
    contactDetails.PhoneNumber = "+1234567890";
    
    BrowserData browserData = new BrowserData();
    browserData.ColorDepth = 24;
    browserData.JavaEnabled = false;
    browserData.ScreenHeight = "1200";
    browserData.ScreenWidth = "1920";
    
    CustomerDevice device = new CustomerDevice();
    device.AcceptHeader = "texthtml,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8";
    device.BrowserData = browserData;
    device.IpAddress = "123.123.123.123";
    device.Locale = "en-US";
    device.TimezoneOffsetUtcMinutes = "420";
    device.UserAgent = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1 Safari/605.1.15";
    
    PersonalName name = new PersonalName();
    name.FirstName = "Wile";
    name.Surname = "Coyote";
    name.SurnamePrefix = "E.";
    name.Title = "Mr.";
    
    PersonalInformation personalInformation = new PersonalInformation();
    personalInformation.DateOfBirth = "19490917";
    personalInformation.Gender = "male";
    personalInformation.Name = name;
    
    Customer customer = new Customer();
    customer.AccountType = "none";
    customer.BillingAddress = billingAddress;
    customer.CompanyInformation = companyInformation;
    customer.ContactDetails = contactDetails;
    customer.Device = device;
    customer.Locale = "en_US";
    customer.MerchantCustomerId = "1234";
    customer.PersonalInformation = personalInformation;
    
    OrderInvoiceData invoiceData = new OrderInvoiceData();
    invoiceData.InvoiceDate = "20140306191500";
    invoiceData.InvoiceNumber = "000000123";
    
    OrderReferences references = new OrderReferences();
    references.Descriptor = "Fast and Furry-ous";
    references.InvoiceData = invoiceData;
    references.MerchantOrderId = 123456L;
    references.MerchantReference = "AcmeOrder0001";
    
    PersonalName shippingName = new PersonalName();
    shippingName.FirstName = "Road";
    shippingName.Surname = "Runner";
    shippingName.Title = "Miss";
    
    AddressPersonal address = new AddressPersonal();
    address.AdditionalInfo = "Suite II";
    address.City = "Monument Valley";
    address.CountryCode = "US";
    address.HouseNumber = "1";
    address.Name = shippingName;
    address.State = "Utah";
    address.Street = "Desertroad";
    address.Zip = "84536";
    
    Shipping shipping = new Shipping();
    shipping.Address = address;
    
    IList<LineItem> items = new List<LineItem>();
    
    AmountOfMoney item1AmountOfMoney = new AmountOfMoney();
    item1AmountOfMoney.Amount = 2500L;
    item1AmountOfMoney.CurrencyCode = "EUR";
    
    LineItemInvoiceData item1InvoiceData = new LineItemInvoiceData();
    item1InvoiceData.Description = "ACME Super Outfit";
    item1InvoiceData.NrOfItems = "1";
    item1InvoiceData.PricePerItem = 2500L;
    
    LineItem item1 = new LineItem();
    item1.AmountOfMoney = item1AmountOfMoney;
    item1.InvoiceData = item1InvoiceData;
    
    items.Add(item1);
    
    AmountOfMoney item2AmountOfMoney = new AmountOfMoney();
    item2AmountOfMoney.Amount = 480L;
    item2AmountOfMoney.CurrencyCode = "EUR";
    
    LineItemInvoiceData item2InvoiceData = new LineItemInvoiceData();
    item2InvoiceData.Description = "Aspirin";
    item2InvoiceData.NrOfItems = "12";
    item2InvoiceData.PricePerItem = 40L;
    
    LineItem item2 = new LineItem();
    item2.AmountOfMoney = item2AmountOfMoney;
    item2.InvoiceData = item2InvoiceData;
    
    items.Add(item2);
    
    ShoppingCart shoppingCart = new ShoppingCart();
    shoppingCart.Items = items;
    
    Order order = new Order();
    order.AmountOfMoney = amountOfMoney;
    order.Customer = customer;
    order.References = references;
    order.Shipping = shipping;
    order.ShoppingCart = shoppingCart;
    
    CreatePaymentRequest body = new CreatePaymentRequest();
    body.CardPaymentMethodSpecificInput = cardPaymentMethodSpecificInput;
    body.Order = order;
    
    try
    {
        CreatePaymentResponse response = await client.Merchant("merchantId").Payments().Create(body);
    }
    catch (DeclinedPaymentException e)
    {
        HandleDeclinedPayment(e.CreatePaymentResult);
    }
    catch (ApiException e)
    {
        HandleApiErrors(e.Errors);
    }
    
  • Card card = new Card();
    card.CardNumber = "****************";
    card.Cvv = "***";
    card.ExpiryDate = "****";
    
    ThreeDSecure threeDSecure = new ThreeDSecure();
    threeDSecure.SkipAuthentication = false;
    
    CardPaymentMethodSpecificInput cardPaymentMethodSpecificInput = new CardPaymentMethodSpecificInput();
    cardPaymentMethodSpecificInput.Card = card;
    cardPaymentMethodSpecificInput.PaymentProductId = 1;
    cardPaymentMethodSpecificInput.ThreeDSecure = threeDSecure;
    
    AmountOfMoney amountOfMoney = new AmountOfMoney();
    amountOfMoney.Amount = 4005L;
    amountOfMoney.CurrencyCode = "USD";
    
    Address billingAddress = new Address();
    billingAddress.CountryCode = "US";
    
    Customer customer = new Customer();
    customer.BillingAddress = billingAddress;
    customer.MerchantCustomerId = "1234";
    
    Order order = new Order();
    order.AmountOfMoney = amountOfMoney;
    order.Customer = customer;
    
    CreatePaymentRequest body = new CreatePaymentRequest();
    body.CardPaymentMethodSpecificInput = cardPaymentMethodSpecificInput;
    body.Order = order;
    
    try
    {
        CreatePaymentResponse response = await client.Merchant("merchantId").Payments().Create(body);
    }
    catch (DeclinedPaymentException e)
    {
        HandleDeclinedPayment(e.CreatePaymentResult);
    }
    catch (ApiException e)
    {
        HandleApiErrors(e.Errors);
    }
    
  • AmountOfMoney amountOfMoney = new AmountOfMoney();
    amountOfMoney.Amount = 4005L;
    amountOfMoney.CurrencyCode = "EUR";
    
    Address billingAddress = new Address();
    billingAddress.CountryCode = "US";
    
    Customer customer = new Customer();
    customer.BillingAddress = billingAddress;
    customer.MerchantCustomerId = "1234";
    
    Order order = new Order();
    order.AmountOfMoney = amountOfMoney;
    order.Customer = customer;
    
    RedirectionData redirectionData = new RedirectionData();
    redirectionData.ReturnUrl = "https://www.google.com";
    
    RedirectPaymentMethodSpecificInput redirectPaymentMethodSpecificInput = new RedirectPaymentMethodSpecificInput();
    redirectPaymentMethodSpecificInput.PaymentProductId = 840;
    redirectPaymentMethodSpecificInput.RedirectionData = redirectionData;
    
    CreatePaymentRequest body = new CreatePaymentRequest();
    body.Order = order;
    body.RedirectPaymentMethodSpecificInput = redirectPaymentMethodSpecificInput;
    
    try
    {
        CreatePaymentResponse response = await client.Merchant("merchantId").Payments().Create(body);
    }
    catch (DeclinedPaymentException e)
    {
        HandleDeclinedPayment(e.CreatePaymentResult);
    }
    catch (ApiException e)
    {
        HandleApiErrors(e.Errors);
    }
    
  • Card card = new Card();
    card.CardNumber = "****************";
    card.CardholderName = "Wile E. Coyote";
    card.Cvv = "***";
    card.ExpiryDate = "****";
    
    ThreeDSecure threeDSecure = new ThreeDSecure();
    threeDSecure.SkipAuthentication = false;
    
    CardPaymentMethodSpecificInput cardPaymentMethodSpecificInput = new CardPaymentMethodSpecificInput();
    cardPaymentMethodSpecificInput.Card = card;
    cardPaymentMethodSpecificInput.PaymentProductId = 1;
    cardPaymentMethodSpecificInput.ThreeDSecure = threeDSecure;
    
    AmountOfMoney amountOfMoney = new AmountOfMoney();
    amountOfMoney.Amount = 4005L;
    amountOfMoney.CurrencyCode = "USD";
    
    Address billingAddress = new Address();
    billingAddress.AdditionalInfo = "b";
    billingAddress.City = "Monument Valley";
    billingAddress.CountryCode = "US";
    billingAddress.HouseNumber = "13";
    billingAddress.State = "Utah";
    billingAddress.Street = "Desertroad";
    billingAddress.Zip = "84536";
    
    CompanyInformation companyInformation = new CompanyInformation();
    companyInformation.Name = "Acme Labs";
    companyInformation.VatNumber = "1234AB5678CD";
    
    ContactDetails contactDetails = new ContactDetails();
    contactDetails.EmailAddress = "wile.e.coyote@acmelabs.com";
    contactDetails.EmailMessageType = "html";
    contactDetails.FaxNumber = "+1234567891";
    contactDetails.PhoneNumber = "+1234567890";
    
    PersonalName name = new PersonalName();
    name.FirstName = "Wile";
    name.Surname = "Coyote";
    name.SurnamePrefix = "E.";
    name.Title = "Mr.";
    
    PersonalInformation personalInformation = new PersonalInformation();
    personalInformation.DateOfBirth = "19490917";
    personalInformation.Gender = "male";
    personalInformation.Name = name;
    
    Customer customer = new Customer();
    customer.BillingAddress = billingAddress;
    customer.CompanyInformation = companyInformation;
    customer.ContactDetails = contactDetails;
    customer.Locale = "en";
    customer.MerchantCustomerId = "YOUR_CUST_ID";
    customer.PersonalInformation = personalInformation;
    
    OrderInvoiceData invoiceData = new OrderInvoiceData();
    invoiceData.InvoiceDate = "20140306191500";
    invoiceData.InvoiceNumber = "000000123";
    
    OrderReferences references = new OrderReferences();
    references.Descriptor = "Fast and Furry-ous";
    references.InvoiceData = invoiceData;
    references.MerchantOrderId = 123456L;
    references.MerchantReference = "AcmeOrder0001";
    
    PersonalName shippingName = new PersonalName();
    shippingName.FirstName = "Road";
    shippingName.Surname = "Runner";
    shippingName.Title = "Miss";
    
    AddressPersonal address = new AddressPersonal();
    address.AdditionalInfo = "Suite II";
    address.City = "Monument Valley";
    address.CountryCode = "US";
    address.HouseNumber = "1";
    address.Name = shippingName;
    address.State = "Utah";
    address.Street = "Desertroad";
    address.Zip = "84536";
    
    Shipping shipping = new Shipping();
    shipping.Address = address;
    
    IList<LineItem> items = new List<LineItem>();
    
    AmountOfMoney item1AmountOfMoney = new AmountOfMoney();
    item1AmountOfMoney.Amount = 2005L;
    item1AmountOfMoney.CurrencyCode = "USD";
    
    LineItemInvoiceData item1InvoiceData = new LineItemInvoiceData();
    item1InvoiceData.Description = "ACME Super Outfit";
    item1InvoiceData.NrOfItems = "1";
    item1InvoiceData.PricePerItem = 2005L;
    
    LineItem item1 = new LineItem();
    item1.AmountOfMoney = item1AmountOfMoney;
    item1.InvoiceData = item1InvoiceData;
    
    items.Add(item1);
    
    AmountOfMoney item2AmountOfMoney = new AmountOfMoney();
    item2AmountOfMoney.Amount = 20L;
    item2AmountOfMoney.CurrencyCode = "USD";
    
    LineItemInvoiceData item2InvoiceData = new LineItemInvoiceData();
    item2InvoiceData.Description = "Asperin";
    item2InvoiceData.NrOfItems = "10";
    item2InvoiceData.PricePerItem = 20L;
    
    LineItem item2 = new LineItem();
    item2.AmountOfMoney = item2AmountOfMoney;
    item2.InvoiceData = item2InvoiceData;
    
    items.Add(item2);
    
    ShoppingCart shoppingCart = new ShoppingCart();
    shoppingCart.Items = items;
    
    Order order = new Order();
    order.AmountOfMoney = amountOfMoney;
    order.Customer = customer;
    order.References = references;
    order.Shipping = shipping;
    order.ShoppingCart = shoppingCart;
    
    CreatePaymentRequest body = new CreatePaymentRequest();
    body.CardPaymentMethodSpecificInput = cardPaymentMethodSpecificInput;
    body.Order = order;
    
    try
    {
        CreatePaymentResponse response = await client.Merchant("merchantId").Payments().Create(body);
    }
    catch (DeclinedPaymentException e)
    {
        HandleDeclinedPayment(e.CreatePaymentResult);
    }
    catch (ApiException e)
    {
        HandleApiErrors(e.Errors);
    }
    

Responses

Please find below an overview of the possible responses.

Response 201 - CreatedCreatePaymentResponse

The payment request was successfully processed and a payment object was created.

In the HTTP header the location is provided of the created hostedCheckout object so you can easily query its status, by simply performing a GET on the URI provided in this header.

Properties
Property Type Required Details
close

Description

Object containing the details of the created payment
  • SDK Object type
    PaymentCreationOutput
close

Description

The additional reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
close

Description

The external reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
close

Description

Indicates whether the customer ticked the "Remember my details for future purchases" checkbox on the MyCheckout hosted payment pages
close

Description

Indicates if a new token was created
  • true - A new token was created
  • false - A token with the same card number already exists and is returned. Please note that the existing token has not been updated. When you want to update other data then the card number, you need to update data stored in the token explicitly, as data is never updated during the creation of a token.
close

Description

ID of the token
close

Description

Indicates if tokenization was successful or not. If this value is false, then the token and isNewToken properties will not be set.
close

Description

Object that contains the action, including the needed data, that you should perform next, like showing instructions, showing the transaction results or redirect to a third party to complete the payment
  • SDK Object type
    MerchantAction
close

Description

Action merchants needs to take in the online payment process. Possible values are:
  • REDIRECT - The customer needs to be redirected using the details found in redirectData
  • SHOW_FORM - The customer needs to be shown a form with the fields found in formFields. You can submit the data entered by the user in a Complete payment request. Additionally:
    • for payment product 3012 (Bancontact), to support payments via the Bancontact app, showData contains a QR code and URL intent.
    • for payment product 863 (WeChat Pay), to support payments via the WeChat app, showData contains a QR code, URL intent, or signature and nonce combination. The showData property describes when each of these values can be returned.
      Note that WeChat Pay does not support completing payments.
  • SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData
  • SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData
  • MOBILE_THREEDS_CHALLENGE - The customer needs to complete a challenge as part of the 3D Secure authentication inside your mobile app. The details contained in mobileThreeDSecureChallengeParameters need to be provided to the EMVco certified Mobile SDK as a challengeParameters object.
  • CALL_THIRD_PARTY - The merchant needs to call a third party using the data found in thirdPartyData
close

Description

Populated only when the actionType of the merchantAction is SHOW_FORM. In this case, this property contains the list of fields to render, in the format that is also used in the response of Get payment product.
close
  • SDK Object type
    PaymentProductField
close

Description

Object containing data restrictions that apply to this field, like minimum and/or maximum length
  • SDK Object type
    PaymentProductFieldDataRestrictions
close

Description

  • true - Indicates that this field is required
  • false - Indicates that this field is optional
close

Description

Object containing the details of the validations on the field
  • SDK Object type
    PaymentProductFieldValidators
close

Description

Indicates the requiredness of the field based on the fiscalnumber for Boleto Bancario
  • SDK Object type
    BoletoBancarioRequirednessValidator
close

Description

When performing a payment with Boleto Bancario, some values are only required when the fiscalnumber has a specific length. The length the fiscalnumber has to have to make the field required is defined here. For example the CompanyName is required when the fiscalnumber is a CNPJ. The firstname and surname are required when the fiscalnumber is a CPF.
close

Description

Indicates that the content should be validated against the rules for an email address
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content should be validated against the rules for an expiration date (it should be in the future)
  • SDK Object type
    EmptyValidator
close

Description

Indicates that content should be one of the, in this object, listed items
  • SDK Object type
    FixedListValidator
close

Description

List of the allowed values that the field will be validated against
close

Description

Indicates that the content of this (iban) field needs to validated against format checks and modulo check (as described in ISO 7064)
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content needs to be validated against length criteria defined in this object
  • SDK Object type
    LengthValidator
close

Description

The maximum allowed length
close

Description

The minimum allowed length
close

Description

Indicates that the content needs to be validated using a LUHN check
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content needs to be validated against a, in this object, defined range
  • SDK Object type
    RangeValidator
close

Description

Upper value of the range that is still valid
close

Description

Lower value of the range that is still valid
close

Description

A string representing the regular expression to check
  • SDK Object type
    RegularExpressionValidator
close

Description

Contains the regular expression that the value of the field needs to be validated against
close

Description

Indicates that the content needs to be validated as per the Chinese resident identity number format
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content should be validated as such that the customer has accepted the field as if they were terms and conditions of a service
  • SDK Object type
    EmptyValidator
close

Description

Object containing display hints for this field, like the order, mask, preferred keyboard
  • SDK Object type
    PaymentProductFieldDisplayHints
close

Description

  • true - Indicates that this field is advised to be captured to increase the success rates even though it isn't marked as required. Please note that making the field required could hurt the success rates negatively. This boolean only indicates our advise to always show this field to the customer.
  • false - Indicates that this field is not to be shown unless it is a required field.
close

Description

The order in which the fields should be shown (ascending)
close

Description

Object detailing the type of form element that should be used to present the field
  • SDK Object type
    PaymentProductFieldFormElement
close

Description

Type of form element to be used. The following types can be returned:
  • text - A normal text input field
  • list - A list of values that the customer needs to choose from, is detailed in the valueMapping array
  • currency - Currency fields should be split into two fields, with the second one being specifically for the cents
  • boolean - Boolean fields should offer the customer a choice, like accepting the terms and conditions of a product.
  • date - let the customer pick a date.
close

Description

An array of values and displayNames that should be used to populate the list object in the GUI
close
  • SDK Object type
    ValueMappingElement
close

Description

List of extra data of the value.
close
  • SDK Object type
    PaymentProductFieldDisplayElement
close

Description

The ID of the display element.
close

Description

The label of the display element.
close

Description

The type of the display element. Indicates how the value should be presented. Possible values are:
  • STRING - as plain text
  • CURRENCY - as an amount in cents displayed with a decimal separator and the currency of the payment
  • PERCENTAGE - as a number with a percentage sign
  • INTEGER - as an integer
  • URI - as a link
close

Description

the value of the display element.
close
Deprecated: Use displayElements instead with ID 'displayName'

Description

Key name
close

Description

Value corresponding to the key
close

Description

Label/Name of the field to be used in the user interface
close

Description

Link that should be used to replace the '{link}' variable in the label.
close

Description

A mask that can be used in the input field. You can use it to inject additional characters to provide a better user experience and to restrict the accepted character set (illegal characters to be ignored during typing).
* is used for wildcards (and also chars)
9 is used for numbers
Everything outside {{ and }} is used as-is.
close

Description

  • true - The data in this field should be obfuscated as it is entered, just like a password field
  • false - The data in this field does not need to be obfuscated
close

Description

A placeholder value for the form element
close

Description

The type of keyboard that can best be used to fill out the value of this field. Possible values are:
  • PhoneNumberKeyboard - Keyboard that is normally used to enter phone numbers
  • StringKeyboard - Keyboard that is used to enter strings
  • IntegerKeyboard - Keyboard that is used to enter only numerical values
  • EmailAddressKeyboard - Keyboard that allows easier entry of email addresses
close

Description

Object that contains an optional tooltip to assist the customer
  • SDK Object type
    PaymentProductFieldTooltip
close

Description

Relative URL that can be used to retrieve an image for the tooltip image. You can use our server-side resize functionality by appending '?size={{width}}x{{height}}' to the full URL, where width and height are specified in pixels. The resized image will always keep its correct aspect ratio.
close

Description

A text explaining the field in more detail. This is meant to be used for displaying to the customer.
close

Description

The ID of the field
close

Description

The type of field, possible values are:
  • string - Any UTF-8 chracters
  • numericstring - A string that consisting only of numbers. Note that you should strip out anything that is not a digit, but leading zeros are allowed
  • date - Date in the format DDMMYYYY
  • expirydate - Expiration date in the format MMYY
  • integer - An integer
  • boolean - A boolean
close

Description

Indicates that the product can be used in a get customer details call and that when that call is done the field should be supplied as (one of the) key(s) with a valid value.
close

Description

Populated only when the actionType of the merchantAction is MOBILE_THREEDS_CHALLENGE. In this case, this object contains the list of properties to provide to the EMVco certified Mobile SDK as a challengeParameters object.
  • SDK Object type
    MobileThreeDSecureChallengeParameters
close

Description

The unique identifier assigned by the EMVCo Secretariat upon testing and approval.
close

Description

Contains the JWS object created by the ACS for the challenge (ARes).
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer).
close

Description

The 3-D Secure version 2 transaction ID that is used for the 3D Authentication
close

Description

Object containing all data needed to redirect the customer
  • SDK Object type
    RedirectData
close

Description

A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment
close

Description

The URL that the customer should be redirected to. Be sure to redirect using the GET method.
close

Description

This property contains the blob with data for the instructions rendering service.

This service will be available at the following endpoint: http(s)://{{merchant specific subdomain}}.{{base MyCheckout hosted payment pages domain}}/instructions/{{merchantId}}/{{clientSessionId}}

This instructions page rendering service accepts the following parameters:

  • instructionsRenderingData (required, the content of this property)
  • locale (optional, if present overrides default locale, e.g. "en_GB")
  • variant (optional, code of a variant, if present overrides default variant, e.g. "100")
  • customerId (required for Pix, otherwise optional, the customerId from a client session)
You can offer a link to a customer to see an instructions page for a payment done earlier. Because of the size of the instructionsRenderingData this will need to be set in a web form as a value of a hidden field. Before presenting the link you need to obtain a clientSessionId by creating a session using the S2S API. You will need to use the MyCheckout hosted payment pages domain hosted in the same region as the API domain used for the createClientSession call.

The instructionsRenderingData is a String blob that is presented to you via the Server API as part of the merchantAction (if available, and non-redirect) in the JSON return values for the createPayment call or the getHostedCheckoutStatus call (merchantAction inside createdPaymentOutput when available). You are responsible to store the instructionsRenderingData blob in order to be able to present the instructions page at a later time, when this information might no longer be available through Server API calls.

close

Description

This is returned for the SHOW_INSTRUCTION, the SHOW_TRANSACTION_RESULTS and the SHOW_FORM actionType.
When returned for SHOW_TRANSACTION_RESULTS or SHOW_FORM, this contains an array of key value pairs of data that needs to be shown to the customer.
Note: The returned value for the key BARCODE is a base64 encoded gif image. By prepending 'data:image/gif;base64,' this value can be used as the source of an HTML inline image.

For SHOW_FORM, for payment product 3012 (Bancontact), this contains a QR code and a URL intent that can be used to complete the payment in the Bancontact app.
In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by an Android device with the Bancontact app). The key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on an Android device.

For SHOW_FORM, for payment product 863 (WeChat Pay), this contains the PaymentId that WeChat has assigned to the payment. In this case, the key WECHAT_PAYMENTID contains this PaymentId. In addition, this can contain different values depending on the integration type:
  • desktopQRCode - contains a QR code that can be used to complete the payment in the WeChat app. In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by a mobile device with the WeChat app).
  • urlIntent - contains a URL intent that can be used to complete the payment in the WeChat app. In this case, the key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on a mobile device.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
close

Description

This is returned for the CALL_THIRD_PARTY actionType.
The payment product specific field of the payment product used for the payment will be populated with the third party data that should be used when calling the third party.
  • SDK Object type
    ThirdPartyData
close

Description

Contains the third party data for payment product 863 (WeChat Pay).
  • SDK Object type
    PaymentProduct863ThirdPartyData
close

Description

The appId to use in third party calls to WeChat.
close

Description

The nonceStr to use in third party calls to WeChat
close

Description

The packageSign to use in third party calls to WeChat
close

Description

The paySign to use in third party calls to WeChat
close

Description

The prepayId to use in third party calls to WeChat.
close

Description

The signType to use in third party calls to WeChat
close

Description

The timeStamp to use in third party calls to WeChat
close

Description

Object that holds the payment related properties
  • SDK Object type
    Payment
close

Description

Hosted Checkout specific information. Populated if the payment was created on the GlobalCollect platform through a Hosted Checkout.
  • SDK Object type
    HostedCheckoutSpecificOutput
close

Description

The ID of the Hosted Checkout Session in which the payment was made.
close

Description

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your hosted mandate pages in a controlled manner. Please note that you need to specify the ID of the variant.
close

Description

Our unique payment transaction identifier.
close

Description

Object containing payment details
  • SDK Object type
    PaymentOutput
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Amount that has been paid
close

Description

Amount that has been reversed
close

Description

Object containing the bank transfer payment method details
  • SDK Object type
    BankTransferPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the card payment method details
  • SDK Object type
    CardPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
close

Description

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available
close

Description

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available
close

Description

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.
close

Description

Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
  • SDK Object type
    FraugsterResults
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
close

Description

The unique scheme transactionId of the initial transaction that was performed with SCA.
Should be stored by the merchant to allow it to be submitted in future transactions.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

The unique scheme transactionId of this transaction.
Should be stored by the merchant to allow it to be submitted in future transactions. Use this value in case the initialSchemeTransactionId property is empty.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
close

Description

Method of authentication used for this transaction. Possible values:
  • frictionless = The authentication went without a challenge
  • challenged = Cardholder was challenged
  • avs-verified = The authentication was verified by AVS
  • other = Another issuer method was used to authenticate this transaction
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
close

Description

If a token was used for or created during the payment, then the ID of that token.
close

Description

Object containing the cash payment method details
  • SDK Object type
    CashPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the non SEPA direct debit payment method details
  • SDK Object type
    NonSepaDirectDebitPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the e-invoice payment method details
  • SDK Object type
    EInvoicePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

AfterPay Installments (payment product 9000) specific details
  • SDK Object type
    EInvoicePaymentProduct9000SpecificOutput
close

Description

The ID of the installment plan used for the payment.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the invoice payment method details
  • SDK Object type
    InvoicePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the mobile payment method details
  • SDK Object type
    MobilePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
close

Description

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available
close

Description

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available
close

Description

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.
close

Description

Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
  • SDK Object type
    FraugsterResults
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
close

Description

The network that was used for the refund
close

Description

Object containing payment details
  • SDK Object type
    MobilePaymentData
close

Description

The obfuscated DPAN. Only the last four digits are visible.
close

Description

Expiry date of the tokenized card
Format: MMYY
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
close

Description

Method of authentication used for this transaction. Possible values:
  • frictionless = The authentication went without a challenge
  • challenged = Cardholder was challenged
  • avs-verified = The authentication was verified by AVS
  • other = Another issuer method was used to authenticate this transaction
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
close

Description

Object containing the redirect payment product details
  • SDK Object type
    RedirectPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object that holds the Basic Bank Account Number (BBAN) data
  • SDK Object type
    BankAccountBban
close

Description

Name of the account holder
close

Description

Bank account number
close

Description

Bank code
close

Description

Name of the bank
close

Description

Branch code
close

Description

Bank check digit
close

Description

ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
close

Description

Object containing account holder name and IBAN information
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
close

Description

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
close

Description

The BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank or even branch. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

PostFinance Card (payment product 3201) specific details
  • SDK Object type
    PaymentProduct3201SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Trustly (payment product 806) specific details
  • SDK Object type
    PaymentProduct806SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the account details
  • SDK Object type
    TrustlyBankAccount
close

Description

The last digits of the account number
close

Description

The name of the bank
close

Description

The country of the clearing house
close

Description

The ID number of the account holder
close

Description

Sofort (payment product 836) specific details
  • SDK Object type
    PaymentProduct836SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Indicates if SofortBank could estabilish if the transaction could successfully be processed.
  • 0 - You should wait for the transaction to be reported as paid before shipping any goods.
  • 1 - You can ship the goods. In case the transaction is not reported as paid you can initiate a claims process with SofortBank.
close

Description

PayPal (payment product 840) specific details
  • SDK Object type
    PaymentProduct840SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the details of the PayPal account
  • SDK Object type
    PaymentProduct840CustomerAccount
close

Description

Username with which the PayPal account holder has registered at PayPal
close

Description

Identification of the PayPal recurring billing agreement
close

Description

Name of the company in case the PayPal account is owned by a business
close

Description

The phone number of the PayPal account holder
close

Description

Country where the PayPal account is located
close

Description

Status of the PayPal account.
Possible values are:
  • verified - PayPal has verified the funding means for this account
  • unverified - PayPal has not verified the funding means for this account
close

Description

Status of the customer's shipping address as registered by PayPal
Possible values are:
  • none - Status is unknown at PayPal
  • confirmed - The address has been confirmed
  • unconfirmed - The address has not been confirmed
close

Description

First name of the PayPal account holder
close

Description

The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
close

Description

Surname of the PayPal account holder
close

Description

Object containing the address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Protection Eligibility data of the PayPal customer
  • SDK Object type
    ProtectionEligibility
close

Description

Possible values:
  • Eligible
  • PartiallyEligible
  • Ineligible
close

Description

Possible values:
  • ItemNotReceivedEligible
  • UnauthorizedPaymentEligible
  • Ineligible
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

ID of the token. This property is populated when the payment was done with a token or when the payment was tokenized.
close

Description

Object containing the SEPA direct debit details
  • SDK Object type
    SepaDirectDebitPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Output that is SEPA Direct Debit specific (i.e. the used mandate)
  • SDK Object type
    PaymentProduct771SpecificOutput
close

Description

Unique reference to a Mandate
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

ID of the token. This property is populated for the GlobalCollect payment platform when the payment was done with a token or when the payment was tokenized.
close

Description

Payment method identifier used by the our payment engine with the following possible values:
  • bankRefund
  • bankTransfer
  • card
  • cash
  • directDebit
  • eInvoice
  • invoice
  • redirect
close

Description

Object that holds all reference properties that are linked to this transaction
  • SDK Object type
    PaymentReferences
close

Description

Your order ID for this transaction that is also returned in our report files
close

Description

Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
close

Description

Payment Reference generated by WebCollect
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

Provides an additional means of reconciliation, this is the MerchantId used at the provider
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

When you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
close

Description

The reason description given for the reversedAmount property.
close

Description

Current high-level status of the payment in a human-readable form. Possible values are :
  • ACCOUNT_VERIFIED - The account has been verified using a validation services like 0$ auth
  • CREATED - The transaction has been created. This is the initial state once a new payment is created.
  • REDIRECTED - The customer has been redirected to a 3rd party to complete the authentication/payment
  • PENDING_PAYMENT - Instructions have been provided and we are now waiting for the money to come in
  • PENDING_FRAUD_APPROVAL - The transaction has been marked for manual review after an automatic fraud screening
  • PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the capturing of the funds
  • PENDING_COMPLETION - The transaction needs to be completed.
  • PENDING_CAPTURE - The transaction is waiting for you to request one or more captures of the funds.
  • REJECTED - The transaction has been rejected
  • AUTHORIZATION_REQUESTED - we have requested an authorization against an asynchronous system and is awaiting its response
  • CAPTURE_REQUESTED - The transaction is in the queue to be captured
  • CAPTURED - The transaction has been captured and we have received online confirmation
  • PAID - We have matched the incoming funds to the transaction
  • CANCELLED - You have cancelled the transaction
  • REJECTED_CAPTURE - We or one of our downstream acquirers/providers have rejected the capture request
  • REVERSED - The transaction has been reversed
  • CHARGEBACK_NOTIFICATION - We have received a notification of chargeback and this status informs you that your account will be debited for a particular transaction
  • CHARGEBACKED - The transaction has been chargebacked
  • REFUNDED - The transaction has been refunded

Please see Statuses for a full overview of possible values.
close

Description

This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource. In case of failed payments and negative scenarios, detailed error information is listed.
  • SDK Object type
    PaymentStatusOutput
close

Description

Custom object contains the set of errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Indicates if the transaction has been authorized
  • true
  • false
close

Description

Flag indicating if the payment can be cancelled
  • true
  • false
close

Description

Flag indicating if the payment can be refunded
  • true
  • false
close

Description

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee
  • true
  • false
close

Description

This is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
close

Description

Highlevel status of the payment, payout or refund with the following possible values:
  • CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses:
    • CREATED
  • PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses:
    • PENDING_PAYMENT
    • REDIRECTED
  • ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses:
    • ACCOUNT_VERIFIED
  • PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses:
    • PENDING_APPROVAL
    • PENDING_COMPLETION
    • PENDING_CAPTURE
    • PENDING_FRAUD_APPROVAL
  • PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses:
    • AUTHORIZATION_REQUESTED
    • CAPTURE_REQUESTED
    • PAYOUT_REQUESTED
    • REFUND_REQUESTED
  • COMPLETED: The transaction has completed. This category groups the following statuses:
    • CAPTURED
    • PAID
    • ACCOUNT_CREDITED
    • CHARGEBACK_NOTIFICATION
  • REVERSED: The transaction has been reversed. This category groups the following statuses:
    • CHARGEBACKED
    • REVERSED
  • REFUNDED: The transaction has been refunded. This category groups the following statuses:
    • REFUNDED
  • UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
    • CANCELLED
    • REJECTED
    • REJECTED_CAPTURE
    • REJECTED_CREDIT

Please see Statuses for a full overview of possible values.
close

Description

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
close

Description

Date and time of payment
Format: YYYYMMDDHH24MISS
close

Description

The 3D Secure status, with the following possible values:
  • ENROLLED: the card is enrolled for 3D Secure authentication. The customer can be redirected to a 3D Secure access control server (ACS)
  • NOT_ENROLLED: the card is not enrolled for 3D Secure authentication
  • INVALID_PARES_OR_NOT_COMPLETED: the PARes is invalid, or the customer did not complete the 3D Secure authentication
  • AUTHENTICATED: the customer has passed the 3D Secure authentication
  • NOT_AUTHENTICATED: the customer failed the 3D Secure authentication
  • NOT_PARTICIPATING: the cardholder has not set up their card for 2-step 3D Secure.
Note that this status will only be set for payments that make use of 2-step 3D Secure.

Response example

SDK: .NET

This scenario you will probably use the most

  • {
        "creationOutput" : {
            "additionalReference" : "AcmeOrder0001",
            "externalReference" : "AcmeOrder0001"
        },
        "payment" : {
            "id" : "000000850010000188130000200001",
            "paymentOutput" : {
                "amountOfMoney" : {
                    "amount" : 2980,
                    "currencyCode" : "EUR"
                },
                "references" : {
                    "merchantReference" : "AcmeOrder0001",
                    "paymentReference" : "0"
                },
                "paymentMethod" : "card",
                "cardPaymentMethodSpecificOutput" : {
                    "paymentProductId" : 1,
                    "authorisationCode" : "726747",
                    "card" : {
                        "cardNumber" : "************7977",
                        "expiryDate" : "1299"
                    },
                    "fraudResults" : {
                        "avsResult" : "0",
                        "cvvResult" : "0",
                        "fraudServiceResult" : "no-advice"
                    },
                    "threeDSecureResults" : {
                        "authenticationAmount" : {
                            "currencyCode" : "EUR",
                            "amount" : 2980
                        }
                    }
                }
            },
            "status" : "PENDING_APPROVAL",
            "statusOutput" : {
                "isCancellable" : true,
                "statusCode" : 600,
                "statusCodeChangeDateTime" : "20140630154830",
                "isAuthorized" : true
            }
        }
    }
    

Response 400 - Bad requestPaymentErrorResponse

The request was malformed or was missing required data. When a required property was missing the error message will point out which property caused the error.

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Object that contains details on the created payment in case one has been created
  • SDK Object type
    CreatePaymentResult
close

Description

Object containing the details of the created payment
  • SDK Object type
    PaymentCreationOutput
close

Description

The additional reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
close

Description

The external reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
close

Description

Indicates whether the customer ticked the "Remember my details for future purchases" checkbox on the MyCheckout hosted payment pages
close

Description

Indicates if a new token was created
  • true - A new token was created
  • false - A token with the same card number already exists and is returned. Please note that the existing token has not been updated. When you want to update other data then the card number, you need to update data stored in the token explicitly, as data is never updated during the creation of a token.
close

Description

ID of the token
close

Description

Indicates if tokenization was successful or not. If this value is false, then the token and isNewToken properties will not be set.
close

Description

Object that contains the action, including the needed data, that you should perform next, like showing instruction, showing the transaction results or redirect to a third party to complete the payment
  • SDK Object type
    MerchantAction
close

Description

Action merchants needs to take in the online payment process. Possible values are:
  • REDIRECT - The customer needs to be redirected using the details found in redirectData
  • SHOW_FORM - The customer needs to be shown a form with the fields found in formFields. You can submit the data entered by the user in a Complete payment request. Additionally:
    • for payment product 3012 (Bancontact), to support payments via the Bancontact app, showData contains a QR code and URL intent.
    • for payment product 863 (WeChat Pay), to support payments via the WeChat app, showData contains a QR code, URL intent, or signature and nonce combination. The showData property describes when each of these values can be returned.
      Note that WeChat Pay does not support completing payments.
  • SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData
  • SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData
  • MOBILE_THREEDS_CHALLENGE - The customer needs to complete a challenge as part of the 3D Secure authentication inside your mobile app. The details contained in mobileThreeDSecureChallengeParameters need to be provided to the EMVco certified Mobile SDK as a challengeParameters object.
  • CALL_THIRD_PARTY - The merchant needs to call a third party using the data found in thirdPartyData
close

Description

Populated only when the actionType of the merchantAction is SHOW_FORM. In this case, this property contains the list of fields to render, in the format that is also used in the response of Get payment product.
close
  • SDK Object type
    PaymentProductField
close

Description

Object containing data restrictions that apply to this field, like minimum and/or maximum length
  • SDK Object type
    PaymentProductFieldDataRestrictions
close

Description

  • true - Indicates that this field is required
  • false - Indicates that this field is optional
close

Description

Object containing the details of the validations on the field
  • SDK Object type
    PaymentProductFieldValidators
close

Description

Indicates the requiredness of the field based on the fiscalnumber for Boleto Bancario
  • SDK Object type
    BoletoBancarioRequirednessValidator
close

Description

When performing a payment with Boleto Bancario, some values are only required when the fiscalnumber has a specific length. The length the fiscalnumber has to have to make the field required is defined here. For example the CompanyName is required when the fiscalnumber is a CNPJ. The firstname and surname are required when the fiscalnumber is a CPF.
close

Description

Indicates that the content should be validated against the rules for an email address
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content should be validated against the rules for an expiration date (it should be in the future)
  • SDK Object type
    EmptyValidator
close

Description

Indicates that content should be one of the, in this object, listed items
  • SDK Object type
    FixedListValidator
close

Description

List of the allowed values that the field will be validated against
close

Description

Indicates that the content of this (iban) field needs to validated against format checks and modulo check (as described in ISO 7064)
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content needs to be validated against length criteria defined in this object
  • SDK Object type
    LengthValidator
close

Description

The maximum allowed length
close

Description

The minimum allowed length
close

Description

Indicates that the content needs to be validated using a LUHN check
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content needs to be validated against a, in this object, defined range
  • SDK Object type
    RangeValidator
close

Description

Upper value of the range that is still valid
close

Description

Lower value of the range that is still valid
close

Description

A string representing the regular expression to check
  • SDK Object type
    RegularExpressionValidator
close

Description

Contains the regular expression that the value of the field needs to be validated against
close

Description

Indicates that the content needs to be validated as per the Chinese resident identity number format
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content should be validated as such that the customer has accepted the field as if they were terms and conditions of a service
  • SDK Object type
    EmptyValidator
close

Description

Object containing display hints for this field, like the order, mask, preferred keyboard
  • SDK Object type
    PaymentProductFieldDisplayHints
close

Description

  • true - Indicates that this field is advised to be captured to increase the success rates even though it isn't marked as required. Please note that making the field required could hurt the success rates negatively. This boolean only indicates our advise to always show this field to the customer.
  • false - Indicates that this field is not to be shown unless it is a required field.
close

Description

The order in which the fields should be shown (ascending)
close

Description

Object detailing the type of form element that should be used to present the field
  • SDK Object type
    PaymentProductFieldFormElement
close

Description

Type of form element to be used. The following types can be returned:
  • text - A normal text input field
  • list - A list of values that the customer needs to choose from, is detailed in the valueMapping array
  • currency - Currency fields should be split into two fields, with the second one being specifically for the cents
  • boolean - Boolean fields should offer the customer a choice, like accepting the terms and conditions of a product.
  • date - let the customer pick a date.
close

Description

An array of values and displayNames that should be used to populate the list object in the GUI
close
  • SDK Object type
    ValueMappingElement
close

Description

List of extra data of the value.
close
  • SDK Object type
    PaymentProductFieldDisplayElement
close

Description

The ID of the display element.
close

Description

The label of the display element.
close

Description

The type of the display element. Indicates how the value should be presented. Possible values are:
  • STRING - as plain text
  • CURRENCY - as an amount in cents displayed with a decimal separator and the currency of the payment
  • PERCENTAGE - as a number with a percentage sign
  • INTEGER - as an integer
  • URI - as a link
close

Description

the value of the display element.
close
Deprecated: Use displayElements instead with ID 'displayName'

Description

Key name
close

Description

Value corresponding to the key
close

Description

Label/Name of the field to be used in the user interface
close

Description

Link that should be used to replace the '{link}' variable in the label.
close

Description

A mask that can be used in the input field. You can use it to inject additional characters to provide a better user experience and to restrict the accepted character set (illegal characters to be ignored during typing).
* is used for wildcards (and also chars)
9 is used for numbers
Everything outside {{ and }} is used as-is.
close

Description

  • true - The data in this field should be obfuscated as it is entered, just like a password field
  • false - The data in this field does not need to be obfuscated
close

Description

A placeholder value for the form element
close

Description

The type of keyboard that can best be used to fill out the value of this field. Possible values are:
  • PhoneNumberKeyboard - Keyboard that is normally used to enter phone numbers
  • StringKeyboard - Keyboard that is used to enter strings
  • IntegerKeyboard - Keyboard that is used to enter only numerical values
  • EmailAddressKeyboard - Keyboard that allows easier entry of email addresses
close

Description

Object that contains an optional tooltip to assist the customer
  • SDK Object type
    PaymentProductFieldTooltip
close

Description

Relative URL that can be used to retrieve an image for the tooltip image. You can use our server-side resize functionality by appending '?size={{width}}x{{height}}' to the full URL, where width and height are specified in pixels. The resized image will always keep its correct aspect ratio.
close

Description

A text explaining the field in more detail. This is meant to be used for displaying to the customer.
close

Description

The ID of the field
close

Description

The type of field, possible values are:
  • string - Any UTF-8 chracters
  • numericstring - A string that consisting only of numbers. Note that you should strip out anything that is not a digit, but leading zeros are allowed
  • date - Date in the format DDMMYYYY
  • expirydate - Expiration date in the format MMYY
  • integer - An integer
  • boolean - A boolean
close

Description

Indicates that the product can be used in a get customer details call and that when that call is done the field should be supplied as (one of the) key(s) with a valid value.
close

Description

Populated only when the actionType of the merchantAction is MOBILE_THREEDS_CHALLENGE. In this case, this object contains the list of properties to provide to the EMVco certified Mobile SDK as a challengeParameters object.
  • SDK Object type
    MobileThreeDSecureChallengeParameters
close

Description

The unique identifier assigned by the EMVCo Secretariat upon testing and approval.
close

Description

Contains the JWS object created by the ACS for the challenge (ARes).
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer).
close

Description

The 3-D Secure version 2 transaction ID that is used for the 3D Authentication
close

Description

Object containing all data needed to redirect the customer
  • SDK Object type
    RedirectData
close

Description

A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment
close

Description

The URL that the customer should be redirected to. Be sure to redirect using the GET method.
close

Description

This property contains the blob with data for the instructions rendering service.

This service will be available at the following endpoint: http(s)://{{merchant specific subdomain}}.{{base MyCheckout hosted payment pages domain}}/instructions/{{merchantId}}/{{clientSessionId}}

This instructions page rendering service accepts the following parameters:

  • instructionsRenderingData (required, the content of this property)
  • locale (optional, if present overrides default locale, e.g. "en_GB")
  • variant (optional, code of a variant, if present overrides default variant, e.g. "100")
  • customerId (required for Pix, otherwise optional, the customerId from a client session)
You can offer a link to a customer to see an instructions page for a payment done earlier. Because of the size of the instructionsRenderingData this will need to be set in a web form as a value of a hidden field. Before presenting the link you need to obtain a clientSessionId by creating a session using the S2S API. You will need to use the MyCheckout hosted payment pages domain hosted in the same region as the API domain used for the createClientSession call.

The instructionsRenderingData is a String blob that is presented to you via the Server API as part of the merchantAction (if available, and non-redirect) in the JSON return values for the createPayment call or the getHostedCheckoutStatus call (merchantAction inside createdPaymentOutput when available). You are responsible to store the instructionsRenderingData blob in order to be able to present the instructions page at a later time, when this information might no longer be available through Server API calls.

close

Description

This is returned for the SHOW_INSTRUCTION, the SHOW_TRANSACTION_RESULTS and the SHOW_FORM actionType.
When returned for SHOW_TRANSACTION_RESULTS or SHOW_FORM, this contains an array of key value pairs of data that needs to be shown to the customer.
Note: The returned value for the key BARCODE is a base64 encoded gif image. By prepending 'data:image/gif;base64,' this value can be used as the source of an HTML inline image.

For SHOW_FORM, for payment product 3012 (Bancontact), this contains a QR code and a URL intent that can be used to complete the payment in the Bancontact app.
In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by an Android device with the Bancontact app). The key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on an Android device.

For SHOW_FORM, for payment product 863 (WeChat Pay), this contains the PaymentId that WeChat has assigned to the payment. In this case, the key WECHAT_PAYMENTID contains this PaymentId. In addition, this can contain different values depending on the integration type:
  • desktopQRCode - contains a QR code that can be used to complete the payment in the WeChat app. In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by a mobile device with the WeChat app).
  • urlIntent - contains a URL intent that can be used to complete the payment in the WeChat app. In this case, the key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on a mobile device.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
close

Description

This is returned for the CALL_THIRD_PARTY actionType.
The payment product specific field of the payment product used for the payment will be populated with the third party data that should be used when calling the third party.
  • SDK Object type
    ThirdPartyData
close

Description

Contains the third party data for payment product 863 (WeChat Pay).
  • SDK Object type
    PaymentProduct863ThirdPartyData
close

Description

The appId to use in third party calls to WeChat.
close

Description

The nonceStr to use in third party calls to WeChat
close

Description

The packageSign to use in third party calls to WeChat
close

Description

The paySign to use in third party calls to WeChat
close

Description

The prepayId to use in third party calls to WeChat.
close

Description

The signType to use in third party calls to WeChat
close

Description

The timeStamp to use in third party calls to WeChat
close

Description

Object that holds the payment related properties
  • SDK Object type
    Payment
close

Description

Hosted Checkout specific information. Populated if the payment was created on the GlobalCollect platform through a Hosted Checkout.
  • SDK Object type
    HostedCheckoutSpecificOutput
close

Description

The ID of the Hosted Checkout Session in which the payment was made.
close

Description

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your hosted mandate pages in a controlled manner. Please note that you need to specify the ID of the variant.
close

Description

Our unique payment transaction identifier.
close

Description

Object containing payment details
  • SDK Object type
    PaymentOutput
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Amount that has been paid
close

Description

Amount that has been reversed
close

Description

Object containing the bank transfer payment method details
  • SDK Object type
    BankTransferPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the card payment method details
  • SDK Object type
    CardPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
close

Description

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available
close

Description

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available
close

Description

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.
close

Description

Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
  • SDK Object type
    FraugsterResults
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
close

Description

The unique scheme transactionId of the initial transaction that was performed with SCA.
Should be stored by the merchant to allow it to be submitted in future transactions.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

The unique scheme transactionId of this transaction.
Should be stored by the merchant to allow it to be submitted in future transactions. Use this value in case the initialSchemeTransactionId property is empty.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
close

Description

Method of authentication used for this transaction. Possible values:
  • frictionless = The authentication went without a challenge
  • challenged = Cardholder was challenged
  • avs-verified = The authentication was verified by AVS
  • other = Another issuer method was used to authenticate this transaction
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
close

Description

If a token was used for or created during the payment, then the ID of that token.
close

Description

Object containing the cash payment method details
  • SDK Object type
    CashPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the non SEPA direct debit payment method details
  • SDK Object type
    NonSepaDirectDebitPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the e-invoice payment method details
  • SDK Object type
    EInvoicePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

AfterPay Installments (payment product 9000) specific details
  • SDK Object type
    EInvoicePaymentProduct9000SpecificOutput
close

Description

The ID of the installment plan used for the payment.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the invoice payment method details
  • SDK Object type
    InvoicePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the mobile payment method details
  • SDK Object type
    MobilePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
close

Description

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available
close

Description

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available
close

Description

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.
close

Description

Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
  • SDK Object type
    FraugsterResults
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
close

Description

The network that was used for the refund
close

Description

Object containing payment details
  • SDK Object type
    MobilePaymentData
close

Description

The obfuscated DPAN. Only the last four digits are visible.
close

Description

Expiry date of the tokenized card
Format: MMYY
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
close

Description

Method of authentication used for this transaction. Possible values:
  • frictionless = The authentication went without a challenge
  • challenged = Cardholder was challenged
  • avs-verified = The authentication was verified by AVS
  • other = Another issuer method was used to authenticate this transaction
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
close

Description

Object containing the redirect payment product details
  • SDK Object type
    RedirectPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object that holds the Basic Bank Account Number (BBAN) data
  • SDK Object type
    BankAccountBban
close

Description

Name of the account holder
close

Description

Bank account number
close

Description

Bank code
close

Description

Name of the bank
close

Description

Branch code
close

Description

Bank check digit
close

Description

ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
close

Description

Object containing account holder name and IBAN information
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
close

Description

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
close

Description

The BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank or even branch. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

PostFinance Card (payment product 3201) specific details
  • SDK Object type
    PaymentProduct3201SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Trustly (payment product 806) specific details
  • SDK Object type
    PaymentProduct806SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the account details
  • SDK Object type
    TrustlyBankAccount
close

Description

The last digits of the account number
close

Description

The name of the bank
close

Description

The country of the clearing house
close

Description

The ID number of the account holder
close

Description

Sofort (payment product 836) specific details
  • SDK Object type
    PaymentProduct836SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Indicates if SofortBank could estabilish if the transaction could successfully be processed.
  • 0 - You should wait for the transaction to be reported as paid before shipping any goods.
  • 1 - You can ship the goods. In case the transaction is not reported as paid you can initiate a claims process with SofortBank.
close

Description

PayPal (payment product 840) specific details
  • SDK Object type
    PaymentProduct840SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the details of the PayPal account
  • SDK Object type
    PaymentProduct840CustomerAccount
close

Description

Username with which the PayPal account holder has registered at PayPal
close

Description

Identification of the PayPal recurring billing agreement
close

Description

Name of the company in case the PayPal account is owned by a business
close

Description

The phone number of the PayPal account holder
close

Description

Country where the PayPal account is located
close

Description

Status of the PayPal account.
Possible values are:
  • verified - PayPal has verified the funding means for this account
  • unverified - PayPal has not verified the funding means for this account
close

Description

Status of the customer's shipping address as registered by PayPal
Possible values are:
  • none - Status is unknown at PayPal
  • confirmed - The address has been confirmed
  • unconfirmed - The address has not been confirmed
close

Description

First name of the PayPal account holder
close

Description

The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
close

Description

Surname of the PayPal account holder
close

Description

Object containing the address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Protection Eligibility data of the PayPal customer
  • SDK Object type
    ProtectionEligibility
close

Description

Possible values:
  • Eligible
  • PartiallyEligible
  • Ineligible
close

Description

Possible values:
  • ItemNotReceivedEligible
  • UnauthorizedPaymentEligible
  • Ineligible
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

ID of the token. This property is populated when the payment was done with a token or when the payment was tokenized.
close

Description

Object containing the SEPA direct debit details
  • SDK Object type
    SepaDirectDebitPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Output that is SEPA Direct Debit specific (i.e. the used mandate)
  • SDK Object type
    PaymentProduct771SpecificOutput
close

Description

Unique reference to a Mandate
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

ID of the token. This property is populated for the GlobalCollect payment platform when the payment was done with a token or when the payment was tokenized.
close

Description

Payment method identifier used by the our payment engine with the following possible values:
  • bankRefund
  • bankTransfer
  • card
  • cash
  • directDebit
  • eInvoice
  • invoice
  • redirect
close

Description

Object that holds all reference properties that are linked to this transaction
  • SDK Object type
    PaymentReferences
close

Description

Your order ID for this transaction that is also returned in our report files
close

Description

Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
close

Description

Payment Reference generated by WebCollect
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

Provides an additional means of reconciliation, this is the MerchantId used at the provider
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

When you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
close

Description

The reason description given for the reversedAmount property.
close

Description

Current high-level status of the payment in a human-readable form. Possible values are :
  • ACCOUNT_VERIFIED - The account has been verified using a validation services like 0$ auth
  • CREATED - The transaction has been created. This is the initial state once a new payment is created.
  • REDIRECTED - The customer has been redirected to a 3rd party to complete the authentication/payment
  • PENDING_PAYMENT - Instructions have been provided and we are now waiting for the money to come in
  • PENDING_FRAUD_APPROVAL - The transaction has been marked for manual review after an automatic fraud screening
  • PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the capturing of the funds
  • PENDING_COMPLETION - The transaction needs to be completed.
  • PENDING_CAPTURE - The transaction is waiting for you to request one or more captures of the funds.
  • REJECTED - The transaction has been rejected
  • AUTHORIZATION_REQUESTED - we have requested an authorization against an asynchronous system and is awaiting its response
  • CAPTURE_REQUESTED - The transaction is in the queue to be captured
  • CAPTURED - The transaction has been captured and we have received online confirmation
  • PAID - We have matched the incoming funds to the transaction
  • CANCELLED - You have cancelled the transaction
  • REJECTED_CAPTURE - We or one of our downstream acquirers/providers have rejected the capture request
  • REVERSED - The transaction has been reversed
  • CHARGEBACK_NOTIFICATION - We have received a notification of chargeback and this status informs you that your account will be debited for a particular transaction
  • CHARGEBACKED - The transaction has been chargebacked
  • REFUNDED - The transaction has been refunded

Please see Statuses for a full overview of possible values.
close

Description

This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource. In case of failed payments and negative scenarios, detailed error information is listed.
  • SDK Object type
    PaymentStatusOutput
close

Description

Custom object contains the set of errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Indicates if the transaction has been authorized
  • true
  • false
close

Description

Flag indicating if the payment can be cancelled
  • true
  • false
close

Description

Flag indicating if the payment can be refunded
  • true
  • false
close

Description

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee
  • true
  • false
close

Description

This is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
close

Description

Highlevel status of the payment, payout or refund with the following possible values:
  • CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses:
    • CREATED
  • PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses:
    • PENDING_PAYMENT
    • REDIRECTED
  • ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses:
    • ACCOUNT_VERIFIED
  • PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses:
    • PENDING_APPROVAL
    • PENDING_COMPLETION
    • PENDING_CAPTURE
    • PENDING_FRAUD_APPROVAL
  • PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses:
    • AUTHORIZATION_REQUESTED
    • CAPTURE_REQUESTED
    • PAYOUT_REQUESTED
    • REFUND_REQUESTED
  • COMPLETED: The transaction has completed. This category groups the following statuses:
    • CAPTURED
    • PAID
    • ACCOUNT_CREDITED
    • CHARGEBACK_NOTIFICATION
  • REVERSED: The transaction has been reversed. This category groups the following statuses:
    • CHARGEBACKED
    • REVERSED
  • REFUNDED: The transaction has been refunded. This category groups the following statuses:
    • REFUNDED
  • UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
    • CANCELLED
    • REJECTED
    • REJECTED_CAPTURE
    • REJECTED_CREDIT

Please see Statuses for a full overview of possible values.
close

Description

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
close

Description

Date and time of payment
Format: YYYYMMDDHH24MISS
close

Description

The 3D Secure status, with the following possible values:
  • ENROLLED: the card is enrolled for 3D Secure authentication. The customer can be redirected to a 3D Secure access control server (ACS)
  • NOT_ENROLLED: the card is not enrolled for 3D Secure authentication
  • INVALID_PARES_OR_NOT_COMPLETED: the PARes is invalid, or the customer did not complete the 3D Secure authentication
  • AUTHENTICATED: the customer has passed the 3D Secure authentication
  • NOT_AUTHENTICATED: the customer failed the 3D Secure authentication
  • NOT_PARTICIPATING: the cardholder has not set up their card for 2-step 3D Secure.
Note that this status will only be set for payments that make use of 2-step 3D Secure.

Response example

SDK: .NET

This scenario you will probably use the most

  • {
        "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092",
        "errors" : [
            {
                "code" : "20000000",
                "propertyName" : "directDebitPaymentMethodSpecificInput.bankAccountBban.accountNumber",
                "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
            }
        ]
    }
    

Response 402 - Payment requiredPaymentErrorResponse

The payment was declined by a 3rd party (acquirer, payment processor, etc.)

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Object that contains details on the created payment in case one has been created
  • SDK Object type
    CreatePaymentResult
close

Description

Object containing the details of the created payment
  • SDK Object type
    PaymentCreationOutput
close

Description

The additional reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
close

Description

The external reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
close

Description

Indicates whether the customer ticked the "Remember my details for future purchases" checkbox on the MyCheckout hosted payment pages
close

Description

Indicates if a new token was created
  • true - A new token was created
  • false - A token with the same card number already exists and is returned. Please note that the existing token has not been updated. When you want to update other data then the card number, you need to update data stored in the token explicitly, as data is never updated during the creation of a token.
close

Description

ID of the token
close

Description

Indicates if tokenization was successful or not. If this value is false, then the token and isNewToken properties will not be set.
close

Description

Object that contains the action, including the needed data, that you should perform next, like showing instruction, showing the transaction results or redirect to a third party to complete the payment
  • SDK Object type
    MerchantAction
close

Description

Action merchants needs to take in the online payment process. Possible values are:
  • REDIRECT - The customer needs to be redirected using the details found in redirectData
  • SHOW_FORM - The customer needs to be shown a form with the fields found in formFields. You can submit the data entered by the user in a Complete payment request. Additionally:
    • for payment product 3012 (Bancontact), to support payments via the Bancontact app, showData contains a QR code and URL intent.
    • for payment product 863 (WeChat Pay), to support payments via the WeChat app, showData contains a QR code, URL intent, or signature and nonce combination. The showData property describes when each of these values can be returned.
      Note that WeChat Pay does not support completing payments.
  • SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData
  • SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData
  • MOBILE_THREEDS_CHALLENGE - The customer needs to complete a challenge as part of the 3D Secure authentication inside your mobile app. The details contained in mobileThreeDSecureChallengeParameters need to be provided to the EMVco certified Mobile SDK as a challengeParameters object.
  • CALL_THIRD_PARTY - The merchant needs to call a third party using the data found in thirdPartyData
close

Description

Populated only when the actionType of the merchantAction is SHOW_FORM. In this case, this property contains the list of fields to render, in the format that is also used in the response of Get payment product.
close
  • SDK Object type
    PaymentProductField
close

Description

Object containing data restrictions that apply to this field, like minimum and/or maximum length
  • SDK Object type
    PaymentProductFieldDataRestrictions
close

Description

  • true - Indicates that this field is required
  • false - Indicates that this field is optional
close

Description

Object containing the details of the validations on the field
  • SDK Object type
    PaymentProductFieldValidators
close

Description

Indicates the requiredness of the field based on the fiscalnumber for Boleto Bancario
  • SDK Object type
    BoletoBancarioRequirednessValidator
close

Description

When performing a payment with Boleto Bancario, some values are only required when the fiscalnumber has a specific length. The length the fiscalnumber has to have to make the field required is defined here. For example the CompanyName is required when the fiscalnumber is a CNPJ. The firstname and surname are required when the fiscalnumber is a CPF.
close

Description

Indicates that the content should be validated against the rules for an email address
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content should be validated against the rules for an expiration date (it should be in the future)
  • SDK Object type
    EmptyValidator
close

Description

Indicates that content should be one of the, in this object, listed items
  • SDK Object type
    FixedListValidator
close

Description

List of the allowed values that the field will be validated against
close

Description

Indicates that the content of this (iban) field needs to validated against format checks and modulo check (as described in ISO 7064)
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content needs to be validated against length criteria defined in this object
  • SDK Object type
    LengthValidator
close

Description

The maximum allowed length
close

Description

The minimum allowed length
close

Description

Indicates that the content needs to be validated using a LUHN check
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content needs to be validated against a, in this object, defined range
  • SDK Object type
    RangeValidator
close

Description

Upper value of the range that is still valid
close

Description

Lower value of the range that is still valid
close

Description

A string representing the regular expression to check
  • SDK Object type
    RegularExpressionValidator
close

Description

Contains the regular expression that the value of the field needs to be validated against
close

Description

Indicates that the content needs to be validated as per the Chinese resident identity number format
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content should be validated as such that the customer has accepted the field as if they were terms and conditions of a service
  • SDK Object type
    EmptyValidator
close

Description

Object containing display hints for this field, like the order, mask, preferred keyboard
  • SDK Object type
    PaymentProductFieldDisplayHints
close

Description

  • true - Indicates that this field is advised to be captured to increase the success rates even though it isn't marked as required. Please note that making the field required could hurt the success rates negatively. This boolean only indicates our advise to always show this field to the customer.
  • false - Indicates that this field is not to be shown unless it is a required field.
close

Description

The order in which the fields should be shown (ascending)
close

Description

Object detailing the type of form element that should be used to present the field
  • SDK Object type
    PaymentProductFieldFormElement
close

Description

Type of form element to be used. The following types can be returned:
  • text - A normal text input field
  • list - A list of values that the customer needs to choose from, is detailed in the valueMapping array
  • currency - Currency fields should be split into two fields, with the second one being specifically for the cents
  • boolean - Boolean fields should offer the customer a choice, like accepting the terms and conditions of a product.
  • date - let the customer pick a date.
close

Description

An array of values and displayNames that should be used to populate the list object in the GUI
close
  • SDK Object type
    ValueMappingElement
close

Description

List of extra data of the value.
close
  • SDK Object type
    PaymentProductFieldDisplayElement
close

Description

The ID of the display element.
close

Description

The label of the display element.
close

Description

The type of the display element. Indicates how the value should be presented. Possible values are:
  • STRING - as plain text
  • CURRENCY - as an amount in cents displayed with a decimal separator and the currency of the payment
  • PERCENTAGE - as a number with a percentage sign
  • INTEGER - as an integer
  • URI - as a link
close

Description

the value of the display element.
close
Deprecated: Use displayElements instead with ID 'displayName'

Description

Key name
close

Description

Value corresponding to the key
close

Description

Label/Name of the field to be used in the user interface
close

Description

Link that should be used to replace the '{link}' variable in the label.
close

Description

A mask that can be used in the input field. You can use it to inject additional characters to provide a better user experience and to restrict the accepted character set (illegal characters to be ignored during typing).
* is used for wildcards (and also chars)
9 is used for numbers
Everything outside {{ and }} is used as-is.
close

Description

  • true - The data in this field should be obfuscated as it is entered, just like a password field
  • false - The data in this field does not need to be obfuscated
close

Description

A placeholder value for the form element
close

Description

The type of keyboard that can best be used to fill out the value of this field. Possible values are:
  • PhoneNumberKeyboard - Keyboard that is normally used to enter phone numbers
  • StringKeyboard - Keyboard that is used to enter strings
  • IntegerKeyboard - Keyboard that is used to enter only numerical values
  • EmailAddressKeyboard - Keyboard that allows easier entry of email addresses
close

Description

Object that contains an optional tooltip to assist the customer
  • SDK Object type
    PaymentProductFieldTooltip
close

Description

Relative URL that can be used to retrieve an image for the tooltip image. You can use our server-side resize functionality by appending '?size={{width}}x{{height}}' to the full URL, where width and height are specified in pixels. The resized image will always keep its correct aspect ratio.
close

Description

A text explaining the field in more detail. This is meant to be used for displaying to the customer.
close

Description

The ID of the field
close

Description

The type of field, possible values are:
  • string - Any UTF-8 chracters
  • numericstring - A string that consisting only of numbers. Note that you should strip out anything that is not a digit, but leading zeros are allowed
  • date - Date in the format DDMMYYYY
  • expirydate - Expiration date in the format MMYY
  • integer - An integer
  • boolean - A boolean
close

Description

Indicates that the product can be used in a get customer details call and that when that call is done the field should be supplied as (one of the) key(s) with a valid value.
close

Description

Populated only when the actionType of the merchantAction is MOBILE_THREEDS_CHALLENGE. In this case, this object contains the list of properties to provide to the EMVco certified Mobile SDK as a challengeParameters object.
  • SDK Object type
    MobileThreeDSecureChallengeParameters
close

Description

The unique identifier assigned by the EMVCo Secretariat upon testing and approval.
close

Description

Contains the JWS object created by the ACS for the challenge (ARes).
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer).
close

Description

The 3-D Secure version 2 transaction ID that is used for the 3D Authentication
close

Description

Object containing all data needed to redirect the customer
  • SDK Object type
    RedirectData
close

Description

A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment
close

Description

The URL that the customer should be redirected to. Be sure to redirect using the GET method.
close

Description

This property contains the blob with data for the instructions rendering service.

This service will be available at the following endpoint: http(s)://{{merchant specific subdomain}}.{{base MyCheckout hosted payment pages domain}}/instructions/{{merchantId}}/{{clientSessionId}}

This instructions page rendering service accepts the following parameters:

  • instructionsRenderingData (required, the content of this property)
  • locale (optional, if present overrides default locale, e.g. "en_GB")
  • variant (optional, code of a variant, if present overrides default variant, e.g. "100")
  • customerId (required for Pix, otherwise optional, the customerId from a client session)
You can offer a link to a customer to see an instructions page for a payment done earlier. Because of the size of the instructionsRenderingData this will need to be set in a web form as a value of a hidden field. Before presenting the link you need to obtain a clientSessionId by creating a session using the S2S API. You will need to use the MyCheckout hosted payment pages domain hosted in the same region as the API domain used for the createClientSession call.

The instructionsRenderingData is a String blob that is presented to you via the Server API as part of the merchantAction (if available, and non-redirect) in the JSON return values for the createPayment call or the getHostedCheckoutStatus call (merchantAction inside createdPaymentOutput when available). You are responsible to store the instructionsRenderingData blob in order to be able to present the instructions page at a later time, when this information might no longer be available through Server API calls.

close

Description

This is returned for the SHOW_INSTRUCTION, the SHOW_TRANSACTION_RESULTS and the SHOW_FORM actionType.
When returned for SHOW_TRANSACTION_RESULTS or SHOW_FORM, this contains an array of key value pairs of data that needs to be shown to the customer.
Note: The returned value for the key BARCODE is a base64 encoded gif image. By prepending 'data:image/gif;base64,' this value can be used as the source of an HTML inline image.

For SHOW_FORM, for payment product 3012 (Bancontact), this contains a QR code and a URL intent that can be used to complete the payment in the Bancontact app.
In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by an Android device with the Bancontact app). The key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on an Android device.

For SHOW_FORM, for payment product 863 (WeChat Pay), this contains the PaymentId that WeChat has assigned to the payment. In this case, the key WECHAT_PAYMENTID contains this PaymentId. In addition, this can contain different values depending on the integration type:
  • desktopQRCode - contains a QR code that can be used to complete the payment in the WeChat app. In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by a mobile device with the WeChat app).
  • urlIntent - contains a URL intent that can be used to complete the payment in the WeChat app. In this case, the key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on a mobile device.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
close

Description

This is returned for the CALL_THIRD_PARTY actionType.
The payment product specific field of the payment product used for the payment will be populated with the third party data that should be used when calling the third party.
  • SDK Object type
    ThirdPartyData
close

Description

Contains the third party data for payment product 863 (WeChat Pay).
  • SDK Object type
    PaymentProduct863ThirdPartyData
close

Description

The appId to use in third party calls to WeChat.
close

Description

The nonceStr to use in third party calls to WeChat
close

Description

The packageSign to use in third party calls to WeChat
close

Description

The paySign to use in third party calls to WeChat
close

Description

The prepayId to use in third party calls to WeChat.
close

Description

The signType to use in third party calls to WeChat
close

Description

The timeStamp to use in third party calls to WeChat
close

Description

Object that holds the payment related properties
  • SDK Object type
    Payment
close

Description

Hosted Checkout specific information. Populated if the payment was created on the GlobalCollect platform through a Hosted Checkout.
  • SDK Object type
    HostedCheckoutSpecificOutput
close

Description

The ID of the Hosted Checkout Session in which the payment was made.
close

Description

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your hosted mandate pages in a controlled manner. Please note that you need to specify the ID of the variant.
close

Description

Our unique payment transaction identifier.
close

Description

Object containing payment details
  • SDK Object type
    PaymentOutput
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Amount that has been paid
close

Description

Amount that has been reversed
close

Description

Object containing the bank transfer payment method details
  • SDK Object type
    BankTransferPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the card payment method details
  • SDK Object type
    CardPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
close

Description

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available
close

Description

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available
close

Description

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.
close

Description

Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
  • SDK Object type
    FraugsterResults
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
close

Description

The unique scheme transactionId of the initial transaction that was performed with SCA.
Should be stored by the merchant to allow it to be submitted in future transactions.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

The unique scheme transactionId of this transaction.
Should be stored by the merchant to allow it to be submitted in future transactions. Use this value in case the initialSchemeTransactionId property is empty.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
close

Description

Method of authentication used for this transaction. Possible values:
  • frictionless = The authentication went without a challenge
  • challenged = Cardholder was challenged
  • avs-verified = The authentication was verified by AVS
  • other = Another issuer method was used to authenticate this transaction
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
close

Description

If a token was used for or created during the payment, then the ID of that token.
close

Description

Object containing the cash payment method details
  • SDK Object type
    CashPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the non SEPA direct debit payment method details
  • SDK Object type
    NonSepaDirectDebitPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the e-invoice payment method details
  • SDK Object type
    EInvoicePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

AfterPay Installments (payment product 9000) specific details
  • SDK Object type
    EInvoicePaymentProduct9000SpecificOutput
close

Description

The ID of the installment plan used for the payment.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the invoice payment method details
  • SDK Object type
    InvoicePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the mobile payment method details
  • SDK Object type
    MobilePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
close

Description

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available
close

Description

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available
close

Description

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.
close

Description

Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
  • SDK Object type
    FraugsterResults
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
close

Description

The network that was used for the refund
close

Description

Object containing payment details
  • SDK Object type
    MobilePaymentData
close

Description

The obfuscated DPAN. Only the last four digits are visible.
close

Description

Expiry date of the tokenized card
Format: MMYY
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
close

Description

Method of authentication used for this transaction. Possible values:
  • frictionless = The authentication went without a challenge
  • challenged = Cardholder was challenged
  • avs-verified = The authentication was verified by AVS
  • other = Another issuer method was used to authenticate this transaction
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
close

Description

Object containing the redirect payment product details
  • SDK Object type
    RedirectPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object that holds the Basic Bank Account Number (BBAN) data
  • SDK Object type
    BankAccountBban
close

Description

Name of the account holder
close

Description

Bank account number
close

Description

Bank code
close

Description

Name of the bank
close

Description

Branch code
close

Description

Bank check digit
close

Description

ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
close

Description

Object containing account holder name and IBAN information
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
close

Description

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
close

Description

The BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank or even branch. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

PostFinance Card (payment product 3201) specific details
  • SDK Object type
    PaymentProduct3201SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Trustly (payment product 806) specific details
  • SDK Object type
    PaymentProduct806SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the account details
  • SDK Object type
    TrustlyBankAccount
close

Description

The last digits of the account number
close

Description

The name of the bank
close

Description

The country of the clearing house
close

Description

The ID number of the account holder
close

Description

Sofort (payment product 836) specific details
  • SDK Object type
    PaymentProduct836SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Indicates if SofortBank could estabilish if the transaction could successfully be processed.
  • 0 - You should wait for the transaction to be reported as paid before shipping any goods.
  • 1 - You can ship the goods. In case the transaction is not reported as paid you can initiate a claims process with SofortBank.
close

Description

PayPal (payment product 840) specific details
  • SDK Object type
    PaymentProduct840SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the details of the PayPal account
  • SDK Object type
    PaymentProduct840CustomerAccount
close

Description

Username with which the PayPal account holder has registered at PayPal
close

Description

Identification of the PayPal recurring billing agreement
close

Description

Name of the company in case the PayPal account is owned by a business
close

Description

The phone number of the PayPal account holder
close

Description

Country where the PayPal account is located
close

Description

Status of the PayPal account.
Possible values are:
  • verified - PayPal has verified the funding means for this account
  • unverified - PayPal has not verified the funding means for this account
close

Description

Status of the customer's shipping address as registered by PayPal
Possible values are:
  • none - Status is unknown at PayPal
  • confirmed - The address has been confirmed
  • unconfirmed - The address has not been confirmed
close

Description

First name of the PayPal account holder
close

Description

The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
close

Description

Surname of the PayPal account holder
close

Description

Object containing the address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Protection Eligibility data of the PayPal customer
  • SDK Object type
    ProtectionEligibility
close

Description

Possible values:
  • Eligible
  • PartiallyEligible
  • Ineligible
close

Description

Possible values:
  • ItemNotReceivedEligible
  • UnauthorizedPaymentEligible
  • Ineligible
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

ID of the token. This property is populated when the payment was done with a token or when the payment was tokenized.
close

Description

Object containing the SEPA direct debit details
  • SDK Object type
    SepaDirectDebitPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Output that is SEPA Direct Debit specific (i.e. the used mandate)
  • SDK Object type
    PaymentProduct771SpecificOutput
close

Description

Unique reference to a Mandate
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

ID of the token. This property is populated for the GlobalCollect payment platform when the payment was done with a token or when the payment was tokenized.
close

Description

Payment method identifier used by the our payment engine with the following possible values:
  • bankRefund
  • bankTransfer
  • card
  • cash
  • directDebit
  • eInvoice
  • invoice
  • redirect
close

Description

Object that holds all reference properties that are linked to this transaction
  • SDK Object type
    PaymentReferences
close

Description

Your order ID for this transaction that is also returned in our report files
close

Description

Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
close

Description

Payment Reference generated by WebCollect
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

Provides an additional means of reconciliation, this is the MerchantId used at the provider
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

When you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
close

Description

The reason description given for the reversedAmount property.
close

Description

Current high-level status of the payment in a human-readable form. Possible values are :
  • ACCOUNT_VERIFIED - The account has been verified using a validation services like 0$ auth
  • CREATED - The transaction has been created. This is the initial state once a new payment is created.
  • REDIRECTED - The customer has been redirected to a 3rd party to complete the authentication/payment
  • PENDING_PAYMENT - Instructions have been provided and we are now waiting for the money to come in
  • PENDING_FRAUD_APPROVAL - The transaction has been marked for manual review after an automatic fraud screening
  • PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the capturing of the funds
  • PENDING_COMPLETION - The transaction needs to be completed.
  • PENDING_CAPTURE - The transaction is waiting for you to request one or more captures of the funds.
  • REJECTED - The transaction has been rejected
  • AUTHORIZATION_REQUESTED - we have requested an authorization against an asynchronous system and is awaiting its response
  • CAPTURE_REQUESTED - The transaction is in the queue to be captured
  • CAPTURED - The transaction has been captured and we have received online confirmation
  • PAID - We have matched the incoming funds to the transaction
  • CANCELLED - You have cancelled the transaction
  • REJECTED_CAPTURE - We or one of our downstream acquirers/providers have rejected the capture request
  • REVERSED - The transaction has been reversed
  • CHARGEBACK_NOTIFICATION - We have received a notification of chargeback and this status informs you that your account will be debited for a particular transaction
  • CHARGEBACKED - The transaction has been chargebacked
  • REFUNDED - The transaction has been refunded

Please see Statuses for a full overview of possible values.
close

Description

This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource. In case of failed payments and negative scenarios, detailed error information is listed.
  • SDK Object type
    PaymentStatusOutput
close

Description

Custom object contains the set of errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Indicates if the transaction has been authorized
  • true
  • false
close

Description

Flag indicating if the payment can be cancelled
  • true
  • false
close

Description

Flag indicating if the payment can be refunded
  • true
  • false
close

Description

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee
  • true
  • false
close

Description

This is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
close

Description

Highlevel status of the payment, payout or refund with the following possible values:
  • CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses:
    • CREATED
  • PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses:
    • PENDING_PAYMENT
    • REDIRECTED
  • ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses:
    • ACCOUNT_VERIFIED
  • PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses:
    • PENDING_APPROVAL
    • PENDING_COMPLETION
    • PENDING_CAPTURE
    • PENDING_FRAUD_APPROVAL
  • PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses:
    • AUTHORIZATION_REQUESTED
    • CAPTURE_REQUESTED
    • PAYOUT_REQUESTED
    • REFUND_REQUESTED
  • COMPLETED: The transaction has completed. This category groups the following statuses:
    • CAPTURED
    • PAID
    • ACCOUNT_CREDITED
    • CHARGEBACK_NOTIFICATION
  • REVERSED: The transaction has been reversed. This category groups the following statuses:
    • CHARGEBACKED
    • REVERSED
  • REFUNDED: The transaction has been refunded. This category groups the following statuses:
    • REFUNDED
  • UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
    • CANCELLED
    • REJECTED
    • REJECTED_CAPTURE
    • REJECTED_CREDIT

Please see Statuses for a full overview of possible values.
close

Description

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
close

Description

Date and time of payment
Format: YYYYMMDDHH24MISS
close

Description

The 3D Secure status, with the following possible values:
  • ENROLLED: the card is enrolled for 3D Secure authentication. The customer can be redirected to a 3D Secure access control server (ACS)
  • NOT_ENROLLED: the card is not enrolled for 3D Secure authentication
  • INVALID_PARES_OR_NOT_COMPLETED: the PARes is invalid, or the customer did not complete the 3D Secure authentication
  • AUTHENTICATED: the customer has passed the 3D Secure authentication
  • NOT_AUTHENTICATED: the customer failed the 3D Secure authentication
  • NOT_PARTICIPATING: the cardholder has not set up their card for 2-step 3D Secure.
Note that this status will only be set for payments that make use of 2-step 3D Secure.

Response example

SDK: .NET

This scenario you will probably use the most

  • {
        "errorId" : "657b10da-d2f9-4088-a948-bf190ef516b1-000002c5",
        "errors" : [
            {
                "code" : "430285",
                "message" : "Not authorised"
            }
        ],
        "paymentResult" : {
            "creationOutput" : {
                "additionalReference" : "AcmeOrder0001",
                "externalReference" : "AcmeOrder0001"
            },
            "payment" : {
                "id" : "000000850010000188130000200001",
                "paymentOutput" : {
                    "amountOfMoney" : {
                        "amount" : 100,
                        "currencyCode" : "EUR"
                    },
                    "references" : {
                        "merchantReference" : "AcmeOrder0001",
                        "paymentReference" : "0"
                    },
                    "paymentMethod" : "card",
                    "cardPaymentMethodSpecificOutput" : {
                        "paymentProductId" : 1,
                        "card" : {
                            "cardNumber" : "************7977",
                            "expiryDate" : "1299"
                        },
                        "threeDSecureResults" : {
                            "authenticationAmount" : {
                                "currencyCode" : "EUR",
                                "amount" : 100
                            }
                        }
                    }
                },
                "status" : "REJECTED",
                "statusOutput" : {
                    "errors" : [
                        {
                            "code" : "430285",
                            "message" : "Not authorised"
                        }
                    ],
                    "isCancellable" : false,
                    "statusCode" : 100,
                    "statusCodeChangeDateTime" : "20140630154830",
                    "isAuthorized" : false,
                    "isRefundable" : false
                }
            }
        }
    }
    

Response 403 - UnauthorizedPaymentErrorResponse

You are not allowed to access the service or account or your API authentication failed.

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Object that contains details on the created payment in case one has been created
  • SDK Object type
    CreatePaymentResult
close

Description

Object containing the details of the created payment
  • SDK Object type
    PaymentCreationOutput
close

Description

The additional reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
close

Description

The external reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
close

Description

Indicates whether the customer ticked the "Remember my details for future purchases" checkbox on the MyCheckout hosted payment pages
close

Description

Indicates if a new token was created
  • true - A new token was created
  • false - A token with the same card number already exists and is returned. Please note that the existing token has not been updated. When you want to update other data then the card number, you need to update data stored in the token explicitly, as data is never updated during the creation of a token.
close

Description

ID of the token
close

Description

Indicates if tokenization was successful or not. If this value is false, then the token and isNewToken properties will not be set.
close

Description

Object that contains the action, including the needed data, that you should perform next, like showing instruction, showing the transaction results or redirect to a third party to complete the payment
  • SDK Object type
    MerchantAction
close

Description

Action merchants needs to take in the online payment process. Possible values are:
  • REDIRECT - The customer needs to be redirected using the details found in redirectData
  • SHOW_FORM - The customer needs to be shown a form with the fields found in formFields. You can submit the data entered by the user in a Complete payment request. Additionally:
    • for payment product 3012 (Bancontact), to support payments via the Bancontact app, showData contains a QR code and URL intent.
    • for payment product 863 (WeChat Pay), to support payments via the WeChat app, showData contains a QR code, URL intent, or signature and nonce combination. The showData property describes when each of these values can be returned.
      Note that WeChat Pay does not support completing payments.
  • SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData
  • SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData
  • MOBILE_THREEDS_CHALLENGE - The customer needs to complete a challenge as part of the 3D Secure authentication inside your mobile app. The details contained in mobileThreeDSecureChallengeParameters need to be provided to the EMVco certified Mobile SDK as a challengeParameters object.
  • CALL_THIRD_PARTY - The merchant needs to call a third party using the data found in thirdPartyData
close

Description

Populated only when the actionType of the merchantAction is SHOW_FORM. In this case, this property contains the list of fields to render, in the format that is also used in the response of Get payment product.
close
  • SDK Object type
    PaymentProductField
close

Description

Object containing data restrictions that apply to this field, like minimum and/or maximum length
  • SDK Object type
    PaymentProductFieldDataRestrictions
close

Description

  • true - Indicates that this field is required
  • false - Indicates that this field is optional
close

Description

Object containing the details of the validations on the field
  • SDK Object type
    PaymentProductFieldValidators
close

Description

Indicates the requiredness of the field based on the fiscalnumber for Boleto Bancario
  • SDK Object type
    BoletoBancarioRequirednessValidator
close

Description

When performing a payment with Boleto Bancario, some values are only required when the fiscalnumber has a specific length. The length the fiscalnumber has to have to make the field required is defined here. For example the CompanyName is required when the fiscalnumber is a CNPJ. The firstname and surname are required when the fiscalnumber is a CPF.
close

Description

Indicates that the content should be validated against the rules for an email address
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content should be validated against the rules for an expiration date (it should be in the future)
  • SDK Object type
    EmptyValidator
close

Description

Indicates that content should be one of the, in this object, listed items
  • SDK Object type
    FixedListValidator
close

Description

List of the allowed values that the field will be validated against
close

Description

Indicates that the content of this (iban) field needs to validated against format checks and modulo check (as described in ISO 7064)
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content needs to be validated against length criteria defined in this object
  • SDK Object type
    LengthValidator
close

Description

The maximum allowed length
close

Description

The minimum allowed length
close

Description

Indicates that the content needs to be validated using a LUHN check
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content needs to be validated against a, in this object, defined range
  • SDK Object type
    RangeValidator
close

Description

Upper value of the range that is still valid
close

Description

Lower value of the range that is still valid
close

Description

A string representing the regular expression to check
  • SDK Object type
    RegularExpressionValidator
close

Description

Contains the regular expression that the value of the field needs to be validated against
close

Description

Indicates that the content needs to be validated as per the Chinese resident identity number format
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content should be validated as such that the customer has accepted the field as if they were terms and conditions of a service
  • SDK Object type
    EmptyValidator
close

Description

Object containing display hints for this field, like the order, mask, preferred keyboard
  • SDK Object type
    PaymentProductFieldDisplayHints
close

Description

  • true - Indicates that this field is advised to be captured to increase the success rates even though it isn't marked as required. Please note that making the field required could hurt the success rates negatively. This boolean only indicates our advise to always show this field to the customer.
  • false - Indicates that this field is not to be shown unless it is a required field.
close

Description

The order in which the fields should be shown (ascending)
close

Description

Object detailing the type of form element that should be used to present the field
  • SDK Object type
    PaymentProductFieldFormElement
close

Description

Type of form element to be used. The following types can be returned:
  • text - A normal text input field
  • list - A list of values that the customer needs to choose from, is detailed in the valueMapping array
  • currency - Currency fields should be split into two fields, with the second one being specifically for the cents
  • boolean - Boolean fields should offer the customer a choice, like accepting the terms and conditions of a product.
  • date - let the customer pick a date.
close

Description

An array of values and displayNames that should be used to populate the list object in the GUI
close
  • SDK Object type
    ValueMappingElement
close

Description

List of extra data of the value.
close
  • SDK Object type
    PaymentProductFieldDisplayElement
close

Description

The ID of the display element.
close

Description

The label of the display element.
close

Description

The type of the display element. Indicates how the value should be presented. Possible values are:
  • STRING - as plain text
  • CURRENCY - as an amount in cents displayed with a decimal separator and the currency of the payment
  • PERCENTAGE - as a number with a percentage sign
  • INTEGER - as an integer
  • URI - as a link
close

Description

the value of the display element.
close
Deprecated: Use displayElements instead with ID 'displayName'

Description

Key name
close

Description

Value corresponding to the key
close

Description

Label/Name of the field to be used in the user interface
close

Description

Link that should be used to replace the '{link}' variable in the label.
close

Description

A mask that can be used in the input field. You can use it to inject additional characters to provide a better user experience and to restrict the accepted character set (illegal characters to be ignored during typing).
* is used for wildcards (and also chars)
9 is used for numbers
Everything outside {{ and }} is used as-is.
close

Description

  • true - The data in this field should be obfuscated as it is entered, just like a password field
  • false - The data in this field does not need to be obfuscated
close

Description

A placeholder value for the form element
close

Description

The type of keyboard that can best be used to fill out the value of this field. Possible values are:
  • PhoneNumberKeyboard - Keyboard that is normally used to enter phone numbers
  • StringKeyboard - Keyboard that is used to enter strings
  • IntegerKeyboard - Keyboard that is used to enter only numerical values
  • EmailAddressKeyboard - Keyboard that allows easier entry of email addresses
close

Description

Object that contains an optional tooltip to assist the customer
  • SDK Object type
    PaymentProductFieldTooltip
close

Description

Relative URL that can be used to retrieve an image for the tooltip image. You can use our server-side resize functionality by appending '?size={{width}}x{{height}}' to the full URL, where width and height are specified in pixels. The resized image will always keep its correct aspect ratio.
close

Description

A text explaining the field in more detail. This is meant to be used for displaying to the customer.
close

Description

The ID of the field
close

Description

The type of field, possible values are:
  • string - Any UTF-8 chracters
  • numericstring - A string that consisting only of numbers. Note that you should strip out anything that is not a digit, but leading zeros are allowed
  • date - Date in the format DDMMYYYY
  • expirydate - Expiration date in the format MMYY
  • integer - An integer
  • boolean - A boolean
close

Description

Indicates that the product can be used in a get customer details call and that when that call is done the field should be supplied as (one of the) key(s) with a valid value.
close

Description

Populated only when the actionType of the merchantAction is MOBILE_THREEDS_CHALLENGE. In this case, this object contains the list of properties to provide to the EMVco certified Mobile SDK as a challengeParameters object.
  • SDK Object type
    MobileThreeDSecureChallengeParameters
close

Description

The unique identifier assigned by the EMVCo Secretariat upon testing and approval.
close

Description

Contains the JWS object created by the ACS for the challenge (ARes).
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer).
close

Description

The 3-D Secure version 2 transaction ID that is used for the 3D Authentication
close

Description

Object containing all data needed to redirect the customer
  • SDK Object type
    RedirectData
close

Description

A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment
close

Description

The URL that the customer should be redirected to. Be sure to redirect using the GET method.
close

Description

This property contains the blob with data for the instructions rendering service.

This service will be available at the following endpoint: http(s)://{{merchant specific subdomain}}.{{base MyCheckout hosted payment pages domain}}/instructions/{{merchantId}}/{{clientSessionId}}

This instructions page rendering service accepts the following parameters:

  • instructionsRenderingData (required, the content of this property)
  • locale (optional, if present overrides default locale, e.g. "en_GB")
  • variant (optional, code of a variant, if present overrides default variant, e.g. "100")
  • customerId (required for Pix, otherwise optional, the customerId from a client session)
You can offer a link to a customer to see an instructions page for a payment done earlier. Because of the size of the instructionsRenderingData this will need to be set in a web form as a value of a hidden field. Before presenting the link you need to obtain a clientSessionId by creating a session using the S2S API. You will need to use the MyCheckout hosted payment pages domain hosted in the same region as the API domain used for the createClientSession call.

The instructionsRenderingData is a String blob that is presented to you via the Server API as part of the merchantAction (if available, and non-redirect) in the JSON return values for the createPayment call or the getHostedCheckoutStatus call (merchantAction inside createdPaymentOutput when available). You are responsible to store the instructionsRenderingData blob in order to be able to present the instructions page at a later time, when this information might no longer be available through Server API calls.

close

Description

This is returned for the SHOW_INSTRUCTION, the SHOW_TRANSACTION_RESULTS and the SHOW_FORM actionType.
When returned for SHOW_TRANSACTION_RESULTS or SHOW_FORM, this contains an array of key value pairs of data that needs to be shown to the customer.
Note: The returned value for the key BARCODE is a base64 encoded gif image. By prepending 'data:image/gif;base64,' this value can be used as the source of an HTML inline image.

For SHOW_FORM, for payment product 3012 (Bancontact), this contains a QR code and a URL intent that can be used to complete the payment in the Bancontact app.
In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by an Android device with the Bancontact app). The key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on an Android device.

For SHOW_FORM, for payment product 863 (WeChat Pay), this contains the PaymentId that WeChat has assigned to the payment. In this case, the key WECHAT_PAYMENTID contains this PaymentId. In addition, this can contain different values depending on the integration type:
  • desktopQRCode - contains a QR code that can be used to complete the payment in the WeChat app. In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by a mobile device with the WeChat app).
  • urlIntent - contains a URL intent that can be used to complete the payment in the WeChat app. In this case, the key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on a mobile device.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
close

Description

This is returned for the CALL_THIRD_PARTY actionType.
The payment product specific field of the payment product used for the payment will be populated with the third party data that should be used when calling the third party.
  • SDK Object type
    ThirdPartyData
close

Description

Contains the third party data for payment product 863 (WeChat Pay).
  • SDK Object type
    PaymentProduct863ThirdPartyData
close

Description

The appId to use in third party calls to WeChat.
close

Description

The nonceStr to use in third party calls to WeChat
close

Description

The packageSign to use in third party calls to WeChat
close

Description

The paySign to use in third party calls to WeChat
close

Description

The prepayId to use in third party calls to WeChat.
close

Description

The signType to use in third party calls to WeChat
close

Description

The timeStamp to use in third party calls to WeChat
close

Description

Object that holds the payment related properties
  • SDK Object type
    Payment
close

Description

Hosted Checkout specific information. Populated if the payment was created on the GlobalCollect platform through a Hosted Checkout.
  • SDK Object type
    HostedCheckoutSpecificOutput
close

Description

The ID of the Hosted Checkout Session in which the payment was made.
close

Description

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your hosted mandate pages in a controlled manner. Please note that you need to specify the ID of the variant.
close

Description

Our unique payment transaction identifier.
close

Description

Object containing payment details
  • SDK Object type
    PaymentOutput
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Amount that has been paid
close

Description

Amount that has been reversed
close

Description

Object containing the bank transfer payment method details
  • SDK Object type
    BankTransferPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the card payment method details
  • SDK Object type
    CardPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
close

Description

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available
close

Description

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available
close

Description

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.
close

Description

Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
  • SDK Object type
    FraugsterResults
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
close

Description

The unique scheme transactionId of the initial transaction that was performed with SCA.
Should be stored by the merchant to allow it to be submitted in future transactions.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

The unique scheme transactionId of this transaction.
Should be stored by the merchant to allow it to be submitted in future transactions. Use this value in case the initialSchemeTransactionId property is empty.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
close

Description

Method of authentication used for this transaction. Possible values:
  • frictionless = The authentication went without a challenge
  • challenged = Cardholder was challenged
  • avs-verified = The authentication was verified by AVS
  • other = Another issuer method was used to authenticate this transaction
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
close

Description

If a token was used for or created during the payment, then the ID of that token.
close

Description

Object containing the cash payment method details
  • SDK Object type
    CashPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the non SEPA direct debit payment method details
  • SDK Object type
    NonSepaDirectDebitPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the e-invoice payment method details
  • SDK Object type
    EInvoicePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

AfterPay Installments (payment product 9000) specific details
  • SDK Object type
    EInvoicePaymentProduct9000SpecificOutput
close

Description

The ID of the installment plan used for the payment.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the invoice payment method details
  • SDK Object type
    InvoicePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the mobile payment method details
  • SDK Object type
    MobilePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
close

Description

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available
close

Description

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available
close

Description

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.
close

Description

Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
  • SDK Object type
    FraugsterResults
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
close

Description

The network that was used for the refund
close

Description

Object containing payment details
  • SDK Object type
    MobilePaymentData
close

Description

The obfuscated DPAN. Only the last four digits are visible.
close

Description

Expiry date of the tokenized card
Format: MMYY
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
close

Description

Method of authentication used for this transaction. Possible values:
  • frictionless = The authentication went without a challenge
  • challenged = Cardholder was challenged
  • avs-verified = The authentication was verified by AVS
  • other = Another issuer method was used to authenticate this transaction
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
close

Description

Object containing the redirect payment product details
  • SDK Object type
    RedirectPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object that holds the Basic Bank Account Number (BBAN) data
  • SDK Object type
    BankAccountBban
close

Description

Name of the account holder
close

Description

Bank account number
close

Description

Bank code
close

Description

Name of the bank
close

Description

Branch code
close

Description

Bank check digit
close

Description

ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
close

Description

Object containing account holder name and IBAN information
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
close

Description

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
close

Description

The BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank or even branch. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

PostFinance Card (payment product 3201) specific details
  • SDK Object type
    PaymentProduct3201SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Trustly (payment product 806) specific details
  • SDK Object type
    PaymentProduct806SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the account details
  • SDK Object type
    TrustlyBankAccount
close

Description

The last digits of the account number
close

Description

The name of the bank
close

Description

The country of the clearing house
close

Description

The ID number of the account holder
close

Description

Sofort (payment product 836) specific details
  • SDK Object type
    PaymentProduct836SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Indicates if SofortBank could estabilish if the transaction could successfully be processed.
  • 0 - You should wait for the transaction to be reported as paid before shipping any goods.
  • 1 - You can ship the goods. In case the transaction is not reported as paid you can initiate a claims process with SofortBank.
close

Description

PayPal (payment product 840) specific details
  • SDK Object type
    PaymentProduct840SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the details of the PayPal account
  • SDK Object type
    PaymentProduct840CustomerAccount
close

Description

Username with which the PayPal account holder has registered at PayPal
close

Description

Identification of the PayPal recurring billing agreement
close

Description

Name of the company in case the PayPal account is owned by a business
close

Description

The phone number of the PayPal account holder
close

Description

Country where the PayPal account is located
close

Description

Status of the PayPal account.
Possible values are:
  • verified - PayPal has verified the funding means for this account
  • unverified - PayPal has not verified the funding means for this account
close

Description

Status of the customer's shipping address as registered by PayPal
Possible values are:
  • none - Status is unknown at PayPal
  • confirmed - The address has been confirmed
  • unconfirmed - The address has not been confirmed
close

Description

First name of the PayPal account holder
close

Description

The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
close

Description

Surname of the PayPal account holder
close

Description

Object containing the address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Protection Eligibility data of the PayPal customer
  • SDK Object type
    ProtectionEligibility
close

Description

Possible values:
  • Eligible
  • PartiallyEligible
  • Ineligible
close

Description

Possible values:
  • ItemNotReceivedEligible
  • UnauthorizedPaymentEligible
  • Ineligible
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

ID of the token. This property is populated when the payment was done with a token or when the payment was tokenized.
close

Description

Object containing the SEPA direct debit details
  • SDK Object type
    SepaDirectDebitPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Output that is SEPA Direct Debit specific (i.e. the used mandate)
  • SDK Object type
    PaymentProduct771SpecificOutput
close

Description

Unique reference to a Mandate
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

ID of the token. This property is populated for the GlobalCollect payment platform when the payment was done with a token or when the payment was tokenized.
close

Description

Payment method identifier used by the our payment engine with the following possible values:
  • bankRefund
  • bankTransfer
  • card
  • cash
  • directDebit
  • eInvoice
  • invoice
  • redirect
close

Description

Object that holds all reference properties that are linked to this transaction
  • SDK Object type
    PaymentReferences
close

Description

Your order ID for this transaction that is also returned in our report files
close

Description

Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
close

Description

Payment Reference generated by WebCollect
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

Provides an additional means of reconciliation, this is the MerchantId used at the provider
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

When you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
close

Description

The reason description given for the reversedAmount property.
close

Description

Current high-level status of the payment in a human-readable form. Possible values are :
  • ACCOUNT_VERIFIED - The account has been verified using a validation services like 0$ auth
  • CREATED - The transaction has been created. This is the initial state once a new payment is created.
  • REDIRECTED - The customer has been redirected to a 3rd party to complete the authentication/payment
  • PENDING_PAYMENT - Instructions have been provided and we are now waiting for the money to come in
  • PENDING_FRAUD_APPROVAL - The transaction has been marked for manual review after an automatic fraud screening
  • PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the capturing of the funds
  • PENDING_COMPLETION - The transaction needs to be completed.
  • PENDING_CAPTURE - The transaction is waiting for you to request one or more captures of the funds.
  • REJECTED - The transaction has been rejected
  • AUTHORIZATION_REQUESTED - we have requested an authorization against an asynchronous system and is awaiting its response
  • CAPTURE_REQUESTED - The transaction is in the queue to be captured
  • CAPTURED - The transaction has been captured and we have received online confirmation
  • PAID - We have matched the incoming funds to the transaction
  • CANCELLED - You have cancelled the transaction
  • REJECTED_CAPTURE - We or one of our downstream acquirers/providers have rejected the capture request
  • REVERSED - The transaction has been reversed
  • CHARGEBACK_NOTIFICATION - We have received a notification of chargeback and this status informs you that your account will be debited for a particular transaction
  • CHARGEBACKED - The transaction has been chargebacked
  • REFUNDED - The transaction has been refunded

Please see Statuses for a full overview of possible values.
close

Description

This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource. In case of failed payments and negative scenarios, detailed error information is listed.
  • SDK Object type
    PaymentStatusOutput
close

Description

Custom object contains the set of errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Indicates if the transaction has been authorized
  • true
  • false
close

Description

Flag indicating if the payment can be cancelled
  • true
  • false
close

Description

Flag indicating if the payment can be refunded
  • true
  • false
close

Description

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee
  • true
  • false
close

Description

This is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
close

Description

Highlevel status of the payment, payout or refund with the following possible values:
  • CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses:
    • CREATED
  • PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses:
    • PENDING_PAYMENT
    • REDIRECTED
  • ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses:
    • ACCOUNT_VERIFIED
  • PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses:
    • PENDING_APPROVAL
    • PENDING_COMPLETION
    • PENDING_CAPTURE
    • PENDING_FRAUD_APPROVAL
  • PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses:
    • AUTHORIZATION_REQUESTED
    • CAPTURE_REQUESTED
    • PAYOUT_REQUESTED
    • REFUND_REQUESTED
  • COMPLETED: The transaction has completed. This category groups the following statuses:
    • CAPTURED
    • PAID
    • ACCOUNT_CREDITED
    • CHARGEBACK_NOTIFICATION
  • REVERSED: The transaction has been reversed. This category groups the following statuses:
    • CHARGEBACKED
    • REVERSED
  • REFUNDED: The transaction has been refunded. This category groups the following statuses:
    • REFUNDED
  • UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
    • CANCELLED
    • REJECTED
    • REJECTED_CAPTURE
    • REJECTED_CREDIT

Please see Statuses for a full overview of possible values.
close

Description

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
close

Description

Date and time of payment
Format: YYYYMMDDHH24MISS
close

Description

The 3D Secure status, with the following possible values:
  • ENROLLED: the card is enrolled for 3D Secure authentication. The customer can be redirected to a 3D Secure access control server (ACS)
  • NOT_ENROLLED: the card is not enrolled for 3D Secure authentication
  • INVALID_PARES_OR_NOT_COMPLETED: the PARes is invalid, or the customer did not complete the 3D Secure authentication
  • AUTHENTICATED: the customer has passed the 3D Secure authentication
  • NOT_AUTHENTICATED: the customer failed the 3D Secure authentication
  • NOT_PARTICIPATING: the cardholder has not set up their card for 2-step 3D Secure.
Note that this status will only be set for payments that make use of 2-step 3D Secure.

Response example

SDK: .NET

This scenario you will probably use the most

  • {
        "errorId" : "657b10da-d2f9-4088-a948-bf190ef516b1-000002b9",
        "errors" : [
            {
                "code" : "700660",
                "propertyName" : "sepaDirectDebitPaymentMethodSpecificInput.mandate",
                "message" : "SERVICE_NOT_ALLOWED"
            }
        ],
        "paymentResult" : {
            "creationOutput" : {
                "additionalReference" : "AcmeOrder0001",
                "externalReference" : "AcmeOrder0001"
            },
            "payment" : {
                "id" : "000000850010000188130000200001",
                "paymentOutput" : {
                    "amountOfMoney" : {
                        "amount" : 100,
                        "currencyCode" : "EUR"
                    },
                    "references" : {
                        "merchantReference" : "AcmeOrder0001",
                        "paymentReference" : "0"
                    },
                    "paymentMethod" : "card",
                    "cardPaymentMethodSpecificOutput" : {
                        "paymentProductId" : 1,
                        "card" : {
                            "cardNumber" : "************7977",
                            "expiryDate" : "1299"
                        },
                        "threeDSecureResults" : {
                            "authenticationAmount" : {
                                "currencyCode" : "EUR",
                                "amount" : 100
                            }
                        }
                    }
                },
                "status" : "REJECTED",
                "statusOutput" : {
                    "errors" : [
                        {
                            "code" : "700660",
                            "message" : "SERVICE_NOT_ALLOWED"
                        }
                    ],
                    "isCancellable" : false,
                    "statusCode" : 100,
                    "statusCodeChangeDateTime" : "20140630154830",
                    "isAuthorized" : false
                }
            }
        }
    }
    

Response 404 - Not foundErrorResponse

Mandate not found.

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: .NET

This scenario you will probably use the most

  • {
        "errorId" : "cbdd845e-7a7e-409c-acfc-8c549e4d2be8-00000675",
        "errors" : [
            {
                "id" : "MANDATE_NOT_FOUND",
                "code" : "8888888",
                "category" : "MANDATE_PLATFORM_ERROR",
                "propertyName" : "uniqueMandateReference",
                "message" : "Mandate with that reference not found",
                "httpStatusCode" : 404
            }
        ]
    }
    

Response 409 - ConflictErrorResponse

Mandate already exists.

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: .NET

This scenario you will probably use the most

  • {
        "errorId" : "cbdd845e-7a7e-409c-acfc-8c549e4d2be8-00000675",
        "errors" : [
            {
                "id" : "MANDATE_ALREADY_EXISTS",
                "code" : "8888888",
                "category" : "MANDATE_PLATFORM_ERROR",
                "propertyName" : "uniqueMandateReference",
                "message" : "A mandate with that reference already exists",
                "httpStatusCode" : 409
            }
        ]
    }
    

Response 502 - Bad gatewayPaymentErrorResponse

Any 5XX response points to something that went wrong on our end. This could also be that the system was unable to route the transaction to an appropriate acquirer/3rd party. Another reason for such a response if when the 3rd party's response could not be understood.

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Object that contains details on the created payment in case one has been created
  • SDK Object type
    CreatePaymentResult
close

Description

Object containing the details of the created payment
  • SDK Object type
    PaymentCreationOutput
close

Description

The additional reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
close

Description

The external reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
close

Description

Indicates whether the customer ticked the "Remember my details for future purchases" checkbox on the MyCheckout hosted payment pages
close

Description

Indicates if a new token was created
  • true - A new token was created
  • false - A token with the same card number already exists and is returned. Please note that the existing token has not been updated. When you want to update other data then the card number, you need to update data stored in the token explicitly, as data is never updated during the creation of a token.
close

Description

ID of the token
close

Description

Indicates if tokenization was successful or not. If this value is false, then the token and isNewToken properties will not be set.
close

Description

Object that contains the action, including the needed data, that you should perform next, like showing instruction, showing the transaction results or redirect to a third party to complete the payment
  • SDK Object type
    MerchantAction
close

Description

Action merchants needs to take in the online payment process. Possible values are:
  • REDIRECT - The customer needs to be redirected using the details found in redirectData
  • SHOW_FORM - The customer needs to be shown a form with the fields found in formFields. You can submit the data entered by the user in a Complete payment request. Additionally:
    • for payment product 3012 (Bancontact), to support payments via the Bancontact app, showData contains a QR code and URL intent.
    • for payment product 863 (WeChat Pay), to support payments via the WeChat app, showData contains a QR code, URL intent, or signature and nonce combination. The showData property describes when each of these values can be returned.
      Note that WeChat Pay does not support completing payments.
  • SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData
  • SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData
  • MOBILE_THREEDS_CHALLENGE - The customer needs to complete a challenge as part of the 3D Secure authentication inside your mobile app. The details contained in mobileThreeDSecureChallengeParameters need to be provided to the EMVco certified Mobile SDK as a challengeParameters object.
  • CALL_THIRD_PARTY - The merchant needs to call a third party using the data found in thirdPartyData
close

Description

Populated only when the actionType of the merchantAction is SHOW_FORM. In this case, this property contains the list of fields to render, in the format that is also used in the response of Get payment product.
close
  • SDK Object type
    PaymentProductField
close

Description

Object containing data restrictions that apply to this field, like minimum and/or maximum length
  • SDK Object type
    PaymentProductFieldDataRestrictions
close

Description

  • true - Indicates that this field is required
  • false - Indicates that this field is optional
close

Description

Object containing the details of the validations on the field
  • SDK Object type
    PaymentProductFieldValidators
close

Description

Indicates the requiredness of the field based on the fiscalnumber for Boleto Bancario
  • SDK Object type
    BoletoBancarioRequirednessValidator
close

Description

When performing a payment with Boleto Bancario, some values are only required when the fiscalnumber has a specific length. The length the fiscalnumber has to have to make the field required is defined here. For example the CompanyName is required when the fiscalnumber is a CNPJ. The firstname and surname are required when the fiscalnumber is a CPF.
close

Description

Indicates that the content should be validated against the rules for an email address
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content should be validated against the rules for an expiration date (it should be in the future)
  • SDK Object type
    EmptyValidator
close

Description

Indicates that content should be one of the, in this object, listed items
  • SDK Object type
    FixedListValidator
close

Description

List of the allowed values that the field will be validated against
close

Description

Indicates that the content of this (iban) field needs to validated against format checks and modulo check (as described in ISO 7064)
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content needs to be validated against length criteria defined in this object
  • SDK Object type
    LengthValidator
close

Description

The maximum allowed length
close

Description

The minimum allowed length
close

Description

Indicates that the content needs to be validated using a LUHN check
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content needs to be validated against a, in this object, defined range
  • SDK Object type
    RangeValidator
close

Description

Upper value of the range that is still valid
close

Description

Lower value of the range that is still valid
close

Description

A string representing the regular expression to check
  • SDK Object type
    RegularExpressionValidator
close

Description

Contains the regular expression that the value of the field needs to be validated against
close

Description

Indicates that the content needs to be validated as per the Chinese resident identity number format
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content should be validated as such that the customer has accepted the field as if they were terms and conditions of a service
  • SDK Object type
    EmptyValidator
close

Description

Object containing display hints for this field, like the order, mask, preferred keyboard
  • SDK Object type
    PaymentProductFieldDisplayHints
close

Description

  • true - Indicates that this field is advised to be captured to increase the success rates even though it isn't marked as required. Please note that making the field required could hurt the success rates negatively. This boolean only indicates our advise to always show this field to the customer.
  • false - Indicates that this field is not to be shown unless it is a required field.
close

Description

The order in which the fields should be shown (ascending)
close

Description

Object detailing the type of form element that should be used to present the field
  • SDK Object type
    PaymentProductFieldFormElement
close

Description

Type of form element to be used. The following types can be returned:
  • text - A normal text input field
  • list - A list of values that the customer needs to choose from, is detailed in the valueMapping array
  • currency - Currency fields should be split into two fields, with the second one being specifically for the cents
  • boolean - Boolean fields should offer the customer a choice, like accepting the terms and conditions of a product.
  • date - let the customer pick a date.
close

Description

An array of values and displayNames that should be used to populate the list object in the GUI
close
  • SDK Object type
    ValueMappingElement
close

Description

List of extra data of the value.
close
  • SDK Object type
    PaymentProductFieldDisplayElement
close

Description

The ID of the display element.
close

Description

The label of the display element.
close

Description

The type of the display element. Indicates how the value should be presented. Possible values are:
  • STRING - as plain text
  • CURRENCY - as an amount in cents displayed with a decimal separator and the currency of the payment
  • PERCENTAGE - as a number with a percentage sign
  • INTEGER - as an integer
  • URI - as a link
close

Description

the value of the display element.
close
Deprecated: Use displayElements instead with ID 'displayName'

Description

Key name
close

Description

Value corresponding to the key
close

Description

Label/Name of the field to be used in the user interface
close

Description

Link that should be used to replace the '{link}' variable in the label.
close

Description

A mask that can be used in the input field. You can use it to inject additional characters to provide a better user experience and to restrict the accepted character set (illegal characters to be ignored during typing).
* is used for wildcards (and also chars)
9 is used for numbers
Everything outside {{ and }} is used as-is.
close

Description

  • true - The data in this field should be obfuscated as it is entered, just like a password field
  • false - The data in this field does not need to be obfuscated
close

Description

A placeholder value for the form element
close

Description

The type of keyboard that can best be used to fill out the value of this field. Possible values are:
  • PhoneNumberKeyboard - Keyboard that is normally used to enter phone numbers
  • StringKeyboard - Keyboard that is used to enter strings
  • IntegerKeyboard - Keyboard that is used to enter only numerical values
  • EmailAddressKeyboard - Keyboard that allows easier entry of email addresses
close

Description

Object that contains an optional tooltip to assist the customer
  • SDK Object type
    PaymentProductFieldTooltip
close

Description

Relative URL that can be used to retrieve an image for the tooltip image. You can use our server-side resize functionality by appending '?size={{width}}x{{height}}' to the full URL, where width and height are specified in pixels. The resized image will always keep its correct aspect ratio.
close

Description

A text explaining the field in more detail. This is meant to be used for displaying to the customer.
close

Description

The ID of the field
close

Description

The type of field, possible values are:
  • string - Any UTF-8 chracters
  • numericstring - A string that consisting only of numbers. Note that you should strip out anything that is not a digit, but leading zeros are allowed
  • date - Date in the format DDMMYYYY
  • expirydate - Expiration date in the format MMYY
  • integer - An integer
  • boolean - A boolean
close

Description

Indicates that the product can be used in a get customer details call and that when that call is done the field should be supplied as (one of the) key(s) with a valid value.
close

Description

Populated only when the actionType of the merchantAction is MOBILE_THREEDS_CHALLENGE. In this case, this object contains the list of properties to provide to the EMVco certified Mobile SDK as a challengeParameters object.
  • SDK Object type
    MobileThreeDSecureChallengeParameters
close

Description

The unique identifier assigned by the EMVCo Secretariat upon testing and approval.
close

Description

Contains the JWS object created by the ACS for the challenge (ARes).
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer).
close

Description

The 3-D Secure version 2 transaction ID that is used for the 3D Authentication
close

Description

Object containing all data needed to redirect the customer
  • SDK Object type
    RedirectData
close

Description

A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment
close

Description

The URL that the customer should be redirected to. Be sure to redirect using the GET method.
close

Description

This property contains the blob with data for the instructions rendering service.

This service will be available at the following endpoint: http(s)://{{merchant specific subdomain}}.{{base MyCheckout hosted payment pages domain}}/instructions/{{merchantId}}/{{clientSessionId}}

This instructions page rendering service accepts the following parameters:

  • instructionsRenderingData (required, the content of this property)
  • locale (optional, if present overrides default locale, e.g. "en_GB")
  • variant (optional, code of a variant, if present overrides default variant, e.g. "100")
  • customerId (required for Pix, otherwise optional, the customerId from a client session)
You can offer a link to a customer to see an instructions page for a payment done earlier. Because of the size of the instructionsRenderingData this will need to be set in a web form as a value of a hidden field. Before presenting the link you need to obtain a clientSessionId by creating a session using the S2S API. You will need to use the MyCheckout hosted payment pages domain hosted in the same region as the API domain used for the createClientSession call.

The instructionsRenderingData is a String blob that is presented to you via the Server API as part of the merchantAction (if available, and non-redirect) in the JSON return values for the createPayment call or the getHostedCheckoutStatus call (merchantAction inside createdPaymentOutput when available). You are responsible to store the instructionsRenderingData blob in order to be able to present the instructions page at a later time, when this information might no longer be available through Server API calls.

close

Description

This is returned for the SHOW_INSTRUCTION, the SHOW_TRANSACTION_RESULTS and the SHOW_FORM actionType.
When returned for SHOW_TRANSACTION_RESULTS or SHOW_FORM, this contains an array of key value pairs of data that needs to be shown to the customer.
Note: The returned value for the key BARCODE is a base64 encoded gif image. By prepending 'data:image/gif;base64,' this value can be used as the source of an HTML inline image.

For SHOW_FORM, for payment product 3012 (Bancontact), this contains a QR code and a URL intent that can be used to complete the payment in the Bancontact app.
In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by an Android device with the Bancontact app). The key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on an Android device.

For SHOW_FORM, for payment product 863 (WeChat Pay), this contains the PaymentId that WeChat has assigned to the payment. In this case, the key WECHAT_PAYMENTID contains this PaymentId. In addition, this can contain different values depending on the integration type:
  • desktopQRCode - contains a QR code that can be used to complete the payment in the WeChat app. In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by a mobile device with the WeChat app).
  • urlIntent - contains a URL intent that can be used to complete the payment in the WeChat app. In this case, the key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on a mobile device.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
close

Description

This is returned for the CALL_THIRD_PARTY actionType.
The payment product specific field of the payment product used for the payment will be populated with the third party data that should be used when calling the third party.
  • SDK Object type
    ThirdPartyData
close

Description

Contains the third party data for payment product 863 (WeChat Pay).
  • SDK Object type
    PaymentProduct863ThirdPartyData
close

Description

The appId to use in third party calls to WeChat.
close

Description

The nonceStr to use in third party calls to WeChat
close

Description

The packageSign to use in third party calls to WeChat
close

Description

The paySign to use in third party calls to WeChat
close

Description

The prepayId to use in third party calls to WeChat.
close

Description

The signType to use in third party calls to WeChat
close

Description

The timeStamp to use in third party calls to WeChat
close

Description

Object that holds the payment related properties
  • SDK Object type
    Payment
close

Description

Hosted Checkout specific information. Populated if the payment was created on the GlobalCollect platform through a Hosted Checkout.
  • SDK Object type
    HostedCheckoutSpecificOutput
close

Description

The ID of the Hosted Checkout Session in which the payment was made.
close

Description

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your hosted mandate pages in a controlled manner. Please note that you need to specify the ID of the variant.
close

Description

Our unique payment transaction identifier.
close

Description

Object containing payment details
  • SDK Object type
    PaymentOutput
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Amount that has been paid
close

Description

Amount that has been reversed
close

Description

Object containing the bank transfer payment method details
  • SDK Object type
    BankTransferPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the card payment method details
  • SDK Object type
    CardPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
close

Description

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available
close

Description

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available
close

Description

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.
close

Description

Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
  • SDK Object type
    FraugsterResults
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
close

Description

The unique scheme transactionId of the initial transaction that was performed with SCA.
Should be stored by the merchant to allow it to be submitted in future transactions.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

The unique scheme transactionId of this transaction.
Should be stored by the merchant to allow it to be submitted in future transactions. Use this value in case the initialSchemeTransactionId property is empty.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
close

Description

Method of authentication used for this transaction. Possible values:
  • frictionless = The authentication went without a challenge
  • challenged = Cardholder was challenged
  • avs-verified = The authentication was verified by AVS
  • other = Another issuer method was used to authenticate this transaction
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
close

Description

If a token was used for or created during the payment, then the ID of that token.
close

Description

Object containing the cash payment method details
  • SDK Object type
    CashPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the non SEPA direct debit payment method details
  • SDK Object type
    NonSepaDirectDebitPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the e-invoice payment method details
  • SDK Object type
    EInvoicePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

AfterPay Installments (payment product 9000) specific details
  • SDK Object type
    EInvoicePaymentProduct9000SpecificOutput
close

Description

The ID of the installment plan used for the payment.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the invoice payment method details
  • SDK Object type
    InvoicePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the mobile payment method details
  • SDK Object type
    MobilePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
close

Description

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available
close

Description

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available
close

Description

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.
close

Description

Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
  • SDK Object type
    FraugsterResults
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
close

Description

The network that was used for the refund
close

Description

Object containing payment details
  • SDK Object type
    MobilePaymentData
close

Description

The obfuscated DPAN. Only the last four digits are visible.
close

Description

Expiry date of the tokenized card
Format: MMYY
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
close

Description

Method of authentication used for this transaction. Possible values:
  • frictionless = The authentication went without a challenge
  • challenged = Cardholder was challenged
  • avs-verified = The authentication was verified by AVS
  • other = Another issuer method was used to authenticate this transaction
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
close

Description

Object containing the redirect payment product details
  • SDK Object type
    RedirectPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object that holds the Basic Bank Account Number (BBAN) data
  • SDK Object type
    BankAccountBban
close

Description

Name of the account holder
close

Description

Bank account number
close

Description

Bank code
close

Description

Name of the bank
close

Description

Branch code
close

Description

Bank check digit
close

Description

ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
close

Description

Object containing account holder name and IBAN information
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
close

Description

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
close

Description

The BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank or even branch. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

PostFinance Card (payment product 3201) specific details
  • SDK Object type
    PaymentProduct3201SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Trustly (payment product 806) specific details
  • SDK Object type
    PaymentProduct806SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the account details
  • SDK Object type
    TrustlyBankAccount
close

Description

The last digits of the account number
close

Description

The name of the bank
close

Description

The country of the clearing house
close

Description

The ID number of the account holder
close

Description

Sofort (payment product 836) specific details
  • SDK Object type
    PaymentProduct836SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Indicates if SofortBank could estabilish if the transaction could successfully be processed.
  • 0 - You should wait for the transaction to be reported as paid before shipping any goods.
  • 1 - You can ship the goods. In case the transaction is not reported as paid you can initiate a claims process with SofortBank.
close

Description

PayPal (payment product 840) specific details
  • SDK Object type
    PaymentProduct840SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the details of the PayPal account
  • SDK Object type
    PaymentProduct840CustomerAccount
close

Description

Username with which the PayPal account holder has registered at PayPal
close

Description

Identification of the PayPal recurring billing agreement
close

Description

Name of the company in case the PayPal account is owned by a business
close

Description

The phone number of the PayPal account holder
close

Description

Country where the PayPal account is located
close

Description

Status of the PayPal account.
Possible values are:
  • verified - PayPal has verified the funding means for this account
  • unverified - PayPal has not verified the funding means for this account
close

Description

Status of the customer's shipping address as registered by PayPal
Possible values are:
  • none - Status is unknown at PayPal
  • confirmed - The address has been confirmed
  • unconfirmed - The address has not been confirmed
close

Description

First name of the PayPal account holder
close

Description

The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
close

Description

Surname of the PayPal account holder
close

Description

Object containing the address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Protection Eligibility data of the PayPal customer
  • SDK Object type
    ProtectionEligibility
close

Description

Possible values:
  • Eligible
  • PartiallyEligible
  • Ineligible
close

Description

Possible values:
  • ItemNotReceivedEligible
  • UnauthorizedPaymentEligible
  • Ineligible
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

ID of the token. This property is populated when the payment was done with a token or when the payment was tokenized.
close

Description

Object containing the SEPA direct debit details
  • SDK Object type
    SepaDirectDebitPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Output that is SEPA Direct Debit specific (i.e. the used mandate)
  • SDK Object type
    PaymentProduct771SpecificOutput
close

Description

Unique reference to a Mandate
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

ID of the token. This property is populated for the GlobalCollect payment platform when the payment was done with a token or when the payment was tokenized.
close

Description

Payment method identifier used by the our payment engine with the following possible values:
  • bankRefund
  • bankTransfer
  • card
  • cash
  • directDebit
  • eInvoice
  • invoice
  • redirect
close

Description

Object that holds all reference properties that are linked to this transaction
  • SDK Object type
    PaymentReferences
close

Description

Your order ID for this transaction that is also returned in our report files
close

Description

Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
close

Description

Payment Reference generated by WebCollect
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

Provides an additional means of reconciliation, this is the MerchantId used at the provider
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

When you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
close

Description

The reason description given for the reversedAmount property.
close

Description

Current high-level status of the payment in a human-readable form. Possible values are :
  • ACCOUNT_VERIFIED - The account has been verified using a validation services like 0$ auth
  • CREATED - The transaction has been created. This is the initial state once a new payment is created.
  • REDIRECTED - The customer has been redirected to a 3rd party to complete the authentication/payment
  • PENDING_PAYMENT - Instructions have been provided and we are now waiting for the money to come in
  • PENDING_FRAUD_APPROVAL - The transaction has been marked for manual review after an automatic fraud screening
  • PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the capturing of the funds
  • PENDING_COMPLETION - The transaction needs to be completed.
  • PENDING_CAPTURE - The transaction is waiting for you to request one or more captures of the funds.
  • REJECTED - The transaction has been rejected
  • AUTHORIZATION_REQUESTED - we have requested an authorization against an asynchronous system and is awaiting its response
  • CAPTURE_REQUESTED - The transaction is in the queue to be captured
  • CAPTURED - The transaction has been captured and we have received online confirmation
  • PAID - We have matched the incoming funds to the transaction
  • CANCELLED - You have cancelled the transaction
  • REJECTED_CAPTURE - We or one of our downstream acquirers/providers have rejected the capture request
  • REVERSED - The transaction has been reversed
  • CHARGEBACK_NOTIFICATION - We have received a notification of chargeback and this status informs you that your account will be debited for a particular transaction
  • CHARGEBACKED - The transaction has been chargebacked
  • REFUNDED - The transaction has been refunded

Please see Statuses for a full overview of possible values.
close

Description

This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource. In case of failed payments and negative scenarios, detailed error information is listed.
  • SDK Object type
    PaymentStatusOutput
close

Description

Custom object contains the set of errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Indicates if the transaction has been authorized
  • true
  • false
close

Description

Flag indicating if the payment can be cancelled
  • true
  • false
close

Description

Flag indicating if the payment can be refunded
  • true
  • false
close

Description

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee
  • true
  • false
close

Description

This is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
close

Description

Highlevel status of the payment, payout or refund with the following possible values:
  • CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses:
    • CREATED
  • PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses:
    • PENDING_PAYMENT
    • REDIRECTED
  • ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses:
    • ACCOUNT_VERIFIED
  • PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses:
    • PENDING_APPROVAL
    • PENDING_COMPLETION
    • PENDING_CAPTURE
    • PENDING_FRAUD_APPROVAL
  • PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses:
    • AUTHORIZATION_REQUESTED
    • CAPTURE_REQUESTED
    • PAYOUT_REQUESTED
    • REFUND_REQUESTED
  • COMPLETED: The transaction has completed. This category groups the following statuses:
    • CAPTURED
    • PAID
    • ACCOUNT_CREDITED
    • CHARGEBACK_NOTIFICATION
  • REVERSED: The transaction has been reversed. This category groups the following statuses:
    • CHARGEBACKED
    • REVERSED
  • REFUNDED: The transaction has been refunded. This category groups the following statuses:
    • REFUNDED
  • UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
    • CANCELLED
    • REJECTED
    • REJECTED_CAPTURE
    • REJECTED_CREDIT

Please see Statuses for a full overview of possible values.
close

Description

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
close

Description

Date and time of payment
Format: YYYYMMDDHH24MISS
close

Description

The 3D Secure status, with the following possible values:
  • ENROLLED: the card is enrolled for 3D Secure authentication. The customer can be redirected to a 3D Secure access control server (ACS)
  • NOT_ENROLLED: the card is not enrolled for 3D Secure authentication
  • INVALID_PARES_OR_NOT_COMPLETED: the PARes is invalid, or the customer did not complete the 3D Secure authentication
  • AUTHENTICATED: the customer has passed the 3D Secure authentication
  • NOT_AUTHENTICATED: the customer failed the 3D Secure authentication
  • NOT_PARTICIPATING: the cardholder has not set up their card for 2-step 3D Secure.
Note that this status will only be set for payments that make use of 2-step 3D Secure.

Response example

SDK: .NET

This scenario you will probably use the most

  • {
        "errorId" : "657b10da-d2f9-4088-a948-bf190ef516b1-000002c5",
        "errors" : [
            {
                "code" : "400540",
                "message" : "SCENARIO_NOT_SUCCESSFUL"
            }
        ],
        "paymentResult" : {
            "creationOutput" : {
                "additionalReference" : "AcmeOrder0001",
                "externalReference" : "AcmeOrder0001"
            },
            "payment" : {
                "id" : "000000850010000188130000200001",
                "paymentOutput" : {
                    "amountOfMoney" : {
                        "amount" : 100,
                        "currencyCode" : "EUR"
                    },
                    "references" : {
                        "merchantReference" : "AcmeOrder0001",
                        "paymentReference" : "0"
                    },
                    "paymentMethod" : "card",
                    "cardPaymentMethodSpecificOutput" : {
                        "paymentProductId" : 1,
                        "card" : {
                            "cardNumber" : "************7977",
                            "expiryDate" : "1299"
                        },
                        "threeDSecureResults" : {
                            "authenticationAmount" : {
                                "currencyCode" : "EUR",
                                "amount" : 100
                            }
                        }
                    }
                },
                "status" : "REJECTED",
                "statusOutput" : {
                    "errors" : [
                        {
                            "code" : "400540",
                            "message" : "SCENARIO_NOT_SUCCESSFUL"
                        }
                    ],
                    "isCancellable" : false,
                    "statusCode" : 100,
                    "statusCodeChangeDateTime" : "20140630154830",
                    "isAuthorized" : false,
                    "isRefundable" : false
                }
            }
        }
    }
    

Response 503 - Service unavailablePaymentErrorResponse

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Object that contains details on the created payment in case one has been created
  • SDK Object type
    CreatePaymentResult
close

Description

Object containing the details of the created payment
  • SDK Object type
    PaymentCreationOutput
close

Description

The additional reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
close

Description

The external reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
close

Description

Indicates whether the customer ticked the "Remember my details for future purchases" checkbox on the MyCheckout hosted payment pages
close

Description

Indicates if a new token was created
  • true - A new token was created
  • false - A token with the same card number already exists and is returned. Please note that the existing token has not been updated. When you want to update other data then the card number, you need to update data stored in the token explicitly, as data is never updated during the creation of a token.
close

Description

ID of the token
close

Description

Indicates if tokenization was successful or not. If this value is false, then the token and isNewToken properties will not be set.
close

Description

Object that contains the action, including the needed data, that you should perform next, like showing instruction, showing the transaction results or redirect to a third party to complete the payment
  • SDK Object type
    MerchantAction
close

Description

Action merchants needs to take in the online payment process. Possible values are:
  • REDIRECT - The customer needs to be redirected using the details found in redirectData
  • SHOW_FORM - The customer needs to be shown a form with the fields found in formFields. You can submit the data entered by the user in a Complete payment request. Additionally:
    • for payment product 3012 (Bancontact), to support payments via the Bancontact app, showData contains a QR code and URL intent.
    • for payment product 863 (WeChat Pay), to support payments via the WeChat app, showData contains a QR code, URL intent, or signature and nonce combination. The showData property describes when each of these values can be returned.
      Note that WeChat Pay does not support completing payments.
  • SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData
  • SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData
  • MOBILE_THREEDS_CHALLENGE - The customer needs to complete a challenge as part of the 3D Secure authentication inside your mobile app. The details contained in mobileThreeDSecureChallengeParameters need to be provided to the EMVco certified Mobile SDK as a challengeParameters object.
  • CALL_THIRD_PARTY - The merchant needs to call a third party using the data found in thirdPartyData
close

Description

Populated only when the actionType of the merchantAction is SHOW_FORM. In this case, this property contains the list of fields to render, in the format that is also used in the response of Get payment product.
close
  • SDK Object type
    PaymentProductField
close

Description

Object containing data restrictions that apply to this field, like minimum and/or maximum length
  • SDK Object type
    PaymentProductFieldDataRestrictions
close

Description

  • true - Indicates that this field is required
  • false - Indicates that this field is optional
close

Description

Object containing the details of the validations on the field
  • SDK Object type
    PaymentProductFieldValidators
close

Description

Indicates the requiredness of the field based on the fiscalnumber for Boleto Bancario
  • SDK Object type
    BoletoBancarioRequirednessValidator
close

Description

When performing a payment with Boleto Bancario, some values are only required when the fiscalnumber has a specific length. The length the fiscalnumber has to have to make the field required is defined here. For example the CompanyName is required when the fiscalnumber is a CNPJ. The firstname and surname are required when the fiscalnumber is a CPF.
close

Description

Indicates that the content should be validated against the rules for an email address
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content should be validated against the rules for an expiration date (it should be in the future)
  • SDK Object type
    EmptyValidator
close

Description

Indicates that content should be one of the, in this object, listed items
  • SDK Object type
    FixedListValidator
close

Description

List of the allowed values that the field will be validated against
close

Description

Indicates that the content of this (iban) field needs to validated against format checks and modulo check (as described in ISO 7064)
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content needs to be validated against length criteria defined in this object
  • SDK Object type
    LengthValidator
close

Description

The maximum allowed length
close

Description

The minimum allowed length
close

Description

Indicates that the content needs to be validated using a LUHN check
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content needs to be validated against a, in this object, defined range
  • SDK Object type
    RangeValidator
close

Description

Upper value of the range that is still valid
close

Description

Lower value of the range that is still valid
close

Description

A string representing the regular expression to check
  • SDK Object type
    RegularExpressionValidator
close

Description

Contains the regular expression that the value of the field needs to be validated against
close

Description

Indicates that the content needs to be validated as per the Chinese resident identity number format
  • SDK Object type
    EmptyValidator
close

Description

Indicates that the content should be validated as such that the customer has accepted the field as if they were terms and conditions of a service
  • SDK Object type
    EmptyValidator
close

Description

Object containing display hints for this field, like the order, mask, preferred keyboard
  • SDK Object type
    PaymentProductFieldDisplayHints
close

Description

  • true - Indicates that this field is advised to be captured to increase the success rates even though it isn't marked as required. Please note that making the field required could hurt the success rates negatively. This boolean only indicates our advise to always show this field to the customer.
  • false - Indicates that this field is not to be shown unless it is a required field.
close

Description

The order in which the fields should be shown (ascending)
close

Description

Object detailing the type of form element that should be used to present the field
  • SDK Object type
    PaymentProductFieldFormElement
close

Description

Type of form element to be used. The following types can be returned:
  • text - A normal text input field
  • list - A list of values that the customer needs to choose from, is detailed in the valueMapping array
  • currency - Currency fields should be split into two fields, with the second one being specifically for the cents
  • boolean - Boolean fields should offer the customer a choice, like accepting the terms and conditions of a product.
  • date - let the customer pick a date.
close

Description

An array of values and displayNames that should be used to populate the list object in the GUI
close
  • SDK Object type
    ValueMappingElement
close

Description

List of extra data of the value.
close
  • SDK Object type
    PaymentProductFieldDisplayElement
close

Description

The ID of the display element.
close

Description

The label of the display element.
close

Description

The type of the display element. Indicates how the value should be presented. Possible values are:
  • STRING - as plain text
  • CURRENCY - as an amount in cents displayed with a decimal separator and the currency of the payment
  • PERCENTAGE - as a number with a percentage sign
  • INTEGER - as an integer
  • URI - as a link
close

Description

the value of the display element.
close
Deprecated: Use displayElements instead with ID 'displayName'

Description

Key name
close

Description

Value corresponding to the key
close

Description

Label/Name of the field to be used in the user interface
close

Description

Link that should be used to replace the '{link}' variable in the label.
close

Description

A mask that can be used in the input field. You can use it to inject additional characters to provide a better user experience and to restrict the accepted character set (illegal characters to be ignored during typing).
* is used for wildcards (and also chars)
9 is used for numbers
Everything outside {{ and }} is used as-is.
close

Description

  • true - The data in this field should be obfuscated as it is entered, just like a password field
  • false - The data in this field does not need to be obfuscated
close

Description

A placeholder value for the form element
close

Description

The type of keyboard that can best be used to fill out the value of this field. Possible values are:
  • PhoneNumberKeyboard - Keyboard that is normally used to enter phone numbers
  • StringKeyboard - Keyboard that is used to enter strings
  • IntegerKeyboard - Keyboard that is used to enter only numerical values
  • EmailAddressKeyboard - Keyboard that allows easier entry of email addresses
close

Description

Object that contains an optional tooltip to assist the customer
  • SDK Object type
    PaymentProductFieldTooltip
close

Description

Relative URL that can be used to retrieve an image for the tooltip image. You can use our server-side resize functionality by appending '?size={{width}}x{{height}}' to the full URL, where width and height are specified in pixels. The resized image will always keep its correct aspect ratio.
close

Description

A text explaining the field in more detail. This is meant to be used for displaying to the customer.
close

Description

The ID of the field
close

Description

The type of field, possible values are:
  • string - Any UTF-8 chracters
  • numericstring - A string that consisting only of numbers. Note that you should strip out anything that is not a digit, but leading zeros are allowed
  • date - Date in the format DDMMYYYY
  • expirydate - Expiration date in the format MMYY
  • integer - An integer
  • boolean - A boolean
close

Description

Indicates that the product can be used in a get customer details call and that when that call is done the field should be supplied as (one of the) key(s) with a valid value.
close

Description

Populated only when the actionType of the merchantAction is MOBILE_THREEDS_CHALLENGE. In this case, this object contains the list of properties to provide to the EMVco certified Mobile SDK as a challengeParameters object.
  • SDK Object type
    MobileThreeDSecureChallengeParameters
close

Description

The unique identifier assigned by the EMVCo Secretariat upon testing and approval.
close

Description

Contains the JWS object created by the ACS for the challenge (ARes).
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer).
close

Description

The 3-D Secure version 2 transaction ID that is used for the 3D Authentication
close

Description

Object containing all data needed to redirect the customer
  • SDK Object type
    RedirectData
close

Description

A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment
close

Description

The URL that the customer should be redirected to. Be sure to redirect using the GET method.
close

Description

This property contains the blob with data for the instructions rendering service.

This service will be available at the following endpoint: http(s)://{{merchant specific subdomain}}.{{base MyCheckout hosted payment pages domain}}/instructions/{{merchantId}}/{{clientSessionId}}

This instructions page rendering service accepts the following parameters:

  • instructionsRenderingData (required, the content of this property)
  • locale (optional, if present overrides default locale, e.g. "en_GB")
  • variant (optional, code of a variant, if present overrides default variant, e.g. "100")
  • customerId (required for Pix, otherwise optional, the customerId from a client session)
You can offer a link to a customer to see an instructions page for a payment done earlier. Because of the size of the instructionsRenderingData this will need to be set in a web form as a value of a hidden field. Before presenting the link you need to obtain a clientSessionId by creating a session using the S2S API. You will need to use the MyCheckout hosted payment pages domain hosted in the same region as the API domain used for the createClientSession call.

The instructionsRenderingData is a String blob that is presented to you via the Server API as part of the merchantAction (if available, and non-redirect) in the JSON return values for the createPayment call or the getHostedCheckoutStatus call (merchantAction inside createdPaymentOutput when available). You are responsible to store the instructionsRenderingData blob in order to be able to present the instructions page at a later time, when this information might no longer be available through Server API calls.

close

Description

This is returned for the SHOW_INSTRUCTION, the SHOW_TRANSACTION_RESULTS and the SHOW_FORM actionType.
When returned for SHOW_TRANSACTION_RESULTS or SHOW_FORM, this contains an array of key value pairs of data that needs to be shown to the customer.
Note: The returned value for the key BARCODE is a base64 encoded gif image. By prepending 'data:image/gif;base64,' this value can be used as the source of an HTML inline image.

For SHOW_FORM, for payment product 3012 (Bancontact), this contains a QR code and a URL intent that can be used to complete the payment in the Bancontact app.
In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by an Android device with the Bancontact app). The key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on an Android device.

For SHOW_FORM, for payment product 863 (WeChat Pay), this contains the PaymentId that WeChat has assigned to the payment. In this case, the key WECHAT_PAYMENTID contains this PaymentId. In addition, this can contain different values depending on the integration type:
  • desktopQRCode - contains a QR code that can be used to complete the payment in the WeChat app. In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by a mobile device with the WeChat app).
  • urlIntent - contains a URL intent that can be used to complete the payment in the WeChat app. In this case, the key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on a mobile device.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
close

Description

This is returned for the CALL_THIRD_PARTY actionType.
The payment product specific field of the payment product used for the payment will be populated with the third party data that should be used when calling the third party.
  • SDK Object type
    ThirdPartyData
close

Description

Contains the third party data for payment product 863 (WeChat Pay).
  • SDK Object type
    PaymentProduct863ThirdPartyData
close

Description

The appId to use in third party calls to WeChat.
close

Description

The nonceStr to use in third party calls to WeChat
close

Description

The packageSign to use in third party calls to WeChat
close

Description

The paySign to use in third party calls to WeChat
close

Description

The prepayId to use in third party calls to WeChat.
close

Description

The signType to use in third party calls to WeChat
close

Description

The timeStamp to use in third party calls to WeChat
close

Description

Object that holds the payment related properties
  • SDK Object type
    Payment
close

Description

Hosted Checkout specific information. Populated if the payment was created on the GlobalCollect platform through a Hosted Checkout.
  • SDK Object type
    HostedCheckoutSpecificOutput
close

Description

The ID of the Hosted Checkout Session in which the payment was made.
close

Description

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your hosted mandate pages in a controlled manner. Please note that you need to specify the ID of the variant.
close

Description

Our unique payment transaction identifier.
close

Description

Object containing payment details
  • SDK Object type
    PaymentOutput
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Amount that has been paid
close

Description

Amount that has been reversed
close

Description

Object containing the bank transfer payment method details
  • SDK Object type
    BankTransferPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the card payment method details
  • SDK Object type
    CardPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
close

Description

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available
close

Description

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available
close

Description

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.
close

Description

Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
  • SDK Object type
    FraugsterResults
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
close

Description

The unique scheme transactionId of the initial transaction that was performed with SCA.
Should be stored by the merchant to allow it to be submitted in future transactions.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

The unique scheme transactionId of this transaction.
Should be stored by the merchant to allow it to be submitted in future transactions. Use this value in case the initialSchemeTransactionId property is empty.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
close

Description

Method of authentication used for this transaction. Possible values:
  • frictionless = The authentication went without a challenge
  • challenged = Cardholder was challenged
  • avs-verified = The authentication was verified by AVS
  • other = Another issuer method was used to authenticate this transaction
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
close

Description

If a token was used for or created during the payment, then the ID of that token.
close

Description

Object containing the cash payment method details
  • SDK Object type
    CashPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the non SEPA direct debit payment method details
  • SDK Object type
    NonSepaDirectDebitPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the e-invoice payment method details
  • SDK Object type
    EInvoicePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

AfterPay Installments (payment product 9000) specific details
  • SDK Object type
    EInvoicePaymentProduct9000SpecificOutput
close

Description

The ID of the installment plan used for the payment.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the invoice payment method details
  • SDK Object type
    InvoicePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the mobile payment method details
  • SDK Object type
    MobilePaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
close

Description

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available
close

Description

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available
close

Description

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.
close

Description

Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
  • SDK Object type
    FraugsterResults
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
close

Description

The network that was used for the refund
close

Description

Object containing payment details
  • SDK Object type
    MobilePaymentData
close

Description

The obfuscated DPAN. Only the last four digits are visible.
close

Description

Expiry date of the tokenized card
Format: MMYY
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
close

Description

The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
close

Description

Method of authentication used for this transaction. Possible values:
  • frictionless = The authentication went without a challenge
  • challenged = Cardholder was challenged
  • avs-verified = The authentication was verified by AVS
  • other = Another issuer method was used to authenticate this transaction
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
close

Description

Object containing the redirect payment product details
  • SDK Object type
    RedirectPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object that holds the Basic Bank Account Number (BBAN) data
  • SDK Object type
    BankAccountBban
close

Description

Name of the account holder
close

Description

Bank account number
close

Description

Bank code
close

Description

Name of the bank
close

Description

Branch code
close

Description

Bank check digit
close

Description

ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
close

Description

Object containing account holder name and IBAN information
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
close

Description

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
close

Description

The BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank or even branch. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

PostFinance Card (payment product 3201) specific details
  • SDK Object type
    PaymentProduct3201SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Trustly (payment product 806) specific details
  • SDK Object type
    PaymentProduct806SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the account details
  • SDK Object type
    TrustlyBankAccount
close

Description

The last digits of the account number
close

Description

The name of the bank
close

Description

The country of the clearing house
close

Description

The ID number of the account holder
close

Description

Sofort (payment product 836) specific details
  • SDK Object type
    PaymentProduct836SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Indicates if SofortBank could estabilish if the transaction could successfully be processed.
  • 0 - You should wait for the transaction to be reported as paid before shipping any goods.
  • 1 - You can ship the goods. In case the transaction is not reported as paid you can initiate a claims process with SofortBank.
close

Description

PayPal (payment product 840) specific details
  • SDK Object type
    PaymentProduct840SpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the details of the PayPal account
  • SDK Object type
    PaymentProduct840CustomerAccount
close

Description

Username with which the PayPal account holder has registered at PayPal
close

Description

Identification of the PayPal recurring billing agreement
close

Description

Name of the company in case the PayPal account is owned by a business
close

Description

The phone number of the PayPal account holder
close

Description

Country where the PayPal account is located
close

Description

Status of the PayPal account.
Possible values are:
  • verified - PayPal has verified the funding means for this account
  • unverified - PayPal has not verified the funding means for this account
close

Description

Status of the customer's shipping address as registered by PayPal
Possible values are:
  • none - Status is unknown at PayPal
  • confirmed - The address has been confirmed
  • unconfirmed - The address has not been confirmed
close

Description

First name of the PayPal account holder
close

Description

The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
close

Description

Surname of the PayPal account holder
close

Description

Object containing the address details of the customer
  • SDK Object type
    Address
close

Description

Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
Notes:
  • The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform
  • The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform
  • The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Protection Eligibility data of the PayPal customer
  • SDK Object type
    ProtectionEligibility
close

Description

Possible values:
  • Eligible
  • PartiallyEligible
  • Ineligible
close

Description

Possible values:
  • ItemNotReceivedEligible
  • UnauthorizedPaymentEligible
  • Ineligible
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

ID of the token. This property is populated when the payment was done with a token or when the payment was tokenized.
close

Description

Object containing the SEPA direct debit details
  • SDK Object type
    SepaDirectDebitPaymentMethodSpecificOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
close

Description

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
close

Description

The type of device used by the customer. Example values:
  • SMARTPHONE
  • PERSONAL_COMPUTER
  • TABLET
  • WEARABLE_COMPUTER
  • GAME_CONSOLE
  • SMART_TV
  • PDA
  • OTHER
  • UNKNOWN
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
close

Description

The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
close

Description

This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
  • SDK Object type
    MicrosoftFraudResults
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
close

Description

This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
close

Description

Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Output that is SEPA Direct Debit specific (i.e. the used mandate)
  • SDK Object type
    PaymentProduct771SpecificOutput
close

Description

Unique reference to a Mandate
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

ID of the token. This property is populated for the GlobalCollect payment platform when the payment was done with a token or when the payment was tokenized.
close

Description

Payment method identifier used by the our payment engine with the following possible values:
  • bankRefund
  • bankTransfer
  • card
  • cash
  • directDebit
  • eInvoice
  • invoice
  • redirect
close

Description

Object that holds all reference properties that are linked to this transaction
  • SDK Object type
    PaymentReferences
close

Description

Your order ID for this transaction that is also returned in our report files
close

Description

Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
close

Description

Payment Reference generated by WebCollect
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

Provides an additional means of reconciliation, this is the MerchantId used at the provider
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

When you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
close

Description

The reason description given for the reversedAmount property.
close

Description

Current high-level status of the payment in a human-readable form. Possible values are :
  • ACCOUNT_VERIFIED - The account has been verified using a validation services like 0$ auth
  • CREATED - The transaction has been created. This is the initial state once a new payment is created.
  • REDIRECTED - The customer has been redirected to a 3rd party to complete the authentication/payment
  • PENDING_PAYMENT - Instructions have been provided and we are now waiting for the money to come in
  • PENDING_FRAUD_APPROVAL - The transaction has been marked for manual review after an automatic fraud screening
  • PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the capturing of the funds
  • PENDING_COMPLETION - The transaction needs to be completed.
  • PENDING_CAPTURE - The transaction is waiting for you to request one or more captures of the funds.
  • REJECTED - The transaction has been rejected
  • AUTHORIZATION_REQUESTED - we have requested an authorization against an asynchronous system and is awaiting its response
  • CAPTURE_REQUESTED - The transaction is in the queue to be captured
  • CAPTURED - The transaction has been captured and we have received online confirmation
  • PAID - We have matched the incoming funds to the transaction
  • CANCELLED - You have cancelled the transaction
  • REJECTED_CAPTURE - We or one of our downstream acquirers/providers have rejected the capture request
  • REVERSED - The transaction has been reversed
  • CHARGEBACK_NOTIFICATION - We have received a notification of chargeback and this status informs you that your account will be debited for a particular transaction
  • CHARGEBACKED - The transaction has been chargebacked
  • REFUNDED - The transaction has been refunded

Please see Statuses for a full overview of possible values.
close

Description

This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource. In case of failed payments and negative scenarios, detailed error information is listed.
  • SDK Object type
    PaymentStatusOutput
close

Description

Custom object contains the set of errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Indicates if the transaction has been authorized
  • true
  • false
close

Description

Flag indicating if the payment can be cancelled
  • true
  • false
close

Description

Flag indicating if the payment can be refunded
  • true
  • false
close

Description

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee
  • true
  • false
close

Description

This is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
close

Description

Highlevel status of the payment, payout or refund with the following possible values:
  • CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses:
    • CREATED
  • PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses:
    • PENDING_PAYMENT
    • REDIRECTED
  • ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses:
    • ACCOUNT_VERIFIED
  • PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses:
    • PENDING_APPROVAL
    • PENDING_COMPLETION
    • PENDING_CAPTURE
    • PENDING_FRAUD_APPROVAL
  • PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses:
    • AUTHORIZATION_REQUESTED
    • CAPTURE_REQUESTED
    • PAYOUT_REQUESTED
    • REFUND_REQUESTED
  • COMPLETED: The transaction has completed. This category groups the following statuses:
    • CAPTURED
    • PAID
    • ACCOUNT_CREDITED
    • CHARGEBACK_NOTIFICATION
  • REVERSED: The transaction has been reversed. This category groups the following statuses:
    • CHARGEBACKED
    • REVERSED
  • REFUNDED: The transaction has been refunded. This category groups the following statuses:
    • REFUNDED
  • UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
    • CANCELLED
    • REJECTED
    • REJECTED_CAPTURE
    • REJECTED_CREDIT

Please see Statuses for a full overview of possible values.
close

Description

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
close

Description

Date and time of payment
Format: YYYYMMDDHH24MISS
close

Description

The 3D Secure status, with the following possible values:
  • ENROLLED: the card is enrolled for 3D Secure authentication. The customer can be redirected to a 3D Secure access control server (ACS)
  • NOT_ENROLLED: the card is not enrolled for 3D Secure authentication
  • INVALID_PARES_OR_NOT_COMPLETED: the PARes is invalid, or the customer did not complete the 3D Secure authentication
  • AUTHENTICATED: the customer has passed the 3D Secure authentication
  • NOT_AUTHENTICATED: the customer failed the 3D Secure authentication
  • NOT_PARTICIPATING: the cardholder has not set up their card for 2-step 3D Secure.
Note that this status will only be set for payments that make use of 2-step 3D Secure.

Response example

SDK: .NET

This scenario you will probably use the most

  • {
        "errorId" : "79d32fb5-f7e0-4725-891b-26a63a5e6b2e",
        "errors" : [
            {
                "code" : "23000000",
                "message" : "COULD NOT CONNECT TO THIRD PARTY"
            }
        ],
        "paymentResult" : {
            "creationOutput" : {
                "additionalReference" : "00000200002014292826",
                "externalReference" : "000002000020142928260000100001"
            },
            "payment" : {
                "id" : "000002000020142928260000100001",
                "paymentOutput" : {
                    "amountOfMoney" : {
                        "amount" : 2345,
                        "currencyCode" : "EUR"
                    },
                    "references" : {
                        "paymentReference" : "200001900929"
                    },
                    "paymentMethod" : "redirect",
                    "redirectPaymentMethodSpecificOutput" : {
                        "paymentProductId" : 816,
                        "bankAccountIban" : {
                            "iban" : "DE46720200700359736690"
                        }
                    }
                },
                "status" : "REJECTED",
                "statusOutput" : {
                    "errors" : [
                        {
                            "code" : "23000000",
                            "message" : "COULD NOT CONNECT TO THIRD PARTY"
                        }
                    ],
                    "isCancellable" : false,
                    "statusCode" : 100,
                    "statusCodeChangeDateTime" : "20150714164930",
                    "isAuthorized" : false
                }
            }
        }
    }