v1

latestOpenAPI 3.0.0Forter License2026-07-1333204516.7 KB
Orders

Order update

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

post/v2/order-update/{id}

Path parameters

idstring required

Headers

api-versionstring required
Example:10.1

Specify the version of the API to target.

x-forter-siteidstring required
Example:a1b2c3d4e5f6

Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.

Authorizationstring required
Example:Basic <base64-encoded-api-key:>

Basic Authentiation in the form of a username and password. Use the API Key as the username and leave the password empty.

Request body

orderIdstring required

Unique order/transaction identifier. Note that Forter treats this ID as case-insensitive; Order123 and ORDER123 will be identified as the same order.

orderType'WEB' | 'PHONE' | 'DYNAMIC_PHONE' | 'MOBILE' | 'MOBILE_IN_STORE' | 'IOS' | 'ANDROID' | 'WAP' | 'STORE' | 'MERCHANT_EMPLOYEE' | 'MAIL_ORDER' | 'AUTOMATIC_RENEWAL_OR_INSTALLMENT_PAYMENT' | 'MERCHANT_INITIATED' | 'UNKNOWN' | 'POS' | 'API_ONLY' | 'PERSONAL_POS' | 'PHONE_LINK' | 'AI_AGENT' nullable

Platform order was made through

Example request

{
  "connectionInformation": {
    "checkoutToolsSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
    "customerIP": "10.0.0.127",
    "forterMobileUID": "6429751237891",
    "forterTokenCookie": "249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg",
    "merchantDeviceIdentifier": "HGJ7512345H3",
    "merchantProvidedSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
    "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
  },
  "merchantFeedback": {
    "agentGeneralImpression": "I_DONT_KNOW",
    "feedbackAppliesToAllFutureDecisionsUntil": 1430997968,
    "merchantCustomerSupport": {
      "contactCustomerIP": "10.0.0.127",
      "contactEmailUsed": {
        "merchantContactedEmail": "jsmith@gmail.com",
        "merchantContactedEmailRole": "BILLING_EMAIL"
      },
      "contactMethodType": "PHONE",
      "contactNameUsed": {
        "customerContactNameType": "OTHER",
        "customerFirstName": "John",
        "customerLastName": "Smith"
      },
      "contactPhoneUsed": {
        "merchantContactedPhoneNumber": "212-555-5555",
        "merchantContactedPhoneRole": "BILLING_PHONE"
      },
      "contactTime": 1430997968,
      "customerSupportChangeOrderDetails": {
        "customerSupportRequestPickupStoreZip": "94104"
      },
      "customerSupportFurtherVerification": {
        "customerAnsweredSecurityQuestions": true,
        "customerSupportAdditionalVerificationDocuments": {
          "documentFirstName": "John",
          "documentLastName": "Smith",
          "documentType": "Passport",
          "documentVerified": true,
          "nationality": "US"
        },
        "customerSupportSMSverification": "+1-212-555-5555"
      },
      "initiatedBy": "CUSTOMER",
      "orderId": "4306795",
      "ticketId": "4306795"
    },
    "merchantWouldLikeApproved": {
      "merchantContactedIssuer": {
        "issuerNameOnCardMatch": "UNKNOWN",
        "issuerPhoneMatch": "UNKNOWN",
        "issuerStreetAddressMatch": "UNKNOWN",
        "issuerZipMatch": "UNKNOWN"
      },
      "merchantDisagreesWithSpecificDeclineReason": {
        "atoIsIrrelevant": {
          "notATOBecauseOfOtherReason": "Password wasn't reset"
        }
      },
      "merchantFoundBuyerExposure": {
        "customerSignedInUsingLegitSocialNetworkAccount": {
          "otherSocialNetwork": "VK"
        },
        "merchantFoundBuyerEmailOnline": {
          "otherSource": "SearchPerson.com"
        },
        "merchantFoundBuyerPhoneNumberOnline": {
          "otherSource": "SearchPerson.com"
        },
        "merchantFoundConnectionBetweenIndividualsInTheOrder": {
          "connectionType": "FAMILY",
          "dataSource": {
            "otherSource": "SearchPerson.com"
          },
          "nameRole1": "CARDHOLDER",
          "nameRole2": "SHIPPING_NAME"
        },
        "merchantFoundConnectionBetweenNameAndAddress": {
          "addressRole": "SHIPPING_ADDRESS",
          "dataSource": {
            "otherSource": "SearchPerson.com"
          },
          "nameRole": "CARDHOLDER"
        },
        "merchantFoundRecipientEmailOnline": {
          "otherSource": "SearchPerson.com"
        },
        "merchantFoundRecipientPhoneNumberOnline": {
          "otherSource": "SearchPerson.com"
        }
      },
      "merchantThinksOrderCharacteristicsAreLegit": {
        "goodCustomer": {
          "establishedAccount": {
            "establishedAccountDetails": {
              "accountAgeInMonths": 18,
              "accountSpendUSD": {
                "amountLocalCurrency": "105.55",
                "amountUSD": "99.95",
                "currency": "CAD"
              }
            },
            "relatedAccountDetails": {
              "accountEmail": "johns.friend@gmail.com",
              "accountId": "1fd95-ao4z00-4wsd153"
            }
          },
          "merchantHasGoodScoreElsewhere": "INTERNAL_SCORE",
          "previousPointOfSalePurchase": {
            "pointOfSalePurchaseState": "NY",
            "pointOfSalePurchaseZip": "10001"
          }
        },
        "lowRiskPaymentMethod": {
          "other": "Apple Pay"
        }
      }
    },
    "merchantWouldLikeDeclined": {
      "fraudTypeSuspectedByMerchant": {
        "merchantSuspectsAccountTakeOver": {
          "merchantSuspectsAccountDetails": {
            "accountDetailsWereChanged": true,
            "highVelocity": true,
            "inactiveAccount": true,
            "linkedToMultipleAccounts": true,
            "other": true
          },
          "merchantSuspectsOrderDetails": {
            "badItem": true,
            "badShippingAddress": true,
            "fakeEmail": true,
            "other": true
          }
        },
        "merchantSuspectsBuyerSellerCollusion": {
          "merchantSuspectsAccountDetails": {
            "accountDetailsWereChanged": true,
            "highVelocity": true,
            "inactiveAccount": true,
            "linkedToMultipleAccounts": true,
            "other": true
          },
          "merchantSuspectsOrderDetails": {
            "badItem": true,
            "badShippingAddress": true,
            "fakeEmail": true,
            "other": true
          }
        },
        "merchantSuspectsFraudOther": {
          "merchantSuspectsAccountDetails": {
            "accountDetailsWereChanged": true,
            "highVelocity": true,
            "inactiveAccount": true,
            "linkedToMultipleAccounts": true,
            "other": true
          },
          "merchantSuspectsOrderDetails": {
            "badItem": true,
            "badShippingAddress": true,
            "fakeEmail": true,
            "other": true
          }
        },
        "merchantSuspectsFriendlyFraud": {
          "merchantSuspectsAccountDetails": {
            "accountDetailsWereChanged": true,
            "highVelocity": true,
            "inactiveAccount": true,
            "linkedToMultipleAccounts": true,
            "other": true
          },
          "merchantSuspectsOrderDetails": {
            "badItem": true,
            "badShippingAddress": true,
            "fakeEmail": true,
            "other": true
          }
        },
        "merchantSuspectsStolenPaymentMethod": {
          "merchantSuspectsAccountDetails": {
            "accountDetailsWereChanged": true,
            "highVelocity": true,
            "inactiveAccount": true,
            "linkedToMultipleAccounts": true,
            "other": true
          },
          "merchantSuspectsOrderDetails": {
            "badItem": true,
            "badShippingAddress": true,
            "fakeEmail": true,
            "other": true
          }
        }
      },
      "merchantConfidenceLevelThisIsFraud": "NOT_SURE_COMMA_LOOKS_SUSPICIOUS",
      "merchantThinksPolicyShouldApply": "Decline all non-US domestic orders"
    }
  },
  "orderId": "2356fdse0rr489",
  "orderType": "PHONE_LINK",
  "payment": [
    {
      "amount": {
        "amountLocalCurrency": "105.55",
        "amountUSD": "99.95",
        "currency": "CAD"
      },
      "androidPay": {
        "bin": "42424242",
        "cardBank": "Chase",
        "cardBrand": "VISA",
        "cardType": "CREDIT",
        "countryOfIssuance": "US",
        "creationTime": 1430997968,
        "expirationMonth": "03",
        "expirationYear": "2018",
        "lastFourDigits": "4242",
        "nameOnCard": "John R. H. Smith",
        "paymentProcessorData": {
          "processorName": "Chase Paymentech",
          "processorTransactionId": "fjdsS46sdklFd20"
        },
        "threeDSecure": {
          "acquirerData": {
            "acquirerBIN": "457173",
            "acquirerCountry": "US",
            "acquirerMerchantId": "5245020244654",
            "acquirerMerchantName": "Simple T-shirt",
            "acquirerName": "Barclays",
            "merchantCategoryCode": 5655,
            "merchantCountryCode": 840
          },
          "challengeIndicator": "NO_PREFERENCE",
          "execute3ds": "DYNAMIC_FORTER_DECISION",
          "forcePsd2Exemption": {
            "channel": "THREEDS_RAILS",
            "type": "LOW_VALUE"
          },
          "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
        },
        "token": "tkn-77620C360132856A103477D2959967AB",
        "verificationResults": {
          "authorizationCode": "A33244",
          "authorizationProcessedWith3DS": true,
          "avsFullResult": "Y",
          "avsNameResult": "M",
          "avsStreetResult": "N",
          "avsZipResult": "M",
          "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
          "cvvResult": "M",
          "eciValue": "05",
          "exemptionStatus": "accepted",
          "issuerResponseCode": "D23",
          "issuerResponseText": "Stolen card",
          "liabilityShift": true,
          "partyExecuted3DS": "PSP",
          "processorResponseCode": "D23",
          "processorResponseText": "Stolen card",
          "threeDsInteractionMode": "FRICTIONLESS",
          "threeDsStatus": "Cardholder authenticated",
          "threeDsVersion": "2.1.0"
        }
      },
      "applePay": {
        "bin": "42424242",
        "cardBank": "Chase",
        "cardBrand": "VISA",
        "cardType": "CREDIT",
        "countryOfIssuance": "US",
        "creationTime": 1430997968,
        "expirationMonth": "03",
        "expirationYear": "2018",
        "lastFourDigits": "4242",
        "nameOnCard": "John R. H. Smith",
        "paymentProcessorData": {
          "processorName": "Chase Paymentech",
          "processorTransactionId": "fjdsS46sdklFd20"
        },
        "threeDSecure": {
          "acquirerData": {
            "acquirerBIN": "457173",
            "acquirerCountry": "US",
            "acquirerMerchantId": "5245020244654",
            "acquirerMerchantName": "Simple T-shirt",
            "acquirerName": "Barclays",
            "merchantCategoryCode": 5655,
            "merchantCountryCode": 840
          },
          "challengeIndicator": "NO_PREFERENCE",
          "execute3ds": "DYNAMIC_FORTER_DECISION",
          "forcePsd2Exemption": {
            "channel": "THREEDS_RAILS",
            "type": "LOW_VALUE"
          },
          "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
        },
        "token": "tkn-77620C360132856A103477D2959967AB",
        "verificationResults": {
          "authorizationCode": "A33244",
          "authorizationProcessedWith3DS": true,
          "avsFullResult": "Y",
          "avsNameResult": "M",
          "avsStreetResult": "N",
          "avsZipResult": "M",
          "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
          "cvvResult": "M",
          "eciValue": "05",
          "exemptionStatus": "accepted",
          "issuerResponseCode": "D23",
          "issuerResponseText": "Stolen card",
          "liabilityShift": true,
          "partyExecuted3DS": "PSP",
          "processorResponseCode": "D23",
          "processorResponseText": "Stolen card",
          "threeDsInteractionMode": "FRICTIONLESS",
          "threeDsStatus": "Cardholder authenticated",
          "threeDsVersion": "2.1.0"
        }
      },
      "bankTransfer": {
        "accountHolderFirstName": "John",
        "accountHolderLastName": "Smith",
        "achProcessingType": "SAME_DAY_ACH",
        "bankAccountIdentifier": "TEST63TEST1212121212",
        "bankAccountType": "Savings",
        "bankName": "Citigroup",
        "paymentGatewayData": {
          "gatewayName": "Braintree",
          "gatewayTransactionId": "fjdsS46sdklFd20"
        },
        "paymentSuccessStatus": "Payment Successful",
        "serviceName": "Direct Debit"
      },
      "billingDetails": {
        "address": {
          "address1": "235 Montgomery st.",
          "address2": "Ste. 1110",
          "city": "San Francisco",
          "company": "Generic Corp. ltd.",
          "country": "US",
          "region": "CA",
          "savedData": {
            "usedSavedData": true
          },
          "zip": "94104"
        },
        "allAdditionalVerificationDocuments": [
          {
            "address": {
              "address1": "235 Montgomery st.",
              "address2": "Ste. 1110",
              "city": "San Francisco",
              "company": "Generic Corp. ltd.",
              "country": "US",
              "region": "CA",
              "savedData": {
                "usedSavedData": true
              },
              "zip": "94104"
            },
            "documentDateOfBirth": "1991-01-09",
            "documentExpiration": "2017-01-15",
            "documentFirstName": "John",
            "documentIssuingState": "NY",
            "documentLastName": "Smith",
            "documentNumber": "20439190",
            "documentSource": "UPLOADED_FILE",
            "documentStatus": "SENT_TO_CLIENT",
            "documentType": "Passport",
            "documentVerificationServiceAnswer": "APPROVED",
            "documentVerificationServiceName": "IDVerification.com",
            "documentVerified": true,
            "eventTime": 1420070400,
            "nationality": "US"
          }
        ],
        "employmentInformation": [
          {
            "employerAddress": {
              "address1": "235 Montgomery st.",
              "address2": "Ste. 1110",
              "city": "San Francisco",
              "company": "Generic Corp. ltd.",
              "country": "US",
              "region": "CA",
              "savedData": {
                "usedSavedData": true
              },
              "zip": "94104"
            },
            "employerCompanySizeRange": "20",
            "employerIndustry": "Retail",
            "employerName": "Forter",
            "employerPhone": "+12126667777",
            "income": {
              "amountLocalCurrency": "105.55",
              "amountUSD": "99.95",
              "currency": "CAD"
            },
            "jobTitle": "Fraud Analyst"
          }
        ],
        "personalDetails": {
          "birthdate": "1987-05-22",
          "email": "john_s@test.com",
          "firstName": "John",
          "fullName": "John Smith",
          "gender": "MALE",
          "lastName": "Smith"
        },
        "phone": [
          {
            "phone": "15557654321",
            "smsVerified": {
              "sent": true,
              "timeSent": 1389567341
            }
          }
        ]
      },
      "cameraCaptured": true,
      "creditCard": {
        "bin": "42424242",
        "cardBank": "Chase",
        "cardBrand": "VISA",
        "cardType": "CREDIT",
        "countryOfIssuance": "US",
        "expirationMonth": "03",
        "expirationYear": "2018",
        "fingerprint": "Xt5EWLLDS7FJjR1c",
        "fullCreditCard": "2424242424242424",
        "lastFourDigits": "4242",
        "nameOnCard": "John R. H. Smith",
        "paymentGatewayData": {
          "gatewayName": "Braintree",
          "gatewayTransactionId": "fjdsS46sdklFd20"
        },
        "paymentProcessorData": {
          "processorName": "Chase Paymentech",
          "processorTransactionId": "fjdsS46sdklFd20"
        },
        "threeDSecure": {
          "acquirerData": {
            "acquirerBIN": "457173",
            "acquirerCountry": "US",
            "acquirerMerchantId": "5245020244654",
            "acquirerMerchantName": "Simple T-shirt",
            "acquirerName": "Barclays",
            "merchantCategoryCode": 5655,
            "merchantCountryCode": 840
          },
          "challengeIndicator": "NO_PREFERENCE",
          "execute3ds": "DYNAMIC_FORTER_DECISION",
          "forcePsd2Exemption": {
            "channel": "THREEDS_RAILS",
            "type": "LOW_VALUE"
          },
          "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
        },
        "verificationResults": {
          "authorizationCode": "A33244",
          "authorizationProcessedWith3DS": true,
          "avsFullResult": "Y",
          "avsNameResult": "M",
          "avsStreetResult": "N",
          "avsZipResult": "M",
          "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
          "cvvResult": "M",
          "eciValue": "05",
          "exemptionStatus": "accepted",
          "issuerResponseCode": "D23",
          "issuerResponseText": "Stolen card",
          "liabilityShift": true,
          "partyExecuted3DS": "PSP",
          "processorResponseCode": "D23",
          "processorResponseText": "Stolen card",
          "threeDsInteractionMode": "FRICTIONLESS",
          "threeDsStatus": "Cardholder authenticated",
          "threeDsVersion": "2.1.0"
        }
      },
      "creditLineDetails": {
        "creditLineLimitIncreaseMethod": "AT_PURCHASE",
        "currentCreditLineLimit": {
          "amountLocalCurrency": "105.55",
          "amountUSD": "99.95",
          "currency": "CAD"
        },
        "originalCreditLineLimit": {
          "amountLocalCurrency": "105.55",
          "amountUSD": "99.95",
          "currency": "CAD"
        }
      },
      "cryptoWallet": {
        "cryptoWalletName": "CryptoWallet",
        "cryptoWalletPaymentId": "3JQiwG88SQvwihDAHg9M2EnqEisharz49c",
        "cryptoWalletType": "EXTERNAL"
      },
      "digitalWallet": {
        "digitalWalletName": "ALIPAY",
        "digitalWalletPayerEmail": "john_s@test.com",
        "digitalWalletPayerId": "FD000A45P",
        "digitalWalletpaymentId": "PAY-0MB00000KR8073311KZSDEYA",
        "freeTextDigitalWalletName": "ALIBABA",
        "payerAccountCountry": "US",
        "paymentSuccessStatus": "COMPLETED",
        "underlyingPaymentMethod": {
          "bankTransfer": {
            "accountHolderFirstName": "John",
            "accountHolderLastName": "Smith",
            "achProcessingType": "SAME_DAY_ACH",
            "bankAccountIdentifier": "TEST63TEST1212121212",
            "bankAccountType": "Savings",
            "bankName": "Citigroup",
            "paymentGatewayData": {
              "gatewayName": "Braintree",
              "gatewayTransactionId": "fjdsS46sdklFd20"
            },
            "paymentSuccessStatus": "Payment Successful",
            "serviceName": "Direct Debit"
          },
          "creditCard": {
            "bin": "42424242",
            "cardBank": "Chase",
            "cardBrand": "VISA",
            "cardType": "CREDIT",
            "countryOfIssuance": "US",
            "creationTime": 1430997968,
            "expirationMonth": "03",
            "expirationYear": "2018",
            "lastFourDigits": "4242",
            "nameOnCard": "John R. H. Smith",
            "paymentProcessorData": {
              "processorName": "Chase Paymentech",
              "processorTransactionId": "fjdsS46sdklFd20"
            },
            "threeDSecure": {
              "acquirerData": {
                "acquirerBIN": "457173",
                "acquirerCountry": "US",
                "acquirerMerchantId": "5245020244654",
                "acquirerMerchantName": "Simple T-shirt",
                "acquirerName": "Barclays",
                "merchantCategoryCode": 5655,
                "merchantCountryCode": 840
              },
              "challengeIndicator": "NO_PREFERENCE",
              "execute3ds": "DYNAMIC_FORTER_DECISION",
              "forcePsd2Exemption": {
                "channel": "THREEDS_RAILS",
                "type": "LOW_VALUE"
              },
              "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
            },
            "token": "tkn-77620C360132856A103477D2959967AB",
            "verificationResults": {
              "authorizationCode": "A33244",
              "authorizationProcessedWith3DS": true,
              "avsFullResult": "Y",
              "avsNameResult": "M",
              "avsStreetResult": "N",
              "avsZipResult": "M",
              "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
              "cvvResult": "M",
              "eciValue": "05",
              "exemptionStatus": "accepted",
              "issuerResponseCode": "D23",
              "issuerResponseText": "Stolen card",
              "liabilityShift": true,
              "partyExecuted3DS": "PSP",
              "processorResponseCode": "D23",
              "processorResponseText": "Stolen card",
              "threeDsInteractionMode": "FRICTIONLESS",
              "threeDsStatus": "Cardholder authenticated",
              "threeDsVersion": "2.1.0"
            }
          },
          "underlyingPaymentMethodType": "UNKNOWN"
        }
      },
      "giftCard": {
        "activationTime": 1448549922,
        "creditCurrency": "CAD",
        "creditOrigin": "CS Compensation",
        "merchantPaymentId": "eab12-ba9a-367-60b",
        "value": {
          "amountLocalCurrency": "105.55",
          "amountUSD": "99.95",
          "currency": "CAD"
        }
      },
      "installmentService": {
        "firstName": "John",
        "lastName": "Smith",
        "paymentId": "YTZ8IATEGAWRRVVG",
        "serviceName": "Affirm",
        "serviceResponseCode": "200"
      },
      "loyaltyPoints": {
        "loyaltyPointsCount": 1506,
        "loyaltyPointsSource": "IN_ACCOUNT_PURCHASES",
        "loyaltyPointsValue": {
          "amountLocalCurrency": "105.55",
          "amountUSD": "99.95",
          "currency": "CAD"
        },
        "merchantPaymentId": "eab12-ba9a-367-60b"
      },
      "merchantInitiated": {
        "initialOrderId": "2356fdse0rr489"
      },
      "mobileMoney": {
        "mobileMoneyNetwork": "MPESA",
        "paymentAcquirerData": {
          "acquirerBIN": "457173",
          "acquirerCountry": "US",
          "acquirerMerchantId": "5245020244654",
          "acquirerMerchantName": "Simple T-shirt",
          "acquirerName": "Barclays",
          "merchantCategoryCode": 5655,
          "merchantCountryCode": 840
        },
        "paymentGatewayData": {
          "gatewayName": "Braintree",
          "gatewayTransactionId": "fjdsS46sdklFd20"
        },
        "paymentSuccessStatus": "success",
        "phoneNumber": "15557654321"
      },
      "numberOfInstallments": 12,
      "paymentMethodNickname": "My Work Card",
      "paypal": {
        "authorizationId": "2WC75407LV7300439",
        "payerAccountCountry": "US",
        "payerAddressStatus": "CONFIRMED",
        "payerEmail": "john_s@test.com",
        "payerId": "FD000A45P",
        "payerStatus": "VERIFIED",
        "paymentGatewayData": {
          "gatewayName": "Braintree",
          "gatewayTransactionId": "fjdsS46sdklFd20"
        },
        "paymentId": "PAY-0MB00000KR8073311KZSDEYA",
        "paymentStatus": "COMPLETED",
        "protectionEligibility": "ELIGIBLE"
      },
      "recurringPayment": {
        "currentPaymentNumber": 1,
        "initialPaymentOrderId": "2356fdse0rr483",
        "recurringPaymentExpirationDate": "1988-06-22",
        "recurringPaymentFrequency": "7",
        "totalNumberOfPayments": 12
      },
      "samsungPay": {
        "bin": "42424242",
        "cardBank": "Chase",
        "cardBrand": "VISA",
        "cardType": "CREDIT",
        "countryOfIssuance": "US",
        "creationTime": 1430997968,
        "expirationMonth": "03",
        "expirationYear": "2018",
        "lastFourDigits": "4242",
        "nameOnCard": "John R. H. Smith",
        "paymentProcessorData": {
          "processorName": "Chase Paymentech",
          "processorTransactionId": "fjdsS46sdklFd20"
        },
        "threeDSecure": {
          "acquirerData": {
            "acquirerBIN": "457173",
            "acquirerCountry": "US",
            "acquirerMerchantId": "5245020244654",
            "acquirerMerchantName": "Simple T-shirt",
            "acquirerName": "Barclays",
            "merchantCategoryCode": 5655,
            "merchantCountryCode": 840
          },
          "challengeIndicator": "NO_PREFERENCE",
          "execute3ds": "DYNAMIC_FORTER_DECISION",
          "forcePsd2Exemption": {
            "channel": "THREEDS_RAILS",
            "type": "LOW_VALUE"
          },
          "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
        },
        "token": "tkn-77620C360132856A103477D2959967AB",
        "verificationResults": {
          "authorizationCode": "A33244",
          "authorizationProcessedWith3DS": true,
          "avsFullResult": "Y",
          "avsNameResult": "M",
          "avsStreetResult": "N",
          "avsZipResult": "M",
          "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
          "cvvResult": "M",
          "eciValue": "05",
          "exemptionStatus": "accepted",
          "issuerResponseCode": "D23",
          "issuerResponseText": "Stolen card",
          "liabilityShift": true,
          "partyExecuted3DS": "PSP",
          "processorResponseCode": "D23",
          "processorResponseText": "Stolen card",
          "threeDsInteractionMode": "FRICTIONLESS",
          "threeDsStatus": "Cardholder authenticated",
          "threeDsVersion": "2.1.0"
        }
      },
      "savedData": {
        "usedSavedData": true
      },
      "storeCreditUsed": {
        "activationTime": 1448549922,
        "creditCurrency": "CAD",
        "creditOrigin": "CS Compensation",
        "merchantPaymentId": "eab12-ba9a-367-60b",
        "value": {
          "amountLocalCurrency": "105.55",
          "amountUSD": "99.95",
          "currency": "CAD"
        }
      },
      "tokenizedCard": {
        "bin": "42424242",
        "cardBank": "Chase",
        "cardBrand": "VISA",
        "cardType": "CREDIT",
        "countryOfIssuance": "US",
        "creationTime": 1430997968,
        "expirationMonth": "03",
        "expirationYear": "2018",
        "lastFourDigits": "4242",
        "nameOnCard": "John R. H. Smith",
        "paymentProcessorData": {
          "processorName": "Chase Paymentech",
          "processorTransactionId": "fjdsS46sdklFd20"
        },
        "threeDSecure": {
          "acquirerData": {
            "acquirerBIN": "457173",
            "acquirerCountry": "US",
            "acquirerMerchantId": "5245020244654",
            "acquirerMerchantName": "Simple T-shirt",
            "acquirerName": "Barclays",
            "merchantCategoryCode": 5655,
            "merchantCountryCode": 840
          },
          "challengeIndicator": "NO_PREFERENCE",
          "execute3ds": "DYNAMIC_FORTER_DECISION",
          "forcePsd2Exemption": {
            "channel": "THREEDS_RAILS",
            "type": "LOW_VALUE"
          },
          "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
        },
        "token": "tkn-77620C360132856A103477D2959967AB",
        "verificationResults": {
          "authorizationCode": "A33244",
          "authorizationProcessedWith3DS": true,
          "avsFullResult": "Y",
          "avsNameResult": "M",
          "avsStreetResult": "N",
          "avsZipResult": "M",
          "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
          "cvvResult": "M",
          "eciValue": "05",
          "exemptionStatus": "accepted",
          "issuerResponseCode": "D23",
          "issuerResponseText": "Stolen card",
          "liabilityShift": true,
          "partyExecuted3DS": "PSP",
          "processorResponseCode": "D23",
          "processorResponseText": "Stolen card",
          "threeDsInteractionMode": "FRICTIONLESS",
          "threeDsStatus": "Cardholder authenticated",
          "threeDsVersion": "2.1.0"
        }
      },
      "venmo": {
        "paymentId": "1KZSDEYA",
        "token": "77620C360132856A103477D2959967AB",
        "userId": "johndoe",
        "userName": "johndoe1987"
      }
    }
  ],
  "primaryRecipient": {
    "additionalVerificationDocuments": {
      "address": {
        "address1": "235 Montgomery st.",
        "address2": "Ste. 1110",
        "city": "San Francisco",
        "company": "Generic Corp. ltd.",
        "country": "US",
        "region": "CA",
        "savedData": {
          "usedSavedData": true
        },
        "zip": "94104"
      },
      "documentDateOfBirth": "1991-01-09",
      "documentExpiration": "2017-01-15",
      "documentFirstName": "John",
      "documentIssuingState": "NY",
      "documentLastName": "Smith",
      "documentNumber": "20439190",
      "documentSource": "UPLOADED_FILE",
      "documentStatus": "SENT_TO_CLIENT",
      "documentType": "Passport",
      "documentVerificationServiceAnswer": "APPROVED",
      "documentVerificationServiceName": "IDVerification.com",
      "documentVerified": true,
      "eventTime": 1420070400,
      "nationality": "US"
    },
    "address": {
      "address1": "235 Montgomery st.",
      "address2": "Ste. 1110",
      "city": "San Francisco",
      "company": "Generic Corp. ltd.",
      "country": "US",
      "region": "CA",
      "savedData": {
        "usedSavedData": true
      },
      "zip": "94104"
    },
    "bankAccount": {
      "accountHolderFirstName": "John",
      "accountHolderLastName": "Smith",
      "achProcessingType": "SAME_DAY_ACH",
      "bankAccountIdentifier": "TEST63TEST1212121212",
      "bankAccountType": "Savings",
      "bankName": "Citigroup",
      "paymentGatewayData": {
        "gatewayName": "Braintree",
        "gatewayTransactionId": "fjdsS46sdklFd20"
      },
      "paymentSuccessStatus": "Payment Successful",
      "serviceName": "Direct Debit"
    },
    "comments": {
      "merchantComments": "Shipping delayed",
      "messageToBeneficiary": "Enjoy the gift John!",
      "userCommentsToMerchant": "Please wrap with care!!"
    },
    "cryptoWallet": {
      "cryptoWalletName": "CryptoWallet",
      "cryptoWalletPaymentId": "3JQiwG88SQvwihDAHg9M2EnqEisharz49c",
      "cryptoWalletType": "EXTERNAL"
    },
    "loyaltyProgram": [
      {
        "accountNumber": "VC1568OP",
        "loyaltyPointsValue": {
          "amountLocalCurrency": "105.55",
          "amountUSD": "99.95",
          "currency": "CAD"
        },
        "programName": "StarAlliance",
        "tier": "Blue"
      }
    ],
    "personalDetails": {
      "birthdate": "1987-05-22",
      "email": "john_s@test.com",
      "firstName": "John",
      "fullName": "John Smith",
      "gender": "MALE",
      "lastName": "Smith"
    },
    "phone": [
      {
        "phone": "15557654321",
        "smsVerified": {
          "sent": true,
          "timeSent": 1389567341
        }
      }
    ]
  },
  "totalAmount": {
    "amountLocalCurrency": "105.55",
    "amountUSD": "99.95",
    "currency": "CAD"
  }
}

Response

Example validationResponse

actionstring required

The message containing the decision

messagestring required

The message containing status response text

reasonCodestring required
recommendationsstring[] required

Forter's recommendations for the optimal way of proceeding with the order

statusstring required

Status of the request processing

transactionstring required

Transaction id. Note that Forter treats this ID as case-insensitive; Order123 and ORDER123 will be identified as the same order.

Example response

{
  "action": "approve",
  "paymentRecommendations": {
    "processors": [
      {
        "priority": 1
      }
    ]
  },
  "recommendations": [],
  "status": "success",
  "transaction": "123456"
}