Order update

POST

https://api.forter-secure.com/v2/order-update/{id}

For orders placed over the phone, add the customer's connection information to receive a fraud or abuse decision.

Path Parameters

idstringrequired

Header Parameters

api-versionstringrequired
Example
10.3
Description
Specify the version of the API to target.
x-forter-siteidstringrequired
Example
a1b2c3d4e5f6
Description
Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.

Body Parameters

bodyvalidationUpdateRequestrequired
Description
For orders placed over the phone, add the customer's connection information to receive a fraud or abuse decision.
- connectionInformationobject
  - ConnectionInformation
    - checkoutToolsSessionIdstring
      Example
      HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd
      Description
      CheckoutToolsSessionId received from the SDK
      Max Length
      128
    - customerIPstringrequired
      Example
      10.0.0.127
      Description
      Customer IP address in IPv4 or IPv6 format. If missing should be populated with 127.0.0.1
    - forterMobileUIDstring
      Example
      6429751237891
      Description
      Conditional.
      mobile UID. The device identifier such as IMEI in android or identifier for vendor in iOS. This should match the deviceId sent via the mobile events API (for mobile transactions only)
      Max Length
      128
    - forterTokenCookiestring
      Example
      249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg
      Description
      Conditional. Forter token cookie from request headers
      Max Length
      128
    - merchantDeviceIdentifierstring
      Example
      HGJ7512345H3
      Description
      Conditional. A unique device identifier generated by merchant
      Max Length
      100
    - merchantProvidedSessionIdstring
      Example
      HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd
      Description
      An identifier of the merchant session
      Max Length
      128
    - userAgentstringrequired
      Example
      Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36
      Description
      Customer's User agent
      Max Length
      4096
- merchantFeedbackobject
  - MerchantFeedback
    - agentGeneralImpression
      Example
      I_DONT_KNOW
      Description
      Conditional.
      What is your general impression of the customer following your interaction/analysis (do you believe he is suspicious? do you believe he is legitimate?)
      Allowed
      CUSTOMER_IS_LEGITI_DONT_KNOWCUSTOMER_IS_SUSPICIOUS
      Max Length
      75
    - doesNotAffectFutureDecisionsboolean
      Description
      A property to allow the Forter dashboard to receive information from the risk agent in case the agent adds information for training the model with more data, without triggering a decision change
    - feedbackAppliesToAllFutureDecisionsUntilnumber
      Example
      1430997968
      Description
      Until this timestamp (epoch seconds), the feedback will apply to all future transactions of this type
    - isFutureDecisionboolean
      Description
      Use the new decision only for next order sent by the user. The current order fulfillment status will not change due to the new decision provided.
    - isPolicyApproveboolean
      Description
      Set to true if the customer has been previously declined, but should be approved as a matter of policy in their next transaction.
    - merchantCustomerSupportobject
      - ContactWithCustomer
        contactCustomerIPstring
        Example
        10.0.0.127
        Description
        Conditional. Customer IP address used to contact the merchant in IPv4 or IPv6 format. Typically available when customer contact is via chat
        contactEmailUsedobject
        MerchantContactedCustomerEmail
        merchantContactedEmailstring
        Example
        [email protected]
        Description
        email used to contact the customer (if not one of the emails used in the order)
        Max Length
        75
        merchantContactedEmailRole
        Example
        BILLING_EMAIL
        Description
        I used the following phone to contact the customer
        Allowed
        BILLING_EMAILSHIPPING_EMAILACCOUNT_EMAILOTHER_EMAILNA
        contactMethodTyperequired
        Example
        PHONE
        Description
        Method used by customer to contact support
        Allowed
        PHONEEMAILCHATSUPPORT_FORM
        contactNameUsedobject
        MerchantContactedCustomerName
        customerContactNameTyperequired
        Example
        OTHER
        Description
        The role of the contact (name) that interacted with customer support.
        Allowed
        CARDHOLDERBILLING_NAMESHIPPING_NAMEACCOUNT_HOLDEROTHERNA
        customerFirstNamestring
        Example
        John
        Description
        Conditional. First name of the person who contacted the merchant's customer support
        Max Length
        75
        customerLastNamestring
        Example
        Smith
        Description
        Conditional. Last name of the person who contacted the merchant's customer support
        Max Length
        75
        contactPhoneUsedobject
        MerchantContactedCustomerPhone
        merchantContactedPhoneNumberstring
        Example
        212-555-5555
        Description
        Phone number used (if not one of the phones used in the order)
        merchantContactedPhoneRole
        Example
        BILLING_PHONE
        Description
        I used the following phone to contact the customer
        Allowed
        BILLING_PHONESHIPPING_PHONEACCOUNT_PHONEOTHER_PHONENA
        contactTimenumberrequired
        Example
        1430997968
        Description
        Time of the latest consumer communication with customer support (e.g. a support ticket was submitted or a merchant agent reached out to the consumer) in seconds since unix epoch (UTC, Jan 1, 1970)
        customerSupportChangeOrderDetailsobject
        CustomerSupportChangeOrderDetails
        customerSupportRequestPickupFromShippingCarrierboolean
        Description
        The customer would like to pick up his order from the shipping carrier
        customerSupportRequestPickupStoreZipstring
        Example
        94104
        Description
        The customer would like to pick up his order from the store located at this zipcode
        Max Length
        20
        customerSupportRequestSwitchBillingAndShippingboolean
        Description
        The customer accidentally typed the shipping address as the billing address. Would like to switch them.
        customerSupportFurtherVerificationobject
        CustomerSupportFurtherVerification
        customerAnsweredSecurityQuestionsbooleanrequired
        Example
        true
        Description
        The customer successfully answered security questions that only the cardholder should be able to answer
        customerSupportAdditionalVerificationDocumentsobject
        CustomerSupportAdditionalVerificationDocuments
        documentFirstNamestring
        Example
        John
        Description
        First name as appears on the document
        Max Length
        75
        documentLastNamestring
        Example
        Smith
        Description
        Last name as appears on the document
        Max Length
        75
        documentTypestringrequired
        Example
        Passport
        Description
        Type of document (Passport, ID, Driving license)
        Max Length
        35
        documentVerifiedboolean
        Example
        true
        Description
        Conditional. True if document was verified as authentic by merchant or 3rd party service
        nationalitystring
        Example
        US
        Description
        Conditional. Document holder's nationality
        Max Length
        25
        customerSupportSMSverificationstring
        Example
        +1-212-555-5555
        Description
        The customer successfully SMS-verified this phone number
        Max Length
        50
        initiatedByrequired
        Example
        CUSTOMER
        Description
        The initiator of the interaction
        Allowed
        MERCHANTCUSTOMER
        orderIdstring
        Example
        4306795
        Description
        Unique order id that the service ticket refers to. Should match the order id sent to Forter at checkout. Note that Forter treats this ID as case-insensitive; Order123 and ORDER123 will be identified as the same order.
        Max Length
        40
        ticketIdstring
        Example
        4306795
        Description
        Customer service ticket identifier
        Max Length
        50
    - merchantWouldLikeApprovedobject
      - MerchantRiskAnalysisAdditionalPositiveIndicators
        merchantContactedIssuerobject
        merchantContactedIssuer
        accessToBankAccountVerifiedByCustomerboolean
        Description
        Using a strong verification method, the customer has verified access to the bank account
        issuerNameOnCardMatch
        Example
        UNKNOWN
        Description
        According to the issuing bank, the cardholder's name matches their records
        Allowed
        MATCHMISMATCHDID_NOT_CHECKUNKNOWNNA
        issuerPhoneMatch
        Example
        UNKNOWN
        Description
        According to the issuing bank, the billing phone matches their records
        Allowed
        MATCHMISMATCHDID_NOT_CHECKUNKNOWNNA
        issuerStreetAddressMatch
        Example
        UNKNOWN
        Description
        According to the issuing bank, the billing street address matches their records
        Allowed
        MATCHMISMATCHDID_NOT_CHECKUNKNOWNNA
        issuerZipMatch
        Example
        UNKNOWN
        Description
        According to the issuing bank, the billing zip code matches their records
        Allowed
        MATCHMISMATCHDID_NOT_CHECKUNKNOWNNA
        merchantDisagreesWithSpecificDeclineReasonobject
        MerchantSpecificReasonFeedback
        atoIsIrrelevantobject
        MerchantAccountTakeOverFeedback
        confirmedValidAccountOwnerUsingOldEmailboolean
        Description
        I was able to confirm this order with the original account holder (or they contacted me) using the original EMAIL ADDRESS connected to the account
        confirmedValidAccountOwnerUsingOldPhoneboolean
        Description
        I was able to confirm this order with the original account holder (or they contacted me) using the original PHONE connected to the account
        notATOBecauseOfOtherReasonstring
        Example
        Password wasn't reset
        Description
        I don't think this is an Account Take Over because of a different reason
        notATOBecauseOldDeviceUsedboolean
        Description
        I don't think this is an Account Take Over since the same or similar device is used as has been in previous orders by the original account holder
        notATOBecauseOldIPUsedboolean
        Description
        I don't think this is an Account Take Over since the same or similar IP is used as has been in previous orders by the original account holder
        notATOBecauseSimilarItemPurchasedboolean
        Description
        I don't think this is an Account Take Over since the purchasing patterns are similar to those of the original account holder (same item, similar amounts and frequency, etc.)
        chbkIsIrrelevantobject
        MerchantChargebackFeedback
        cannotFindRelatedChargebacksboolean
        Description
        I can't find any chargeback related to this order or account
        chbksResolvedboolean
        Description
        The chargebacks connected to this account were not truly fraud-related, and were already resolved with the customer
        chbksResolvedOrderIdsstring[]
        Description
        These are the IDs of the resolved chargebacks. After removing these chargebacks, they will no longer be covered by Forter, since they will be considered service-related
        couponAbuseIsIrrelevantboolean
        Description
        This was declined because of suspected coupon abuse, but I think this is a legitimate use of coupons and would like to approve
        multipleLinksAreIrrelevantboolean
        Description
        Could not find multiple accounts related to this account holder (available only for account feedback)
        policyNotApplicableboolean
        Description
        This is marked as a merchant policy decline, but I don't think the policy is applicable here (e.g. a US order being declined under a international order blocking policy)
        merchantFoundBuyerExposureobject
        MerchantFoundBuyerExposure
        customerSignedInUsingLegitSocialNetworkAccountobject
        CustomerRegistrationSources
        facebookboolean
        Description
        Facebook
        Max Length
        50
        googleboolean
        Description
        Google
        Max Length
        50
        linkedinboolean
        Description
        LinkedIn
        Max Length
        50
        otherSocialNetworkstring
        Example
        VK
        Description
        Other Social Network
        Max Length
        50
        paypalboolean
        Description
        PayPal
        Max Length
        50
        twitterboolean
        Description
        Twitter
        Max Length
        50
        merchantFoundBuyerEmailOnlineobject
        MerchantExposureSources
        facebookboolean
        Description
        Facebook
        Max Length
        50
        googlePlusboolean
        Description
        Google+
        Max Length
        50
        googleSearchboolean
        Description
        Online search (Google, Bing, etc.)
        Max Length
        50
        linkedinboolean
        Description
        LinkedIn
        Max Length
        50
        otherSocialNetworkboolean
        Description
        Other Social Network
        Max Length
        50
        otherSourcestring
        Example
        SearchPerson.com
        Description
        Other
        Max Length
        50
        whitePagesboolean
        Description
        White Pages
        Max Length
        50
        merchantFoundBuyerPhoneNumberOnlineobject
        MerchantExposureSources
        facebookboolean
        Description
        Facebook
        Max Length
        50
        googlePlusboolean
        Description
        Google+
        Max Length
        50
        googleSearchboolean
        Description
        Online search (Google, Bing, etc.)
        Max Length
        50
        linkedinboolean
        Description
        LinkedIn
        Max Length
        50
        otherSocialNetworkboolean
        Description
        Other Social Network
        Max Length
        50
        otherSourcestring
        Example
        SearchPerson.com
        Description
        Other
        Max Length
        50
        whitePagesboolean
        Description
        White Pages
        Max Length
        50
        merchantFoundConnectionBetweenIndividualsInTheOrderNameAndNameConnectionrequired
        Description
        I was able to find a connection between the cardholder and the recipient of the order -
        connectionType
        Example
        FAMILY
        Description
        These people are connected because they are -
        Allowed
        FAMILYFRIENDSHAVE_A_PERSONAL_RELATIONSHIPWORK_TOGETHERHAVE_A_BUSINESS_RELATIONSHIPNA
        Max Length
        50
        dataSourceobject
        MerchantNameDataSources
        googleSearchboolean
        Description
        Online search (Google, Bing, etc.)
        Max Length
        50
        otherSourcestring
        Example
        SearchPerson.com
        Description
        Other
        Max Length
        50
        socialNetworkboolean
        Description
        Social Network
        Max Length
        50
        whitePagesboolean
        Description
        White Pages
        Max Length
        50
        nameRole1
        Example
        CARDHOLDER
        Description
        I was able to connect this person -
        Allowed
        CARDHOLDERBILLING_NAMESHIPPING_NAMEACCOUNT_HOLDEROTHERNA
        Max Length
        50
        nameRole2
        Example
        SHIPPING_NAME
        Description
        To this person -
        Allowed
        CARDHOLDERBILLING_NAMESHIPPING_NAMEACCOUNT_HOLDEROTHERNA
        Max Length
        50
        merchantFoundConnectionBetweenNameAndAddressAddressAndNameConnectionrequired
        Description
        I was able to find a connection between some of the addresses in the order and some of the names -
        addressRole
        Example
        SHIPPING_ADDRESS
        Description
        I was able to connect this address -
        Allowed
        SHIPPING_ADDRESSBILLING_ADDRESSNA
        Max Length
        50
        dataSourceobject
        MerchantAddressDataSources
        googleSearchboolean
        Description
        Online search (Google, Bing, etc.)
        Max Length
        50
        otherSourcestring
        Example
        SearchPerson.com
        Description
        Other
        Max Length
        50
        whitePagesboolean
        Description
        White Pages
        Max Length
        50
        nameRole
        Example
        CARDHOLDER
        Description
        To this name -
        Allowed
        CARDHOLDERBILLING_NAMESHIPPING_NAMEACCOUNT_HOLDEROTHERNA
        Max Length
        50
        merchantFoundLegitShippingAddress
        Description
        I was able to identify the order's shipping address as a non-fraud indication
        Allowed
        AN_OFFICE_OR_OTHER_WORKPLACE_RELATED_TO_THE_CUSTOMERA_MILITARY_OR_OTHER_GOVERNMENT_FACILITY_OR_INSTITUTIONSHIPPING_ADDRESS_IS_SAME_AS_BILLING_ADDRESS_AND_AVS_CHECK_MATCHESNA
        merchantFoundRecipientEmailOnlineobject
        MerchantExposureSources
        facebookboolean
        Description
        Facebook
        Max Length
        50
        googlePlusboolean
        Description
        Google+
        Max Length
        50
        googleSearchboolean
        Description
        Online search (Google, Bing, etc.)
        Max Length
        50
        linkedinboolean
        Description
        LinkedIn
        Max Length
        50
        otherSocialNetworkboolean
        Description
        Other Social Network
        Max Length
        50
        otherSourcestring
        Example
        SearchPerson.com
        Description
        Other
        Max Length
        50
        whitePagesboolean
        Description
        White Pages
        Max Length
        50
        merchantFoundRecipientPhoneNumberOnlineobject
        MerchantExposureSources
        facebookboolean
        Description
        Facebook
        Max Length
        50
        googlePlusboolean
        Description
        Google+
        Max Length
        50
        googleSearchboolean
        Description
        Online search (Google, Bing, etc.)
        Max Length
        50
        linkedinboolean
        Description
        LinkedIn
        Max Length
        50
        otherSocialNetworkboolean
        Description
        Other Social Network
        Max Length
        50
        otherSourcestring
        Example
        SearchPerson.com
        Description
        Other
        Max Length
        50
        whitePagesboolean
        Description
        White Pages
        Max Length
        50
        merchantPolicyDecisionNotApplicableobject
        merchantPolicyDecisionNotApplicable
        inrAbuseNotApplicableboolean
        Description
        INR Abuse - INR/Refund abuse policy is not applicable
        multipleLinksPolicyNotApplicableboolean
        Description
        Multiple Account Abuse - Merchant unique account policy is not applicable
        promotionAbuseNotApplicableboolean
        Description
        Promotion Abuse - Promotion abuse policy is not applicable
        resellerAbuseNotApplicableboolean
        Description
        Reseller Abuse - Reseller abuse policy is not applicable
        returnsAbuseNotApplicableboolean
        Description
        Returns Abuse - Returns abuse policy is not applicable
        merchantThinksOrderCharacteristicsAreLegitobject
        GoodOrderCharachteristicsAccordingToMerchant
        goodCustomerobject
        GoodCustomerAccordingToMerchant
        establishedAccountobject
        MerchantConsidersAccountEstablished
        establishedAccountDetailsobject
        EstablishedAccountDetails
        Max depth limit reached
        relatedAccountDetailsobject
        AccountIdentifiersForMerchant
        Max depth limit reached
        relatedToAnEstablishedAccountboolean
        Description
        The account that created this order is related to a well established account
        thisIsAnEstablishedAccountboolean
        Description
        The account that created this order is a well established account
        forterPreviouslyApprovedboolean
        Description
        Forter previously approved this customer
        knowCustomerPersonally
        Description
        I know this customer personally (company employee, family member, etc.)
        Allowed
        COMPANY_EMPLOYEE_OR_RELATED_TO_ONECOMPANY_BUSINESS_ASSOCIATE_OR_SERVICE_PROVIDERTESTING_ACCOUNTOTHERNA
        merchantHasGoodScoreElsewhere
        Example
        INTERNAL_SCORE
        Description
        This order has a good score on another fraud tool (internal or 3rd party) and I think it is probably a good order
        Allowed
        INTERNAL_SCORETHIRD_PARTY_TOOLNA
        previousPointOfSalePurchaseobject
        PastPointOfSalePurchase
        madePointOfSalePurchaseboolean
        Description
        Customer made purchases in a physical store in the past
        pointOfSalePurchaseStatestring
        Example
        NY
        Description
        Purchase was made in a store located in the following state / region
        pointOfSalePurchaseZipstring
        Example
        10001
        Description
        Purchase was made in a store located in the following zipcode
        lowRiskItemboolean
        Description
        In our experience, the item purchased is a low-risk item
        lowRiskPaymentMethodobject
        LowRiskPaymentMethodsAccordingToMerchant
        giftCardboolean
        Description
        Gift Card
        otherstring
        Example
        Apple Pay
        Description
        Other payment method
        storeCreditboolean
        Description
        Store Credit
        wireTransferboolean
        Description
        Wire transfer or other direct forms of payment
    - merchantWouldLikeDeclinedobject
      - MerchantRiskAnalysisAdditionalNegativeIndicators
        fraudTypeSuspectedByMerchantobject
        FraudTypeSuspectedByMerchant
        merchantInrAbuseType
        Description
        INR Abuse type as labeled by the merchant
        Allowed
        HIGHLIGHTEDPREVENTED
        merchantReceivedFraudAlertboolean
        Description
        Fraud Alert - Merchant was notified by a 3rd party tool or other source that the order is fraudulent
        merchantSuspectsAccountTakeOverobject
        ReasonMerchantSuspectsFraud
        merchantSuspectsAccountDetailsobject
        SuspiciousAccountDetails
        accountDetailsWereChangedboolean
        Example
        true
        Description
        Account details were recently changed in a way that is suspicious
        highVelocityboolean
        Example
        true
        Description
        Purchase frequency and amount is too high, and is likely fraudulent
        inactiveAccountboolean
        Example
        true
        Description
        Account was inactive for a very long time and is now displaying suspicious behaviour
        linkedToMultipleAccountsboolean
        Example
        true
        Description
        Identified multiple accounts linked to this account holder (available only for account feedback)
        otherboolean
        Example
        true
        Description
        Other (available only for account feedback)
        merchantSuspectsOrderDetailsobject
        SuspiciousOrderDetails
        badItemboolean
        Example
        true
        Description
        Item purchased is a strong fraud indicator
        badShippingAddressboolean
        Example
        true
        Description
        Shipping address seems suspicious
        fakeEmailboolean
        Example
        true
        Description
        The email seems fake, or related to a suspicious persona, or to a person completely unrelated to the order
        otherboolean
        Example
        true
        Description
        Other (this option will only be open for account feedback)
        merchantWasContactedByVictimboolean
        Description
        The victim of this fraud attempt contacted us to complain (cardholder, or account owner in case of account takeover)
        merchantSuspectsBuyerSellerCollusionobject
        ReasonMerchantSuspectsFraud
        merchantSuspectsAccountDetailsobject
        SuspiciousAccountDetails
        accountDetailsWereChangedboolean
        Example
        true
        Description
        Account details were recently changed in a way that is suspicious
        highVelocityboolean
        Example
        true
        Description
        Purchase frequency and amount is too high, and is likely fraudulent
        inactiveAccountboolean
        Example
        true
        Description
        Account was inactive for a very long time and is now displaying suspicious behaviour
        linkedToMultipleAccountsboolean
        Example
        true
        Description
        Identified multiple accounts linked to this account holder (available only for account feedback)
        otherboolean
        Example
        true
        Description
        Other (available only for account feedback)
        merchantSuspectsOrderDetailsobject
        SuspiciousOrderDetails
        badItemboolean
        Example
        true
        Description
        Item purchased is a strong fraud indicator
        badShippingAddressboolean
        Example
        true
        Description
        Shipping address seems suspicious
        fakeEmailboolean
        Example
        true
        Description
        The email seems fake, or related to a suspicious persona, or to a person completely unrelated to the order
        otherboolean
        Example
        true
        Description
        Other (this option will only be open for account feedback)
        merchantWasContactedByVictimboolean
        Description
        The victim of this fraud attempt contacted us to complain (cardholder, or account owner in case of account takeover)
        merchantSuspectsCouponAbuseboolean
        Description
        Promotion Abuse - I believe this order was made by an individual trying to abuse our coupon policy (e.g. signing up with new accounts to get more coupons)
        merchantSuspectsFraudOtherobject
        ReasonMerchantSuspectsFraud
        merchantSuspectsAccountDetailsobject
        SuspiciousAccountDetails
        accountDetailsWereChangedboolean
        Example
        true
        Description
        Account details were recently changed in a way that is suspicious
        highVelocityboolean
        Example
        true
        Description
        Purchase frequency and amount is too high, and is likely fraudulent
        inactiveAccountboolean
        Example
        true
        Description
        Account was inactive for a very long time and is now displaying suspicious behaviour
        linkedToMultipleAccountsboolean
        Example
        true
        Description
        Identified multiple accounts linked to this account holder (available only for account feedback)
        otherboolean
        Example
        true
        Description
        Other (available only for account feedback)
        merchantSuspectsOrderDetailsobject
        SuspiciousOrderDetails
        badItemboolean
        Example
        true
        Description
        Item purchased is a strong fraud indicator
        badShippingAddressboolean
        Example
        true
        Description
        Shipping address seems suspicious
        fakeEmailboolean
        Example
        true
        Description
        The email seems fake, or related to a suspicious persona, or to a person completely unrelated to the order
        otherboolean
        Example
        true
        Description
        Other (this option will only be open for account feedback)
        merchantWasContactedByVictimboolean
        Description
        The victim of this fraud attempt contacted us to complain (cardholder, or account owner in case of account takeover)
        merchantSuspectsFriendlyFraudobject
        ReasonMerchantSuspectsFraud
        merchantSuspectsAccountDetailsobject
        SuspiciousAccountDetails
        accountDetailsWereChangedboolean
        Example
        true
        Description
        Account details were recently changed in a way that is suspicious
        highVelocityboolean
        Example
        true
        Description
        Purchase frequency and amount is too high, and is likely fraudulent
        inactiveAccountboolean
        Example
        true
        Description
        Account was inactive for a very long time and is now displaying suspicious behaviour
        linkedToMultipleAccountsboolean
        Example
        true
        Description
        Identified multiple accounts linked to this account holder (available only for account feedback)
        otherboolean
        Example
        true
        Description
        Other (available only for account feedback)
        merchantSuspectsOrderDetailsobject
        SuspiciousOrderDetails
        badItemboolean
        Example
        true
        Description
        Item purchased is a strong fraud indicator
        badShippingAddressboolean
        Example
        true
        Description
        Shipping address seems suspicious
        fakeEmailboolean
        Example
        true
        Description
        The email seems fake, or related to a suspicious persona, or to a person completely unrelated to the order
        otherboolean
        Example
        true
        Description
        Other (this option will only be open for account feedback)
        merchantWasContactedByVictimboolean
        Description
        The victim of this fraud attempt contacted us to complain (cardholder, or account owner in case of account takeover)
        merchantSuspectsInrAbuseboolean
        Description
        INR/Refund Abuse - Customer is suspected of INR/refund abuse
        merchantSuspectsOtherPolicyBreachboolean
        Description
        Breach Of Policy - This order was made by an individual who is in breach of store policy. We do not wish to transact with this customer in the future.
        merchantSuspectsPromotionAbuseboolean
        Description
        Promotion Abuse - Customer is suspected of promotion abuse
        merchantSuspectsResellerAbuseboolean
        Description
        Reseller Abuse - Customer is suspected of reseller abuse
        merchantSuspectsReturnAbuseboolean
        Description
        Returns Abuse - Customer is suspected of returns abuse
        merchantSuspectsStolenPaymentMethodobject
        ReasonMerchantSuspectsFraud
        merchantSuspectsAccountDetailsobject
        SuspiciousAccountDetails
        accountDetailsWereChangedboolean
        Example
        true
        Description
        Account details were recently changed in a way that is suspicious
        highVelocityboolean
        Example
        true
        Description
        Purchase frequency and amount is too high, and is likely fraudulent
        inactiveAccountboolean
        Example
        true
        Description
        Account was inactive for a very long time and is now displaying suspicious behaviour
        linkedToMultipleAccountsboolean
        Example
        true
        Description
        Identified multiple accounts linked to this account holder (available only for account feedback)
        otherboolean
        Example
        true
        Description
        Other (available only for account feedback)
        merchantSuspectsOrderDetailsobject
        SuspiciousOrderDetails
        badItemboolean
        Example
        true
        Description
        Item purchased is a strong fraud indicator
        badShippingAddressboolean
        Example
        true
        Description
        Shipping address seems suspicious
        fakeEmailboolean
        Example
        true
        Description
        The email seems fake, or related to a suspicious persona, or to a person completely unrelated to the order
        otherboolean
        Example
        true
        Description
        Other (this option will only be open for account feedback)
        merchantWasContactedByVictimboolean
        Description
        The victim of this fraud attempt contacted us to complain (cardholder, or account owner in case of account takeover)
        merchantConfidenceLevelThisIsFraud
        Example
        NOT_SURE_COMMA_LOOKS_SUSPICIOUS
        Description
        My level of confidence that this order is fraudulent
        Allowed
        NOT_SURE_COMMA_LOOKS_SUSPICIOUSHIGH_CONFIDENCE_THIS_IS_FRAUDVICTIM_CONFIRMED_THIS_IS_FRAUD
        merchantThinksPolicyShouldApplystring
        Example
        Decline all non-US domestic orders
        Description
        I believe the order should not be approved since it is in breach of this business policy that we would like Forter to enforce
        Max Length
        200
    - undoPreviousFeedbackboolean
      Description
      A property to allow the customer to reset all previous feedbacks given on the session, previous feedbacks will not affect the model anymore
- orderIdstringrequired
  Example
  2356fdse0rr489
  Description
  Unique order/transaction identifier. Note that Forter treats this ID as case-insensitive; Order123 and ORDER123 will be identified as the same order.
  Max Length
  40
- orderType
  Example
  PHONE_LINK
  Description
  Platform order was made through
  Allowed
  WEBPHONEDYNAMIC_PHONEMOBILEMOBILE_IN_STOREIOSANDROIDWAPSTOREMERCHANT_EMPLOYEEMAIL_ORDERAUTOMATIC_RENEWAL_OR_INSTALLMENT_PAYMENTMERCHANT_INITIATEDUNKNOWNPOSAPI_ONLYPERSONAL_POSPHONE_LINK
- paymentPayment[]
  Description
  A list of all payment methods and billing details used in the transaction
  - allowedMerchantInitiatedTransactionsboolean
    Description
    True if customer chose to allow future transactions to initiate without taking further action (payment that's initiated on behalf of a customer)
  - amountobject
    - Amount
      - amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
      - amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
      - currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
  - androidPayobject
    - TokenizedCreditCard
      - cardBankstring
        Example
        Chase
        Description
        Conditional. Credit card's issuing bank
        Max Length
        128
      - cardBrandstring
        Example
        VISA
        Description
        Conditional. Credit card's issuer brand
        Max Length
        50
      - cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Example
        CREDIT
        Description
        Conditional. Payment card type
        Allowed
        CREDITDEBITPREPAIDUNKNOWN
      - countryOfIssuancestring
        Example
        US
        Description
        Conditional.
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Max Length
        2
        Pattern
        [A-Za-z]{2}
      - creationTimenumber
        Example
        1430997968
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
      - creditCardCorrelationIdstring
        Description
        Conditional.
        Credit card - CorrelationId that was recieved by the init 3DS API
      - expirationMonthstring
        Example
        03
        Description
        Credit card's expiration month, in MM format
        Max Length
        2
        Pattern
        [0-9]{2}
      - expirationYearstring
        Example
        2018
        Description
        Credit card's expiration year, in YYYY format
        Max Length
        4
        Pattern
        [0-9]{4}
      - fullResponsePayloadobject
        GeneralPayloadMap
      - lastFourDigitsstring
        Example
        4242
        Description
        Credit card's last 4 digits
        Max Length
        4
        Pattern
        [0-9]{2,4}
      - nameOnCardstring
        Example
        John R. H. Smith
        Description
        Cardholder's full name
        Max Length
        75
      - paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Example
        Chase Paymentech
        Description
        Conditional. Payment processor name
        Max Length
        50
        processorTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by processor)
        Max Length
        50
      - threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Example
        457173
        Description
        Conditional.
        Bank acquirer BIN (Bank Identification Number)
        Max Length
        12
        acquirerCountrystring<AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CK | CR | HR | CU | CY | CZ | DK | DJ | DM | DO | TP | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | NF | KP | GB | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | SH | KN | LC | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SK | SI | SB | SO | ZA | GS | KR | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TJ | TZ | TH | CD | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | YU | ZM | ZW>
        Example
        US
        Description
        Acquirer country
        Allowed
        AFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRHRCUCYCZDKDJDMDOTPECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFKPGBMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWSHKNLCPMVCWSSMSTSASNRSSCSLSGSKSISBSOZAGSKRSSESLKSDSRSJSZSECHSYTJTZTHCDTLTGTKTOTTTNTRTMTCTVUGUAAEUSUMUYUZVUVEVNVGVIWFEHYEYUZMZW
        acquirerMerchantIdstring
        Example
        5245020244654
        Description
        Conditional.
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Max Length
        30
        acquirerMerchantNamestring
        Example
        Simple T-shirt
        Description
        Merchant Name as appearing in processor records
        Max Length
        100
        acquirerNamestring
        Example
        Barclays
        Description
        Bank acquirer Name
        Max Length
        50
        merchantCategoryCodenumber
        Example
        5655
        Description
        Conditional.
        A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
        Max Length
        4
        merchantCountryCodenumber
        Example
        840
        Description
        Conditional. Merchant country code
        Max Length
        3
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Example
        NO_PREFERENCE
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Allowed
        NO_PREFERENCENO_CHALLENGECHALLENGECHALLENGE_AS_MANDATE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Example
        DYNAMIC_FORTER_DECISION
        Description
        Request your preference regarding the execution of 3DS
        Allowed
        FORCE_3DSNOT_SUPPORTED_BY_MERCHANTDYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Example
        THREEDS_RAILS
        Description
        The channel through which the exemption is requested
        Allowed
        THREEDS_RAILSAUTHORIZATION
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Example
        LOW_VALUE
        Description
        The type of exemption requested
        Allowed
        LOW_VALUETRANSACTION_RISK_ANALYSISSECURE_CORPORATETRUSTED_BENEFICIARY
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        threeDSServerTransIDstringrequired
        Example
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        Description
        Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call
        Max Length
        100
        threeDsExecutorstring<FORTER | MERCHANT>
        Description
        Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs
        Allowed
        FORTERMERCHANT
      - tokenstring
        Example
        tkn-77620C360132856A103477D2959967AB
        Description
        Credit card token used by the merchant
        Max Length
        200
      - tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | FORTER_TOKEN | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        Allowed
        PSPEMV_PAYMENT_TOKENMERCHANT_GENERATEDFORTER_TOKENOTHER
        Max Length
        128
      - verificationResultsobject
        CreditCardVerification
        authorizationCodestring
        Example
        A33244
        Description
        Conditional. Card authorization code from payment gateway
        Max Length
        255
        authorizationProcessedWith3DSboolean
        Example
        true
        Description
        3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization
        avsFullResultstring
        Example
        Y
        Description
        Conditional.
        Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string
        Max Length
        50
        avsNameResultstring
        Example
        M
        Description
        Conditional.
        Name portion of card's AVS result (when available)
        Max Length
        30
        avsStreetResultstring
        Example
        N
        Description
        Conditional. Street address portion of card's AVS result
        Max Length
        30
        avsZipResultstring
        Example
        M
        Description
        Conditional. Zipcode portion of card's AVS result
        Max Length
        30
        cavvResultstring
        Example
        VYboNwcsB3F9gTIsbaUjvEuLW0o=
        Description
        Conditional.
        3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response
        Max Length
        50
        cvvResultstring
        Example
        M
        Description
        Conditional.
        CVV result (if no data please send the value U)
        Max Length
        30
        eciValuestring
        Example
        05
        Description
        Conditional.
        3DSecure - ECI value recieved from authorization/authentication response
        Max Length
        2
        exemptionStatusstring
        Example
        accepted
        Description
        Conditional. Exemption status as received from the processor
        Max Length
        100
        external3dsVendorPayloadobject
        GeneralPayloadMap
        issuerResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from issuer
        Max Length
        50
        issuerResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from issuer
        Max Length
        255
        liabilityShiftboolean
        Example
        true
        Description
        Conditional.
        3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer
        partyExecuted3DSstring<PSP | FORTER | BOTH>
        Example
        PSP
        Description
        3DSecure - Party executed the 3DS authentication
        Allowed
        PSPFORTERBOTH
        processorResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from processor
        Max Length
        50
        processorResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from processor
        Max Length
        255
        threeDsInteractionModestring<FRICTIONLESS | CHALLENGED>
        Example
        FRICTIONLESS
        Description
        Conditional.
        3DSecure - Indication of the friction that the user experienced
        Allowed
        FRICTIONLESSCHALLENGED
        threeDsStatusstring
        Example
        Cardholder authenticated
        Description
        Conditional.
        3DSecure - Status text received from 3D secure vendor
        Max Length
        100
        threeDsVersionstring
        Example
        2.1.0
        Description
        Conditional.
        3DSecure - Version used in the transaction
        Max Length
        5
  - applePayobject
    - TokenizedCreditCard
      - cardBankstring
        Example
        Chase
        Description
        Conditional. Credit card's issuing bank
        Max Length
        128
      - cardBrandstring
        Example
        VISA
        Description
        Conditional. Credit card's issuer brand
        Max Length
        50
      - cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Example
        CREDIT
        Description
        Conditional. Payment card type
        Allowed
        CREDITDEBITPREPAIDUNKNOWN
      - countryOfIssuancestring
        Example
        US
        Description
        Conditional.
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Max Length
        2
        Pattern
        [A-Za-z]{2}
      - creationTimenumber
        Example
        1430997968
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
      - creditCardCorrelationIdstring
        Description
        Conditional.
        Credit card - CorrelationId that was recieved by the init 3DS API
      - expirationMonthstring
        Example
        03
        Description
        Credit card's expiration month, in MM format
        Max Length
        2
        Pattern
        [0-9]{2}
      - expirationYearstring
        Example
        2018
        Description
        Credit card's expiration year, in YYYY format
        Max Length
        4
        Pattern
        [0-9]{4}
      - fullResponsePayloadobject
        GeneralPayloadMap
      - lastFourDigitsstring
        Example
        4242
        Description
        Credit card's last 4 digits
        Max Length
        4
        Pattern
        [0-9]{2,4}
      - nameOnCardstring
        Example
        John R. H. Smith
        Description
        Cardholder's full name
        Max Length
        75
      - paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Example
        Chase Paymentech
        Description
        Conditional. Payment processor name
        Max Length
        50
        processorTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by processor)
        Max Length
        50
      - threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Example
        457173
        Description
        Conditional.
        Bank acquirer BIN (Bank Identification Number)
        Max Length
        12
        acquirerCountrystring<AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CK | CR | HR | CU | CY | CZ | DK | DJ | DM | DO | TP | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | NF | KP | GB | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | SH | KN | LC | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SK | SI | SB | SO | ZA | GS | KR | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TJ | TZ | TH | CD | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | YU | ZM | ZW>
        Example
        US
        Description
        Acquirer country
        Allowed
        AFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRHRCUCYCZDKDJDMDOTPECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFKPGBMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWSHKNLCPMVCWSSMSTSASNRSSCSLSGSKSISBSOZAGSKRSSESLKSDSRSJSZSECHSYTJTZTHCDTLTGTKTOTTTNTRTMTCTVUGUAAEUSUMUYUZVUVEVNVGVIWFEHYEYUZMZW
        acquirerMerchantIdstring
        Example
        5245020244654
        Description
        Conditional.
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Max Length
        30
        acquirerMerchantNamestring
        Example
        Simple T-shirt
        Description
        Merchant Name as appearing in processor records
        Max Length
        100
        acquirerNamestring
        Example
        Barclays
        Description
        Bank acquirer Name
        Max Length
        50
        merchantCategoryCodenumber
        Example
        5655
        Description
        Conditional.
        A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
        Max Length
        4
        merchantCountryCodenumber
        Example
        840
        Description
        Conditional. Merchant country code
        Max Length
        3
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Example
        NO_PREFERENCE
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Allowed
        NO_PREFERENCENO_CHALLENGECHALLENGECHALLENGE_AS_MANDATE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Example
        DYNAMIC_FORTER_DECISION
        Description
        Request your preference regarding the execution of 3DS
        Allowed
        FORCE_3DSNOT_SUPPORTED_BY_MERCHANTDYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Example
        THREEDS_RAILS
        Description
        The channel through which the exemption is requested
        Allowed
        THREEDS_RAILSAUTHORIZATION
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Example
        LOW_VALUE
        Description
        The type of exemption requested
        Allowed
        LOW_VALUETRANSACTION_RISK_ANALYSISSECURE_CORPORATETRUSTED_BENEFICIARY
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        threeDSServerTransIDstringrequired
        Example
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        Description
        Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call
        Max Length
        100
        threeDsExecutorstring<FORTER | MERCHANT>
        Description
        Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs
        Allowed
        FORTERMERCHANT
      - tokenstring
        Example
        tkn-77620C360132856A103477D2959967AB
        Description
        Credit card token used by the merchant
        Max Length
        200
      - tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | FORTER_TOKEN | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        Allowed
        PSPEMV_PAYMENT_TOKENMERCHANT_GENERATEDFORTER_TOKENOTHER
        Max Length
        128
      - verificationResultsobject
        CreditCardVerification
        authorizationCodestring
        Example
        A33244
        Description
        Conditional. Card authorization code from payment gateway
        Max Length
        255
        authorizationProcessedWith3DSboolean
        Example
        true
        Description
        3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization
        avsFullResultstring
        Example
        Y
        Description
        Conditional.
        Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string
        Max Length
        50
        avsNameResultstring
        Example
        M
        Description
        Conditional.
        Name portion of card's AVS result (when available)
        Max Length
        30
        avsStreetResultstring
        Example
        N
        Description
        Conditional. Street address portion of card's AVS result
        Max Length
        30
        avsZipResultstring
        Example
        M
        Description
        Conditional. Zipcode portion of card's AVS result
        Max Length
        30
        cavvResultstring
        Example
        VYboNwcsB3F9gTIsbaUjvEuLW0o=
        Description
        Conditional.
        3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response
        Max Length
        50
        cvvResultstring
        Example
        M
        Description
        Conditional.
        CVV result (if no data please send the value U)
        Max Length
        30
        eciValuestring
        Example
        05
        Description
        Conditional.
        3DSecure - ECI value recieved from authorization/authentication response
        Max Length
        2
        exemptionStatusstring
        Example
        accepted
        Description
        Conditional. Exemption status as received from the processor
        Max Length
        100
        external3dsVendorPayloadobject
        GeneralPayloadMap
        issuerResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from issuer
        Max Length
        50
        issuerResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from issuer
        Max Length
        255
        liabilityShiftboolean
        Example
        true
        Description
        Conditional.
        3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer
        partyExecuted3DSstring<PSP | FORTER | BOTH>
        Example
        PSP
        Description
        3DSecure - Party executed the 3DS authentication
        Allowed
        PSPFORTERBOTH
        processorResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from processor
        Max Length
        50
        processorResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from processor
        Max Length
        255
        threeDsInteractionModestring<FRICTIONLESS | CHALLENGED>
        Example
        FRICTIONLESS
        Description
        Conditional.
        3DSecure - Indication of the friction that the user experienced
        Allowed
        FRICTIONLESSCHALLENGED
        threeDsStatusstring
        Example
        Cardholder authenticated
        Description
        Conditional.
        3DSecure - Status text received from 3D secure vendor
        Max Length
        100
        threeDsVersionstring
        Example
        2.1.0
        Description
        Conditional.
        3DSecure - Version used in the transaction
        Max Length
        5
  - bankTransferobject
    - BankTransfer
      - accountHolderFirstNamestring
        Example
        John
        Description
        Bank account holder first name
        Max Length
        50
      - accountHolderLastNamestring
        Example
        Smith
        Description
        Bank account holder last name
        Max Length
        50
      - achProcessingTypestring
        Example
        SAME_DAY_ACH
        Description
        Type of ACH processing used in the transaction
        Max Length
        50
      - bankAccountIdentifierstring
        Example
        TEST63TEST1212121212
        Description
        Bank account unique identifier (IBAN or equivalent)
        Max Length
        40
      - bankAccountTypestring
        Example
        Savings
        Description
        Type of bank account payment is made from (e.g. savings/checking, etc.)
        Max Length
        50
      - bankNamestring
        Example
        Citigroup
        Description
        Name of bank payment is made from
        Max Length
        50
      - paymentGatewayDataobject
        PaymentGatewayData
        gatewayNamestring
        Example
        Braintree
        Description
        Conditional. Payment gateway name
        Max Length
        50
        gatewayTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by gateway)
        Max Length
        50
      - paymentSuccessStatusstring
        Example
        Payment Successful
        Description
        Response text as received from the service provider
      - serviceNamestring
        Example
        Direct Debit
        Description
        Conditional. Payment method name
        Max Length
        30
  - billingDetailsobject
    - Person
      - addressAddressrequired
        Description
        Address details
        address1stringrequired
        Example
        235 Montgomery st.
        Description
        Street-level address. Required when full address details are available
        Max Length
        255
        address2string
        Example
        Ste. 1110
        Description
        Conditional.
        Unit-level address
        Max Length
        255
        citystringrequired
        Example
        San Francisco
        Description
        City. Required when full address details are available
        Max Length
        200
        companystring
        Example
        Generic Corp. ltd.
        Description
        Company
        Max Length
        225
        countrystringrequired
        Example
        US
        Description
        Country, two-letter ISO 3166-1 alpha-2 country code
        Min Length
        2
        Max Length
        2
        regionstring
        Example
        CA
        Description
        Conditional.
        Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York)
        Max Length
        200
        savedDataobject
        SavedData
        choseToSaveDataboolean
        Description
        True if customer chose to save data in the account for future use
        usedSavedDatabooleanrequired
        Example
        true
        Description
        True if customer chose to use data saved in the account
        zipstring
        Example
        94104
        Description
        Conditional. Zipcode
        Max Length
        20
      - allAdditionalVerificationDocumentsAdditionalVerificationDocuments[]
        Description
        Conditional. Additional identification documents details and verification
        documentDateOfBirthstring<date>
        Example
        1991-01-09
        Description
        Date of birth as appears on the document. Use YYYY-MM-DD format.
        Format
        date
        documentExpirationstring<date>
        Example
        2017-01-15
        Description
        Document's exipration date. Use YYYY-MM-DD format.
        Format
        date
        documentFirstNamestring
        Example
        John
        Description
        First name as appears on the document
        Max Length
        50
        documentIssuingStatestring
        Example
        NY
        Description
        Conditional. Document issuing state or region
        Max Length
        25
        documentLastNamestring
        Example
        Smith
        Description
        Last name as appears on the document
        Max Length
        50
        documentNumberstring
        Example
        20439190
        Description
        Conditional.
        Official document's number (e.g. passport number, driving license number, etc.)
        Max Length
        50
        documentSourcestring<CAMERA_CAPTURED | UPLOADED_FILE | TYPED | OTHER>required
        Example
        UPLOADED_FILE
        Description
        Source of document (e.g. uploaded file, captured by camera, typed in by customer, etc.)
        Allowed
        CAMERA_CAPTUREDUPLOADED_FILETYPEDOTHER
        documentStatusstring<SENT_TO_CLIENT | RECEIVED_FROM_CLIENT | ABANDONED_BY_CLIENT | RECEIVED_FROM_CLIENT_FAULTY>
        Example
        SENT_TO_CLIENT
        Description
        Conditional.
        Status of verification document (e.g. sent to customer, received by customer, abandoned by customer ).
        Allowed
        SENT_TO_CLIENTRECEIVED_FROM_CLIENTABANDONED_BY_CLIENTRECEIVED_FROM_CLIENT_FAULTY
        Max Length
        50
        documentTypestringrequired
        Example
        Passport
        Description
        Type of document (Passport, ID, Driving license)
        Max Length
        35
        documentVerificationServiceAnswerstring
        Example
        APPROVED
        Description
        Conditional. Answer received from 3rd party document verification services
        Max Length
        20
        documentVerificationServiceNamestring
        Example
        IDVerification.com
        Description
        Conditional. Name of 3rd party document verifcation service
        Max Length
        50
        documentVerificationServiceResponsePayloadobject
        GeneralPayloadMap
        documentVerifiedboolean
        Example
        true
        Description
        Conditional. True if document was verified as authentic by merchant or 3rd party service
        eventTimenumber
        Example
        1420070400
        Description
        Time of event in seconds since unix epoch (UTC, Jan 1, 1970). For example, 01/01/2015 00
        is 1420070400
        nationalitystring
        Example
        US
        Description
        Conditional. Document holder's nationality
        Max Length
        25
      - employmentInformationEmploymentInformation[]
        Description
        Credit applicant's employment information
        employerAddressobject
        Address
        address1stringrequired
        Example
        235 Montgomery st.
        Description
        Street-level address. Required when full address details are available
        Max Length
        255
        address2string
        Example
        Ste. 1110
        Description
        Conditional.
        Unit-level address
        Max Length
        255
        citystringrequired
        Example
        San Francisco
        Description
        City. Required when full address details are available
        Max Length
        200
        companystring
        Example
        Generic Corp. ltd.
        Description
        Company
        Max Length
        225
        countrystringrequired
        Example
        US
        Description
        Country, two-letter ISO 3166-1 alpha-2 country code
        Min Length
        2
        Max Length
        2
        regionstring
        Example
        CA
        Description
        Conditional.
        Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York)
        Max Length
        200
        savedDataobject
        SavedData
        choseToSaveDataboolean
        Description
        True if customer chose to save data in the account for future use
        usedSavedDatabooleanrequired
        Example
        true
        Description
        True if customer chose to use data saved in the account
        zipstring
        Example
        94104
        Description
        Conditional. Zipcode
        Max Length
        20
        employerCompanySizeRangestring
        Example
        20
        Description
        Employing company's number of employees
        Max Length
        30
        employerIndustrystring
        Example
        Retail
        Description
        Employing company's industry
        Max Length
        100
        employerNamestringrequired
        Example
        Forter
        Description
        Employing company's name
        Max Length
        100
        employerPhonestring
        Example
        +12126667777
        Description
        Employing company's phone
        Max Length
        30
        incomeobject
        Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
        jobTitlestring
        Example
        Fraud Analyst
        Description
        Job title
        Max Length
        50
      - personalDetailsPersonalDetailsrequired
        Description
        Personal information such as name and birthdate
        birthdatestring<date>
        Example
        1987-05-22
        Description
        Conditional.
        Date of birth. Use YYYY-MM-DD format.
        Format
        date
        emailstring
        Example
        [email protected]
        Description
        Conditional. Email address
        Max Length
        256
        firstNamestring
        Example
        John
        Description
        Conditional. First name
        Max Length
        75
        fullNamestring
        Example
        John Smith
        Description
        Conditional. Full name. Not Needed if firstName and LastName are provided independently.
        Max Length
        150
        genderstring<MALE | FEMALE | CHOSE_NOT_TO_SPECIFY | NONE>
        Example
        MALE
        Description
        Conditional. Gender
        Allowed
        MALEFEMALECHOSE_NOT_TO_SPECIFYNONE
        lastNamestring
        Example
        Smith
        Description
        Conditional. Last name
        Max Length
        75
      - phonePhone[]
        Description
        Conditional. Phone details
        phonestringrequired
        Example
        15557654321
        Description
        Phone number including all country and local access codes
        Max Length
        25
        smsVerifiedVerificationrequired
        Description
        Phone verification details
        sentbooleanrequired
        Example
        true
        Description
        True if verification email was sent to email address or verification SMS was sent to phone number
        timeSentnumber
        Example
        1389567341
        Description
        Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)
        verifiedbooleanrequired
        Description
        True if customer received email verification message to this address and clicked-through back to merchant's site, or received SMS message and enterd code in merchant's site (two-factor authentication)
  - cameraCapturedboolean
    Example
    true
    Description
    Conditional. True if payment instrument details were captured by OCR from a picture. False if payment instrument details were manually typed in
  - cashboolean
    Description
    Payed with cash
  - creditCardobject
    - CreditCard
      - binstringrequired
        Example
        42424242
        Description
        Credit card's BIN (Bank Identification Number)
        Max Length
        8
        Pattern
        [0-9]{6,8}
      - cardBankstring
        Example
        Chase
        Description
        Credit card's issuing bank
        Max Length
        128
      - cardBrandstring
        Example
        VISA
        Description
        Credit Card's issuer brand
        Max Length
        30
      - cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Example
        CREDIT
        Description
        Conditional. Payment card type
        Allowed
        CREDITDEBITPREPAIDUNKNOWN
      - countryOfIssuancestring
        Example
        US
        Description
        Conditional.
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Max Length
        2
        Pattern
        [A-Za-z]{2}
      - creditCardCorrelationIdstring
        Description
        Conditional.
        Credit card - CorrelationId that was recieved by the init 3DS API
      - expirationMonthstringrequired
        Example
        03
        Description
        Credit card's expiration month, in MM format
        Max Length
        2
        Pattern
        [0-9]{2}
      - expirationYearstringrequired
        Example
        2018
        Description
        Credit card's expiration year, in YYYY format
        Max Length
        4
        Pattern
        [0-9]{4}
      - fingerprintstring
        Example
        Xt5EWLLDS7FJjR1c
        Description
        Conditional.
        Unique identifier for card (sent by gateway or processor)
        Max Length
        128
      - fullCreditCardstring
        Example
        2424242424242424
        Description
        Credit Card's full PAN - needed for the 3DS secure implementation
        Max Length
        30
      - fullResponsePayloadobject
        GeneralPayloadMap
      - lastFourDigitsstringrequired
        Example
        4242
        Description
        Credit card's last 4 digits (For Amex, take 4 digits from last digit)
        Max Length
        4
        Pattern
        [0-9]{2,4}
      - nameOnCardstringrequired
        Example
        John R. H. Smith
        Description
        Cardholder's full name
        Max Length
        75
      - paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Example
        Chase Paymentech
        Description
        Conditional. Payment processor name
        Max Length
        50
        processorTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by processor)
        Max Length
        50
      - threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Example
        457173
        Description
        Conditional.
        Bank acquirer BIN (Bank Identification Number)
        Max Length
        12
        acquirerCountrystring<AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CK | CR | HR | CU | CY | CZ | DK | DJ | DM | DO | TP | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | NF | KP | GB | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | SH | KN | LC | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SK | SI | SB | SO | ZA | GS | KR | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TJ | TZ | TH | CD | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | YU | ZM | ZW>
        Example
        US
        Description
        Acquirer country
        Allowed
        AFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRHRCUCYCZDKDJDMDOTPECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFKPGBMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWSHKNLCPMVCWSSMSTSASNRSSCSLSGSKSISBSOZAGSKRSSESLKSDSRSJSZSECHSYTJTZTHCDTLTGTKTOTTTNTRTMTCTVUGUAAEUSUMUYUZVUVEVNVGVIWFEHYEYUZMZW
        acquirerMerchantIdstring
        Example
        5245020244654
        Description
        Conditional.
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Max Length
        30
        acquirerMerchantNamestring
        Example
        Simple T-shirt
        Description
        Merchant Name as appearing in processor records
        Max Length
        100
        acquirerNamestring
        Example
        Barclays
        Description
        Bank acquirer Name
        Max Length
        50
        merchantCategoryCodenumber
        Example
        5655
        Description
        Conditional.
        A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
        Max Length
        4
        merchantCountryCodenumber
        Example
        840
        Description
        Conditional. Merchant country code
        Max Length
        3
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Example
        NO_PREFERENCE
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Allowed
        NO_PREFERENCENO_CHALLENGECHALLENGECHALLENGE_AS_MANDATE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Example
        DYNAMIC_FORTER_DECISION
        Description
        Request your preference regarding the execution of 3DS
        Allowed
        FORCE_3DSNOT_SUPPORTED_BY_MERCHANTDYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Example
        THREEDS_RAILS
        Description
        The channel through which the exemption is requested
        Allowed
        THREEDS_RAILSAUTHORIZATION
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Example
        LOW_VALUE
        Description
        The type of exemption requested
        Allowed
        LOW_VALUETRANSACTION_RISK_ANALYSISSECURE_CORPORATETRUSTED_BENEFICIARY
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        threeDSServerTransIDstringrequired
        Example
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        Description
        Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call
        Max Length
        100
        threeDsExecutorstring<FORTER | MERCHANT>
        Description
        Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs
        Allowed
        FORTERMERCHANT
      - verificationResultsobject
        CreditCardVerification
        authorizationCodestring
        Example
        A33244
        Description
        Conditional. Card authorization code from payment gateway
        Max Length
        255
        authorizationProcessedWith3DSboolean
        Example
        true
        Description
        3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization
        avsFullResultstring
        Example
        Y
        Description
        Conditional.
        Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string
        Max Length
        50
        avsNameResultstring
        Example
        M
        Description
        Conditional.
        Name portion of card's AVS result (when available)
        Max Length
        30
        avsStreetResultstring
        Example
        N
        Description
        Conditional. Street address portion of card's AVS result
        Max Length
        30
        avsZipResultstring
        Example
        M
        Description
        Conditional. Zipcode portion of card's AVS result
        Max Length
        30
        cavvResultstring
        Example
        VYboNwcsB3F9gTIsbaUjvEuLW0o=
        Description
        Conditional.
        3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response
        Max Length
        50
        cvvResultstring
        Example
        M
        Description
        Conditional.
        CVV result (if no data please send the value U)
        Max Length
        30
        eciValuestring
        Example
        05
        Description
        Conditional.
        3DSecure - ECI value recieved from authorization/authentication response
        Max Length
        2
        exemptionStatusstring
        Example
        accepted
        Description
        Conditional. Exemption status as received from the processor
        Max Length
        100
        external3dsVendorPayloadobject
        GeneralPayloadMap
        issuerResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from issuer
        Max Length
        50
        issuerResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from issuer
        Max Length
        255
        liabilityShiftboolean
        Example
        true
        Description
        Conditional.
        3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer
        partyExecuted3DSstring<PSP | FORTER | BOTH>
        Example
        PSP
        Description
        3DSecure - Party executed the 3DS authentication
        Allowed
        PSPFORTERBOTH
        processorResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from processor
        Max Length
        50
        processorResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from processor
        Max Length
        255
        threeDsInteractionModestring<FRICTIONLESS | CHALLENGED>
        Example
        FRICTIONLESS
        Description
        Conditional.
        3DSecure - Indication of the friction that the user experienced
        Allowed
        FRICTIONLESSCHALLENGED
        threeDsStatusstring
        Example
        Cardholder authenticated
        Description
        Conditional.
        3DSecure - Status text received from 3D secure vendor
        Max Length
        100
        threeDsVersionstring
        Example
        2.1.0
        Description
        Conditional.
        3DSecure - Version used in the transaction
        Max Length
        5
  - creditLineDetailsobject
    - CreditLineDetails
      - askedToIncreaseCreditLineLimitbooleanrequired
        Description
        True if customer asked to increase credit line limit
      - creditLineLimitIncreaseMethodstring<PRE_APPROVAL | AT_PURCHASE>required
        Example
        AT_PURCHASE
        Description
        Method customer chose to ask to increase credit line limit - PRE_APPROVAL, AT_PURCHASE
        Allowed
        PRE_APPROVALAT_PURCHASE
      - currentCreditLineLimitAmountrequired
        Description
        Current limit that was set for the credit line
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
      - originalCreditLineLimitAmountrequired
        Description
        Original limit that was set for the credit line
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
  - cryptoWalletobject
    - CryptoWallet
      - cryptoWalletNamestring
        Example
        CryptoWallet
        Description
        Crypto wallet name
        Max Length
        30
      - cryptoWalletPaymentIdstring
        Example
        3JQiwG88SQvwihDAHg9M2EnqEisharz49c
        Description
        Crypto wallet payment ID
        Max Length
        50
      - cryptoWalletTypestring<INTERNAL | EXTERNAL>required
        Example
        EXTERNAL
        Description
        Crypto wallet type (Indicate whether wallet provider is internal to the site ecosystem)
        Allowed
        INTERNALEXTERNAL
  - digitalWalletobject
    - DigitalWallet
      - digitalWalletNamestring<AMAZONPAY | FACEBOOKPAY | ALIPAY | WECHAT | AMEDIGITAL | MERCADOPAGO | DUE | ZELLE | PAYONEER | ALLIEDWALLET | KONBINI | UNIONPAY | IYZICO | VENMO | BARTER | PAYNOW | PAYCO | KAKAOPAY | NAVERPAY | LINEPAY | BANCONTACT | MBWAY | AIIA | BLIK | EPS | OVO | DANA | GCASH | GOPAY | RAKUTENPAY | APLAZO | GRABPAY | TWINT | TRUEMONEY | SWISH | KLARNA | SHOPBACK | OTHER | PAYPAY>required
        Example
        ALIPAY
        Description
        Digital wallet name
        Allowed
        AMAZONPAYFACEBOOKPAYALIPAYWECHATAMEDIGITALMERCADOPAGODUEZELLEPAYONEERALLIEDWALLETKONBINIUNIONPAYIYZICOVENMOBARTERPAYNOWPAYCOKAKAOPAYNAVERPAYLINEPAYBANCONTACTMBWAYAIIABLIKEPSOVODANAGCASHGOPAYRAKUTENPAYAPLAZOGRABPAYTWINTTRUEMONEYSWISHKLARNASHOPBACKOTHERPAYPAY
      - digitalWalletPayerEmailstring
        Example
        [email protected]
        Description
        Conditional. Email address associated with the digital wallet account
        Max Length
        75
      - digitalWalletPayerIdstring
        Example
        FD000A45P
        Description
        Conditional.
        Unique identifier for each digital wallet account. This ID should persist across all orders made by the same user, regardless of underlying payment methods.
        Max Length
        154
      - digitalWalletpaymentIdstring
        Example
        PAY-0MB00000KR8073311KZSDEYA
        Description
        Digital wallet payment ID
        Max Length
        50
      - freeTextDigitalWalletNamestring
        Example
        ALIBABA
        Description
        Conditional.
        Specifics about the source of the wallet such as the name / 3rd party name, etc. (required for OTHER digitalWalletName)
      - fullDigitalWalletResponsePayloadobject
        GeneralPayloadMap
      - payerAccountCountrystring
        Example
        US
        Description
        Conditional.
        Digital wallet account country, two-letter ISO 3166-1 alpha-2 country code
        Min Length
        2
        Max Length
        2
      - paymentSuccessStatusstring
        Example
        COMPLETED
        Description
        Conditional. Digital wallet payment status
        Max Length
        50
      - underlyingPaymentMethodUnderlyingPaymentMethodrequired
        Description
        The underlying payment method associated to the digital wallet that was used in the current transaction
        bankTransferobject
        BankTransfer
        accountHolderFirstNamestring
        Example
        John
        Description
        Bank account holder first name
        Max Length
        50
        accountHolderLastNamestring
        Example
        Smith
        Description
        Bank account holder last name
        Max Length
        50
        achProcessingTypestring
        Example
        SAME_DAY_ACH
        Description
        Type of ACH processing used in the transaction
        Max Length
        50
        bankAccountIdentifierstring
        Example
        TEST63TEST1212121212
        Description
        Bank account unique identifier (IBAN or equivalent)
        Max Length
        40
        bankAccountTypestring
        Example
        Savings
        Description
        Type of bank account payment is made from (e.g. savings/checking, etc.)
        Max Length
        50
        bankNamestring
        Example
        Citigroup
        Description
        Name of bank payment is made from
        Max Length
        50
        paymentGatewayDataobject
        PaymentGatewayData
        gatewayNamestring
        Example
        Braintree
        Description
        Conditional. Payment gateway name
        Max Length
        50
        gatewayTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by gateway)
        Max Length
        50
        paymentSuccessStatusstring
        Example
        Payment Successful
        Description
        Response text as received from the service provider
        serviceNamestring
        Example
        Direct Debit
        Description
        Conditional. Payment method name
        Max Length
        30
        bitcoinboolean
        Description
        Conditional. Bitcoin payment details
        cashboolean
        Description
        Conditional. Payed with cash
        creditCardobject
        TokenizedCreditCard
        cardBankstring
        Example
        Chase
        Description
        Conditional. Credit card's issuing bank
        Max Length
        128
        cardBrandstring
        Example
        VISA
        Description
        Conditional. Credit card's issuer brand
        Max Length
        50
        cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Example
        CREDIT
        Description
        Conditional. Payment card type
        Allowed
        CREDITDEBITPREPAIDUNKNOWN
        countryOfIssuancestring
        Example
        US
        Description
        Conditional.
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Max Length
        2
        Pattern
        [A-Za-z]{2}
        creationTimenumber
        Example
        1430997968
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
        creditCardCorrelationIdstring
        Description
        Conditional.
        Credit card - CorrelationId that was recieved by the init 3DS API
        expirationMonthstring
        Example
        03
        Description
        Credit card's expiration month, in MM format
        Max Length
        2
        Pattern
        [0-9]{2}
        expirationYearstring
        Example
        2018
        Description
        Credit card's expiration year, in YYYY format
        Max Length
        4
        Pattern
        [0-9]{4}
        fullResponsePayloadobject
        GeneralPayloadMap
        lastFourDigitsstring
        Example
        4242
        Description
        Credit card's last 4 digits
        Max Length
        4
        Pattern
        [0-9]{2,4}
        nameOnCardstring
        Example
        John R. H. Smith
        Description
        Cardholder's full name
        Max Length
        75
        paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Example
        Chase Paymentech
        Description
        Conditional. Payment processor name
        Max Length
        50
        processorTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by processor)
        Max Length
        50
        threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        Max depth limit reached
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Example
        NO_PREFERENCE
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Allowed
        NO_PREFERENCENO_CHALLENGECHALLENGECHALLENGE_AS_MANDATE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Example
        DYNAMIC_FORTER_DECISION
        Description
        Request your preference regarding the execution of 3DS
        Allowed
        FORCE_3DSNOT_SUPPORTED_BY_MERCHANTDYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        Max depth limit reached
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        threeDSServerTransIDstringrequired
        Example
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        Description
        Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call
        Max Length
        100
        threeDsExecutorstring<FORTER | MERCHANT>
        Description
        Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs
        Allowed
        FORTERMERCHANT
        tokenstring
        Example
        tkn-77620C360132856A103477D2959967AB
        Description
        Credit card token used by the merchant
        Max Length
        200
        tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | FORTER_TOKEN | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        Allowed
        PSPEMV_PAYMENT_TOKENMERCHANT_GENERATEDFORTER_TOKENOTHER
        Max Length
        128
        verificationResultsobject
        CreditCardVerification
        authorizationCodestring
        Example
        A33244
        Description
        Conditional. Card authorization code from payment gateway
        Max Length
        255
        authorizationProcessedWith3DSboolean
        Example
        true
        Description
        3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization
        avsFullResultstring
        Example
        Y
        Description
        Conditional.
        Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string
        Max Length
        50
        avsNameResultstring
        Example
        M
        Description
        Conditional.
        Name portion of card's AVS result (when available)
        Max Length
        30
        avsStreetResultstring
        Example
        N
        Description
        Conditional. Street address portion of card's AVS result
        Max Length
        30
        avsZipResultstring
        Example
        M
        Description
        Conditional. Zipcode portion of card's AVS result
        Max Length
        30
        cavvResultstring
        Example
        VYboNwcsB3F9gTIsbaUjvEuLW0o=
        Description
        Conditional.
        3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response
        Max Length
        50
        cvvResultstring
        Example
        M
        Description
        Conditional.
        CVV result (if no data please send the value U)
        Max Length
        30
        eciValuestring
        Example
        05
        Description
        Conditional.
        3DSecure - ECI value recieved from authorization/authentication response
        Max Length
        2
        exemptionStatusstring
        Example
        accepted
        Description
        Conditional. Exemption status as received from the processor
        Max Length
        100
        external3dsVendorPayloadobject
        GeneralPayloadMap
        Max depth limit reached
        issuerResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from issuer
        Max Length
        50
        issuerResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from issuer
        Max Length
        255
        liabilityShiftboolean
        Example
        true
        Description
        Conditional.
        3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer
        partyExecuted3DSstring<PSP | FORTER | BOTH>
        Example
        PSP
        Description
        3DSecure - Party executed the 3DS authentication
        Allowed
        PSPFORTERBOTH
        processorResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from processor
        Max Length
        50
        processorResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from processor
        Max Length
        255
        threeDsInteractionModestring<FRICTIONLESS | CHALLENGED>
        Example
        FRICTIONLESS
        Description
        Conditional.
        3DSecure - Indication of the friction that the user experienced
        Allowed
        FRICTIONLESSCHALLENGED
        threeDsStatusstring
        Example
        Cardholder authenticated
        Description
        Conditional.
        3DSecure - Status text received from 3D secure vendor
        Max Length
        100
        threeDsVersionstring
        Example
        2.1.0
        Description
        Conditional.
        3DSecure - Version used in the transaction
        Max Length
        5
        underlyingPaymentMethodTypestring<UNKNOWN | CREDITCARD | BANKTRANSFER | CASH | BITCOIN>required
        Example
        UNKNOWN
        Description
        Underlying payment method type used in current transaction
        Allowed
        UNKNOWNCREDITCARDBANKTRANSFERCASHBITCOIN
  - giftCardobject
    - CreditUsed
      - activationTimenumber
        Example
        1448549922
        Description
        Time credit/gift card was activated in the account, in seconds since unix epoch (UTC, Jan 1, 1970)
      - creditCurrencystring
        Example
        CAD
        Description
        Conditional.
        Original transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
      - creditOriginstring
        Example
        CS Compensation
        Description
        Source which created gift card for customer.
      - merchantPaymentIdstring
        Example
        eab12-ba9a-367-60b
        Description
        unique payment identifier for the merchant reference.
        Max Length
        150
      - valueobject
        Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
  - installmentServiceobject
    - InstallmentService
      - firstNamestring
        Example
        John
        Description
        Account holder's first name
        Max Length
        75
      - fullResponsePayloadobject
        GeneralPayloadMap
      - lastNamestring
        Example
        Smith
        Description
        Account holder's last name
        Max Length
        75
      - paymentIdstring
        Example
        YTZ8IATEGAWRRVVG
        Description
        Installment payment ID
        Max Length
        50
      - serviceNamestring
        Example
        Affirm
        Description
        Conditional. Installment service's name
        Max Length
        30
      - serviceResponseCodestring
        Example
        200
        Description
        Response code received from installment service
        Max Length
        50
  - loyaltyPointsobject
    - LoyaltyPoints
      - loyaltyPointsCountnumberrequired
        Example
        1506
        Description
        Number of points (miles, stars, etc.)
      - loyaltyPointsSourcestring<REFERRAL | IN_ACCOUNT_PURCHASES | PROMOTION | COMPENSATION | CARD_SCHEME_POINTS>
        Example
        IN_ACCOUNT_PURCHASES
        Description
        Conditional.
        Source of points (promo, referral, etc.)
        Allowed
        REFERRALIN_ACCOUNT_PURCHASESPROMOTIONCOMPENSATIONCARD_SCHEME_POINTS
      - loyaltyPointsValueobject
        Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
      - merchantPaymentIdstring
        Example
        eab12-ba9a-367-60b
        Description
        unique payment identifier for the merchant reference.
        Max Length
        150
  - merchantInitiatedobject
    - MerchantInitiatedPayment
      - initialOrderIdstring
        Example
        2356fdse0rr489
        Description
        Unique order/transaction identifier of the initial order (CIT).
        Max Length
        40
      - typestring<RECURRING_TRANSACTION | INSTALMENT_TRANSACTION | ADD_CARD | MAINTAIN_CARD_INFORMATION | ACCOUNT_VERIFICATION | SPLIT_OR_DELAYED_SHIPMENT | TOP_UP | MAIL_ORDER | TELEPHONE_ORDER | WHITELIST_STATUS_CHECK | OTHER_PAYMENT>
        Description
        Specifies the type of merchant-initiated payment
        Allowed
        RECURRING_TRANSACTIONINSTALMENT_TRANSACTIONADD_CARDMAINTAIN_CARD_INFORMATIONACCOUNT_VERIFICATIONSPLIT_OR_DELAYED_SHIPMENTTOP_UPMAIL_ORDERTELEPHONE_ORDERWHITELIST_STATUS_CHECKOTHER_PAYMENT
  - mobileMoneyobject
    - MobileMoney
      - fullResponsePayloadobject
        GeneralPayloadMap
      - mobileMoneyNetworkstring<MPESA | MTN | MPAWA | MSHWAEI | SAFARICOM | DASH>required
        Example
        MPESA
        Description
        Mobile money provider name
        Allowed
        MPESAMTNMPAWAMSHWAEISAFARICOMDASH
      - paymentAcquirerDataobject
        AcquirerData
        acquirerBINstring
        Example
        457173
        Description
        Conditional.
        Bank acquirer BIN (Bank Identification Number)
        Max Length
        12
        acquirerCountrystring<AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CK | CR | HR | CU | CY | CZ | DK | DJ | DM | DO | TP | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | NF | KP | GB | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | SH | KN | LC | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SK | SI | SB | SO | ZA | GS | KR | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TJ | TZ | TH | CD | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | YU | ZM | ZW>
        Example
        US
        Description
        Acquirer country
        Allowed
        AFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRHRCUCYCZDKDJDMDOTPECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFKPGBMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWSHKNLCPMVCWSSMSTSASNRSSCSLSGSKSISBSOZAGSKRSSESLKSDSRSJSZSECHSYTJTZTHCDTLTGTKTOTTTNTRTMTCTVUGUAAEUSUMUYUZVUVEVNVGVIWFEHYEYUZMZW
        acquirerMerchantIdstring
        Example
        5245020244654
        Description
        Conditional.
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Max Length
        30
        acquirerMerchantNamestring
        Example
        Simple T-shirt
        Description
        Merchant Name as appearing in processor records
        Max Length
        100
        acquirerNamestring
        Example
        Barclays
        Description
        Bank acquirer Name
        Max Length
        50
        merchantCategoryCodenumber
        Example
        5655
        Description
        Conditional.
        A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
        Max Length
        4
        merchantCountryCodenumber
        Example
        840
        Description
        Conditional. Merchant country code
        Max Length
        3
      - paymentGatewayDataobject
        PaymentGatewayData
        gatewayNamestring
        Example
        Braintree
        Description
        Conditional. Payment gateway name
        Max Length
        50
        gatewayTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by gateway)
        Max Length
        50
      - paymentSuccessStatusstring
        Example
        success
        Description
        Mobile money payment status
        Max Length
        50
      - phoneNumberstringrequired
        Example
        15557654321
        Description
        Account phone number
        Max Length
        50
  - numberOfInstallmentsinteger
    Example
    12
    Description
    Conditional. Number of payments if customer chose to pay in several installments
  - paymentMethodNicknamestring
    Example
    My Work Card
    Description
    Conditional. Nickname assigned to this payment method by the user
  - paypalobject
    - Paypal
      - authorizationIdstring
        Example
        2WC75407LV7300439
        Description
        Conditional. PayPal authorization ID
        Max Length
        50
      - fullPaypalResponsePayloadobject
        GeneralPayloadMap
      - payerAccountCountrystring
        Example
        US
        Description
        Conditional.
        PayPal account country, two-letter ISO 3166-1 alpha-2 country code
        Min Length
        2
        Max Length
        2
      - payerAddressStatusstring
        Example
        CONFIRMED
        Description
        Conditional. PayPal payer address status
      - payerEmailstringrequired
        Example
        [email protected]
        Description
        PayPal payer Email address
        Max Length
        256
      - payerIdstringrequired
        Example
        FD000A45P
        Description
        PayPal payer ID
        Max Length
        154
      - payerStatusstring
        Example
        VERIFIED
        Description
        Conditional. PayPal payer status
      - paymentGatewayDataobject
        PaymentGatewayData
        gatewayNamestring
        Example
        Braintree
        Description
        Conditional. Payment gateway name
        Max Length
        50
        gatewayTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by gateway)
        Max Length
        50
      - paymentIdstring
        Example
        PAY-0MB00000KR8073311KZSDEYA
        Description
        Conditional. PayPal payment ID
        Max Length
        50
      - paymentStatusstring
        Example
        COMPLETED
        Description
        PayPal payment status
        Max Length
        50
      - protectionEligibilitystring
        Example
        ELIGIBLE
        Description
        Conditional. PayPal protection eligibility
  - recurringPaymentobject
    - RecurringPaymentDetails
      - currentPaymentNumberinteger
        Example
        1
        Description
        The number of payments processed in this recurring event including current transaction (1 for the original transaction)
      - initialPaymentOrderIdstringrequired
        Example
        2356fdse0rr483
        Description
        Original order/transaction identifier that started the recurring event (payment number 1)
        Max Length
        40
      - isPaymentAmountIdenticalForAllPaymentsboolean
        Description
        True if the amount is constant between payments
      - recurringPaymentExpirationDatestring<date>
        Example
        1988-06-22
        Description
        Date of last expected payment event. Use YYYY-MM-DD format.
        Format
        date
      - recurringPaymentFrequencystringrequired
        Example
        7
        Description
        The number of days between transactions.
      - totalNumberOfPaymentsinteger
        Example
        12
        Description
        Expected number of payments processed in this recurring event
  - samsungPayobject
    - TokenizedCreditCard
      - cardBankstring
        Example
        Chase
        Description
        Conditional. Credit card's issuing bank
        Max Length
        128
      - cardBrandstring
        Example
        VISA
        Description
        Conditional. Credit card's issuer brand
        Max Length
        50
      - cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Example
        CREDIT
        Description
        Conditional. Payment card type
        Allowed
        CREDITDEBITPREPAIDUNKNOWN
      - countryOfIssuancestring
        Example
        US
        Description
        Conditional.
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Max Length
        2
        Pattern
        [A-Za-z]{2}
      - creationTimenumber
        Example
        1430997968
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
      - creditCardCorrelationIdstring
        Description
        Conditional.
        Credit card - CorrelationId that was recieved by the init 3DS API
      - expirationMonthstring
        Example
        03
        Description
        Credit card's expiration month, in MM format
        Max Length
        2
        Pattern
        [0-9]{2}
      - expirationYearstring
        Example
        2018
        Description
        Credit card's expiration year, in YYYY format
        Max Length
        4
        Pattern
        [0-9]{4}
      - fullResponsePayloadobject
        GeneralPayloadMap
      - lastFourDigitsstring
        Example
        4242
        Description
        Credit card's last 4 digits
        Max Length
        4
        Pattern
        [0-9]{2,4}
      - nameOnCardstring
        Example
        John R. H. Smith
        Description
        Cardholder's full name
        Max Length
        75
      - paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Example
        Chase Paymentech
        Description
        Conditional. Payment processor name
        Max Length
        50
        processorTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by processor)
        Max Length
        50
      - threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Example
        457173
        Description
        Conditional.
        Bank acquirer BIN (Bank Identification Number)
        Max Length
        12
        acquirerCountrystring<AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CK | CR | HR | CU | CY | CZ | DK | DJ | DM | DO | TP | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | NF | KP | GB | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | SH | KN | LC | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SK | SI | SB | SO | ZA | GS | KR | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TJ | TZ | TH | CD | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | YU | ZM | ZW>
        Example
        US
        Description
        Acquirer country
        Allowed
        AFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRHRCUCYCZDKDJDMDOTPECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFKPGBMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWSHKNLCPMVCWSSMSTSASNRSSCSLSGSKSISBSOZAGSKRSSESLKSDSRSJSZSECHSYTJTZTHCDTLTGTKTOTTTNTRTMTCTVUGUAAEUSUMUYUZVUVEVNVGVIWFEHYEYUZMZW
        acquirerMerchantIdstring
        Example
        5245020244654
        Description
        Conditional.
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Max Length
        30
        acquirerMerchantNamestring
        Example
        Simple T-shirt
        Description
        Merchant Name as appearing in processor records
        Max Length
        100
        acquirerNamestring
        Example
        Barclays
        Description
        Bank acquirer Name
        Max Length
        50
        merchantCategoryCodenumber
        Example
        5655
        Description
        Conditional.
        A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
        Max Length
        4
        merchantCountryCodenumber
        Example
        840
        Description
        Conditional. Merchant country code
        Max Length
        3
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Example
        NO_PREFERENCE
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Allowed
        NO_PREFERENCENO_CHALLENGECHALLENGECHALLENGE_AS_MANDATE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Example
        DYNAMIC_FORTER_DECISION
        Description
        Request your preference regarding the execution of 3DS
        Allowed
        FORCE_3DSNOT_SUPPORTED_BY_MERCHANTDYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Example
        THREEDS_RAILS
        Description
        The channel through which the exemption is requested
        Allowed
        THREEDS_RAILSAUTHORIZATION
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Example
        LOW_VALUE
        Description
        The type of exemption requested
        Allowed
        LOW_VALUETRANSACTION_RISK_ANALYSISSECURE_CORPORATETRUSTED_BENEFICIARY
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        threeDSServerTransIDstringrequired
        Example
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        Description
        Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call
        Max Length
        100
        threeDsExecutorstring<FORTER | MERCHANT>
        Description
        Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs
        Allowed
        FORTERMERCHANT
      - tokenstring
        Example
        tkn-77620C360132856A103477D2959967AB
        Description
        Credit card token used by the merchant
        Max Length
        200
      - tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | FORTER_TOKEN | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        Allowed
        PSPEMV_PAYMENT_TOKENMERCHANT_GENERATEDFORTER_TOKENOTHER
        Max Length
        128
      - verificationResultsobject
        CreditCardVerification
        authorizationCodestring
        Example
        A33244
        Description
        Conditional. Card authorization code from payment gateway
        Max Length
        255
        authorizationProcessedWith3DSboolean
        Example
        true
        Description
        3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization
        avsFullResultstring
        Example
        Y
        Description
        Conditional.
        Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string
        Max Length
        50
        avsNameResultstring
        Example
        M
        Description
        Conditional.
        Name portion of card's AVS result (when available)
        Max Length
        30
        avsStreetResultstring
        Example
        N
        Description
        Conditional. Street address portion of card's AVS result
        Max Length
        30
        avsZipResultstring
        Example
        M
        Description
        Conditional. Zipcode portion of card's AVS result
        Max Length
        30
        cavvResultstring
        Example
        VYboNwcsB3F9gTIsbaUjvEuLW0o=
        Description
        Conditional.
        3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response
        Max Length
        50
        cvvResultstring
        Example
        M
        Description
        Conditional.
        CVV result (if no data please send the value U)
        Max Length
        30
        eciValuestring
        Example
        05
        Description
        Conditional.
        3DSecure - ECI value recieved from authorization/authentication response
        Max Length
        2
        exemptionStatusstring
        Example
        accepted
        Description
        Conditional. Exemption status as received from the processor
        Max Length
        100
        external3dsVendorPayloadobject
        GeneralPayloadMap
        issuerResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from issuer
        Max Length
        50
        issuerResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from issuer
        Max Length
        255
        liabilityShiftboolean
        Example
        true
        Description
        Conditional.
        3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer
        partyExecuted3DSstring<PSP | FORTER | BOTH>
        Example
        PSP
        Description
        3DSecure - Party executed the 3DS authentication
        Allowed
        PSPFORTERBOTH
        processorResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from processor
        Max Length
        50
        processorResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from processor
        Max Length
        255
        threeDsInteractionModestring<FRICTIONLESS | CHALLENGED>
        Example
        FRICTIONLESS
        Description
        Conditional.
        3DSecure - Indication of the friction that the user experienced
        Allowed
        FRICTIONLESSCHALLENGED
        threeDsStatusstring
        Example
        Cardholder authenticated
        Description
        Conditional.
        3DSecure - Status text received from 3D secure vendor
        Max Length
        100
        threeDsVersionstring
        Example
        2.1.0
        Description
        Conditional.
        3DSecure - Version used in the transaction
        Max Length
        5
  - savedDataobject
    - SavedData
      - choseToSaveDataboolean
        Description
        True if customer chose to save data in the account for future use
      - usedSavedDatabooleanrequired
        Example
        true
        Description
        True if customer chose to use data saved in the account
  - storeCreditUsedobject
    - CreditUsed
      - activationTimenumber
        Example
        1448549922
        Description
        Time credit/gift card was activated in the account, in seconds since unix epoch (UTC, Jan 1, 1970)
      - creditCurrencystring
        Example
        CAD
        Description
        Conditional.
        Original transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
      - creditOriginstring
        Example
        CS Compensation
        Description
        Source which created gift card for customer.
      - merchantPaymentIdstring
        Example
        eab12-ba9a-367-60b
        Description
        unique payment identifier for the merchant reference.
        Max Length
        150
      - valueobject
        Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
  - tokenizedCardobject
    - TokenizedCreditCard
      - cardBankstring
        Example
        Chase
        Description
        Conditional. Credit card's issuing bank
        Max Length
        128
      - cardBrandstring
        Example
        VISA
        Description
        Conditional. Credit card's issuer brand
        Max Length
        50
      - cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Example
        CREDIT
        Description
        Conditional. Payment card type
        Allowed
        CREDITDEBITPREPAIDUNKNOWN
      - countryOfIssuancestring
        Example
        US
        Description
        Conditional.
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Max Length
        2
        Pattern
        [A-Za-z]{2}
      - creationTimenumber
        Example
        1430997968
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
      - creditCardCorrelationIdstring
        Description
        Conditional.
        Credit card - CorrelationId that was recieved by the init 3DS API
      - expirationMonthstring
        Example
        03
        Description
        Credit card's expiration month, in MM format
        Max Length
        2
        Pattern
        [0-9]{2}
      - expirationYearstring
        Example
        2018
        Description
        Credit card's expiration year, in YYYY format
        Max Length
        4
        Pattern
        [0-9]{4}
      - fullResponsePayloadobject
        GeneralPayloadMap
      - lastFourDigitsstring
        Example
        4242
        Description
        Credit card's last 4 digits
        Max Length
        4
        Pattern
        [0-9]{2,4}
      - nameOnCardstring
        Example
        John R. H. Smith
        Description
        Cardholder's full name
        Max Length
        75
      - paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Example
        Chase Paymentech
        Description
        Conditional. Payment processor name
        Max Length
        50
        processorTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by processor)
        Max Length
        50
      - threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Example
        457173
        Description
        Conditional.
        Bank acquirer BIN (Bank Identification Number)
        Max Length
        12
        acquirerCountrystring<AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CK | CR | HR | CU | CY | CZ | DK | DJ | DM | DO | TP | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | NF | KP | GB | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | SH | KN | LC | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SK | SI | SB | SO | ZA | GS | KR | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TJ | TZ | TH | CD | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | YU | ZM | ZW>
        Example
        US
        Description
        Acquirer country
        Allowed
        AFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRHRCUCYCZDKDJDMDOTPECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFKPGBMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWSHKNLCPMVCWSSMSTSASNRSSCSLSGSKSISBSOZAGSKRSSESLKSDSRSJSZSECHSYTJTZTHCDTLTGTKTOTTTNTRTMTCTVUGUAAEUSUMUYUZVUVEVNVGVIWFEHYEYUZMZW
        acquirerMerchantIdstring
        Example
        5245020244654
        Description
        Conditional.
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Max Length
        30
        acquirerMerchantNamestring
        Example
        Simple T-shirt
        Description
        Merchant Name as appearing in processor records
        Max Length
        100
        acquirerNamestring
        Example
        Barclays
        Description
        Bank acquirer Name
        Max Length
        50
        merchantCategoryCodenumber
        Example
        5655
        Description
        Conditional.
        A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
        Max Length
        4
        merchantCountryCodenumber
        Example
        840
        Description
        Conditional. Merchant country code
        Max Length
        3
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Example
        NO_PREFERENCE
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Allowed
        NO_PREFERENCENO_CHALLENGECHALLENGECHALLENGE_AS_MANDATE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Example
        DYNAMIC_FORTER_DECISION
        Description
        Request your preference regarding the execution of 3DS
        Allowed
        FORCE_3DSNOT_SUPPORTED_BY_MERCHANTDYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Example
        THREEDS_RAILS
        Description
        The channel through which the exemption is requested
        Allowed
        THREEDS_RAILSAUTHORIZATION
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Example
        LOW_VALUE
        Description
        The type of exemption requested
        Allowed
        LOW_VALUETRANSACTION_RISK_ANALYSISSECURE_CORPORATETRUSTED_BENEFICIARY
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        threeDSServerTransIDstringrequired
        Example
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        Description
        Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call
        Max Length
        100
        threeDsExecutorstring<FORTER | MERCHANT>
        Description
        Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs
        Allowed
        FORTERMERCHANT
      - tokenstring
        Example
        tkn-77620C360132856A103477D2959967AB
        Description
        Credit card token used by the merchant
        Max Length
        200
      - tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | FORTER_TOKEN | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        Allowed
        PSPEMV_PAYMENT_TOKENMERCHANT_GENERATEDFORTER_TOKENOTHER
        Max Length
        128
      - verificationResultsobject
        CreditCardVerification
        authorizationCodestring
        Example
        A33244
        Description
        Conditional. Card authorization code from payment gateway
        Max Length
        255
        authorizationProcessedWith3DSboolean
        Example
        true
        Description
        3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization
        avsFullResultstring
        Example
        Y
        Description
        Conditional.
        Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string
        Max Length
        50
        avsNameResultstring
        Example
        M
        Description
        Conditional.
        Name portion of card's AVS result (when available)
        Max Length
        30
        avsStreetResultstring
        Example
        N
        Description
        Conditional. Street address portion of card's AVS result
        Max Length
        30
        avsZipResultstring
        Example
        M
        Description
        Conditional. Zipcode portion of card's AVS result
        Max Length
        30
        cavvResultstring
        Example
        VYboNwcsB3F9gTIsbaUjvEuLW0o=
        Description
        Conditional.
        3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response
        Max Length
        50
        cvvResultstring
        Example
        M
        Description
        Conditional.
        CVV result (if no data please send the value U)
        Max Length
        30
        eciValuestring
        Example
        05
        Description
        Conditional.
        3DSecure - ECI value recieved from authorization/authentication response
        Max Length
        2
        exemptionStatusstring
        Example
        accepted
        Description
        Conditional. Exemption status as received from the processor
        Max Length
        100
        external3dsVendorPayloadobject
        GeneralPayloadMap
        issuerResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from issuer
        Max Length
        50
        issuerResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from issuer
        Max Length
        255
        liabilityShiftboolean
        Example
        true
        Description
        Conditional.
        3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer
        partyExecuted3DSstring<PSP | FORTER | BOTH>
        Example
        PSP
        Description
        3DSecure - Party executed the 3DS authentication
        Allowed
        PSPFORTERBOTH
        processorResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from processor
        Max Length
        50
        processorResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from processor
        Max Length
        255
        threeDsInteractionModestring<FRICTIONLESS | CHALLENGED>
        Example
        FRICTIONLESS
        Description
        Conditional.
        3DSecure - Indication of the friction that the user experienced
        Allowed
        FRICTIONLESSCHALLENGED
        threeDsStatusstring
        Example
        Cardholder authenticated
        Description
        Conditional.
        3DSecure - Status text received from 3D secure vendor
        Max Length
        100
        threeDsVersionstring
        Example
        2.1.0
        Description
        Conditional.
        3DSecure - Version used in the transaction
        Max Length
        5
  - venmoobject
    - Venmo
      - fullVenmoResponsePayloadGeneralPayloadMaprequired
        Description
        Full Venmo response object
      - paymentIdstring
        Example
        1KZSDEYA
        Description
        Conditional. Venmo payment ID
        Max Length
        50
      - tokenstringrequired
        Example
        77620C360132856A103477D2959967AB
        Description
        Token representing the specific payment method used within the Venmo vault
        Max Length
        200
      - userIdstringrequired
        Example
        johndoe
        Description
        Venmo userID
        Max Length
        50
      - userNamestringrequired
        Example
        johndoe1987
        Description
        Venmo user name
        Max Length
        50
- primaryRecipientobject
  - Beneficiary
    - additionalVerificationDocumentsobject
      - AdditionalVerificationDocuments
        documentDateOfBirthstring<date>
        Example
        1991-01-09
        Description
        Date of birth as appears on the document. Use YYYY-MM-DD format.
        Format
        date
        documentExpirationstring<date>
        Example
        2017-01-15
        Description
        Document's exipration date. Use YYYY-MM-DD format.
        Format
        date
        documentFirstNamestring
        Example
        John
        Description
        First name as appears on the document
        Max Length
        50
        documentIssuingStatestring
        Example
        NY
        Description
        Conditional. Document issuing state or region
        Max Length
        25
        documentLastNamestring
        Example
        Smith
        Description
        Last name as appears on the document
        Max Length
        50
        documentNumberstring
        Example
        20439190
        Description
        Conditional.
        Official document's number (e.g. passport number, driving license number, etc.)
        Max Length
        50
        documentSourcestring<CAMERA_CAPTURED | UPLOADED_FILE | TYPED | OTHER>required
        Example
        UPLOADED_FILE
        Description
        Source of document (e.g. uploaded file, captured by camera, typed in by customer, etc.)
        Allowed
        CAMERA_CAPTUREDUPLOADED_FILETYPEDOTHER
        documentStatusstring<SENT_TO_CLIENT | RECEIVED_FROM_CLIENT | ABANDONED_BY_CLIENT | RECEIVED_FROM_CLIENT_FAULTY>
        Example
        SENT_TO_CLIENT
        Description
        Conditional.
        Status of verification document (e.g. sent to customer, received by customer, abandoned by customer ).
        Allowed
        SENT_TO_CLIENTRECEIVED_FROM_CLIENTABANDONED_BY_CLIENTRECEIVED_FROM_CLIENT_FAULTY
        Max Length
        50
        documentTypestringrequired
        Example
        Passport
        Description
        Type of document (Passport, ID, Driving license)
        Max Length
        35
        documentVerificationServiceAnswerstring
        Example
        APPROVED
        Description
        Conditional. Answer received from 3rd party document verification services
        Max Length
        20
        documentVerificationServiceNamestring
        Example
        IDVerification.com
        Description
        Conditional. Name of 3rd party document verifcation service
        Max Length
        50
        documentVerificationServiceResponsePayloadobject
        GeneralPayloadMap
        documentVerifiedboolean
        Example
        true
        Description
        Conditional. True if document was verified as authentic by merchant or 3rd party service
        eventTimenumber
        Example
        1420070400
        Description
        Time of event in seconds since unix epoch (UTC, Jan 1, 1970). For example, 01/01/2015 00
        is 1420070400
        nationalitystring
        Example
        US
        Description
        Conditional. Document holder's nationality
        Max Length
        25
    - addressobject
      - Address
        address1stringrequired
        Example
        235 Montgomery st.
        Description
        Street-level address. Required when full address details are available
        Max Length
        255
        address2string
        Example
        Ste. 1110
        Description
        Conditional.
        Unit-level address
        Max Length
        255
        citystringrequired
        Example
        San Francisco
        Description
        City. Required when full address details are available
        Max Length
        200
        companystring
        Example
        Generic Corp. ltd.
        Description
        Company
        Max Length
        225
        countrystringrequired
        Example
        US
        Description
        Country, two-letter ISO 3166-1 alpha-2 country code
        Min Length
        2
        Max Length
        2
        regionstring
        Example
        CA
        Description
        Conditional.
        Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York)
        Max Length
        200
        savedDataobject
        SavedData
        choseToSaveDataboolean
        Description
        True if customer chose to save data in the account for future use
        usedSavedDatabooleanrequired
        Example
        true
        Description
        True if customer chose to use data saved in the account
        zipstring
        Example
        94104
        Description
        Conditional. Zipcode
        Max Length
        20
    - bankAccountobject
      - BankTransfer
        accountHolderFirstNamestring
        Example
        John
        Description
        Bank account holder first name
        Max Length
        50
        accountHolderLastNamestring
        Example
        Smith
        Description
        Bank account holder last name
        Max Length
        50
        achProcessingTypestring
        Example
        SAME_DAY_ACH
        Description
        Type of ACH processing used in the transaction
        Max Length
        50
        bankAccountIdentifierstring
        Example
        TEST63TEST1212121212
        Description
        Bank account unique identifier (IBAN or equivalent)
        Max Length
        40
        bankAccountTypestring
        Example
        Savings
        Description
        Type of bank account payment is made from (e.g. savings/checking, etc.)
        Max Length
        50
        bankNamestring
        Example
        Citigroup
        Description
        Name of bank payment is made from
        Max Length
        50
        paymentGatewayDataobject
        PaymentGatewayData
        gatewayNamestring
        Example
        Braintree
        Description
        Conditional. Payment gateway name
        Max Length
        50
        gatewayTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by gateway)
        Max Length
        50
        paymentSuccessStatusstring
        Example
        Payment Successful
        Description
        Response text as received from the service provider
        serviceNamestring
        Example
        Direct Debit
        Description
        Conditional. Payment method name
        Max Length
        30
    - commentsobject
      - Comments
        merchantCommentsstring
        Example
        Shipping delayed
        Description
        Comments by the merchant
        Max Length
        600
        messageToBeneficiarystring
        Example
        Enjoy the gift John!
        Description
        Comments the customer left to the beneficiary of the purchase made
        Max Length
        600
        userCommentsToMerchantstring
        Example
        Please wrap with care!!
        Description
        Comments the customer left to the merchant
        Max Length
        600
    - cryptoWalletobject
      - CryptoWallet
        cryptoWalletNamestring
        Example
        CryptoWallet
        Description
        Crypto wallet name
        Max Length
        30
        cryptoWalletPaymentIdstring
        Example
        3JQiwG88SQvwihDAHg9M2EnqEisharz49c
        Description
        Crypto wallet payment ID
        Max Length
        50
        cryptoWalletTypestring<INTERNAL | EXTERNAL>required
        Example
        EXTERNAL
        Description
        Crypto wallet type (Indicate whether wallet provider is internal to the site ecosystem)
        Allowed
        INTERNALEXTERNAL
    - identityCardstring
      Description
      Recipient's identity card number
    - loyaltyProgramLoyaltyProgram[]
      Description
      Details regarding loyalty program customer entered to receive points for this order
      - accountNumberstring
        Example
        VC1568OP
        Description
        Customer's rewards/loyalty/frequent flyer account number
        Max Length
        100
      - loyaltyPointsValueobject
        Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
      - programNamestring
        Example
        StarAlliance
        Description
        Conditional. Name of program
        Max Length
        100
      - programPointsnumber
        Description
        Customer's rewards/loyalty/frequent flyer miles/point/stars
        Max Length
        20
      - tierstring
        Example
        Blue
        Description
        Conditional. Program tier name
        Max Length
        100
    - personalDetailsPersonalDetailsrequired
      Description
      Personal information such as name, birthdate and email
      - birthdatestring<date>
        Example
        1987-05-22
        Description
        Conditional.
        Date of birth. Use YYYY-MM-DD format.
        Format
        date
      - emailstring
        Example
        [email protected]
        Description
        Conditional. Email address
        Max Length
        256
      - firstNamestring
        Example
        John
        Description
        Conditional. First name
        Max Length
        75
      - fullNamestring
        Example
        John Smith
        Description
        Conditional. Full name. Not Needed if firstName and LastName are provided independently.
        Max Length
        150
      - genderstring<MALE | FEMALE | CHOSE_NOT_TO_SPECIFY | NONE>
        Example
        MALE
        Description
        Conditional. Gender
        Allowed
        MALEFEMALECHOSE_NOT_TO_SPECIFYNONE
      - lastNamestring
        Example
        Smith
        Description
        Conditional. Last name
        Max Length
        75
    - phonePhone[]
      Description
      Conditional. Phone details
      - phonestringrequired
        Example
        15557654321
        Description
        Phone number including all country and local access codes
        Max Length
        25
      - smsVerifiedVerificationrequired
        Description
        Phone verification details
        sentbooleanrequired
        Example
        true
        Description
        True if verification email was sent to email address or verification SMS was sent to phone number
        timeSentnumber
        Example
        1389567341
        Description
        Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)
        verifiedbooleanrequired
        Description
        True if customer received email verification message to this address and clicked-through back to merchant's site, or received SMS message and enterd code in merchant's site (two-factor authentication)
- totalAmountobject
  - Amount
    - amountLocalCurrencystring
      Example
      105.55
      Description
      Conditional. Transaction amount in currency chosen by the buyer
      Max Length
      20
    - amountUSDstring
      Example
      99.95
      Description
      Conditional. Transaction amount in USD
      Max Length
      12
    - currencystring
      Example
      CAD
      Description
      Conditional.
      Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
      Max Length
      3
      Pattern
      [A-Z]{3}

Responses

200Example validationResponse

validationResponse
Description
The response object of a forter validations call
- actionstringrequired
  Example
  approve
  Description
  The message containing the decision
  Max Length
  1000
- messagestringrequired
  Description
  The message containing status response text
  Max Length
  1000
- reasonCodestringrequired
  Max Length
  1000
- recommendationsstring[]required
  Description
  Forter's recommendations for the optimal way of proceeding with the order
- statusstringrequired
  Example
  success
  Description
  Status of the request processing
  Max Length
  50
- transactionstringrequired
  Example
  123456
  Description
  Transaction id. Note that Forter treats this ID as case-insensitive; Order123 and ORDER123 will be identified as the same order.
  Max Length
  100

400

Bad Request (Often missing a required parameter)

401

Unauthorized (No valid API key provided)

404

Not Found (The requested item doesn't exist)

500

Server Error (Something went wrong on Forter's end)

curl

curl --request POST \
     --url https://api.forter-secure.com/v2/order-update/{id} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'api-version: 10.3' \
     --header 'x-forter-siteid: a1b2c3d4e5f6' \
     --header 'authorization: Basic <base64-encoded-api-key:>' \
     --data '{
     "connectionInformation": {
     "customerIP": "10.0.0.127",
     "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
     },
     "merchantFeedback": {
     "merchantCustomerSupport": {
     "contactEmailUsed": {},
     "contactMethodType": "PHONE",
     "contactNameUsed": {
     "customerContactNameType": "OTHER"
     },
     "contactPhoneUsed": {},
     "contactTime": 1430997968,
     "customerSupportChangeOrderDetails": {},
     "customerSupportFurtherVerification": {
     "customerAnsweredSecurityQuestions": true,
     "customerSupportAdditionalVerificationDocuments": {
     "documentType": "Passport"
     }
     },
     "initiatedBy": "CUSTOMER"
     },
     "merchantWouldLikeApproved": {
     "merchantContactedIssuer": {},
     "merchantDisagreesWithSpecificDeclineReason": {
     "atoIsIrrelevant": {},
     "chbkIsIrrelevant": {}
     },
     "merchantFoundBuyerExposure": {
     "customerSignedInUsingLegitSocialNetworkAccount": {},
     "merchantFoundBuyerEmailOnline": {},
     "merchantFoundBuyerPhoneNumberOnline": {},
     "merchantFoundConnectionBetweenIndividualsInTheOrder": {
     "dataSource": {}
     },
     "merchantFoundConnectionBetweenNameAndAddress": {
     "dataSource": {}
     },
     "merchantFoundRecipientEmailOnline": {},
     "merchantFoundRecipientPhoneNumberOnline": {}
     },
     "merchantPolicyDecisionNotApplicable": {},
     "merchantThinksOrderCharacteristicsAreLegit": {
     "goodCustomer": {
     "establishedAccount": {
     "establishedAccountDetails": {},
     "relatedAccountDetails": {}
     },
     "previousPointOfSalePurchase": {}
     },
     "lowRiskPaymentMethod": {}
     }
     },
     "merchantWouldLikeDeclined": {
     "fraudTypeSuspectedByMerchant": {
     "merchantSuspectsAccountTakeOver": {
     "merchantSuspectsAccountDetails": {},
     "merchantSuspectsOrderDetails": {}
     },
     "merchantSuspectsBuyerSellerCollusion": {
     "merchantSuspectsAccountDetails": {},
     "merchantSuspectsOrderDetails": {}
     },
     "merchantSuspectsFraudOther": {
     "merchantSuspectsAccountDetails": {},
     "merchantSuspectsOrderDetails": {}
     },
     "merchantSuspectsFriendlyFraud": {
     "merchantSuspectsAccountDetails": {},
     "merchantSuspectsOrderDetails": {}
     },
     "merchantSuspectsStolenPaymentMethod": {
     "merchantSuspectsAccountDetails": {},
     "merchantSuspectsOrderDetails": {}
     }
     }
     }
     },
     "orderId": "2356fdse0rr489",
     "primaryRecipient": {
     "additionalVerificationDocuments": {
     "documentSource": "UPLOADED_FILE",
     "documentType": "Passport",
     "documentVerificationServiceResponsePayload": {}
     },
     "address": {
     "address1": "235 Montgomery st.",
     "city": "San Francisco",
     "country": "US",
     "savedData": {
     "usedSavedData": true
     }
     },
     "bankAccount": {
     "paymentGatewayData": {}
     },
     "comments": {},
     "cryptoWallet": {
     "cryptoWalletType": "EXTERNAL"
     },
     "personalDetails": {},
     "phone": [
     {
     "phone": "15557654321",
     "smsVerified": {
     "sent": true,
     "verified": false
     }
     }
     ]
     },
     "totalAmount": {}
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("api-version", "10.3");
myHeaders.append("x-forter-siteid", "a1b2c3d4e5f6");
myHeaders.append("authorization", "Basic <base64-encoded-api-key:>");

var raw = JSON.stringify({
   "connectionInformation": {
      "customerIP": "10.0.0.127",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
   },
   "merchantFeedback": {
      "merchantCustomerSupport": {
         "contactEmailUsed": {},
         "contactMethodType": "PHONE",
         "contactNameUsed": {
            "customerContactNameType": "OTHER"
         },
         "contactPhoneUsed": {},
         "contactTime": 1430997968,
         "customerSupportChangeOrderDetails": {},
         "customerSupportFurtherVerification": {
            "customerAnsweredSecurityQuestions": true,
            "customerSupportAdditionalVerificationDocuments": {
               "documentType": "Passport"
            }
         },
         "initiatedBy": "CUSTOMER"
      },
      "merchantWouldLikeApproved": {
         "merchantContactedIssuer": {},
         "merchantDisagreesWithSpecificDeclineReason": {
            "atoIsIrrelevant": {},
            "chbkIsIrrelevant": {}
         },
         "merchantFoundBuyerExposure": {
            "customerSignedInUsingLegitSocialNetworkAccount": {},
            "merchantFoundBuyerEmailOnline": {},
            "merchantFoundBuyerPhoneNumberOnline": {},
            "merchantFoundConnectionBetweenIndividualsInTheOrder": {
               "dataSource": {}
            },
            "merchantFoundConnectionBetweenNameAndAddress": {
               "dataSource": {}
            },
            "merchantFoundRecipientEmailOnline": {},
            "merchantFoundRecipientPhoneNumberOnline": {}
         },
         "merchantPolicyDecisionNotApplicable": {},
         "merchantThinksOrderCharacteristicsAreLegit": {
            "goodCustomer": {
               "establishedAccount": {
                  "establishedAccountDetails": {},
                  "relatedAccountDetails": {}
               },
               "previousPointOfSalePurchase": {}
            },
            "lowRiskPaymentMethod": {}
         }
      },
      "merchantWouldLikeDeclined": {
         "fraudTypeSuspectedByMerchant": {
            "merchantSuspectsAccountTakeOver": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            },
            "merchantSuspectsBuyerSellerCollusion": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            },
            "merchantSuspectsFraudOther": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            },
            "merchantSuspectsFriendlyFraud": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            },
            "merchantSuspectsStolenPaymentMethod": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            }
         }
      }
   },
   "orderId": "2356fdse0rr489",
   "primaryRecipient": {
      "additionalVerificationDocuments": {
         "documentSource": "UPLOADED_FILE",
         "documentType": "Passport",
         "documentVerificationServiceResponsePayload": {}
      },
      "address": {
         "address1": "235 Montgomery st.",
         "city": "San Francisco",
         "country": "US",
         "savedData": {
            "usedSavedData": true
         }
      },
      "bankAccount": {
         "paymentGatewayData": {}
      },
      "comments": {},
      "cryptoWallet": {
         "cryptoWalletType": "EXTERNAL"
      },
      "personalDetails": {},
      "phone": [
         {
            "phone": "15557654321",
            "smsVerified": {
               "sent": true,
               "verified": false
            }
         }
      ]
   },
   "totalAmount": {}
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.forter-secure.com/v2/order-update/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.forter-secure.com/v2/order-update/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["api-version"] = "10.3"
request["x-forter-siteid"] = "a1b2c3d4e5f6"
request["authorization"] = "Basic <base64-encoded-api-key:>"
request.body = JSON.dump({
   "connectionInformation": {
      "customerIP": "10.0.0.127",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
   },
   "merchantFeedback": {
      "merchantCustomerSupport": {
         "contactEmailUsed": {},
         "contactMethodType": "PHONE",
         "contactNameUsed": {
            "customerContactNameType": "OTHER"
         },
         "contactPhoneUsed": {},
         "contactTime": 1430997968,
         "customerSupportChangeOrderDetails": {},
         "customerSupportFurtherVerification": {
            "customerAnsweredSecurityQuestions": true,
            "customerSupportAdditionalVerificationDocuments": {
               "documentType": "Passport"
            }
         },
         "initiatedBy": "CUSTOMER"
      },
      "merchantWouldLikeApproved": {
         "merchantContactedIssuer": {},
         "merchantDisagreesWithSpecificDeclineReason": {
            "atoIsIrrelevant": {},
            "chbkIsIrrelevant": {}
         },
         "merchantFoundBuyerExposure": {
            "customerSignedInUsingLegitSocialNetworkAccount": {},
            "merchantFoundBuyerEmailOnline": {},
            "merchantFoundBuyerPhoneNumberOnline": {},
            "merchantFoundConnectionBetweenIndividualsInTheOrder": {
               "dataSource": {}
            },
            "merchantFoundConnectionBetweenNameAndAddress": {
               "dataSource": {}
            },
            "merchantFoundRecipientEmailOnline": {},
            "merchantFoundRecipientPhoneNumberOnline": {}
         },
         "merchantPolicyDecisionNotApplicable": {},
         "merchantThinksOrderCharacteristicsAreLegit": {
            "goodCustomer": {
               "establishedAccount": {
                  "establishedAccountDetails": {},
                  "relatedAccountDetails": {}
               },
               "previousPointOfSalePurchase": {}
            },
            "lowRiskPaymentMethod": {}
         }
      },
      "merchantWouldLikeDeclined": {
         "fraudTypeSuspectedByMerchant": {
            "merchantSuspectsAccountTakeOver": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            },
            "merchantSuspectsBuyerSellerCollusion": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            },
            "merchantSuspectsFraudOther": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            },
            "merchantSuspectsFriendlyFraud": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            },
            "merchantSuspectsStolenPaymentMethod": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            }
         }
      }
   },
   "orderId": "2356fdse0rr489",
   "primaryRecipient": {
      "additionalVerificationDocuments": {
         "documentSource": "UPLOADED_FILE",
         "documentType": "Passport",
         "documentVerificationServiceResponsePayload": {}
      },
      "address": {
         "address1": "235 Montgomery st.",
         "city": "San Francisco",
         "country": "US",
         "savedData": {
            "usedSavedData": true
         }
      },
      "bankAccount": {
         "paymentGatewayData": {}
      },
      "comments": {},
      "cryptoWallet": {
         "cryptoWalletType": "EXTERNAL"
      },
      "personalDetails": {},
      "phone": [
         {
            "phone": "15557654321",
            "smsVerified": {
               "sent": true,
               "verified": false
            }
         }
      ]
   },
   "totalAmount": {}
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.forter-secure.com/v2/order-update/{id}"

payload = json.dumps({
   "connectionInformation": {
      "customerIP": "10.0.0.127",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
   },
   "merchantFeedback": {
      "merchantCustomerSupport": {
         "contactEmailUsed": {},
         "contactMethodType": "PHONE",
         "contactNameUsed": {
            "customerContactNameType": "OTHER"
         },
         "contactPhoneUsed": {},
         "contactTime": 1430997968,
         "customerSupportChangeOrderDetails": {},
         "customerSupportFurtherVerification": {
            "customerAnsweredSecurityQuestions": True,
            "customerSupportAdditionalVerificationDocuments": {
               "documentType": "Passport"
            }
         },
         "initiatedBy": "CUSTOMER"
      },
      "merchantWouldLikeApproved": {
         "merchantContactedIssuer": {},
         "merchantDisagreesWithSpecificDeclineReason": {
            "atoIsIrrelevant": {},
            "chbkIsIrrelevant": {}
         },
         "merchantFoundBuyerExposure": {
            "customerSignedInUsingLegitSocialNetworkAccount": {},
            "merchantFoundBuyerEmailOnline": {},
            "merchantFoundBuyerPhoneNumberOnline": {},
            "merchantFoundConnectionBetweenIndividualsInTheOrder": {
               "dataSource": {}
            },
            "merchantFoundConnectionBetweenNameAndAddress": {
               "dataSource": {}
            },
            "merchantFoundRecipientEmailOnline": {},
            "merchantFoundRecipientPhoneNumberOnline": {}
         },
         "merchantPolicyDecisionNotApplicable": {},
         "merchantThinksOrderCharacteristicsAreLegit": {
            "goodCustomer": {
               "establishedAccount": {
                  "establishedAccountDetails": {},
                  "relatedAccountDetails": {}
               },
               "previousPointOfSalePurchase": {}
            },
            "lowRiskPaymentMethod": {}
         }
      },
      "merchantWouldLikeDeclined": {
         "fraudTypeSuspectedByMerchant": {
            "merchantSuspectsAccountTakeOver": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            },
            "merchantSuspectsBuyerSellerCollusion": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            },
            "merchantSuspectsFraudOther": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            },
            "merchantSuspectsFriendlyFraud": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            },
            "merchantSuspectsStolenPaymentMethod": {
               "merchantSuspectsAccountDetails": {},
               "merchantSuspectsOrderDetails": {}
            }
         }
      }
   },
   "orderId": "2356fdse0rr489",
   "primaryRecipient": {
      "additionalVerificationDocuments": {
         "documentSource": "UPLOADED_FILE",
         "documentType": "Passport",
         "documentVerificationServiceResponsePayload": {}
      },
      "address": {
         "address1": "235 Montgomery st.",
         "city": "San Francisco",
         "country": "US",
         "savedData": {
            "usedSavedData": True
         }
      },
      "bankAccount": {
         "paymentGatewayData": {}
      },
      "comments": {},
      "cryptoWallet": {
         "cryptoWalletType": "EXTERNAL"
      },
      "personalDetails": {},
      "phone": [
         {
            "phone": "15557654321",
            "smsVerified": {
               "sent": True,
               "verified": False
            }
         }
      ]
   },
   "totalAmount": {}
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'api-version': '10.3',
   'x-forter-siteid': 'a1b2c3d4e5f6',
   'authorization': 'Basic <base64-encoded-api-key:>'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Example validationResponse
{
  "action": "approve",
  "message": "",
  "reasonCode": "",
  "recommendations": [
    ""
  ],
  "status": "success",
  "transaction": "123456"
}

400

// Bad Request (Often missing a required parameter)

401

// Unauthorized (No valid API key provided)

404

// Not Found (The requested item doesn't exist)

500

// Server Error (Something went wrong on Forter's end)