--- title: Order update slug: reference/order-update docTags: createdAt: 2026-08-23T06:01:06.452Z --- { "id": "tpKPBusovUulQqrXCxZlz", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.forter-secure.com/v2/order-update/{id}", "servers": [ { "url": "https://api.forter-secure.com/v2/order-update/{id}" } ], "name": "Order update", "description": "

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

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "api-version", "type": "string", "example": "10.3", "description": "Specify the version of the API to target." }, { "kind": "required", "name": "x-forter-siteid", "type": "string", "example": "a1b2c3d4e5f6", "description": "

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

" }, { "kind": "required", "name": "Authorization", "type": "string", "example": "Basic ", "description": "Basic Authentiation in the form of a username and password. Use the API Key as the username and leave the password empty." } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "

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

", "customType": "validationUpdateRequest", "schema": [ { "name": "connectionInformation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ConnectionInformation", "description": "", "modelRef": "#/components/schemas/ConnectionInformation", "schema": [ { "name": "checkoutToolsSessionId", "kind": "optional", "type": "string", "nullable": true, "description": "CheckoutToolsSessionId received from the SDK", "example": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd", "maxLength": 128 }, { "name": "customerIP", "kind": "required", "type": "string", "description": "Customer IP address in IPv4 or IPv6 format. If missing should be populated with 127.0.0.1", "example": "10.0.0.127" }, { "name": "forterMobileUID", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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)

", "example": "6429751237891", "maxLength": 128 }, { "name": "forterTokenCookie", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nForter token cookie from request headers", "example": "249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg", "maxLength": 128 }, { "name": "merchantDeviceIdentifier", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nA unique device identifier generated by merchant", "example": "HGJ7512345H3", "maxLength": 100 }, { "name": "merchantProvidedSessionId", "kind": "optional", "type": "string", "nullable": true, "description": "An identifier of the merchant session", "example": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd", "maxLength": 128 }, { "name": "userAgent", "kind": "required", "type": "string", "description": "Customer's User agent", "example": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36", "maxLength": 4096 } ] } ], "schema": [] }, { "name": "merchantFeedback", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantFeedback", "description": "", "modelRef": "#/components/schemas/MerchantFeedback", "schema": [ { "name": "agentGeneralImpression", "kind": "optional", "type": "", "conditional": true, "nullable": true, "description": "Conditional.\n

What is your general impression of the customer following your interaction/analysis (do you believe he is suspicious? do you believe he is legitimate?)

", "example": "I_DONT_KNOW", "enum": [ "CUSTOMER_IS_LEGIT", "I_DONT_KNOW", "CUSTOMER_IS_SUSPICIOUS" ], "maxLength": 75 }, { "name": "doesNotAffectFutureDecisions", "kind": "optional", "type": "boolean", "nullable": true, "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

" }, { "name": "feedbackAppliesToAllFutureDecisionsUntil", "kind": "optional", "type": "number", "nullable": true, "description": "

Until this timestamp (epoch seconds), the feedback will apply to all future transactions of this type

", "example": 1430997968 }, { "name": "isFutureDecision", "kind": "optional", "type": "boolean", "nullable": true, "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." }, { "name": "isPolicyApprove", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Set to true if the customer has been previously declined, but should be approved as a matter of policy in their next transaction.

" }, { "name": "merchantCustomerSupport", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ContactWithCustomer", "description": "", "modelRef": "#/components/schemas/ContactWithCustomer", "schema": [ { "name": "contactCustomerIP", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCustomer IP address used to contact the merchant in IPv4 or IPv6 format. Typically available when customer contact is via chat", "example": "10.0.0.127" }, { "name": "contactEmailUsed", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantContactedCustomerEmail", "description": "", "modelRef": "#/components/schemas/MerchantContactedCustomerEmail", "schema": [ { "name": "merchantContactedEmail", "kind": "optional", "type": "string", "nullable": true, "description": "

email used to contact the customer (if not one of the emails used in the order)

", "example": "jsmith@gmail.com", "maxLength": 75 }, { "name": "merchantContactedEmailRole", "kind": "optional", "type": "", "nullable": true, "description": "I used the following phone to contact the customer", "example": "BILLING_EMAIL", "enum": [ "BILLING_EMAIL", "SHIPPING_EMAIL", "ACCOUNT_EMAIL", "OTHER_EMAIL", "NA" ] } ] } ], "schema": [] }, { "name": "contactMethodType", "kind": "required", "type": "", "description": "Method used by customer to contact support", "example": "PHONE", "enum": [ "PHONE", "EMAIL", "CHAT", "SUPPORT_FORM" ] }, { "name": "contactNameUsed", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantContactedCustomerName", "description": "", "modelRef": "#/components/schemas/MerchantContactedCustomerName", "schema": [ { "name": "customerContactNameType", "kind": "required", "type": "", "description": "

The role of the contact (name) that interacted with customer support.

", "example": "OTHER", "enum": [ "CARDHOLDER", "BILLING_NAME", "SHIPPING_NAME", "ACCOUNT_HOLDER", "OTHER", "NA" ] }, { "name": "customerFirstName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFirst name of the person who contacted the merchant's customer support", "example": "John", "maxLength": 75 }, { "name": "customerLastName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nLast name of the person who contacted the merchant's customer support", "example": "Smith", "maxLength": 75 } ] } ], "schema": [] }, { "name": "contactPhoneUsed", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantContactedCustomerPhone", "description": "", "modelRef": "#/components/schemas/MerchantContactedCustomerPhone", "schema": [ { "name": "merchantContactedPhoneNumber", "kind": "optional", "type": "string", "nullable": true, "description": "

Phone number used (if not one of the phones used in the order)

", "example": "212-555-5555" }, { "name": "merchantContactedPhoneRole", "kind": "optional", "type": "", "nullable": true, "description": "I used the following phone to contact the customer", "example": "BILLING_PHONE", "enum": [ "BILLING_PHONE", "SHIPPING_PHONE", "ACCOUNT_PHONE", "OTHER_PHONE", "NA" ] } ] } ], "schema": [] }, { "name": "contactTime", "kind": "required", "type": "number", "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)

", "example": 1430997968 }, { "name": "customerSupportChangeOrderDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CustomerSupportChangeOrderDetails", "description": "", "modelRef": "#/components/schemas/CustomerSupportChangeOrderDetails", "schema": [ { "name": "customerSupportRequestPickupFromShippingCarrier", "kind": "optional", "type": "boolean", "nullable": true, "description": "The customer would like to pick up his order from the shipping carrier", "example": false }, { "name": "customerSupportRequestPickupStoreZip", "kind": "optional", "type": "string", "nullable": true, "description": "The customer would like to pick up his order from the store located at this zipcode", "example": "94104", "maxLength": 20 }, { "name": "customerSupportRequestSwitchBillingAndShipping", "kind": "optional", "type": "boolean", "nullable": true, "description": "The customer accidentally typed the shipping address as the billing address. Would like to switch them.", "example": false } ] } ], "schema": [] }, { "name": "customerSupportFurtherVerification", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CustomerSupportFurtherVerification", "description": "", "modelRef": "#/components/schemas/CustomerSupportFurtherVerification", "schema": [ { "name": "customerAnsweredSecurityQuestions", "kind": "required", "type": "boolean", "description": "The customer successfully answered security questions that only the cardholder should be able to answer", "example": true }, { "name": "customerSupportAdditionalVerificationDocuments", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CustomerSupportAdditionalVerificationDocuments", "description": "", "modelRef": "#/components/schemas/CustomerSupportAdditionalVerificationDocuments", "schema": [ { "name": "documentFirstName", "kind": "optional", "type": "string", "nullable": true, "description": "First name as appears on the document", "example": "John", "maxLength": 75 }, { "name": "documentLastName", "kind": "optional", "type": "string", "nullable": true, "description": "Last name as appears on the document", "example": "Smith", "maxLength": 75 }, { "name": "documentType", "kind": "required", "type": "string", "description": "

Type of document (Passport, ID, Driving license)

", "example": "Passport", "maxLength": 35 }, { "name": "documentVerified", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if document was verified as authentic by merchant or 3rd party service", "example": true }, { "name": "nationality", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nDocument holder's nationality", "example": "US", "maxLength": 25 } ] } ], "schema": [] }, { "name": "customerSupportSMSverification", "kind": "optional", "type": "string", "nullable": true, "description": "

The customer successfully SMS-verified this phone number

", "example": "+1-212-555-5555", "maxLength": 50 } ] } ], "schema": [] }, { "name": "initiatedBy", "kind": "required", "type": "", "description": "The initiator of the interaction", "example": "CUSTOMER", "enum": [ "MERCHANT", "CUSTOMER" ] }, { "name": "orderId", "kind": "optional", "type": "string", "nullable": true, "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.

", "example": "4306795", "maxLength": 40 }, { "name": "ticketId", "kind": "optional", "type": "string", "nullable": true, "description": "Customer service ticket identifier", "example": "4306795", "maxLength": 50 } ] } ], "schema": [] }, { "name": "merchantWouldLikeApproved", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantRiskAnalysisAdditionalPositiveIndicators", "description": "", "modelRef": "#/components/schemas/MerchantRiskAnalysisAdditionalPositiveIndicators", "schema": [ { "name": "merchantContactedIssuer", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "merchantContactedIssuer", "description": "", "modelRef": "#/components/schemas/merchantContactedIssuer", "schema": [ { "name": "accessToBankAccountVerifiedByCustomer", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Using a strong verification method, the customer has verified access to the bank account

", "example": false }, { "name": "issuerNameOnCardMatch", "kind": "optional", "type": "", "nullable": true, "description": "

According to the issuing bank, the cardholder's name matches their records

", "example": "UNKNOWN", "enum": [ "MATCH", "MISMATCH", "DID_NOT_CHECK", "UNKNOWN", "NA" ] }, { "name": "issuerPhoneMatch", "kind": "optional", "type": "", "nullable": true, "description": "

According to the issuing bank, the billing phone matches their records

", "example": "UNKNOWN", "enum": [ "MATCH", "MISMATCH", "DID_NOT_CHECK", "UNKNOWN", "NA" ] }, { "name": "issuerStreetAddressMatch", "kind": "optional", "type": "", "nullable": true, "description": "

According to the issuing bank, the billing street address matches their records

", "example": "UNKNOWN", "enum": [ "MATCH", "MISMATCH", "DID_NOT_CHECK", "UNKNOWN", "NA" ] }, { "name": "issuerZipMatch", "kind": "optional", "type": "", "nullable": true, "description": "

According to the issuing bank, the billing zip code matches their records

", "example": "UNKNOWN", "enum": [ "MATCH", "MISMATCH", "DID_NOT_CHECK", "UNKNOWN", "NA" ] } ] } ], "schema": [] }, { "name": "merchantDisagreesWithSpecificDeclineReason", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantSpecificReasonFeedback", "description": "", "modelRef": "#/components/schemas/MerchantSpecificReasonFeedback", "schema": [ { "name": "atoIsIrrelevant", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantAccountTakeOverFeedback", "description": "", "modelRef": "#/components/schemas/MerchantAccountTakeOverFeedback", "schema": [ { "name": "confirmedValidAccountOwnerUsingOldEmail", "kind": "optional", "type": "boolean", "nullable": true, "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

", "example": false }, { "name": "confirmedValidAccountOwnerUsingOldPhone", "kind": "optional", "type": "boolean", "nullable": true, "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

", "example": false }, { "name": "notATOBecauseOfOtherReason", "kind": "optional", "type": "string", "nullable": true, "description": "I don't think this is an Account Take Over because of a different reason", "example": "Password wasn't reset" }, { "name": "notATOBecauseOldDeviceUsed", "kind": "optional", "type": "boolean", "nullable": true, "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", "example": false }, { "name": "notATOBecauseOldIPUsed", "kind": "optional", "type": "boolean", "nullable": true, "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", "example": false }, { "name": "notATOBecauseSimilarItemPurchased", "kind": "optional", "type": "boolean", "nullable": true, "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.)

", "example": false } ] } ], "schema": [] }, { "name": "chbkIsIrrelevant", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantChargebackFeedback", "description": "", "modelRef": "#/components/schemas/MerchantChargebackFeedback", "schema": [ { "name": "cannotFindRelatedChargebacks", "kind": "optional", "type": "boolean", "nullable": true, "description": "I can't find any chargeback related to this order or account", "example": false }, { "name": "chbksResolved", "kind": "optional", "type": "boolean", "nullable": true, "description": "

The chargebacks connected to this account were not truly fraud-related, and were already resolved with the customer

", "example": false }, { "name": "chbksResolvedOrderIds", "kind": "optional", "type": "array", "nullable": true, "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

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] } ], "schema": [] }, { "name": "couponAbuseIsIrrelevant", "kind": "optional", "type": "boolean", "nullable": true, "description": "

This was declined because of suspected coupon abuse, but I think this is a legitimate use of coupons and would like to approve

", "example": false }, { "name": "multipleLinksAreIrrelevant", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Could not find multiple accounts related to this account holder (available only for account feedback)

", "example": false }, { "name": "policyNotApplicable", "kind": "optional", "type": "boolean", "nullable": true, "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)

", "example": false } ] } ], "schema": [] }, { "name": "merchantFoundBuyerExposure", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantFoundBuyerExposure", "description": "", "modelRef": "#/components/schemas/MerchantFoundBuyerExposure", "schema": [ { "name": "customerSignedInUsingLegitSocialNetworkAccount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CustomerRegistrationSources", "description": "", "modelRef": "#/components/schemas/CustomerRegistrationSources", "schema": [ { "name": "facebook", "kind": "optional", "type": "boolean", "nullable": true, "description": "Facebook", "example": false, "maxLength": 50 }, { "name": "google", "kind": "optional", "type": "boolean", "nullable": true, "description": "Google", "example": false, "maxLength": 50 }, { "name": "linkedin", "kind": "optional", "type": "boolean", "nullable": true, "description": "LinkedIn", "example": false, "maxLength": 50 }, { "name": "otherSocialNetwork", "kind": "optional", "type": "string", "nullable": true, "description": "Other Social Network", "example": "VK", "maxLength": 50 }, { "name": "paypal", "kind": "optional", "type": "boolean", "nullable": true, "description": "PayPal", "example": false, "maxLength": 50 }, { "name": "twitter", "kind": "optional", "type": "boolean", "nullable": true, "description": "Twitter", "example": false, "maxLength": 50 } ] } ], "schema": [] }, { "name": "merchantFoundBuyerEmailOnline", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantExposureSources", "description": "", "modelRef": "#/components/schemas/MerchantExposureSources", "schema": [ { "name": "facebook", "kind": "optional", "type": "boolean", "nullable": true, "description": "Facebook", "example": false, "maxLength": 50 }, { "name": "googlePlus", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Google+

", "example": false, "maxLength": 50 }, { "name": "googleSearch", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Online search (Google, Bing, etc.)

", "example": false, "maxLength": 50 }, { "name": "linkedin", "kind": "optional", "type": "boolean", "nullable": true, "description": "LinkedIn", "example": false, "maxLength": 50 }, { "name": "otherSocialNetwork", "kind": "optional", "type": "boolean", "nullable": true, "description": "Other Social Network", "example": false, "maxLength": 50 }, { "name": "otherSource", "kind": "optional", "type": "string", "nullable": true, "description": "Other", "example": "SearchPerson.com", "maxLength": 50 }, { "name": "whitePages", "kind": "optional", "type": "boolean", "nullable": true, "description": "White Pages", "example": false, "maxLength": 50 } ] } ], "schema": [] }, { "name": "merchantFoundBuyerPhoneNumberOnline", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantExposureSources", "description": "", "modelRef": "#/components/schemas/MerchantExposureSources", "schema": [ { "name": "facebook", "kind": "optional", "type": "boolean", "nullable": true, "description": "Facebook", "example": false, "maxLength": 50 }, { "name": "googlePlus", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Google+

", "example": false, "maxLength": 50 }, { "name": "googleSearch", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Online search (Google, Bing, etc.)

", "example": false, "maxLength": 50 }, { "name": "linkedin", "kind": "optional", "type": "boolean", "nullable": true, "description": "LinkedIn", "example": false, "maxLength": 50 }, { "name": "otherSocialNetwork", "kind": "optional", "type": "boolean", "nullable": true, "description": "Other Social Network", "example": false, "maxLength": 50 }, { "name": "otherSource", "kind": "optional", "type": "string", "nullable": true, "description": "Other", "example": "SearchPerson.com", "maxLength": 50 }, { "name": "whitePages", "kind": "optional", "type": "boolean", "nullable": true, "description": "White Pages", "example": false, "maxLength": 50 } ] } ], "schema": [] }, { "name": "merchantFoundConnectionBetweenIndividualsInTheOrder", "kind": "required", "type": "object", "description": "

I was able to find a connection between the cardholder and the recipient of the order -

", "modelRef": "#/components/schemas/NameAndNameConnection", "customType": "NameAndNameConnection", "schema": [ { "name": "connectionType", "kind": "optional", "type": "", "nullable": true, "description": "

These people are connected because they are -

", "example": "FAMILY", "enum": [ "FAMILY", "FRIENDS", "HAVE_A_PERSONAL_RELATIONSHIP", "WORK_TOGETHER", "HAVE_A_BUSINESS_RELATIONSHIP", "NA" ], "maxLength": 50 }, { "name": "dataSource", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantNameDataSources", "description": "", "modelRef": "#/components/schemas/MerchantNameDataSources", "schema": [ { "name": "googleSearch", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Online search (Google, Bing, etc.)

", "example": false, "maxLength": 50 }, { "name": "otherSource", "kind": "optional", "type": "string", "nullable": true, "description": "Other", "example": "SearchPerson.com", "maxLength": 50 }, { "name": "socialNetwork", "kind": "optional", "type": "boolean", "nullable": true, "description": "Social Network", "example": false, "maxLength": 50 }, { "name": "whitePages", "kind": "optional", "type": "boolean", "nullable": true, "description": "White Pages", "example": false, "maxLength": 50 } ] } ], "schema": [] }, { "name": "nameRole1", "kind": "optional", "type": "", "nullable": true, "description": "

I was able to connect this person -

", "example": "CARDHOLDER", "enum": [ "CARDHOLDER", "BILLING_NAME", "SHIPPING_NAME", "ACCOUNT_HOLDER", "OTHER", "NA" ], "maxLength": 50 }, { "name": "nameRole2", "kind": "optional", "type": "", "nullable": true, "description": "

To this person -

", "example": "SHIPPING_NAME", "enum": [ "CARDHOLDER", "BILLING_NAME", "SHIPPING_NAME", "ACCOUNT_HOLDER", "OTHER", "NA" ], "maxLength": 50 } ] }, { "name": "merchantFoundConnectionBetweenNameAndAddress", "kind": "required", "type": "object", "description": "

I was able to find a connection between some of the addresses in the order and some of the names -

", "modelRef": "#/components/schemas/AddressAndNameConnection", "customType": "AddressAndNameConnection", "schema": [ { "name": "addressRole", "kind": "optional", "type": "", "nullable": true, "description": "

I was able to connect this address -

", "example": "SHIPPING_ADDRESS", "enum": [ "SHIPPING_ADDRESS", "BILLING_ADDRESS", "NA" ], "maxLength": 50 }, { "name": "dataSource", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantAddressDataSources", "description": "", "modelRef": "#/components/schemas/MerchantAddressDataSources", "schema": [ { "name": "googleSearch", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Online search (Google, Bing, etc.)

", "example": false, "maxLength": 50 }, { "name": "otherSource", "kind": "optional", "type": "string", "nullable": true, "description": "Other", "example": "SearchPerson.com", "maxLength": 50 }, { "name": "whitePages", "kind": "optional", "type": "boolean", "nullable": true, "description": "White Pages", "example": false, "maxLength": 50 } ] } ], "schema": [] }, { "name": "nameRole", "kind": "optional", "type": "", "nullable": true, "description": "

To this name -

", "example": "CARDHOLDER", "enum": [ "CARDHOLDER", "BILLING_NAME", "SHIPPING_NAME", "ACCOUNT_HOLDER", "OTHER", "NA" ], "maxLength": 50 } ] }, { "name": "merchantFoundLegitShippingAddress", "kind": "optional", "type": "", "nullable": true, "description": "

I was able to identify the order's shipping address as a non-fraud indication

", "enum": [ "AN_OFFICE_OR_OTHER_WORKPLACE_RELATED_TO_THE_CUSTOMER", "A_MILITARY_OR_OTHER_GOVERNMENT_FACILITY_OR_INSTITUTION", "SHIPPING_ADDRESS_IS_SAME_AS_BILLING_ADDRESS_AND_AVS_CHECK_MATCHES", "NA" ] }, { "name": "merchantFoundRecipientEmailOnline", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantExposureSources", "description": "", "modelRef": "#/components/schemas/MerchantExposureSources", "schema": [ { "name": "facebook", "kind": "optional", "type": "boolean", "nullable": true, "description": "Facebook", "example": false, "maxLength": 50 }, { "name": "googlePlus", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Google+

", "example": false, "maxLength": 50 }, { "name": "googleSearch", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Online search (Google, Bing, etc.)

", "example": false, "maxLength": 50 }, { "name": "linkedin", "kind": "optional", "type": "boolean", "nullable": true, "description": "LinkedIn", "example": false, "maxLength": 50 }, { "name": "otherSocialNetwork", "kind": "optional", "type": "boolean", "nullable": true, "description": "Other Social Network", "example": false, "maxLength": 50 }, { "name": "otherSource", "kind": "optional", "type": "string", "nullable": true, "description": "Other", "example": "SearchPerson.com", "maxLength": 50 }, { "name": "whitePages", "kind": "optional", "type": "boolean", "nullable": true, "description": "White Pages", "example": false, "maxLength": 50 } ] } ], "schema": [] }, { "name": "merchantFoundRecipientPhoneNumberOnline", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantExposureSources", "description": "", "modelRef": "#/components/schemas/MerchantExposureSources", "schema": [ { "name": "facebook", "kind": "optional", "type": "boolean", "nullable": true, "description": "Facebook", "example": false, "maxLength": 50 }, { "name": "googlePlus", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Google+

", "example": false, "maxLength": 50 }, { "name": "googleSearch", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Online search (Google, Bing, etc.)

", "example": false, "maxLength": 50 }, { "name": "linkedin", "kind": "optional", "type": "boolean", "nullable": true, "description": "LinkedIn", "example": false, "maxLength": 50 }, { "name": "otherSocialNetwork", "kind": "optional", "type": "boolean", "nullable": true, "description": "Other Social Network", "example": false, "maxLength": 50 }, { "name": "otherSource", "kind": "optional", "type": "string", "nullable": true, "description": "Other", "example": "SearchPerson.com", "maxLength": 50 }, { "name": "whitePages", "kind": "optional", "type": "boolean", "nullable": true, "description": "White Pages", "example": false, "maxLength": 50 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "merchantPolicyDecisionNotApplicable", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "merchantPolicyDecisionNotApplicable", "description": "", "modelRef": "#/components/schemas/merchantPolicyDecisionNotApplicable", "schema": [ { "name": "inrAbuseNotApplicable", "kind": "optional", "type": "boolean", "nullable": true, "description": "

INR Abuse - INR/Refund abuse policy is not applicable

" }, { "name": "multipleLinksPolicyNotApplicable", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Multiple Account Abuse - Merchant unique account policy is not applicable

" }, { "name": "promotionAbuseNotApplicable", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Promotion Abuse - Promotion abuse policy is not applicable

" }, { "name": "resellerAbuseNotApplicable", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Reseller Abuse - Reseller abuse policy is not applicable

" }, { "name": "returnsAbuseNotApplicable", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Returns Abuse - Returns abuse policy is not applicable

" } ] } ], "schema": [] }, { "name": "merchantThinksOrderCharacteristicsAreLegit", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GoodOrderCharachteristicsAccordingToMerchant", "description": "", "modelRef": "#/components/schemas/GoodOrderCharachteristicsAccordingToMerchant", "schema": [ { "name": "goodCustomer", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GoodCustomerAccordingToMerchant", "description": "", "modelRef": "#/components/schemas/GoodCustomerAccordingToMerchant", "schema": [ { "name": "establishedAccount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantConsidersAccountEstablished", "description": "", "modelRef": "#/components/schemas/MerchantConsidersAccountEstablished", "schema": [ { "name": "establishedAccountDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "EstablishedAccountDetails", "description": "", "modelRef": "#/components/schemas/EstablishedAccountDetails", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "relatedAccountDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AccountIdentifiersForMerchant", "description": "", "modelRef": "#/components/schemas/AccountIdentifiersForMerchant", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "relatedToAnEstablishedAccount", "kind": "optional", "type": "boolean", "nullable": true, "description": "The account that created this order is related to a well established account", "example": false }, { "name": "thisIsAnEstablishedAccount", "kind": "optional", "type": "boolean", "nullable": true, "description": "The account that created this order is a well established account", "example": false } ] } ], "schema": [] }, { "name": "forterPreviouslyApproved", "kind": "optional", "type": "boolean", "nullable": true, "description": "Forter previously approved this customer" }, { "name": "knowCustomerPersonally", "kind": "optional", "type": "", "nullable": true, "description": "

I know this customer personally (company employee, family member, etc.)

", "enum": [ "COMPANY_EMPLOYEE_OR_RELATED_TO_ONE", "COMPANY_BUSINESS_ASSOCIATE_OR_SERVICE_PROVIDER", "TESTING_ACCOUNT", "OTHER", "NA" ] }, { "name": "merchantHasGoodScoreElsewhere", "kind": "optional", "type": "", "nullable": true, "description": "

This order has a good score on another fraud tool (internal or 3rd party) and I think it is probably a good order

", "example": "INTERNAL_SCORE", "enum": [ "INTERNAL_SCORE", "THIRD_PARTY_TOOL", "NA" ] }, { "name": "previousPointOfSalePurchase", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PastPointOfSalePurchase", "description": "", "modelRef": "#/components/schemas/PastPointOfSalePurchase", "schema": [ { "name": "madePointOfSalePurchase", "kind": "optional", "type": "boolean", "nullable": true, "description": "Customer made purchases in a physical store in the past", "example": false }, { "name": "pointOfSalePurchaseState", "kind": "optional", "type": "string", "nullable": true, "description": "

Purchase was made in a store located in the following state / region

", "example": "NY" }, { "name": "pointOfSalePurchaseZip", "kind": "optional", "type": "string", "nullable": true, "description": "Purchase was made in a store located in the following zipcode", "example": "10001" } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "lowRiskItem", "kind": "optional", "type": "boolean", "nullable": true, "description": "

In our experience, the item purchased is a low-risk item

", "example": false }, { "name": "lowRiskPaymentMethod", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "LowRiskPaymentMethodsAccordingToMerchant", "description": "", "modelRef": "#/components/schemas/LowRiskPaymentMethodsAccordingToMerchant", "schema": [ { "name": "giftCard", "kind": "optional", "type": "boolean", "nullable": true, "description": "Gift Card", "example": false }, { "name": "other", "kind": "optional", "type": "string", "nullable": true, "description": "Other payment method", "example": "Apple Pay" }, { "name": "storeCredit", "kind": "optional", "type": "boolean", "nullable": true, "description": "Store Credit", "example": false }, { "name": "wireTransfer", "kind": "optional", "type": "boolean", "nullable": true, "description": "Wire transfer or other direct forms of payment", "example": false } ] } ], "schema": [] } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "merchantWouldLikeDeclined", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantRiskAnalysisAdditionalNegativeIndicators", "description": "", "modelRef": "#/components/schemas/MerchantRiskAnalysisAdditionalNegativeIndicators", "schema": [ { "name": "fraudTypeSuspectedByMerchant", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "FraudTypeSuspectedByMerchant", "description": "", "modelRef": "#/components/schemas/FraudTypeSuspectedByMerchant", "schema": [ { "name": "merchantInrAbuseType", "kind": "optional", "type": "", "nullable": true, "description": "INR Abuse type as labeled by the merchant", "enum": [ "HIGHLIGHTED", "PREVENTED" ] }, { "name": "merchantReceivedFraudAlert", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Fraud Alert - Merchant was notified by a 3rd party tool or other source that the order is fraudulent

" }, { "name": "merchantSuspectsAccountTakeOver", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ReasonMerchantSuspectsFraud", "description": "", "modelRef": "#/components/schemas/ReasonMerchantSuspectsFraud", "schema": [ { "name": "merchantSuspectsAccountDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SuspiciousAccountDetails", "description": "", "modelRef": "#/components/schemas/SuspiciousAccountDetails", "schema": [ { "name": "accountDetailsWereChanged", "kind": "optional", "type": "boolean", "nullable": true, "description": "Account details were recently changed in a way that is suspicious", "example": true }, { "name": "highVelocity", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Purchase frequency and amount is too high, and is likely fraudulent

", "example": true }, { "name": "inactiveAccount", "kind": "optional", "type": "boolean", "nullable": true, "description": "Account was inactive for a very long time and is now displaying suspicious behaviour", "example": true }, { "name": "linkedToMultipleAccounts", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Identified multiple accounts linked to this account holder (available only for account feedback)

", "example": true }, { "name": "other", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Other (available only for account feedback)

", "example": true } ] } ], "schema": [] }, { "name": "merchantSuspectsOrderDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SuspiciousOrderDetails", "description": "", "modelRef": "#/components/schemas/SuspiciousOrderDetails", "schema": [ { "name": "badItem", "kind": "optional", "type": "boolean", "nullable": true, "description": "Item purchased is a strong fraud indicator", "example": true }, { "name": "badShippingAddress", "kind": "optional", "type": "boolean", "nullable": true, "description": "Shipping address seems suspicious", "example": true }, { "name": "fakeEmail", "kind": "optional", "type": "boolean", "nullable": true, "description": "

The email seems fake, or related to a suspicious persona, or to a person completely unrelated to the order

", "example": true }, { "name": "other", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Other (this option will only be open for account feedback)

", "example": true } ] } ], "schema": [] }, { "name": "merchantWasContactedByVictim", "kind": "optional", "type": "boolean", "nullable": true, "description": "

The victim of this fraud attempt contacted us to complain (cardholder, or account owner in case of account takeover)

", "example": false } ] } ], "schema": [] }, { "name": "merchantSuspectsBuyerSellerCollusion", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ReasonMerchantSuspectsFraud", "description": "", "modelRef": "#/components/schemas/ReasonMerchantSuspectsFraud", "schema": [ { "name": "merchantSuspectsAccountDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SuspiciousAccountDetails", "description": "", "modelRef": "#/components/schemas/SuspiciousAccountDetails", "schema": [ { "name": "accountDetailsWereChanged", "kind": "optional", "type": "boolean", "nullable": true, "description": "Account details were recently changed in a way that is suspicious", "example": true }, { "name": "highVelocity", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Purchase frequency and amount is too high, and is likely fraudulent

", "example": true }, { "name": "inactiveAccount", "kind": "optional", "type": "boolean", "nullable": true, "description": "Account was inactive for a very long time and is now displaying suspicious behaviour", "example": true }, { "name": "linkedToMultipleAccounts", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Identified multiple accounts linked to this account holder (available only for account feedback)

", "example": true }, { "name": "other", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Other (available only for account feedback)

", "example": true } ] } ], "schema": [] }, { "name": "merchantSuspectsOrderDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SuspiciousOrderDetails", "description": "", "modelRef": "#/components/schemas/SuspiciousOrderDetails", "schema": [ { "name": "badItem", "kind": "optional", "type": "boolean", "nullable": true, "description": "Item purchased is a strong fraud indicator", "example": true }, { "name": "badShippingAddress", "kind": "optional", "type": "boolean", "nullable": true, "description": "Shipping address seems suspicious", "example": true }, { "name": "fakeEmail", "kind": "optional", "type": "boolean", "nullable": true, "description": "

The email seems fake, or related to a suspicious persona, or to a person completely unrelated to the order

", "example": true }, { "name": "other", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Other (this option will only be open for account feedback)

", "example": true } ] } ], "schema": [] }, { "name": "merchantWasContactedByVictim", "kind": "optional", "type": "boolean", "nullable": true, "description": "

The victim of this fraud attempt contacted us to complain (cardholder, or account owner in case of account takeover)

", "example": false } ] } ], "schema": [] }, { "name": "merchantSuspectsCouponAbuse", "kind": "optional", "type": "boolean", "nullable": true, "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)

" }, { "name": "merchantSuspectsFraudOther", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ReasonMerchantSuspectsFraud", "description": "", "modelRef": "#/components/schemas/ReasonMerchantSuspectsFraud", "schema": [ { "name": "merchantSuspectsAccountDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SuspiciousAccountDetails", "description": "", "modelRef": "#/components/schemas/SuspiciousAccountDetails", "schema": [ { "name": "accountDetailsWereChanged", "kind": "optional", "type": "boolean", "nullable": true, "description": "Account details were recently changed in a way that is suspicious", "example": true }, { "name": "highVelocity", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Purchase frequency and amount is too high, and is likely fraudulent

", "example": true }, { "name": "inactiveAccount", "kind": "optional", "type": "boolean", "nullable": true, "description": "Account was inactive for a very long time and is now displaying suspicious behaviour", "example": true }, { "name": "linkedToMultipleAccounts", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Identified multiple accounts linked to this account holder (available only for account feedback)

", "example": true }, { "name": "other", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Other (available only for account feedback)

", "example": true } ] } ], "schema": [] }, { "name": "merchantSuspectsOrderDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SuspiciousOrderDetails", "description": "", "modelRef": "#/components/schemas/SuspiciousOrderDetails", "schema": [ { "name": "badItem", "kind": "optional", "type": "boolean", "nullable": true, "description": "Item purchased is a strong fraud indicator", "example": true }, { "name": "badShippingAddress", "kind": "optional", "type": "boolean", "nullable": true, "description": "Shipping address seems suspicious", "example": true }, { "name": "fakeEmail", "kind": "optional", "type": "boolean", "nullable": true, "description": "

The email seems fake, or related to a suspicious persona, or to a person completely unrelated to the order

", "example": true }, { "name": "other", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Other (this option will only be open for account feedback)

", "example": true } ] } ], "schema": [] }, { "name": "merchantWasContactedByVictim", "kind": "optional", "type": "boolean", "nullable": true, "description": "

The victim of this fraud attempt contacted us to complain (cardholder, or account owner in case of account takeover)

", "example": false } ] } ], "schema": [] }, { "name": "merchantSuspectsFriendlyFraud", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ReasonMerchantSuspectsFraud", "description": "", "modelRef": "#/components/schemas/ReasonMerchantSuspectsFraud", "schema": [ { "name": "merchantSuspectsAccountDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SuspiciousAccountDetails", "description": "", "modelRef": "#/components/schemas/SuspiciousAccountDetails", "schema": [ { "name": "accountDetailsWereChanged", "kind": "optional", "type": "boolean", "nullable": true, "description": "Account details were recently changed in a way that is suspicious", "example": true }, { "name": "highVelocity", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Purchase frequency and amount is too high, and is likely fraudulent

", "example": true }, { "name": "inactiveAccount", "kind": "optional", "type": "boolean", "nullable": true, "description": "Account was inactive for a very long time and is now displaying suspicious behaviour", "example": true }, { "name": "linkedToMultipleAccounts", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Identified multiple accounts linked to this account holder (available only for account feedback)

", "example": true }, { "name": "other", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Other (available only for account feedback)

", "example": true } ] } ], "schema": [] }, { "name": "merchantSuspectsOrderDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SuspiciousOrderDetails", "description": "", "modelRef": "#/components/schemas/SuspiciousOrderDetails", "schema": [ { "name": "badItem", "kind": "optional", "type": "boolean", "nullable": true, "description": "Item purchased is a strong fraud indicator", "example": true }, { "name": "badShippingAddress", "kind": "optional", "type": "boolean", "nullable": true, "description": "Shipping address seems suspicious", "example": true }, { "name": "fakeEmail", "kind": "optional", "type": "boolean", "nullable": true, "description": "

The email seems fake, or related to a suspicious persona, or to a person completely unrelated to the order

", "example": true }, { "name": "other", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Other (this option will only be open for account feedback)

", "example": true } ] } ], "schema": [] }, { "name": "merchantWasContactedByVictim", "kind": "optional", "type": "boolean", "nullable": true, "description": "

The victim of this fraud attempt contacted us to complain (cardholder, or account owner in case of account takeover)

", "example": false } ] } ], "schema": [] }, { "name": "merchantSuspectsInrAbuse", "kind": "optional", "type": "boolean", "nullable": true, "description": "

INR/Refund Abuse - Customer is suspected of INR/refund abuse

" }, { "name": "merchantSuspectsOtherPolicyBreach", "kind": "optional", "type": "boolean", "nullable": true, "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.

" }, { "name": "merchantSuspectsPromotionAbuse", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Promotion Abuse - Customer is suspected of promotion abuse

" }, { "name": "merchantSuspectsResellerAbuse", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Reseller Abuse - Customer is suspected of reseller abuse

" }, { "name": "merchantSuspectsReturnAbuse", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Returns Abuse - Customer is suspected of returns abuse

" }, { "name": "merchantSuspectsStolenPaymentMethod", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ReasonMerchantSuspectsFraud", "description": "", "modelRef": "#/components/schemas/ReasonMerchantSuspectsFraud", "schema": [ { "name": "merchantSuspectsAccountDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SuspiciousAccountDetails", "description": "", "modelRef": "#/components/schemas/SuspiciousAccountDetails", "schema": [ { "name": "accountDetailsWereChanged", "kind": "optional", "type": "boolean", "nullable": true, "description": "Account details were recently changed in a way that is suspicious", "example": true }, { "name": "highVelocity", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Purchase frequency and amount is too high, and is likely fraudulent

", "example": true }, { "name": "inactiveAccount", "kind": "optional", "type": "boolean", "nullable": true, "description": "Account was inactive for a very long time and is now displaying suspicious behaviour", "example": true }, { "name": "linkedToMultipleAccounts", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Identified multiple accounts linked to this account holder (available only for account feedback)

", "example": true }, { "name": "other", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Other (available only for account feedback)

", "example": true } ] } ], "schema": [] }, { "name": "merchantSuspectsOrderDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SuspiciousOrderDetails", "description": "", "modelRef": "#/components/schemas/SuspiciousOrderDetails", "schema": [ { "name": "badItem", "kind": "optional", "type": "boolean", "nullable": true, "description": "Item purchased is a strong fraud indicator", "example": true }, { "name": "badShippingAddress", "kind": "optional", "type": "boolean", "nullable": true, "description": "Shipping address seems suspicious", "example": true }, { "name": "fakeEmail", "kind": "optional", "type": "boolean", "nullable": true, "description": "

The email seems fake, or related to a suspicious persona, or to a person completely unrelated to the order

", "example": true }, { "name": "other", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Other (this option will only be open for account feedback)

", "example": true } ] } ], "schema": [] }, { "name": "merchantWasContactedByVictim", "kind": "optional", "type": "boolean", "nullable": true, "description": "

The victim of this fraud attempt contacted us to complain (cardholder, or account owner in case of account takeover)

", "example": false } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "merchantConfidenceLevelThisIsFraud", "kind": "optional", "type": "", "nullable": true, "description": "My level of confidence that this order is fraudulent", "example": "NOT_SURE_COMMA_LOOKS_SUSPICIOUS", "enum": [ "NOT_SURE_COMMA_LOOKS_SUSPICIOUS", "HIGH_CONFIDENCE_THIS_IS_FRAUD", "VICTIM_CONFIRMED_THIS_IS_FRAUD" ] }, { "name": "merchantThinksPolicyShouldApply", "kind": "optional", "type": "string", "nullable": true, "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", "example": "Decline all non-US domestic orders", "maxLength": 200 } ] } ], "schema": [] }, { "name": "undoPreviousFeedback", "kind": "optional", "type": "boolean", "nullable": true, "description": "

A property to allow the customer to reset all previous feedbacks given on the session, previous feedbacks will not affect the model anymore

" } ] } ], "schema": [] }, { "name": "orderId", "kind": "required", "type": "string", "description": "

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

", "example": "2356fdse0rr489", "maxLength": 40 }, { "name": "orderType", "kind": "optional", "type": "", "nullable": true, "description": "Platform order was made through", "example": "PHONE_LINK", "enum": [ "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" ] }, { "name": "payment", "kind": "optional", "type": "array", "nullable": true, "description": "A list of all payment methods and billing details used in the transaction", "modelRef": "#/components/schemas/Payment", "customType": "Payment[]", "schema": [ { "name": "allowedMerchantInitiatedTransactions", "kind": "optional", "type": "boolean", "nullable": true, "description": "

True if customer chose to allow future transactions to initiate without taking further action (payment that's initiated on behalf of a customer)

", "example": false }, { "name": "amount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "androidPay", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "TokenizedCreditCard", "description": "", "modelRef": "#/components/schemas/TokenizedCreditCard", "schema": [ { "name": "cardBank", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCredit card's issuing bank", "example": "Chase", "maxLength": 128 }, { "name": "cardBrand", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCredit card's issuer brand", "example": "VISA", "maxLength": 50 }, { "name": "cardType", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment card type", "example": "CREDIT", "enum": [ "CREDIT", "DEBIT", "PREPAID", "UNKNOWN" ] }, { "name": "countryOfIssuance", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code

", "example": "US", "maxLength": 2, "pattern": "[A-Za-z]{2}" }, { "name": "creationTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1430997968 }, { "name": "creditCardCorrelationId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Credit card - CorrelationId that was recieved by the init 3DS API

" }, { "name": "expirationMonth", "kind": "optional", "type": "string", "nullable": true, "description": "

Credit card's expiration month, in MM format

", "example": "03", "maxLength": 2, "pattern": "[0-9]{2}" }, { "name": "expirationYear", "kind": "optional", "type": "string", "nullable": true, "description": "

Credit card's expiration year, in YYYY format

", "example": "2018", "maxLength": 4, "pattern": "[0-9]{4}" }, { "name": "fullResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "lastFourDigits", "kind": "optional", "type": "string", "nullable": true, "description": "Credit card's last 4 digits", "example": "4242", "maxLength": 4, "pattern": "[0-9]{2,4}" }, { "name": "nameOnCard", "kind": "optional", "type": "string", "nullable": true, "description": "Cardholder's full name", "example": "John R. H. Smith", "maxLength": 75 }, { "name": "paymentProcessorData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentProcessorData", "description": "", "modelRef": "#/components/schemas/PaymentProcessorData", "schema": [ { "name": "processorName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment processor name", "example": "Chase Paymentech", "maxLength": 50 }, { "name": "processorTransactionId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique transaction identifier (sent by processor)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "threeDSecure", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureInput", "description": "", "modelRef": "#/components/schemas/ThreeDSecureInput", "schema": [ { "name": "acquirerData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AcquirerData", "description": "", "modelRef": "#/components/schemas/AcquirerData", "schema": [ { "name": "acquirerBIN", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Bank acquirer BIN (Bank Identification Number)

", "example": "457173", "maxLength": 12 }, { "name": "acquirerCountry", "kind": "optional", "type": "string", "nullable": true, "description": "Acquirer country", "example": "US", "enum": [ "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" ] }, { "name": "acquirerMerchantId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor

", "example": "5245020244654", "maxLength": 30 }, { "name": "acquirerMerchantName", "kind": "optional", "type": "string", "nullable": true, "description": "Merchant Name as appearing in processor records", "example": "Simple T-shirt", "maxLength": 100 }, { "name": "acquirerName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank acquirer Name", "example": "Barclays", "maxLength": 50 }, { "name": "merchantCategoryCode", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\n

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.

", "example": 5655, "maxLength": 4 }, { "name": "merchantCountryCode", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\nMerchant country code", "example": 840, "maxLength": 3 } ] } ], "schema": [] }, { "name": "challengeIndicator", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation", "example": "NO_PREFERENCE", "enum": [ "NO_PREFERENCE", "NO_CHALLENGE", "CHALLENGE", "CHALLENGE_AS_MANDATE" ] }, { "name": "execute3ds", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the execution of 3DS", "example": "DYNAMIC_FORTER_DECISION", "enum": [ "FORCE_3DS", "NOT_SUPPORTED_BY_MERCHANT", "DYNAMIC_FORTER_DECISION" ] }, { "name": "forcePsd2Exemption", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureForcePsd2Exemption", "description": "", "modelRef": "#/components/schemas/ThreeDSecureForcePsd2Exemption", "schema": [ { "name": "channel", "kind": "required", "type": "string", "description": "The channel through which the exemption is requested", "example": "THREEDS_RAILS", "enum": [ "THREEDS_RAILS", "AUTHORIZATION" ] }, { "name": "type", "kind": "required", "type": "string", "description": "The type of exemption requested", "example": "LOW_VALUE", "enum": [ "LOW_VALUE", "TRANSACTION_RISK_ANALYSIS", "SECURE_CORPORATE", "TRUSTED_BENEFICIARY" ] } ] } ], "schema": [] }, { "name": "requestChallenge", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates if a 3DS challenge should be requested from the Issuer ACS.", "example": false }, { "name": "threeDSServerTransID", "kind": "required", "type": "string", "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", "example": "26d648a9-da8a-4f8b-a76d-094801d2fd45", "maxLength": 100 }, { "name": "threeDsExecutor", "kind": "optional", "type": "string", "nullable": true, "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

", "enum": [ "FORTER", "MERCHANT" ] } ] } ], "schema": [] }, { "name": "token", "kind": "optional", "type": "string", "nullable": true, "description": "Credit card token used by the merchant", "example": "tkn-77620C360132856A103477D2959967AB", "maxLength": 200 }, { "name": "tokenType", "kind": "optional", "type": "string", "nullable": true, "description": "

Token type, determined by the party/protocol the token created by

", "enum": [ "PSP", "EMV_PAYMENT_TOKEN", "MERCHANT_GENERATED", "FORTER_TOKEN", "OTHER" ], "maxLength": 128 }, { "name": "verificationResults", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CreditCardVerification", "description": "", "modelRef": "#/components/schemas/CreditCardVerification", "schema": [ { "name": "authorizationCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCard authorization code from payment gateway", "example": "A33244", "maxLength": 255 }, { "name": "authorizationProcessedWith3DS", "kind": "optional", "type": "boolean", "nullable": true, "description": "

3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization

", "example": true }, { "name": "avsFullResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string

", "example": "Y", "maxLength": 50 }, { "name": "avsNameResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Name portion of card's AVS result (when available)

", "example": "M", "maxLength": 30 }, { "name": "avsStreetResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nStreet address portion of card's AVS result", "example": "N", "maxLength": 30 }, { "name": "avsZipResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode portion of card's AVS result", "example": "M", "maxLength": 30 }, { "name": "cavvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response

", "example": "VYboNwcsB3F9gTIsbaUjvEuLW0o=", "maxLength": 50 }, { "name": "cvvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

CVV result (if no data please send the value U)

", "example": "M", "maxLength": 30 }, { "name": "eciValue", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - ECI value recieved from authorization/authentication response

", "example": "05", "maxLength": 2 }, { "name": "exemptionStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nExemption status as received from the processor", "example": "accepted", "maxLength": 100 }, { "name": "external3dsVendorPayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "issuerResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from issuer", "example": "D23", "maxLength": 50 }, { "name": "issuerResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from issuer", "example": "Stolen card", "maxLength": 255 }, { "name": "liabilityShift", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer

", "example": true }, { "name": "partyExecuted3DS", "kind": "optional", "type": "string", "nullable": true, "description": "

3DSecure - Party executed the 3DS authentication

", "example": "PSP", "enum": [ "PSP", "FORTER", "BOTH" ] }, { "name": "processorResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from processor", "example": "D23", "maxLength": 50 }, { "name": "processorResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from processor", "example": "Stolen card", "maxLength": 255 }, { "name": "threeDsInteractionMode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Indication of the friction that the user experienced

", "example": "FRICTIONLESS", "enum": [ "FRICTIONLESS", "CHALLENGED" ] }, { "name": "threeDsStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Status text received from 3D secure vendor

", "example": "Cardholder authenticated", "maxLength": 100 }, { "name": "threeDsVersion", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Version used in the transaction

", "example": "2.1.0", "maxLength": 5 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "applePay", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "TokenizedCreditCard", "description": "", "modelRef": "#/components/schemas/TokenizedCreditCard", "schema": [ { "name": "cardBank", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCredit card's issuing bank", "example": "Chase", "maxLength": 128 }, { "name": "cardBrand", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCredit card's issuer brand", "example": "VISA", "maxLength": 50 }, { "name": "cardType", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment card type", "example": "CREDIT", "enum": [ "CREDIT", "DEBIT", "PREPAID", "UNKNOWN" ] }, { "name": "countryOfIssuance", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code

", "example": "US", "maxLength": 2, "pattern": "[A-Za-z]{2}" }, { "name": "creationTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1430997968 }, { "name": "creditCardCorrelationId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Credit card - CorrelationId that was recieved by the init 3DS API

" }, { "name": "expirationMonth", "kind": "optional", "type": "string", "nullable": true, "description": "

Credit card's expiration month, in MM format

", "example": "03", "maxLength": 2, "pattern": "[0-9]{2}" }, { "name": "expirationYear", "kind": "optional", "type": "string", "nullable": true, "description": "

Credit card's expiration year, in YYYY format

", "example": "2018", "maxLength": 4, "pattern": "[0-9]{4}" }, { "name": "fullResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "lastFourDigits", "kind": "optional", "type": "string", "nullable": true, "description": "Credit card's last 4 digits", "example": "4242", "maxLength": 4, "pattern": "[0-9]{2,4}" }, { "name": "nameOnCard", "kind": "optional", "type": "string", "nullable": true, "description": "Cardholder's full name", "example": "John R. H. Smith", "maxLength": 75 }, { "name": "paymentProcessorData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentProcessorData", "description": "", "modelRef": "#/components/schemas/PaymentProcessorData", "schema": [ { "name": "processorName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment processor name", "example": "Chase Paymentech", "maxLength": 50 }, { "name": "processorTransactionId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique transaction identifier (sent by processor)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "threeDSecure", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureInput", "description": "", "modelRef": "#/components/schemas/ThreeDSecureInput", "schema": [ { "name": "acquirerData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AcquirerData", "description": "", "modelRef": "#/components/schemas/AcquirerData", "schema": [ { "name": "acquirerBIN", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Bank acquirer BIN (Bank Identification Number)

", "example": "457173", "maxLength": 12 }, { "name": "acquirerCountry", "kind": "optional", "type": "string", "nullable": true, "description": "Acquirer country", "example": "US", "enum": [ "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" ] }, { "name": "acquirerMerchantId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor

", "example": "5245020244654", "maxLength": 30 }, { "name": "acquirerMerchantName", "kind": "optional", "type": "string", "nullable": true, "description": "Merchant Name as appearing in processor records", "example": "Simple T-shirt", "maxLength": 100 }, { "name": "acquirerName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank acquirer Name", "example": "Barclays", "maxLength": 50 }, { "name": "merchantCategoryCode", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\n

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.

", "example": 5655, "maxLength": 4 }, { "name": "merchantCountryCode", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\nMerchant country code", "example": 840, "maxLength": 3 } ] } ], "schema": [] }, { "name": "challengeIndicator", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation", "example": "NO_PREFERENCE", "enum": [ "NO_PREFERENCE", "NO_CHALLENGE", "CHALLENGE", "CHALLENGE_AS_MANDATE" ] }, { "name": "execute3ds", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the execution of 3DS", "example": "DYNAMIC_FORTER_DECISION", "enum": [ "FORCE_3DS", "NOT_SUPPORTED_BY_MERCHANT", "DYNAMIC_FORTER_DECISION" ] }, { "name": "forcePsd2Exemption", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureForcePsd2Exemption", "description": "", "modelRef": "#/components/schemas/ThreeDSecureForcePsd2Exemption", "schema": [ { "name": "channel", "kind": "required", "type": "string", "description": "The channel through which the exemption is requested", "example": "THREEDS_RAILS", "enum": [ "THREEDS_RAILS", "AUTHORIZATION" ] }, { "name": "type", "kind": "required", "type": "string", "description": "The type of exemption requested", "example": "LOW_VALUE", "enum": [ "LOW_VALUE", "TRANSACTION_RISK_ANALYSIS", "SECURE_CORPORATE", "TRUSTED_BENEFICIARY" ] } ] } ], "schema": [] }, { "name": "requestChallenge", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates if a 3DS challenge should be requested from the Issuer ACS.", "example": false }, { "name": "threeDSServerTransID", "kind": "required", "type": "string", "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", "example": "26d648a9-da8a-4f8b-a76d-094801d2fd45", "maxLength": 100 }, { "name": "threeDsExecutor", "kind": "optional", "type": "string", "nullable": true, "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

", "enum": [ "FORTER", "MERCHANT" ] } ] } ], "schema": [] }, { "name": "token", "kind": "optional", "type": "string", "nullable": true, "description": "Credit card token used by the merchant", "example": "tkn-77620C360132856A103477D2959967AB", "maxLength": 200 }, { "name": "tokenType", "kind": "optional", "type": "string", "nullable": true, "description": "

Token type, determined by the party/protocol the token created by

", "enum": [ "PSP", "EMV_PAYMENT_TOKEN", "MERCHANT_GENERATED", "FORTER_TOKEN", "OTHER" ], "maxLength": 128 }, { "name": "verificationResults", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CreditCardVerification", "description": "", "modelRef": "#/components/schemas/CreditCardVerification", "schema": [ { "name": "authorizationCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCard authorization code from payment gateway", "example": "A33244", "maxLength": 255 }, { "name": "authorizationProcessedWith3DS", "kind": "optional", "type": "boolean", "nullable": true, "description": "

3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization

", "example": true }, { "name": "avsFullResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string

", "example": "Y", "maxLength": 50 }, { "name": "avsNameResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Name portion of card's AVS result (when available)

", "example": "M", "maxLength": 30 }, { "name": "avsStreetResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nStreet address portion of card's AVS result", "example": "N", "maxLength": 30 }, { "name": "avsZipResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode portion of card's AVS result", "example": "M", "maxLength": 30 }, { "name": "cavvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response

", "example": "VYboNwcsB3F9gTIsbaUjvEuLW0o=", "maxLength": 50 }, { "name": "cvvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

CVV result (if no data please send the value U)

", "example": "M", "maxLength": 30 }, { "name": "eciValue", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - ECI value recieved from authorization/authentication response

", "example": "05", "maxLength": 2 }, { "name": "exemptionStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nExemption status as received from the processor", "example": "accepted", "maxLength": 100 }, { "name": "external3dsVendorPayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "issuerResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from issuer", "example": "D23", "maxLength": 50 }, { "name": "issuerResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from issuer", "example": "Stolen card", "maxLength": 255 }, { "name": "liabilityShift", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer

", "example": true }, { "name": "partyExecuted3DS", "kind": "optional", "type": "string", "nullable": true, "description": "

3DSecure - Party executed the 3DS authentication

", "example": "PSP", "enum": [ "PSP", "FORTER", "BOTH" ] }, { "name": "processorResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from processor", "example": "D23", "maxLength": 50 }, { "name": "processorResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from processor", "example": "Stolen card", "maxLength": 255 }, { "name": "threeDsInteractionMode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Indication of the friction that the user experienced

", "example": "FRICTIONLESS", "enum": [ "FRICTIONLESS", "CHALLENGED" ] }, { "name": "threeDsStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Status text received from 3D secure vendor

", "example": "Cardholder authenticated", "maxLength": 100 }, { "name": "threeDsVersion", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Version used in the transaction

", "example": "2.1.0", "maxLength": 5 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "bankTransfer", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "BankTransfer", "description": "", "modelRef": "#/components/schemas/BankTransfer", "schema": [ { "name": "accountHolderFirstName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank account holder first name", "example": "John", "maxLength": 50 }, { "name": "accountHolderLastName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank account holder last name", "example": "Smith", "maxLength": 50 }, { "name": "achProcessingType", "kind": "optional", "type": "string", "nullable": true, "description": "Type of ACH processing used in the transaction", "example": "SAME_DAY_ACH", "maxLength": 50 }, { "name": "bankAccountIdentifier", "kind": "optional", "type": "string", "nullable": true, "description": "

Bank account unique identifier (IBAN or equivalent)

", "example": "TEST63TEST1212121212", "maxLength": 40 }, { "name": "bankAccountType", "kind": "optional", "type": "string", "nullable": true, "description": "

Type of bank account payment is made from (e.g. savings/checking, etc.)

", "example": "Savings", "maxLength": 50 }, { "name": "bankName", "kind": "optional", "type": "string", "nullable": true, "description": "Name of bank payment is made from", "example": "Citigroup", "maxLength": 50 }, { "name": "paymentGatewayData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentGatewayData", "description": "", "modelRef": "#/components/schemas/PaymentGatewayData", "schema": [ { "name": "gatewayName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment gateway name", "example": "Braintree", "maxLength": 50 }, { "name": "gatewayTransactionId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique transaction identifier (sent by gateway)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "paymentSuccessStatus", "kind": "optional", "type": "string", "nullable": true, "description": "Response text as received from the service provider", "example": "Payment Successful" }, { "name": "serviceName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment method name", "example": "Direct Debit", "maxLength": 30 } ] } ], "schema": [] }, { "name": "billingDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Person", "description": "", "modelRef": "#/components/schemas/Person", "schema": [ { "name": "address", "kind": "required", "type": "object", "description": "Address details", "modelRef": "#/components/schemas/Address", "customType": "Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

Street-level address. Required when full address details are available

", "example": "235 Montgomery st.", "maxLength": 255 }, { "name": "address2", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unit-level address

", "example": "Ste. 1110", "maxLength": 255 }, { "name": "city", "kind": "required", "type": "string", "description": "City. Required when full address details are available", "example": "San Francisco", "maxLength": 200 }, { "name": "company", "kind": "optional", "type": "string", "nullable": true, "description": "Company", "example": "Generic Corp. ltd.", "maxLength": 225 }, { "name": "country", "kind": "required", "type": "string", "description": "

Country, two-letter ISO 3166-1 alpha-2 country code

", "example": "US", "minLength": 2, "maxLength": 2 }, { "name": "region", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York)

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] }, { "name": "allAdditionalVerificationDocuments", "kind": "optional", "type": "array", "conditional": true, "nullable": true, "description": "Conditional.\nAdditional identification documents details and verification", "modelRef": "#/components/schemas/AdditionalVerificationDocuments", "customType": "AdditionalVerificationDocuments[]", "schema": [ { "name": "documentDateOfBirth", "kind": "optional", "type": "string", "nullable": true, "description": "

Date of birth as appears on the document. Use YYYY-MM-DD format.

", "example": "1991-01-09", "format": "date" }, { "name": "documentExpiration", "kind": "optional", "type": "string", "nullable": true, "description": "

Document's exipration date. Use YYYY-MM-DD format.

", "example": "2017-01-15", "format": "date" }, { "name": "documentFirstName", "kind": "optional", "type": "string", "nullable": true, "description": "First name as appears on the document", "example": "John", "maxLength": 50 }, { "name": "documentIssuingState", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nDocument issuing state or region", "example": "NY", "maxLength": 25 }, { "name": "documentLastName", "kind": "optional", "type": "string", "nullable": true, "description": "Last name as appears on the document", "example": "Smith", "maxLength": 50 }, { "name": "documentNumber", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Official document's number (e.g. passport number, driving license number, etc.)

", "example": "20439190", "maxLength": 50 }, { "name": "documentSource", "kind": "required", "type": "string", "description": "

Source of document (e.g. uploaded file, captured by camera, typed in by customer, etc.)

", "example": "UPLOADED_FILE", "enum": [ "CAMERA_CAPTURED", "UPLOADED_FILE", "TYPED", "OTHER" ] }, { "name": "documentStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Status of verification document (e.g. sent to customer, received by customer, abandoned by customer ).

", "example": "SENT_TO_CLIENT", "enum": [ "SENT_TO_CLIENT", "RECEIVED_FROM_CLIENT", "ABANDONED_BY_CLIENT", "RECEIVED_FROM_CLIENT_FAULTY" ], "maxLength": 50 }, { "name": "documentType", "kind": "required", "type": "string", "description": "

Type of document (Passport, ID, Driving license)

", "example": "Passport", "maxLength": 35 }, { "name": "documentVerificationServiceAnswer", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nAnswer received from 3rd party document verification services", "example": "APPROVED", "maxLength": 20 }, { "name": "documentVerificationServiceName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nName of 3rd party document verifcation service", "example": "IDVerification.com", "maxLength": 50 }, { "name": "documentVerificationServiceResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "documentVerified", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if document was verified as authentic by merchant or 3rd party service", "example": true }, { "name": "eventTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time of event in seconds since unix epoch (UTC, Jan 1, 1970). For example, 01/01/2015 00

is 1420070400

", "example": 1420070400 }, { "name": "nationality", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nDocument holder's nationality", "example": "US", "maxLength": 25 } ] }, { "name": "employmentInformation", "kind": "optional", "type": "array", "nullable": true, "description": "Credit applicant's employment information", "modelRef": "#/components/schemas/EmploymentInformation", "customType": "EmploymentInformation[]", "schema": [ { "name": "employerAddress", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

Street-level address. Required when full address details are available

", "example": "235 Montgomery st.", "maxLength": 255 }, { "name": "address2", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unit-level address

", "example": "Ste. 1110", "maxLength": 255 }, { "name": "city", "kind": "required", "type": "string", "description": "City. Required when full address details are available", "example": "San Francisco", "maxLength": 200 }, { "name": "company", "kind": "optional", "type": "string", "nullable": true, "description": "Company", "example": "Generic Corp. ltd.", "maxLength": 225 }, { "name": "country", "kind": "required", "type": "string", "description": "

Country, two-letter ISO 3166-1 alpha-2 country code

", "example": "US", "minLength": 2, "maxLength": 2 }, { "name": "region", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York)

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "employerCompanySizeRange", "kind": "optional", "type": "string", "nullable": true, "description": "Employing company's number of employees", "example": "20", "maxLength": 30 }, { "name": "employerIndustry", "kind": "optional", "type": "string", "nullable": true, "description": "Employing company's industry", "example": "Retail", "maxLength": 100 }, { "name": "employerName", "kind": "required", "type": "string", "description": "Employing company's name", "example": "Forter", "maxLength": 100 }, { "name": "employerPhone", "kind": "optional", "type": "string", "nullable": true, "description": "Employing company's phone", "example": "+12126667777", "maxLength": 30 }, { "name": "income", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "jobTitle", "kind": "optional", "type": "string", "nullable": true, "description": "Job title", "example": "Fraud Analyst", "maxLength": 50 } ] }, { "name": "personalDetails", "kind": "required", "type": "object", "description": "Personal information such as name and birthdate", "modelRef": "#/components/schemas/PersonalDetails", "customType": "PersonalDetails", "schema": [ { "name": "birthdate", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Date of birth. Use YYYY-MM-DD format.

", "example": "1987-05-22", "format": "date" }, { "name": "email", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nEmail address", "example": "john_s@test.com", "maxLength": 256 }, { "name": "firstName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFirst name", "example": "John", "maxLength": 75 }, { "name": "fullName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFull name. Not Needed if firstName and LastName are provided independently.", "example": "John Smith", "maxLength": 150 }, { "name": "gender", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nGender", "example": "MALE", "enum": [ "MALE", "FEMALE", "CHOSE_NOT_TO_SPECIFY", "NONE" ] }, { "name": "lastName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nLast name", "example": "Smith", "maxLength": 75 } ] }, { "name": "phone", "kind": "optional", "type": "array", "conditional": true, "nullable": true, "description": "Conditional.\nPhone details", "modelRef": "#/components/schemas/Phone", "customType": "Phone[]", "schema": [ { "name": "phone", "kind": "required", "type": "string", "description": "Phone number including all country and local access codes", "example": "15557654321", "maxLength": 25 }, { "name": "smsVerified", "kind": "required", "type": "object", "description": "Phone verification details", "modelRef": "#/components/schemas/Verification", "customType": "Verification", "schema": [ { "name": "sent", "kind": "required", "type": "boolean", "description": "True if verification email was sent to email address or verification SMS was sent to phone number", "example": true }, { "name": "timeSent", "kind": "optional", "type": "number", "nullable": true, "description": "

Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1389567341 }, { "name": "verified", "kind": "required", "type": "boolean", "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)

", "example": false } ] } ] } ] } ], "schema": [] }, { "name": "cameraCaptured", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if payment instrument details were captured by OCR from a picture. False if payment instrument details were manually typed in", "example": true }, { "name": "cash", "kind": "optional", "type": "boolean", "nullable": true, "description": "Payed with cash", "example": false }, { "name": "creditCard", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CreditCard", "description": "", "modelRef": "#/components/schemas/CreditCard", "schema": [ { "name": "bin", "kind": "required", "type": "string", "description": "

Credit card's BIN (Bank Identification Number)

", "example": "42424242", "maxLength": 8, "pattern": "[0-9]{6,8}" }, { "name": "cardBank", "kind": "optional", "type": "string", "nullable": true, "description": "Credit card's issuing bank", "example": "Chase", "maxLength": 128 }, { "name": "cardBrand", "kind": "optional", "type": "string", "nullable": true, "description": "Credit Card's issuer brand", "example": "VISA", "maxLength": 30 }, { "name": "cardType", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment card type", "example": "CREDIT", "enum": [ "CREDIT", "DEBIT", "PREPAID", "UNKNOWN" ] }, { "name": "countryOfIssuance", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code

", "example": "US", "maxLength": 2, "pattern": "[A-Za-z]{2}" }, { "name": "creditCardCorrelationId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Credit card - CorrelationId that was recieved by the init 3DS API

" }, { "name": "expirationMonth", "kind": "required", "type": "string", "description": "

Credit card's expiration month, in MM format

", "example": "03", "maxLength": 2, "pattern": "[0-9]{2}" }, { "name": "expirationYear", "kind": "required", "type": "string", "description": "

Credit card's expiration year, in YYYY format

", "example": "2018", "maxLength": 4, "pattern": "[0-9]{4}" }, { "name": "fingerprint", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique identifier for card (sent by gateway or processor)

", "example": "Xt5EWLLDS7FJjR1c", "maxLength": 128 }, { "name": "fullCreditCard", "kind": "optional", "type": "string", "nullable": true, "description": "

Credit Card's full PAN - needed for the 3DS secure implementation

", "example": "2424242424242424", "maxLength": 30 }, { "name": "fullResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "lastFourDigits", "kind": "required", "type": "string", "description": "

Credit card's last 4 digits (For Amex, take 4 digits from last digit)

", "example": "4242", "maxLength": 4, "pattern": "[0-9]{2,4}" }, { "name": "nameOnCard", "kind": "required", "type": "string", "description": "Cardholder's full name", "example": "John R. H. Smith", "maxLength": 75 }, { "name": "paymentProcessorData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentProcessorData", "description": "", "modelRef": "#/components/schemas/PaymentProcessorData", "schema": [ { "name": "processorName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment processor name", "example": "Chase Paymentech", "maxLength": 50 }, { "name": "processorTransactionId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique transaction identifier (sent by processor)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "threeDSecure", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureInput", "description": "", "modelRef": "#/components/schemas/ThreeDSecureInput", "schema": [ { "name": "acquirerData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AcquirerData", "description": "", "modelRef": "#/components/schemas/AcquirerData", "schema": [ { "name": "acquirerBIN", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Bank acquirer BIN (Bank Identification Number)

", "example": "457173", "maxLength": 12 }, { "name": "acquirerCountry", "kind": "optional", "type": "string", "nullable": true, "description": "Acquirer country", "example": "US", "enum": [ "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" ] }, { "name": "acquirerMerchantId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor

", "example": "5245020244654", "maxLength": 30 }, { "name": "acquirerMerchantName", "kind": "optional", "type": "string", "nullable": true, "description": "Merchant Name as appearing in processor records", "example": "Simple T-shirt", "maxLength": 100 }, { "name": "acquirerName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank acquirer Name", "example": "Barclays", "maxLength": 50 }, { "name": "merchantCategoryCode", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\n

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.

", "example": 5655, "maxLength": 4 }, { "name": "merchantCountryCode", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\nMerchant country code", "example": 840, "maxLength": 3 } ] } ], "schema": [] }, { "name": "challengeIndicator", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation", "example": "NO_PREFERENCE", "enum": [ "NO_PREFERENCE", "NO_CHALLENGE", "CHALLENGE", "CHALLENGE_AS_MANDATE" ] }, { "name": "execute3ds", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the execution of 3DS", "example": "DYNAMIC_FORTER_DECISION", "enum": [ "FORCE_3DS", "NOT_SUPPORTED_BY_MERCHANT", "DYNAMIC_FORTER_DECISION" ] }, { "name": "forcePsd2Exemption", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureForcePsd2Exemption", "description": "", "modelRef": "#/components/schemas/ThreeDSecureForcePsd2Exemption", "schema": [ { "name": "channel", "kind": "required", "type": "string", "description": "The channel through which the exemption is requested", "example": "THREEDS_RAILS", "enum": [ "THREEDS_RAILS", "AUTHORIZATION" ] }, { "name": "type", "kind": "required", "type": "string", "description": "The type of exemption requested", "example": "LOW_VALUE", "enum": [ "LOW_VALUE", "TRANSACTION_RISK_ANALYSIS", "SECURE_CORPORATE", "TRUSTED_BENEFICIARY" ] } ] } ], "schema": [] }, { "name": "requestChallenge", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates if a 3DS challenge should be requested from the Issuer ACS.", "example": false }, { "name": "threeDSServerTransID", "kind": "required", "type": "string", "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", "example": "26d648a9-da8a-4f8b-a76d-094801d2fd45", "maxLength": 100 }, { "name": "threeDsExecutor", "kind": "optional", "type": "string", "nullable": true, "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

", "enum": [ "FORTER", "MERCHANT" ] } ] } ], "schema": [] }, { "name": "verificationResults", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CreditCardVerification", "description": "", "modelRef": "#/components/schemas/CreditCardVerification", "schema": [ { "name": "authorizationCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCard authorization code from payment gateway", "example": "A33244", "maxLength": 255 }, { "name": "authorizationProcessedWith3DS", "kind": "optional", "type": "boolean", "nullable": true, "description": "

3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization

", "example": true }, { "name": "avsFullResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string

", "example": "Y", "maxLength": 50 }, { "name": "avsNameResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Name portion of card's AVS result (when available)

", "example": "M", "maxLength": 30 }, { "name": "avsStreetResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nStreet address portion of card's AVS result", "example": "N", "maxLength": 30 }, { "name": "avsZipResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode portion of card's AVS result", "example": "M", "maxLength": 30 }, { "name": "cavvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response

", "example": "VYboNwcsB3F9gTIsbaUjvEuLW0o=", "maxLength": 50 }, { "name": "cvvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

CVV result (if no data please send the value U)

", "example": "M", "maxLength": 30 }, { "name": "eciValue", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - ECI value recieved from authorization/authentication response

", "example": "05", "maxLength": 2 }, { "name": "exemptionStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nExemption status as received from the processor", "example": "accepted", "maxLength": 100 }, { "name": "external3dsVendorPayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "issuerResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from issuer", "example": "D23", "maxLength": 50 }, { "name": "issuerResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from issuer", "example": "Stolen card", "maxLength": 255 }, { "name": "liabilityShift", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer

", "example": true }, { "name": "partyExecuted3DS", "kind": "optional", "type": "string", "nullable": true, "description": "

3DSecure - Party executed the 3DS authentication

", "example": "PSP", "enum": [ "PSP", "FORTER", "BOTH" ] }, { "name": "processorResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from processor", "example": "D23", "maxLength": 50 }, { "name": "processorResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from processor", "example": "Stolen card", "maxLength": 255 }, { "name": "threeDsInteractionMode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Indication of the friction that the user experienced

", "example": "FRICTIONLESS", "enum": [ "FRICTIONLESS", "CHALLENGED" ] }, { "name": "threeDsStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Status text received from 3D secure vendor

", "example": "Cardholder authenticated", "maxLength": 100 }, { "name": "threeDsVersion", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Version used in the transaction

", "example": "2.1.0", "maxLength": 5 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "creditLineDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CreditLineDetails", "description": "", "modelRef": "#/components/schemas/CreditLineDetails", "schema": [ { "name": "askedToIncreaseCreditLineLimit", "kind": "required", "type": "boolean", "description": "True if customer asked to increase credit line limit", "example": false }, { "name": "creditLineLimitIncreaseMethod", "kind": "required", "type": "string", "description": "

Method customer chose to ask to increase credit line limit - PRE_APPROVAL, AT_PURCHASE

", "example": "AT_PURCHASE", "enum": [ "PRE_APPROVAL", "AT_PURCHASE" ] }, { "name": "currentCreditLineLimit", "kind": "required", "type": "object", "description": "Current limit that was set for the credit line", "modelRef": "#/components/schemas/Amount", "customType": "Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] }, { "name": "originalCreditLineLimit", "kind": "required", "type": "object", "description": "Original limit that was set for the credit line", "modelRef": "#/components/schemas/Amount", "customType": "Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ] } ], "schema": [] }, { "name": "cryptoWallet", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CryptoWallet", "description": "", "modelRef": "#/components/schemas/CryptoWallet", "schema": [ { "name": "cryptoWalletName", "kind": "optional", "type": "string", "nullable": true, "description": "Crypto wallet name", "example": "CryptoWallet", "maxLength": 30 }, { "name": "cryptoWalletPaymentId", "kind": "optional", "type": "string", "nullable": true, "description": "Crypto wallet payment ID", "example": "3JQiwG88SQvwihDAHg9M2EnqEisharz49c", "maxLength": 50 }, { "name": "cryptoWalletType", "kind": "required", "type": "string", "description": "

Crypto wallet type (Indicate whether wallet provider is internal to the site ecosystem)

", "example": "EXTERNAL", "enum": [ "INTERNAL", "EXTERNAL" ] } ] } ], "schema": [] }, { "name": "digitalWallet", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "DigitalWallet", "description": "", "modelRef": "#/components/schemas/DigitalWallet", "schema": [ { "name": "digitalWalletName", "kind": "required", "type": "string", "description": "Digital wallet name", "example": "ALIPAY", "enum": [ "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" ] }, { "name": "digitalWalletPayerEmail", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nEmail address associated with the digital wallet account", "example": "john_s@test.com", "maxLength": 75 }, { "name": "digitalWalletPayerId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique identifier for each digital wallet account. This ID should persist across all orders made by the same user, regardless of underlying payment methods.

", "example": "FD000A45P", "maxLength": 154 }, { "name": "digitalWalletpaymentId", "kind": "optional", "type": "string", "nullable": true, "description": "Digital wallet payment ID", "example": "PAY-0MB00000KR8073311KZSDEYA", "maxLength": 50 }, { "name": "freeTextDigitalWalletName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Specifics about the source of the wallet such as the name / 3rd party name, etc. (required for OTHER digitalWalletName)

", "example": "ALIBABA" }, { "name": "fullDigitalWalletResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "payerAccountCountry", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Digital wallet account country, two-letter ISO 3166-1 alpha-2 country code

", "example": "US", "minLength": 2, "maxLength": 2 }, { "name": "paymentSuccessStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nDigital wallet payment status", "example": "COMPLETED", "maxLength": 50 }, { "name": "underlyingPaymentMethod", "kind": "required", "type": "object", "description": "The underlying payment method associated to the digital wallet that was used in the current transaction", "modelRef": "#/components/schemas/UnderlyingPaymentMethod", "customType": "UnderlyingPaymentMethod", "schema": [ { "name": "bankTransfer", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "BankTransfer", "description": "", "modelRef": "#/components/schemas/BankTransfer", "schema": [ { "name": "accountHolderFirstName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank account holder first name", "example": "John", "maxLength": 50 }, { "name": "accountHolderLastName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank account holder last name", "example": "Smith", "maxLength": 50 }, { "name": "achProcessingType", "kind": "optional", "type": "string", "nullable": true, "description": "Type of ACH processing used in the transaction", "example": "SAME_DAY_ACH", "maxLength": 50 }, { "name": "bankAccountIdentifier", "kind": "optional", "type": "string", "nullable": true, "description": "

Bank account unique identifier (IBAN or equivalent)

", "example": "TEST63TEST1212121212", "maxLength": 40 }, { "name": "bankAccountType", "kind": "optional", "type": "string", "nullable": true, "description": "

Type of bank account payment is made from (e.g. savings/checking, etc.)

", "example": "Savings", "maxLength": 50 }, { "name": "bankName", "kind": "optional", "type": "string", "nullable": true, "description": "Name of bank payment is made from", "example": "Citigroup", "maxLength": 50 }, { "name": "paymentGatewayData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentGatewayData", "description": "", "modelRef": "#/components/schemas/PaymentGatewayData", "schema": [ { "name": "gatewayName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment gateway name", "example": "Braintree", "maxLength": 50 }, { "name": "gatewayTransactionId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique transaction identifier (sent by gateway)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "paymentSuccessStatus", "kind": "optional", "type": "string", "nullable": true, "description": "Response text as received from the service provider", "example": "Payment Successful" }, { "name": "serviceName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment method name", "example": "Direct Debit", "maxLength": 30 } ] } ], "schema": [] }, { "name": "bitcoin", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nBitcoin payment details", "example": false }, { "name": "cash", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nPayed with cash", "example": false }, { "name": "creditCard", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "TokenizedCreditCard", "description": "", "modelRef": "#/components/schemas/TokenizedCreditCard", "schema": [ { "name": "cardBank", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCredit card's issuing bank", "example": "Chase", "maxLength": 128 }, { "name": "cardBrand", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCredit card's issuer brand", "example": "VISA", "maxLength": 50 }, { "name": "cardType", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment card type", "example": "CREDIT", "enum": [ "CREDIT", "DEBIT", "PREPAID", "UNKNOWN" ] }, { "name": "countryOfIssuance", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code

", "example": "US", "maxLength": 2, "pattern": "[A-Za-z]{2}" }, { "name": "creationTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1430997968 }, { "name": "creditCardCorrelationId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Credit card - CorrelationId that was recieved by the init 3DS API

" }, { "name": "expirationMonth", "kind": "optional", "type": "string", "nullable": true, "description": "

Credit card's expiration month, in MM format

", "example": "03", "maxLength": 2, "pattern": "[0-9]{2}" }, { "name": "expirationYear", "kind": "optional", "type": "string", "nullable": true, "description": "

Credit card's expiration year, in YYYY format

", "example": "2018", "maxLength": 4, "pattern": "[0-9]{4}" }, { "name": "fullResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "lastFourDigits", "kind": "optional", "type": "string", "nullable": true, "description": "Credit card's last 4 digits", "example": "4242", "maxLength": 4, "pattern": "[0-9]{2,4}" }, { "name": "nameOnCard", "kind": "optional", "type": "string", "nullable": true, "description": "Cardholder's full name", "example": "John R. H. Smith", "maxLength": 75 }, { "name": "paymentProcessorData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentProcessorData", "description": "", "modelRef": "#/components/schemas/PaymentProcessorData", "schema": [ { "name": "processorName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment processor name", "example": "Chase Paymentech", "maxLength": 50 }, { "name": "processorTransactionId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique transaction identifier (sent by processor)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "threeDSecure", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureInput", "description": "", "modelRef": "#/components/schemas/ThreeDSecureInput", "schema": [ { "name": "acquirerData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AcquirerData", "description": "", "modelRef": "#/components/schemas/AcquirerData", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "challengeIndicator", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation", "example": "NO_PREFERENCE", "enum": [ "NO_PREFERENCE", "NO_CHALLENGE", "CHALLENGE", "CHALLENGE_AS_MANDATE" ] }, { "name": "execute3ds", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the execution of 3DS", "example": "DYNAMIC_FORTER_DECISION", "enum": [ "FORCE_3DS", "NOT_SUPPORTED_BY_MERCHANT", "DYNAMIC_FORTER_DECISION" ] }, { "name": "forcePsd2Exemption", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureForcePsd2Exemption", "description": "", "modelRef": "#/components/schemas/ThreeDSecureForcePsd2Exemption", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "requestChallenge", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates if a 3DS challenge should be requested from the Issuer ACS.", "example": false }, { "name": "threeDSServerTransID", "kind": "required", "type": "string", "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", "example": "26d648a9-da8a-4f8b-a76d-094801d2fd45", "maxLength": 100 }, { "name": "threeDsExecutor", "kind": "optional", "type": "string", "nullable": true, "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

", "enum": [ "FORTER", "MERCHANT" ] } ] } ], "schema": [] }, { "name": "token", "kind": "optional", "type": "string", "nullable": true, "description": "Credit card token used by the merchant", "example": "tkn-77620C360132856A103477D2959967AB", "maxLength": 200 }, { "name": "tokenType", "kind": "optional", "type": "string", "nullable": true, "description": "

Token type, determined by the party/protocol the token created by

", "enum": [ "PSP", "EMV_PAYMENT_TOKEN", "MERCHANT_GENERATED", "FORTER_TOKEN", "OTHER" ], "maxLength": 128 }, { "name": "verificationResults", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CreditCardVerification", "description": "", "modelRef": "#/components/schemas/CreditCardVerification", "schema": [ { "name": "authorizationCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCard authorization code from payment gateway", "example": "A33244", "maxLength": 255 }, { "name": "authorizationProcessedWith3DS", "kind": "optional", "type": "boolean", "nullable": true, "description": "

3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization

", "example": true }, { "name": "avsFullResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string

", "example": "Y", "maxLength": 50 }, { "name": "avsNameResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Name portion of card's AVS result (when available)

", "example": "M", "maxLength": 30 }, { "name": "avsStreetResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nStreet address portion of card's AVS result", "example": "N", "maxLength": 30 }, { "name": "avsZipResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode portion of card's AVS result", "example": "M", "maxLength": 30 }, { "name": "cavvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response

", "example": "VYboNwcsB3F9gTIsbaUjvEuLW0o=", "maxLength": 50 }, { "name": "cvvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

CVV result (if no data please send the value U)

", "example": "M", "maxLength": 30 }, { "name": "eciValue", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - ECI value recieved from authorization/authentication response

", "example": "05", "maxLength": 2 }, { "name": "exemptionStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nExemption status as received from the processor", "example": "accepted", "maxLength": 100 }, { "name": "external3dsVendorPayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "issuerResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from issuer", "example": "D23", "maxLength": 50 }, { "name": "issuerResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from issuer", "example": "Stolen card", "maxLength": 255 }, { "name": "liabilityShift", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer

", "example": true }, { "name": "partyExecuted3DS", "kind": "optional", "type": "string", "nullable": true, "description": "

3DSecure - Party executed the 3DS authentication

", "example": "PSP", "enum": [ "PSP", "FORTER", "BOTH" ] }, { "name": "processorResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from processor", "example": "D23", "maxLength": 50 }, { "name": "processorResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from processor", "example": "Stolen card", "maxLength": 255 }, { "name": "threeDsInteractionMode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Indication of the friction that the user experienced

", "example": "FRICTIONLESS", "enum": [ "FRICTIONLESS", "CHALLENGED" ] }, { "name": "threeDsStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Status text received from 3D secure vendor

", "example": "Cardholder authenticated", "maxLength": 100 }, { "name": "threeDsVersion", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Version used in the transaction

", "example": "2.1.0", "maxLength": 5 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "underlyingPaymentMethodType", "kind": "required", "type": "string", "description": "Underlying payment method type used in current transaction", "example": "UNKNOWN", "enum": [ "UNKNOWN", "CREDITCARD", "BANKTRANSFER", "CASH", "BITCOIN" ] } ] } ] } ], "schema": [] }, { "name": "giftCard", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CreditUsed", "description": "", "modelRef": "#/components/schemas/CreditUsed", "schema": [ { "name": "activationTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time credit/gift card was activated in the account, in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "creditCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Original transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" }, { "name": "creditOrigin", "kind": "optional", "type": "string", "nullable": true, "description": "Source which created gift card for customer.", "example": "CS Compensation" }, { "name": "merchantPaymentId", "kind": "optional", "type": "string", "nullable": true, "description": "unique payment identifier for the merchant reference.", "example": "eab12-ba9a-367-60b", "maxLength": 150 }, { "name": "value", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "installmentService", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "InstallmentService", "description": "", "modelRef": "#/components/schemas/InstallmentService", "schema": [ { "name": "firstName", "kind": "optional", "type": "string", "nullable": true, "description": "Account holder's first name", "example": "John", "maxLength": 75 }, { "name": "fullResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "lastName", "kind": "optional", "type": "string", "nullable": true, "description": "Account holder's last name", "example": "Smith", "maxLength": 75 }, { "name": "paymentId", "kind": "optional", "type": "string", "nullable": true, "description": "Installment payment ID", "example": "YTZ8IATEGAWRRVVG", "maxLength": 50 }, { "name": "serviceName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nInstallment service's name", "example": "Affirm", "maxLength": 30 }, { "name": "serviceResponseCode", "kind": "optional", "type": "string", "nullable": true, "description": "Response code received from installment service", "example": "200", "maxLength": 50 } ] } ], "schema": [] }, { "name": "loyaltyPoints", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "LoyaltyPoints", "description": "", "modelRef": "#/components/schemas/LoyaltyPoints", "schema": [ { "name": "loyaltyPointsCount", "kind": "required", "type": "number", "description": "

Number of points (miles, stars, etc.)

", "example": 1506 }, { "name": "loyaltyPointsSource", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Source of points (promo, referral, etc.)

", "example": "IN_ACCOUNT_PURCHASES", "enum": [ "REFERRAL", "IN_ACCOUNT_PURCHASES", "PROMOTION", "COMPENSATION", "CARD_SCHEME_POINTS" ] }, { "name": "loyaltyPointsValue", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "merchantPaymentId", "kind": "optional", "type": "string", "nullable": true, "description": "unique payment identifier for the merchant reference.", "example": "eab12-ba9a-367-60b", "maxLength": 150 } ] } ], "schema": [] }, { "name": "merchantInitiated", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantInitiatedPayment", "description": "", "modelRef": "#/components/schemas/MerchantInitiatedPayment", "schema": [ { "name": "initialOrderId", "kind": "optional", "type": "string", "nullable": true, "description": "

Unique order/transaction identifier of the initial order (CIT).

", "example": "2356fdse0rr489", "maxLength": 40 }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "

Specifies the type of merchant-initiated payment

", "enum": [ "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" ] } ] } ], "schema": [] }, { "name": "mobileMoney", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MobileMoney", "description": "", "modelRef": "#/components/schemas/MobileMoney", "schema": [ { "name": "fullResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "mobileMoneyNetwork", "kind": "required", "type": "string", "description": "Mobile money provider name", "example": "MPESA", "enum": [ "MPESA", "MTN", "MPAWA", "MSHWAEI", "SAFARICOM", "DASH" ] }, { "name": "paymentAcquirerData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AcquirerData", "description": "", "modelRef": "#/components/schemas/AcquirerData", "schema": [ { "name": "acquirerBIN", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Bank acquirer BIN (Bank Identification Number)

", "example": "457173", "maxLength": 12 }, { "name": "acquirerCountry", "kind": "optional", "type": "string", "nullable": true, "description": "Acquirer country", "example": "US", "enum": [ "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" ] }, { "name": "acquirerMerchantId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor

", "example": "5245020244654", "maxLength": 30 }, { "name": "acquirerMerchantName", "kind": "optional", "type": "string", "nullable": true, "description": "Merchant Name as appearing in processor records", "example": "Simple T-shirt", "maxLength": 100 }, { "name": "acquirerName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank acquirer Name", "example": "Barclays", "maxLength": 50 }, { "name": "merchantCategoryCode", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\n

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.

", "example": 5655, "maxLength": 4 }, { "name": "merchantCountryCode", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\nMerchant country code", "example": 840, "maxLength": 3 } ] } ], "schema": [] }, { "name": "paymentGatewayData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentGatewayData", "description": "", "modelRef": "#/components/schemas/PaymentGatewayData", "schema": [ { "name": "gatewayName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment gateway name", "example": "Braintree", "maxLength": 50 }, { "name": "gatewayTransactionId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique transaction identifier (sent by gateway)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "paymentSuccessStatus", "kind": "optional", "type": "string", "nullable": true, "description": "Mobile money payment status", "example": "success", "maxLength": 50 }, { "name": "phoneNumber", "kind": "required", "type": "string", "description": "Account phone number", "example": "15557654321", "maxLength": 50 } ] } ], "schema": [] }, { "name": "numberOfInstallments", "kind": "optional", "type": "integer", "conditional": true, "nullable": true, "description": "Conditional.\nNumber of payments if customer chose to pay in several installments", "example": 12 }, { "name": "paymentMethodNickname", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nNickname assigned to this payment method by the user", "example": "My Work Card" }, { "name": "paypal", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Paypal", "description": "", "modelRef": "#/components/schemas/Paypal", "schema": [ { "name": "authorizationId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayPal authorization ID", "example": "2WC75407LV7300439", "maxLength": 50 }, { "name": "fullPaypalResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "payerAccountCountry", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

PayPal account country, two-letter ISO 3166-1 alpha-2 country code

", "example": "US", "minLength": 2, "maxLength": 2 }, { "name": "payerAddressStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayPal payer address status", "example": "CONFIRMED" }, { "name": "payerEmail", "kind": "required", "type": "string", "description": "PayPal payer Email address", "example": "john_s@test.com", "maxLength": 256 }, { "name": "payerId", "kind": "required", "type": "string", "description": "PayPal payer ID", "example": "FD000A45P", "maxLength": 154 }, { "name": "payerStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayPal payer status", "example": "VERIFIED" }, { "name": "paymentGatewayData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentGatewayData", "description": "", "modelRef": "#/components/schemas/PaymentGatewayData", "schema": [ { "name": "gatewayName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment gateway name", "example": "Braintree", "maxLength": 50 }, { "name": "gatewayTransactionId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique transaction identifier (sent by gateway)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "paymentId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayPal payment ID", "example": "PAY-0MB00000KR8073311KZSDEYA", "maxLength": 50 }, { "name": "paymentStatus", "kind": "optional", "type": "string", "nullable": true, "description": "PayPal payment status", "example": "COMPLETED", "maxLength": 50 }, { "name": "protectionEligibility", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayPal protection eligibility", "example": "ELIGIBLE" } ] } ], "schema": [] }, { "name": "recurringPayment", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "RecurringPaymentDetails", "description": "", "modelRef": "#/components/schemas/RecurringPaymentDetails", "schema": [ { "name": "currentPaymentNumber", "kind": "optional", "type": "integer", "nullable": true, "description": "

The number of payments processed in this recurring event including current transaction (1 for the original transaction)

", "example": 1 }, { "name": "initialPaymentOrderId", "kind": "required", "type": "string", "description": "

Original order/transaction identifier that started the recurring event (payment number 1)

", "example": "2356fdse0rr483", "maxLength": 40 }, { "name": "isPaymentAmountIdenticalForAllPayments", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if the amount is constant between payments", "example": false }, { "name": "recurringPaymentExpirationDate", "kind": "optional", "type": "string", "nullable": true, "description": "

Date of last expected payment event. Use YYYY-MM-DD format.

", "example": "1988-06-22", "format": "date" }, { "name": "recurringPaymentFrequency", "kind": "required", "type": "string", "description": "The number of days between transactions.", "example": "7" }, { "name": "totalNumberOfPayments", "kind": "optional", "type": "integer", "nullable": true, "description": "Expected number of payments processed in this recurring event", "example": 12 } ] } ], "schema": [] }, { "name": "samsungPay", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "TokenizedCreditCard", "description": "", "modelRef": "#/components/schemas/TokenizedCreditCard", "schema": [ { "name": "cardBank", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCredit card's issuing bank", "example": "Chase", "maxLength": 128 }, { "name": "cardBrand", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCredit card's issuer brand", "example": "VISA", "maxLength": 50 }, { "name": "cardType", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment card type", "example": "CREDIT", "enum": [ "CREDIT", "DEBIT", "PREPAID", "UNKNOWN" ] }, { "name": "countryOfIssuance", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code

", "example": "US", "maxLength": 2, "pattern": "[A-Za-z]{2}" }, { "name": "creationTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1430997968 }, { "name": "creditCardCorrelationId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Credit card - CorrelationId that was recieved by the init 3DS API

" }, { "name": "expirationMonth", "kind": "optional", "type": "string", "nullable": true, "description": "

Credit card's expiration month, in MM format

", "example": "03", "maxLength": 2, "pattern": "[0-9]{2}" }, { "name": "expirationYear", "kind": "optional", "type": "string", "nullable": true, "description": "

Credit card's expiration year, in YYYY format

", "example": "2018", "maxLength": 4, "pattern": "[0-9]{4}" }, { "name": "fullResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "lastFourDigits", "kind": "optional", "type": "string", "nullable": true, "description": "Credit card's last 4 digits", "example": "4242", "maxLength": 4, "pattern": "[0-9]{2,4}" }, { "name": "nameOnCard", "kind": "optional", "type": "string", "nullable": true, "description": "Cardholder's full name", "example": "John R. H. Smith", "maxLength": 75 }, { "name": "paymentProcessorData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentProcessorData", "description": "", "modelRef": "#/components/schemas/PaymentProcessorData", "schema": [ { "name": "processorName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment processor name", "example": "Chase Paymentech", "maxLength": 50 }, { "name": "processorTransactionId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique transaction identifier (sent by processor)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "threeDSecure", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureInput", "description": "", "modelRef": "#/components/schemas/ThreeDSecureInput", "schema": [ { "name": "acquirerData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AcquirerData", "description": "", "modelRef": "#/components/schemas/AcquirerData", "schema": [ { "name": "acquirerBIN", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Bank acquirer BIN (Bank Identification Number)

", "example": "457173", "maxLength": 12 }, { "name": "acquirerCountry", "kind": "optional", "type": "string", "nullable": true, "description": "Acquirer country", "example": "US", "enum": [ "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" ] }, { "name": "acquirerMerchantId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor

", "example": "5245020244654", "maxLength": 30 }, { "name": "acquirerMerchantName", "kind": "optional", "type": "string", "nullable": true, "description": "Merchant Name as appearing in processor records", "example": "Simple T-shirt", "maxLength": 100 }, { "name": "acquirerName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank acquirer Name", "example": "Barclays", "maxLength": 50 }, { "name": "merchantCategoryCode", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\n

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.

", "example": 5655, "maxLength": 4 }, { "name": "merchantCountryCode", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\nMerchant country code", "example": 840, "maxLength": 3 } ] } ], "schema": [] }, { "name": "challengeIndicator", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation", "example": "NO_PREFERENCE", "enum": [ "NO_PREFERENCE", "NO_CHALLENGE", "CHALLENGE", "CHALLENGE_AS_MANDATE" ] }, { "name": "execute3ds", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the execution of 3DS", "example": "DYNAMIC_FORTER_DECISION", "enum": [ "FORCE_3DS", "NOT_SUPPORTED_BY_MERCHANT", "DYNAMIC_FORTER_DECISION" ] }, { "name": "forcePsd2Exemption", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureForcePsd2Exemption", "description": "", "modelRef": "#/components/schemas/ThreeDSecureForcePsd2Exemption", "schema": [ { "name": "channel", "kind": "required", "type": "string", "description": "The channel through which the exemption is requested", "example": "THREEDS_RAILS", "enum": [ "THREEDS_RAILS", "AUTHORIZATION" ] }, { "name": "type", "kind": "required", "type": "string", "description": "The type of exemption requested", "example": "LOW_VALUE", "enum": [ "LOW_VALUE", "TRANSACTION_RISK_ANALYSIS", "SECURE_CORPORATE", "TRUSTED_BENEFICIARY" ] } ] } ], "schema": [] }, { "name": "requestChallenge", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates if a 3DS challenge should be requested from the Issuer ACS.", "example": false }, { "name": "threeDSServerTransID", "kind": "required", "type": "string", "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", "example": "26d648a9-da8a-4f8b-a76d-094801d2fd45", "maxLength": 100 }, { "name": "threeDsExecutor", "kind": "optional", "type": "string", "nullable": true, "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

", "enum": [ "FORTER", "MERCHANT" ] } ] } ], "schema": [] }, { "name": "token", "kind": "optional", "type": "string", "nullable": true, "description": "Credit card token used by the merchant", "example": "tkn-77620C360132856A103477D2959967AB", "maxLength": 200 }, { "name": "tokenType", "kind": "optional", "type": "string", "nullable": true, "description": "

Token type, determined by the party/protocol the token created by

", "enum": [ "PSP", "EMV_PAYMENT_TOKEN", "MERCHANT_GENERATED", "FORTER_TOKEN", "OTHER" ], "maxLength": 128 }, { "name": "verificationResults", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CreditCardVerification", "description": "", "modelRef": "#/components/schemas/CreditCardVerification", "schema": [ { "name": "authorizationCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCard authorization code from payment gateway", "example": "A33244", "maxLength": 255 }, { "name": "authorizationProcessedWith3DS", "kind": "optional", "type": "boolean", "nullable": true, "description": "

3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization

", "example": true }, { "name": "avsFullResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string

", "example": "Y", "maxLength": 50 }, { "name": "avsNameResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Name portion of card's AVS result (when available)

", "example": "M", "maxLength": 30 }, { "name": "avsStreetResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nStreet address portion of card's AVS result", "example": "N", "maxLength": 30 }, { "name": "avsZipResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode portion of card's AVS result", "example": "M", "maxLength": 30 }, { "name": "cavvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response

", "example": "VYboNwcsB3F9gTIsbaUjvEuLW0o=", "maxLength": 50 }, { "name": "cvvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

CVV result (if no data please send the value U)

", "example": "M", "maxLength": 30 }, { "name": "eciValue", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - ECI value recieved from authorization/authentication response

", "example": "05", "maxLength": 2 }, { "name": "exemptionStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nExemption status as received from the processor", "example": "accepted", "maxLength": 100 }, { "name": "external3dsVendorPayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "issuerResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from issuer", "example": "D23", "maxLength": 50 }, { "name": "issuerResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from issuer", "example": "Stolen card", "maxLength": 255 }, { "name": "liabilityShift", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer

", "example": true }, { "name": "partyExecuted3DS", "kind": "optional", "type": "string", "nullable": true, "description": "

3DSecure - Party executed the 3DS authentication

", "example": "PSP", "enum": [ "PSP", "FORTER", "BOTH" ] }, { "name": "processorResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from processor", "example": "D23", "maxLength": 50 }, { "name": "processorResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from processor", "example": "Stolen card", "maxLength": 255 }, { "name": "threeDsInteractionMode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Indication of the friction that the user experienced

", "example": "FRICTIONLESS", "enum": [ "FRICTIONLESS", "CHALLENGED" ] }, { "name": "threeDsStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Status text received from 3D secure vendor

", "example": "Cardholder authenticated", "maxLength": 100 }, { "name": "threeDsVersion", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Version used in the transaction

", "example": "2.1.0", "maxLength": 5 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] }, { "name": "storeCreditUsed", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CreditUsed", "description": "", "modelRef": "#/components/schemas/CreditUsed", "schema": [ { "name": "activationTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time credit/gift card was activated in the account, in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "creditCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Original transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" }, { "name": "creditOrigin", "kind": "optional", "type": "string", "nullable": true, "description": "Source which created gift card for customer.", "example": "CS Compensation" }, { "name": "merchantPaymentId", "kind": "optional", "type": "string", "nullable": true, "description": "unique payment identifier for the merchant reference.", "example": "eab12-ba9a-367-60b", "maxLength": 150 }, { "name": "value", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "tokenizedCard", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "TokenizedCreditCard", "description": "", "modelRef": "#/components/schemas/TokenizedCreditCard", "schema": [ { "name": "cardBank", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCredit card's issuing bank", "example": "Chase", "maxLength": 128 }, { "name": "cardBrand", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCredit card's issuer brand", "example": "VISA", "maxLength": 50 }, { "name": "cardType", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment card type", "example": "CREDIT", "enum": [ "CREDIT", "DEBIT", "PREPAID", "UNKNOWN" ] }, { "name": "countryOfIssuance", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code

", "example": "US", "maxLength": 2, "pattern": "[A-Za-z]{2}" }, { "name": "creationTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1430997968 }, { "name": "creditCardCorrelationId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Credit card - CorrelationId that was recieved by the init 3DS API

" }, { "name": "expirationMonth", "kind": "optional", "type": "string", "nullable": true, "description": "

Credit card's expiration month, in MM format

", "example": "03", "maxLength": 2, "pattern": "[0-9]{2}" }, { "name": "expirationYear", "kind": "optional", "type": "string", "nullable": true, "description": "

Credit card's expiration year, in YYYY format

", "example": "2018", "maxLength": 4, "pattern": "[0-9]{4}" }, { "name": "fullResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "lastFourDigits", "kind": "optional", "type": "string", "nullable": true, "description": "Credit card's last 4 digits", "example": "4242", "maxLength": 4, "pattern": "[0-9]{2,4}" }, { "name": "nameOnCard", "kind": "optional", "type": "string", "nullable": true, "description": "Cardholder's full name", "example": "John R. H. Smith", "maxLength": 75 }, { "name": "paymentProcessorData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentProcessorData", "description": "", "modelRef": "#/components/schemas/PaymentProcessorData", "schema": [ { "name": "processorName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment processor name", "example": "Chase Paymentech", "maxLength": 50 }, { "name": "processorTransactionId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique transaction identifier (sent by processor)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "threeDSecure", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureInput", "description": "", "modelRef": "#/components/schemas/ThreeDSecureInput", "schema": [ { "name": "acquirerData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AcquirerData", "description": "", "modelRef": "#/components/schemas/AcquirerData", "schema": [ { "name": "acquirerBIN", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Bank acquirer BIN (Bank Identification Number)

", "example": "457173", "maxLength": 12 }, { "name": "acquirerCountry", "kind": "optional", "type": "string", "nullable": true, "description": "Acquirer country", "example": "US", "enum": [ "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" ] }, { "name": "acquirerMerchantId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor

", "example": "5245020244654", "maxLength": 30 }, { "name": "acquirerMerchantName", "kind": "optional", "type": "string", "nullable": true, "description": "Merchant Name as appearing in processor records", "example": "Simple T-shirt", "maxLength": 100 }, { "name": "acquirerName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank acquirer Name", "example": "Barclays", "maxLength": 50 }, { "name": "merchantCategoryCode", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\n

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.

", "example": 5655, "maxLength": 4 }, { "name": "merchantCountryCode", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\nMerchant country code", "example": 840, "maxLength": 3 } ] } ], "schema": [] }, { "name": "challengeIndicator", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation", "example": "NO_PREFERENCE", "enum": [ "NO_PREFERENCE", "NO_CHALLENGE", "CHALLENGE", "CHALLENGE_AS_MANDATE" ] }, { "name": "execute3ds", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the execution of 3DS", "example": "DYNAMIC_FORTER_DECISION", "enum": [ "FORCE_3DS", "NOT_SUPPORTED_BY_MERCHANT", "DYNAMIC_FORTER_DECISION" ] }, { "name": "forcePsd2Exemption", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureForcePsd2Exemption", "description": "", "modelRef": "#/components/schemas/ThreeDSecureForcePsd2Exemption", "schema": [ { "name": "channel", "kind": "required", "type": "string", "description": "The channel through which the exemption is requested", "example": "THREEDS_RAILS", "enum": [ "THREEDS_RAILS", "AUTHORIZATION" ] }, { "name": "type", "kind": "required", "type": "string", "description": "The type of exemption requested", "example": "LOW_VALUE", "enum": [ "LOW_VALUE", "TRANSACTION_RISK_ANALYSIS", "SECURE_CORPORATE", "TRUSTED_BENEFICIARY" ] } ] } ], "schema": [] }, { "name": "requestChallenge", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates if a 3DS challenge should be requested from the Issuer ACS.", "example": false }, { "name": "threeDSServerTransID", "kind": "required", "type": "string", "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", "example": "26d648a9-da8a-4f8b-a76d-094801d2fd45", "maxLength": 100 }, { "name": "threeDsExecutor", "kind": "optional", "type": "string", "nullable": true, "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

", "enum": [ "FORTER", "MERCHANT" ] } ] } ], "schema": [] }, { "name": "token", "kind": "optional", "type": "string", "nullable": true, "description": "Credit card token used by the merchant", "example": "tkn-77620C360132856A103477D2959967AB", "maxLength": 200 }, { "name": "tokenType", "kind": "optional", "type": "string", "nullable": true, "description": "

Token type, determined by the party/protocol the token created by

", "enum": [ "PSP", "EMV_PAYMENT_TOKEN", "MERCHANT_GENERATED", "FORTER_TOKEN", "OTHER" ], "maxLength": 128 }, { "name": "verificationResults", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CreditCardVerification", "description": "", "modelRef": "#/components/schemas/CreditCardVerification", "schema": [ { "name": "authorizationCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCard authorization code from payment gateway", "example": "A33244", "maxLength": 255 }, { "name": "authorizationProcessedWith3DS", "kind": "optional", "type": "boolean", "nullable": true, "description": "

3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization

", "example": true }, { "name": "avsFullResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string

", "example": "Y", "maxLength": 50 }, { "name": "avsNameResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Name portion of card's AVS result (when available)

", "example": "M", "maxLength": 30 }, { "name": "avsStreetResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nStreet address portion of card's AVS result", "example": "N", "maxLength": 30 }, { "name": "avsZipResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode portion of card's AVS result", "example": "M", "maxLength": 30 }, { "name": "cavvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response

", "example": "VYboNwcsB3F9gTIsbaUjvEuLW0o=", "maxLength": 50 }, { "name": "cvvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

CVV result (if no data please send the value U)

", "example": "M", "maxLength": 30 }, { "name": "eciValue", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - ECI value recieved from authorization/authentication response

", "example": "05", "maxLength": 2 }, { "name": "exemptionStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nExemption status as received from the processor", "example": "accepted", "maxLength": 100 }, { "name": "external3dsVendorPayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "issuerResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from issuer", "example": "D23", "maxLength": 50 }, { "name": "issuerResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from issuer", "example": "Stolen card", "maxLength": 255 }, { "name": "liabilityShift", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer

", "example": true }, { "name": "partyExecuted3DS", "kind": "optional", "type": "string", "nullable": true, "description": "

3DSecure - Party executed the 3DS authentication

", "example": "PSP", "enum": [ "PSP", "FORTER", "BOTH" ] }, { "name": "processorResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from processor", "example": "D23", "maxLength": 50 }, { "name": "processorResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from processor", "example": "Stolen card", "maxLength": 255 }, { "name": "threeDsInteractionMode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Indication of the friction that the user experienced

", "example": "FRICTIONLESS", "enum": [ "FRICTIONLESS", "CHALLENGED" ] }, { "name": "threeDsStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Status text received from 3D secure vendor

", "example": "Cardholder authenticated", "maxLength": 100 }, { "name": "threeDsVersion", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Version used in the transaction

", "example": "2.1.0", "maxLength": 5 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "venmo", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Venmo", "description": "", "modelRef": "#/components/schemas/Venmo", "schema": [ { "name": "fullVenmoResponsePayload", "kind": "required", "type": "object", "description": "Full Venmo response object", "modelRef": "#/components/schemas/GeneralPayloadMap", "customType": "GeneralPayloadMap", "schema": [] }, { "name": "paymentId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nVenmo payment ID", "example": "1KZSDEYA", "maxLength": 50 }, { "name": "token", "kind": "required", "type": "string", "description": "Token representing the specific payment method used within the Venmo vault", "example": "77620C360132856A103477D2959967AB", "maxLength": 200 }, { "name": "userId", "kind": "required", "type": "string", "description": "Venmo userID", "example": "johndoe", "maxLength": 50 }, { "name": "userName", "kind": "required", "type": "string", "description": "Venmo user name", "example": "johndoe1987", "maxLength": 50 } ] } ], "schema": [] } ] }, { "name": "primaryRecipient", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Beneficiary", "description": "", "modelRef": "#/components/schemas/Beneficiary", "schema": [ { "name": "additionalVerificationDocuments", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AdditionalVerificationDocuments", "description": "", "modelRef": "#/components/schemas/AdditionalVerificationDocuments", "schema": [ { "name": "documentDateOfBirth", "kind": "optional", "type": "string", "nullable": true, "description": "

Date of birth as appears on the document. Use YYYY-MM-DD format.

", "example": "1991-01-09", "format": "date" }, { "name": "documentExpiration", "kind": "optional", "type": "string", "nullable": true, "description": "

Document's exipration date. Use YYYY-MM-DD format.

", "example": "2017-01-15", "format": "date" }, { "name": "documentFirstName", "kind": "optional", "type": "string", "nullable": true, "description": "First name as appears on the document", "example": "John", "maxLength": 50 }, { "name": "documentIssuingState", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nDocument issuing state or region", "example": "NY", "maxLength": 25 }, { "name": "documentLastName", "kind": "optional", "type": "string", "nullable": true, "description": "Last name as appears on the document", "example": "Smith", "maxLength": 50 }, { "name": "documentNumber", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Official document's number (e.g. passport number, driving license number, etc.)

", "example": "20439190", "maxLength": 50 }, { "name": "documentSource", "kind": "required", "type": "string", "description": "

Source of document (e.g. uploaded file, captured by camera, typed in by customer, etc.)

", "example": "UPLOADED_FILE", "enum": [ "CAMERA_CAPTURED", "UPLOADED_FILE", "TYPED", "OTHER" ] }, { "name": "documentStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Status of verification document (e.g. sent to customer, received by customer, abandoned by customer ).

", "example": "SENT_TO_CLIENT", "enum": [ "SENT_TO_CLIENT", "RECEIVED_FROM_CLIENT", "ABANDONED_BY_CLIENT", "RECEIVED_FROM_CLIENT_FAULTY" ], "maxLength": 50 }, { "name": "documentType", "kind": "required", "type": "string", "description": "

Type of document (Passport, ID, Driving license)

", "example": "Passport", "maxLength": 35 }, { "name": "documentVerificationServiceAnswer", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nAnswer received from 3rd party document verification services", "example": "APPROVED", "maxLength": 20 }, { "name": "documentVerificationServiceName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nName of 3rd party document verifcation service", "example": "IDVerification.com", "maxLength": 50 }, { "name": "documentVerificationServiceResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "documentVerified", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if document was verified as authentic by merchant or 3rd party service", "example": true }, { "name": "eventTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time of event in seconds since unix epoch (UTC, Jan 1, 1970). For example, 01/01/2015 00

is 1420070400

", "example": 1420070400 }, { "name": "nationality", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nDocument holder's nationality", "example": "US", "maxLength": 25 } ] } ], "schema": [] }, { "name": "address", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

Street-level address. Required when full address details are available

", "example": "235 Montgomery st.", "maxLength": 255 }, { "name": "address2", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unit-level address

", "example": "Ste. 1110", "maxLength": 255 }, { "name": "city", "kind": "required", "type": "string", "description": "City. Required when full address details are available", "example": "San Francisco", "maxLength": 200 }, { "name": "company", "kind": "optional", "type": "string", "nullable": true, "description": "Company", "example": "Generic Corp. ltd.", "maxLength": 225 }, { "name": "country", "kind": "required", "type": "string", "description": "

Country, two-letter ISO 3166-1 alpha-2 country code

", "example": "US", "minLength": 2, "maxLength": 2 }, { "name": "region", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York)

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "bankAccount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "BankTransfer", "description": "", "modelRef": "#/components/schemas/BankTransfer", "schema": [ { "name": "accountHolderFirstName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank account holder first name", "example": "John", "maxLength": 50 }, { "name": "accountHolderLastName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank account holder last name", "example": "Smith", "maxLength": 50 }, { "name": "achProcessingType", "kind": "optional", "type": "string", "nullable": true, "description": "Type of ACH processing used in the transaction", "example": "SAME_DAY_ACH", "maxLength": 50 }, { "name": "bankAccountIdentifier", "kind": "optional", "type": "string", "nullable": true, "description": "

Bank account unique identifier (IBAN or equivalent)

", "example": "TEST63TEST1212121212", "maxLength": 40 }, { "name": "bankAccountType", "kind": "optional", "type": "string", "nullable": true, "description": "

Type of bank account payment is made from (e.g. savings/checking, etc.)

", "example": "Savings", "maxLength": 50 }, { "name": "bankName", "kind": "optional", "type": "string", "nullable": true, "description": "Name of bank payment is made from", "example": "Citigroup", "maxLength": 50 }, { "name": "paymentGatewayData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentGatewayData", "description": "", "modelRef": "#/components/schemas/PaymentGatewayData", "schema": [ { "name": "gatewayName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment gateway name", "example": "Braintree", "maxLength": 50 }, { "name": "gatewayTransactionId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique transaction identifier (sent by gateway)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "paymentSuccessStatus", "kind": "optional", "type": "string", "nullable": true, "description": "Response text as received from the service provider", "example": "Payment Successful" }, { "name": "serviceName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment method name", "example": "Direct Debit", "maxLength": 30 } ] } ], "schema": [] }, { "name": "comments", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Comments", "description": "", "modelRef": "#/components/schemas/Comments", "schema": [ { "name": "merchantComments", "kind": "optional", "type": "string", "nullable": true, "description": "Comments by the merchant", "example": "Shipping delayed", "maxLength": 600 }, { "name": "messageToBeneficiary", "kind": "optional", "type": "string", "nullable": true, "description": "Comments the customer left to the beneficiary of the purchase made", "example": "Enjoy the gift John!", "maxLength": 600 }, { "name": "userCommentsToMerchant", "kind": "optional", "type": "string", "nullable": true, "description": "Comments the customer left to the merchant", "example": "Please wrap with care!!", "maxLength": 600 } ] } ], "schema": [] }, { "name": "cryptoWallet", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CryptoWallet", "description": "", "modelRef": "#/components/schemas/CryptoWallet", "schema": [ { "name": "cryptoWalletName", "kind": "optional", "type": "string", "nullable": true, "description": "Crypto wallet name", "example": "CryptoWallet", "maxLength": 30 }, { "name": "cryptoWalletPaymentId", "kind": "optional", "type": "string", "nullable": true, "description": "Crypto wallet payment ID", "example": "3JQiwG88SQvwihDAHg9M2EnqEisharz49c", "maxLength": 50 }, { "name": "cryptoWalletType", "kind": "required", "type": "string", "description": "

Crypto wallet type (Indicate whether wallet provider is internal to the site ecosystem)

", "example": "EXTERNAL", "enum": [ "INTERNAL", "EXTERNAL" ] } ] } ], "schema": [] }, { "name": "identityCard", "kind": "optional", "type": "string", "nullable": true, "description": "Recipient's identity card number" }, { "name": "loyaltyProgram", "kind": "optional", "type": "array", "nullable": true, "description": "Details regarding loyalty program customer entered to receive points for this order", "modelRef": "#/components/schemas/LoyaltyProgram", "customType": "LoyaltyProgram[]", "schema": [ { "name": "accountNumber", "kind": "optional", "type": "string", "nullable": true, "description": "

Customer's rewards/loyalty/frequent flyer account number

", "example": "VC1568OP", "maxLength": 100 }, { "name": "loyaltyPointsValue", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "programName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nName of program", "example": "StarAlliance", "maxLength": 100 }, { "name": "programPoints", "kind": "optional", "type": "number", "nullable": true, "description": "

Customer's rewards/loyalty/frequent flyer miles/point/stars

", "example": 0, "maxLength": 20 }, { "name": "tier", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nProgram tier name", "example": "Blue", "maxLength": 100 } ] }, { "name": "personalDetails", "kind": "required", "type": "object", "description": "

Personal information such as name, birthdate and email

", "modelRef": "#/components/schemas/PersonalDetails", "customType": "PersonalDetails", "schema": [ { "name": "birthdate", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Date of birth. Use YYYY-MM-DD format.

", "example": "1987-05-22", "format": "date" }, { "name": "email", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nEmail address", "example": "john_s@test.com", "maxLength": 256 }, { "name": "firstName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFirst name", "example": "John", "maxLength": 75 }, { "name": "fullName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFull name. Not Needed if firstName and LastName are provided independently.", "example": "John Smith", "maxLength": 150 }, { "name": "gender", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nGender", "example": "MALE", "enum": [ "MALE", "FEMALE", "CHOSE_NOT_TO_SPECIFY", "NONE" ] }, { "name": "lastName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nLast name", "example": "Smith", "maxLength": 75 } ] }, { "name": "phone", "kind": "optional", "type": "array", "conditional": true, "nullable": true, "description": "Conditional.\nPhone details", "modelRef": "#/components/schemas/Phone", "customType": "Phone[]", "schema": [ { "name": "phone", "kind": "required", "type": "string", "description": "Phone number including all country and local access codes", "example": "15557654321", "maxLength": 25 }, { "name": "smsVerified", "kind": "required", "type": "object", "description": "Phone verification details", "modelRef": "#/components/schemas/Verification", "customType": "Verification", "schema": [ { "name": "sent", "kind": "required", "type": "boolean", "description": "True if verification email was sent to email address or verification SMS was sent to phone number", "example": true }, { "name": "timeSent", "kind": "optional", "type": "number", "nullable": true, "description": "

Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1389567341 }, { "name": "verified", "kind": "required", "type": "boolean", "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)

", "example": false } ] } ] } ] } ], "schema": [] }, { "name": "totalAmount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] } ], "modelRef": "#/components/schemas/validationUpdateRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "basicAuth", "name": "basicAuth", "kind": "optional", "type": "http", "scheme": "basic" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Example validationResponse", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "The response object of a forter validations call", "customType": "validationResponse", "schema": [ { "name": "action", "kind": "required", "type": "string", "description": "The message containing the decision", "example": "approve", "maxLength": 1000 }, { "name": "message", "kind": "required", "type": "string", "description": "The message containing status response text", "example": "", "maxLength": 1000 }, { "name": "reasonCode", "kind": "required", "type": "string", "description": "", "example": "", "maxLength": 1000 }, { "name": "recommendations", "kind": "required", "type": "array", "description": "Forter's recommendations for the optimal way of proceeding with the order", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "status", "kind": "required", "type": "string", "description": "Status of the request processing", "example": "success", "maxLength": 50 }, { "name": "transaction", "kind": "required", "type": "string", "description": "

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

", "example": "123456", "maxLength": 100 } ], "modelRef": "#/components/schemas/validationResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "

Bad Request (Often missing a required parameter)

", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "

Unauthorized (No valid API key provided)

", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "

Not Found (The requested item doesn't exist)

", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "

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

", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "NDwl5aUFEPIABgbhULR33", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.forter-secure.com/v2/order-update/{id} \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'api-version: 10.3' \\\n --header 'x-forter-siteid: a1b2c3d4e5f6' \\\n --header 'authorization: Basic ' \\\n --data '{\n \"connectionInformation\": {\n \"customerIP\": \"10.0.0.127\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36\"\n },\n \"merchantFeedback\": {\n \"merchantCustomerSupport\": {\n \"contactEmailUsed\": {},\n \"contactMethodType\": \"PHONE\",\n \"contactNameUsed\": {\n \"customerContactNameType\": \"OTHER\"\n },\n \"contactPhoneUsed\": {},\n \"contactTime\": 1430997968,\n \"customerSupportChangeOrderDetails\": {},\n \"customerSupportFurtherVerification\": {\n \"customerAnsweredSecurityQuestions\": true,\n \"customerSupportAdditionalVerificationDocuments\": {\n \"documentType\": \"Passport\"\n }\n },\n \"initiatedBy\": \"CUSTOMER\"\n },\n \"merchantWouldLikeApproved\": {\n \"merchantContactedIssuer\": {},\n \"merchantDisagreesWithSpecificDeclineReason\": {\n \"atoIsIrrelevant\": {},\n \"chbkIsIrrelevant\": {}\n },\n \"merchantFoundBuyerExposure\": {\n \"customerSignedInUsingLegitSocialNetworkAccount\": {},\n \"merchantFoundBuyerEmailOnline\": {},\n \"merchantFoundBuyerPhoneNumberOnline\": {},\n \"merchantFoundConnectionBetweenIndividualsInTheOrder\": {\n \"dataSource\": {}\n },\n \"merchantFoundConnectionBetweenNameAndAddress\": {\n \"dataSource\": {}\n },\n \"merchantFoundRecipientEmailOnline\": {},\n \"merchantFoundRecipientPhoneNumberOnline\": {}\n },\n \"merchantPolicyDecisionNotApplicable\": {},\n \"merchantThinksOrderCharacteristicsAreLegit\": {\n \"goodCustomer\": {\n \"establishedAccount\": {\n \"establishedAccountDetails\": {},\n \"relatedAccountDetails\": {}\n },\n \"previousPointOfSalePurchase\": {}\n },\n \"lowRiskPaymentMethod\": {}\n }\n },\n \"merchantWouldLikeDeclined\": {\n \"fraudTypeSuspectedByMerchant\": {\n \"merchantSuspectsAccountTakeOver\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsBuyerSellerCollusion\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsFraudOther\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsFriendlyFraud\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsStolenPaymentMethod\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n }\n }\n }\n },\n \"orderId\": \"2356fdse0rr489\",\n \"primaryRecipient\": {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"bankAccount\": {\n \"paymentGatewayData\": {}\n },\n \"comments\": {},\n \"cryptoWallet\": {\n \"cryptoWalletType\": \"EXTERNAL\"\n },\n \"personalDetails\": {},\n \"phone\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ]\n },\n \"totalAmount\": {}\n }'" }, { "id": "JaxkgYgK7PJMXH8rx9eK3", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"api-version\", \"10.3\");\nmyHeaders.append(\"x-forter-siteid\", \"a1b2c3d4e5f6\");\nmyHeaders.append(\"authorization\", \"Basic \");\n\nvar raw = JSON.stringify({\n \"connectionInformation\": {\n \"customerIP\": \"10.0.0.127\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36\"\n },\n \"merchantFeedback\": {\n \"merchantCustomerSupport\": {\n \"contactEmailUsed\": {},\n \"contactMethodType\": \"PHONE\",\n \"contactNameUsed\": {\n \"customerContactNameType\": \"OTHER\"\n },\n \"contactPhoneUsed\": {},\n \"contactTime\": 1430997968,\n \"customerSupportChangeOrderDetails\": {},\n \"customerSupportFurtherVerification\": {\n \"customerAnsweredSecurityQuestions\": true,\n \"customerSupportAdditionalVerificationDocuments\": {\n \"documentType\": \"Passport\"\n }\n },\n \"initiatedBy\": \"CUSTOMER\"\n },\n \"merchantWouldLikeApproved\": {\n \"merchantContactedIssuer\": {},\n \"merchantDisagreesWithSpecificDeclineReason\": {\n \"atoIsIrrelevant\": {},\n \"chbkIsIrrelevant\": {}\n },\n \"merchantFoundBuyerExposure\": {\n \"customerSignedInUsingLegitSocialNetworkAccount\": {},\n \"merchantFoundBuyerEmailOnline\": {},\n \"merchantFoundBuyerPhoneNumberOnline\": {},\n \"merchantFoundConnectionBetweenIndividualsInTheOrder\": {\n \"dataSource\": {}\n },\n \"merchantFoundConnectionBetweenNameAndAddress\": {\n \"dataSource\": {}\n },\n \"merchantFoundRecipientEmailOnline\": {},\n \"merchantFoundRecipientPhoneNumberOnline\": {}\n },\n \"merchantPolicyDecisionNotApplicable\": {},\n \"merchantThinksOrderCharacteristicsAreLegit\": {\n \"goodCustomer\": {\n \"establishedAccount\": {\n \"establishedAccountDetails\": {},\n \"relatedAccountDetails\": {}\n },\n \"previousPointOfSalePurchase\": {}\n },\n \"lowRiskPaymentMethod\": {}\n }\n },\n \"merchantWouldLikeDeclined\": {\n \"fraudTypeSuspectedByMerchant\": {\n \"merchantSuspectsAccountTakeOver\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsBuyerSellerCollusion\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsFraudOther\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsFriendlyFraud\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsStolenPaymentMethod\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n }\n }\n }\n },\n \"orderId\": \"2356fdse0rr489\",\n \"primaryRecipient\": {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"bankAccount\": {\n \"paymentGatewayData\": {}\n },\n \"comments\": {},\n \"cryptoWallet\": {\n \"cryptoWalletType\": \"EXTERNAL\"\n },\n \"personalDetails\": {},\n \"phone\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ]\n },\n \"totalAmount\": {}\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.forter-secure.com/v2/order-update/{id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "oYQW-ND1Ynb1TSGjuuJ43", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.forter-secure.com/v2/order-update/{id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"api-version\"] = \"10.3\"\nrequest[\"x-forter-siteid\"] = \"a1b2c3d4e5f6\"\nrequest[\"authorization\"] = \"Basic \"\nrequest.body = JSON.dump({\n \"connectionInformation\": {\n \"customerIP\": \"10.0.0.127\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36\"\n },\n \"merchantFeedback\": {\n \"merchantCustomerSupport\": {\n \"contactEmailUsed\": {},\n \"contactMethodType\": \"PHONE\",\n \"contactNameUsed\": {\n \"customerContactNameType\": \"OTHER\"\n },\n \"contactPhoneUsed\": {},\n \"contactTime\": 1430997968,\n \"customerSupportChangeOrderDetails\": {},\n \"customerSupportFurtherVerification\": {\n \"customerAnsweredSecurityQuestions\": true,\n \"customerSupportAdditionalVerificationDocuments\": {\n \"documentType\": \"Passport\"\n }\n },\n \"initiatedBy\": \"CUSTOMER\"\n },\n \"merchantWouldLikeApproved\": {\n \"merchantContactedIssuer\": {},\n \"merchantDisagreesWithSpecificDeclineReason\": {\n \"atoIsIrrelevant\": {},\n \"chbkIsIrrelevant\": {}\n },\n \"merchantFoundBuyerExposure\": {\n \"customerSignedInUsingLegitSocialNetworkAccount\": {},\n \"merchantFoundBuyerEmailOnline\": {},\n \"merchantFoundBuyerPhoneNumberOnline\": {},\n \"merchantFoundConnectionBetweenIndividualsInTheOrder\": {\n \"dataSource\": {}\n },\n \"merchantFoundConnectionBetweenNameAndAddress\": {\n \"dataSource\": {}\n },\n \"merchantFoundRecipientEmailOnline\": {},\n \"merchantFoundRecipientPhoneNumberOnline\": {}\n },\n \"merchantPolicyDecisionNotApplicable\": {},\n \"merchantThinksOrderCharacteristicsAreLegit\": {\n \"goodCustomer\": {\n \"establishedAccount\": {\n \"establishedAccountDetails\": {},\n \"relatedAccountDetails\": {}\n },\n \"previousPointOfSalePurchase\": {}\n },\n \"lowRiskPaymentMethod\": {}\n }\n },\n \"merchantWouldLikeDeclined\": {\n \"fraudTypeSuspectedByMerchant\": {\n \"merchantSuspectsAccountTakeOver\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsBuyerSellerCollusion\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsFraudOther\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsFriendlyFraud\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsStolenPaymentMethod\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n }\n }\n }\n },\n \"orderId\": \"2356fdse0rr489\",\n \"primaryRecipient\": {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"bankAccount\": {\n \"paymentGatewayData\": {}\n },\n \"comments\": {},\n \"cryptoWallet\": {\n \"cryptoWalletType\": \"EXTERNAL\"\n },\n \"personalDetails\": {},\n \"phone\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ]\n },\n \"totalAmount\": {}\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "YI5Mpm6rpFzrqWWdIiesA", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.forter-secure.com/v2/order-update/{id}\"\n\npayload = json.dumps({\n \"connectionInformation\": {\n \"customerIP\": \"10.0.0.127\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36\"\n },\n \"merchantFeedback\": {\n \"merchantCustomerSupport\": {\n \"contactEmailUsed\": {},\n \"contactMethodType\": \"PHONE\",\n \"contactNameUsed\": {\n \"customerContactNameType\": \"OTHER\"\n },\n \"contactPhoneUsed\": {},\n \"contactTime\": 1430997968,\n \"customerSupportChangeOrderDetails\": {},\n \"customerSupportFurtherVerification\": {\n \"customerAnsweredSecurityQuestions\": True,\n \"customerSupportAdditionalVerificationDocuments\": {\n \"documentType\": \"Passport\"\n }\n },\n \"initiatedBy\": \"CUSTOMER\"\n },\n \"merchantWouldLikeApproved\": {\n \"merchantContactedIssuer\": {},\n \"merchantDisagreesWithSpecificDeclineReason\": {\n \"atoIsIrrelevant\": {},\n \"chbkIsIrrelevant\": {}\n },\n \"merchantFoundBuyerExposure\": {\n \"customerSignedInUsingLegitSocialNetworkAccount\": {},\n \"merchantFoundBuyerEmailOnline\": {},\n \"merchantFoundBuyerPhoneNumberOnline\": {},\n \"merchantFoundConnectionBetweenIndividualsInTheOrder\": {\n \"dataSource\": {}\n },\n \"merchantFoundConnectionBetweenNameAndAddress\": {\n \"dataSource\": {}\n },\n \"merchantFoundRecipientEmailOnline\": {},\n \"merchantFoundRecipientPhoneNumberOnline\": {}\n },\n \"merchantPolicyDecisionNotApplicable\": {},\n \"merchantThinksOrderCharacteristicsAreLegit\": {\n \"goodCustomer\": {\n \"establishedAccount\": {\n \"establishedAccountDetails\": {},\n \"relatedAccountDetails\": {}\n },\n \"previousPointOfSalePurchase\": {}\n },\n \"lowRiskPaymentMethod\": {}\n }\n },\n \"merchantWouldLikeDeclined\": {\n \"fraudTypeSuspectedByMerchant\": {\n \"merchantSuspectsAccountTakeOver\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsBuyerSellerCollusion\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsFraudOther\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsFriendlyFraud\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n },\n \"merchantSuspectsStolenPaymentMethod\": {\n \"merchantSuspectsAccountDetails\": {},\n \"merchantSuspectsOrderDetails\": {}\n }\n }\n }\n },\n \"orderId\": \"2356fdse0rr489\",\n \"primaryRecipient\": {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": True\n }\n },\n \"bankAccount\": {\n \"paymentGatewayData\": {}\n },\n \"comments\": {},\n \"cryptoWallet\": {\n \"cryptoWalletType\": \"EXTERNAL\"\n },\n \"personalDetails\": {},\n \"phone\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": True,\n \"verified\": False\n }\n }\n ]\n },\n \"totalAmount\": {}\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'api-version': '10.3',\n 'x-forter-siteid': 'a1b2c3d4e5f6',\n 'authorization': 'Basic '\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "NDwl5aUFEPIABgbhULR33" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Example validationResponse\n{\n \"action\": \"approve\",\n \"message\": \"\",\n \"reasonCode\": \"\",\n \"recommendations\": [\n \"\"\n ],\n \"status\": \"success\",\n \"transaction\": \"123456\"\n}" }, { "id": "response-1-400", "language": "400", "code": "// Bad Request (Often missing a required parameter)\n" }, { "id": "response-2-401", "language": "401", "code": "// Unauthorized (No valid API key provided)\n" }, { "id": "response-3-404", "language": "404", "code": "// Not Found (The requested item doesn't exist)\n" }, { "id": "response-4-500", "language": "500", "code": "// Server Error (Something went wrong on Forter's end)\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }