Order update - API Reference

Order update

POST

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

Credentials

Path Parameters

Parameter Type Required
id string 

Header Parameters

Header Type Required
api-version string 
x-forter-siteid string 

Body Parameters

Parameter Type Required
body validationUpdateRequest 

Description

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

connectionInformation
All Of
orderId
orderType
payment
primaryRecipient
All Of

Responses

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)

Request

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.1' \
  --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": {}
}'