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

Send login attempt information to receive an account takeover decision. May also be used to determine whether to extend a user's idle session without prompting user for credentials. The response may also include recommendations for additional authentication (MFA) and a correlation ID to include with the authentication result.

", "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.

" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "

Send login attempt information to receive an account takeover decision. May also be used to determine whether to extend a user's idle session without prompting user for credentials. The response may also include recommendations for additional authentication (MFA) and a correlation ID to include with the authentication result.

", "customType": "accountLoginRequest", "schema": [ { "name": "accountData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AccountData", "description": "", "modelRef": "#/components/schemas/AccountData", "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": "addressesInAccount", "kind": "optional", "type": "array", "conditional": true, "nullable": true, "description": "Conditional.\n

All non-billing addresses saved in account. Billing information is included in paymentMethodsInAccount

", "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": "customerEngagement", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CustomerEngagement", "description": "", "modelRef": "#/components/schemas/CustomerEngagement", "schema": [ { "name": "aboutMe", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer added a short bio or about me to the profile", "example": false }, { "name": "communityPostsWritten", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ListProperties", "description": "", "modelRef": "#/components/schemas/ListProperties", "schema": [ { "name": "inUse", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.

", "example": true }, { "name": "itemInListCount", "kind": "optional", "type": "integer", "nullable": true, "description": "Number of items in the list", "example": 4 }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "creationTime", "kind": "required", "type": "number", "description": "

Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastModifiedTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastUsed", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448560456 }, { "name": "removalTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448895522 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "enableDeviceLocation", "kind": "optional", "type": "boolean", "nullable": true, "description": "Set to True if the user has allowed the app to track their location.", "example": false }, { "name": "extendedBioOrDescription", "kind": "optional", "type": "boolean", "nullable": true, "description": "

True if account owner added an extended info/bio/description paragraph to their profile

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

Number of followers of customer's account, or number of likes to user's profile

", "example": 105 }, { "name": "followingCount", "kind": "optional", "type": "integer", "nullable": true, "description": "

Number of other users the customer is following, or number of likes customer gave to other users' profiles

", "example": 230 }, { "name": "invites", "kind": "optional", "type": "array", "nullable": true, "description": "Invites to merchant's site customer sent and received", "modelRef": "#/components/schemas/Invite", "customType": "Invite[]", "schema": [ { "name": "invitationCounterpartyPhone", "kind": "optional", "type": "string", "nullable": true, "description": "

Invitation sender/recipient phone number

", "example": "+12126667777", "maxLength": 25 }, { "name": "sent", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\n

Time invite was sent in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1420955538 }, { "name": "type", "kind": "required", "type": "string", "description": "Type of invite", "example": "SENT", "enum": [ "SENT", "RECEIVED" ] } ] }, { "name": "likedItems", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ListProperties", "description": "", "modelRef": "#/components/schemas/ListProperties", "schema": [ { "name": "inUse", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.

", "example": true }, { "name": "itemInListCount", "kind": "optional", "type": "integer", "nullable": true, "description": "Number of items in the list", "example": 4 }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "creationTime", "kind": "required", "type": "number", "description": "

Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastModifiedTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastUsed", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448560456 }, { "name": "removalTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448895522 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "messagesReceived", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ListProperties", "description": "", "modelRef": "#/components/schemas/ListProperties", "schema": [ { "name": "inUse", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.

", "example": true }, { "name": "itemInListCount", "kind": "optional", "type": "integer", "nullable": true, "description": "Number of items in the list", "example": 4 }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "creationTime", "kind": "required", "type": "number", "description": "

Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastModifiedTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastUsed", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448560456 }, { "name": "removalTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448895522 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "messagesSent", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ListProperties", "description": "", "modelRef": "#/components/schemas/ListProperties", "schema": [ { "name": "inUse", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.

", "example": true }, { "name": "itemInListCount", "kind": "optional", "type": "integer", "nullable": true, "description": "Number of items in the list", "example": 4 }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "creationTime", "kind": "required", "type": "number", "description": "

Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastModifiedTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastUsed", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448560456 }, { "name": "removalTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448895522 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "newsletters", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ListProperties", "description": "", "modelRef": "#/components/schemas/ListProperties", "schema": [ { "name": "inUse", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.

", "example": true }, { "name": "itemInListCount", "kind": "optional", "type": "integer", "nullable": true, "description": "Number of items in the list", "example": 4 }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "creationTime", "kind": "required", "type": "number", "description": "

Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastModifiedTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastUsed", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448560456 }, { "name": "removalTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)

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

True if account owner added a non-default logo to their account

", "example": false }, { "name": "profilePicture", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer added a profile picture", "example": true }, { "name": "requestedDemo", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if account owner requested to schedule a walthrough or demo of the site", "example": true }, { "name": "reviewsWritten", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ListProperties", "description": "", "modelRef": "#/components/schemas/ListProperties", "schema": [ { "name": "inUse", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.

", "example": true }, { "name": "itemInListCount", "kind": "optional", "type": "integer", "nullable": true, "description": "Number of items in the list", "example": 4 }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "creationTime", "kind": "required", "type": "number", "description": "

Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastModifiedTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastUsed", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448560456 }, { "name": "removalTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448895522 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "savedLocations", "kind": "optional", "type": "array", "nullable": true, "description": "Saved locations in account.", "modelRef": "#/components/schemas/ExactLocation", "customType": "ExactLocation[]", "schema": [ { "name": "latitude", "kind": "required", "type": "number", "description": "

Latitude in Decimal Degrees (WGS84)

", "example": 32.07332 }, { "name": "longitude", "kind": "required", "type": "number", "description": "

Longitude in Decimal Degrees (WGS84)

", "example": 34.79675 }, { "name": "source", "kind": "required", "type": "string", "description": "Source of location data", "example": "MOBILE", "maxLength": 50 } ] }, { "name": "sharedItems", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ListProperties", "description": "", "modelRef": "#/components/schemas/ListProperties", "schema": [ { "name": "inUse", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.

", "example": true }, { "name": "itemInListCount", "kind": "optional", "type": "integer", "nullable": true, "description": "Number of items in the list", "example": 4 }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "creationTime", "kind": "required", "type": "number", "description": "

Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastModifiedTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastUsed", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448560456 }, { "name": "removalTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448895522 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "signedUpForPushNotifications", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer asked to receive push notifications from the merchant.", "example": true }, { "name": "signedUpForSMSUpdates", "kind": "optional", "type": "boolean", "nullable": true, "description": "

True if customer asked to receive SMS updates from the merchant regarding discounts, promotions, etc.

", "example": true }, { "name": "wishlist", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ListProperties", "description": "", "modelRef": "#/components/schemas/ListProperties", "schema": [ { "name": "inUse", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.

", "example": true }, { "name": "itemInListCount", "kind": "optional", "type": "integer", "nullable": true, "description": "Number of items in the list", "example": 4 }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "creationTime", "kind": "required", "type": "number", "description": "

Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastModifiedTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448549922 }, { "name": "lastUsed", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448560456 }, { "name": "removalTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1448895522 } ] } ], "schema": [] } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "emailsInAccount", "kind": "optional", "type": "array", "nullable": true, "description": "All email addresses saved in account", "modelRef": "#/components/schemas/Email", "customType": "Email[]", "schema": [ { "name": "email", "kind": "required", "type": "string", "description": "Email address", "example": "john_s@test.com", "maxLength": 256 }, { "name": "emailVerification", "kind": "required", "type": "object", "description": "

True if customer received email verification message to this address and clicked-through back to merchant's site

", "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 } ] } ] }, { "name": "paymentMethodsInAccount", "kind": "optional", "type": "array", "conditional": true, "nullable": true, "description": "Conditional.\nAll payment methods saved in account", "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": "", "description": "", "customType": "Max depth limit reached" } ] } ], "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": "", "description": "", "customType": "Max depth limit reached" } ] } ], "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": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "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": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "threeDSecure", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureInput", "description": "", "modelRef": "#/components/schemas/ThreeDSecureInput", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "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": "", "description": "", "customType": "Max depth limit reached" } ] } ], "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": "phonesInAccount", "kind": "optional", "type": "array", "conditional": true, "nullable": true, "description": "Conditional.\nAll phone numbers saved in account", "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 } ] } ] }, { "name": "ratingAsBuyer", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Rating", "description": "", "modelRef": "#/components/schemas/Rating", "schema": [ { "name": "score", "kind": "required", "type": "string", "description": "

Rating score (numeric - 97 or textual - 'Excellent')

", "example": "4.5", "maxLength": 25 }, { "name": "source", "kind": "required", "type": "string", "description": "

Source of rating, for example tripAdvisor, yelp, etc.

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

Rating type. Internal if rating was generated within the merchant's site or community, otherwise external.

", "example": "INTERNAL_PEERS", "enum": [ "INTERNAL_PEERS", "INTERNAL_MERCHANT", "EXTERNAL_PEERS", "EXTERNAL_INDEPENDENT" ] } ] } ], "schema": [] }, { "name": "registrationIP", "kind": "optional", "type": "string", "nullable": true, "description": "IP address used by the account owner at the time of registration.", "example": "203.12.55.12" }, { "name": "type", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Account type (a business account, a private account, a merchant-operated account)

", "example": "BUSINESS", "enum": [ "GUEST", "PRIVATE", "BUSINESS", "VIP", "MERCHANT_OPERATED", "TRIAL", "MERCHANT_EMPLOYEE", "PREMIUM_PAID", "SMALL_BUSINESS", "AGENT", "BUSINESS_PRIVATE", "BUSINESS_PREMIUM_PAID" ] } ] } ], "schema": [] }, { "name": "accountId", "kind": "required", "type": "string", "description": "Customer's account UID in merchant's site. Should not be the user email.", "example": "e520-ba9a-367-60b", "maxLength": 50 }, { "name": "additionalAuthenticationMethod", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AdvancedAuthenticationMethod", "description": "", "modelRef": "#/components/schemas/AdvancedAuthenticationMethod", "schema": [ { "name": "correlationId", "kind": "required", "type": "string", "description": "A forter unique identifier that was provided as part of a Forter API response recommending additional authentication measures. Used to correlate between the user action which triggered the recommendation and the authentication attempt result. Required when the additional authentication was triggered by Forter's recommendation.", "example": "HGJ7512345H3DE" }, { "name": "documentVerification", "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": "emailVerification", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Email", "description": "", "modelRef": "#/components/schemas/Email", "schema": [ { "name": "email", "kind": "required", "type": "string", "description": "Email address", "example": "john_s@test.com", "maxLength": 256 }, { "name": "emailVerification", "kind": "required", "type": "object", "description": "

True if customer received email verification message to this address and clicked-through back to merchant's site

", "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": "oneTimePasswordVerification", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SimplifiedVerification", "description": "", "modelRef": "#/components/schemas/SimplifiedVerification", "schema": [ { "name": "timeVerified", "kind": "optional", "type": "number", "nullable": true, "description": "

Date user was verified in seconds since unix epoch(UTC, Jan 1, 1970)

", "example": 1388560227 }, { "name": "verificationMethod", "kind": "required", "type": "string", "description": "Type of one time verification method", "example": "Google Authenticator", "maxLength": 50 }, { "name": "verified", "kind": "required", "type": "boolean", "description": "Was the user verified via the chosen verification method", "example": false } ] } ], "schema": [] }, { "name": "paymentInstrumentVerification", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentInstrumentVerification", "description": "", "modelRef": "#/components/schemas/PaymentInstrumentVerification", "schema": [ { "name": "cameraCaptured", "kind": "optional", "type": "boolean", "nullable": true, "description": "The user successfully took a photo of their credit card using an OCR feature of the mobile app", "example": false }, { "name": "creditCardManuallyTypedIn", "kind": "optional", "type": "boolean", "nullable": true, "description": "The user successfully typed in the full number of the credit card that was saved in the account", "example": false }, { "name": "cvvManuallyTypedIn", "kind": "optional", "type": "boolean", "nullable": true, "description": "The user successfully typed in the CVV of the credit card that was saved in the account", "example": false }, { "name": "lastFourDigits", "kind": "optional", "type": "string", "nullable": true, "description": "Last 4 digits of the credit card that was verified", "example": "4242", "maxLength": 4, "pattern": "[0-9]{4}" }, { "name": "token", "kind": "optional", "type": "string", "nullable": true, "description": "Token of the credit card that was verified", "example": "tkn-77620C360132856A103477D2959967AB", "maxLength": 200 } ] } ], "schema": [] }, { "name": "phoneVerification", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Phone", "description": "", "modelRef": "#/components/schemas/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": "verificationOutcome", "kind": "required", "type": "string", "description": "Outcome of verification attempt", "example": "SUCCESS", "enum": [ "SUCCESS", "FAILURE", "NONE_ATTEMPTED" ] } ] } ], "schema": [] }, { "name": "channelType", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThe source channel through which the customer conducted the login. Note that some of the enum values are not relevant for this interaction.", "example": "WEB", "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": "connectionInformation", "kind": "required", "type": "object", "description": "Connection information about the customer typically found in the HTTP request header.", "modelRef": "#/components/schemas/ConnectionInformation", "customType": "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 } ] }, { "name": "eventTime", "kind": "required", "type": "number", "description": "

The time that the trigger event occurred in MILLISECONDS since unix epoch (Jan 1, 1970)

", "example": 1415287568000 }, { "name": "loginMethodType", "kind": "required", "type": "string", "description": "The authentication method used to login", "example": "PASSWORD", "enum": [ "PASSWORD", "SMS", "SOCIAL", "EMAIL_LINK_OTP", "AUTH_TOKEN_REFRESH", "APPLE", "MFA_CODE_REFRESH", "EMAIL_MAGIC_LINK", "PASSKEY", "QR", "OTHER" ] }, { "name": "loginStatus", "kind": "required", "type": "string", "description": "The status of the Login attempt", "example": "SUCCESS", "enum": [ "SUCCESS", "FAILED", "BLOCKED_BY_MERCHANT", "ACCOUNT_DOES_NOT_EXIST" ] }, { "name": "merchantIdentifiers", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantIdentifiers", "description": "", "modelRef": "#/components/schemas/MerchantIdentifiers", "schema": [ { "name": "merchantDomain", "kind": "optional", "type": "string", "nullable": true, "description": "

Use if merchant operates several sites (such as a regular site and a related discount brand)

", "example": "HandbagsExpressDiscounts.com", "maxLength": 2048 }, { "name": "merchantName", "kind": "optional", "type": "string", "nullable": true, "description": "

Use if merchant operates several sites (such as a regular site and a related discount brand)

", "example": "Handbags Express Discounts", "maxLength": 50 } ] } ], "schema": [] }, { "name": "userInput", "kind": "required", "type": "object", "description": "Input details submitted by the user. Required in case Forter does not have a full list of merchant account details", "modelRef": "#/components/schemas/UserLoginInput", "customType": "UserLoginInput", "schema": [ { "name": "additionalInformation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "customerSignedInUsingSocialNetworkAccount", "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": "email", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nEmail address. Required when the input type is EMAIL.", "example": "john_s@test.com", "maxLength": 75 }, { "name": "inputType", "kind": "required", "type": "string", "description": "The type of identifier used by the user to login", "example": "EMAIL", "enum": [ "USERNAME", "EMAIL", "PHONE", "SOCIAL" ] }, { "name": "phone", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPhone number including all country and local access codes. Required when the input type is PHONE.", "example": "15557654321", "maxLength": 25 } ] } ], "modelRef": "#/components/schemas/accountLoginRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "basicAuth", "name": "basicAuth", "kind": "optional", "type": "http", "scheme": "basic" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Example adaptiveAuthAccountsResponse", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Response structure for adaptive auth account requests", "customType": "adaptiveAuthAccountsResponse", "schema": [ { "name": "accountId", "kind": "required", "type": "string", "description": "

When applicable, the customer's account UID in merchant's site

", "example": "e520-ba9a-367-60b" }, { "name": "correlationId", "kind": "required", "type": "string", "description": "A forter unique identifier that should be sent to Forter as part of the AdvancedAuthenticationMethod object to correlate the MFA recommendation given in this response with the relevant additional authentication attempt result", "example": "HGJ7512345H3DE" }, { "name": "decisionReason", "kind": "required", "type": "string", "description": "The main reason behind the Forter decision", "example": "", "maxLength": 1000 }, { "name": "forterDecision", "kind": "required", "type": "string", "description": "The latest Forter decision regarding the attempted action", "enum": [ "APPROVE", "DECLINE", "VERIFICATION_REQUIRED", "NOT_REVIEWED" ] }, { "name": "merchantPolicyId", "kind": "required", "type": "string", "description": "UID of the custom policy created in Forter's Policies tool that resulted in this decision", "example": "0ee8ba28a8654c659addbae9253b707c" }, { "name": "recommendation", "kind": "required", "type": "string", "description": "

A specific recommendation for an action that might help the customer to complete their transaction/action (e.g. verify phone via SMS, verify via push notification, verify email, perform a 3DS check, etc.)

", "example": "", "maxLength": 1000 }, { "name": "verificationMethod", "kind": "required", "type": "object", "description": "The specific verification method to be used when verification is required according to \"recommendation\" field", "modelRef": "#/components/schemas/VerificationMethod", "customType": "VerificationMethod", "schema": [ { "name": "correlationId", "kind": "required", "type": "string", "description": "A forter unique identifier that was provided as part of a Forter API response recommending additional authentication measures. Used to correlate between the user action which triggered the recommendation and the authentication attempt result. Required when the additional authentication was triggered by Forter's recommendation.", "example": "HGJ7512345H3DE" }, { "name": "status", "kind": "required", "type": "string", "description": "Verification status", "example": "FRICTIONLESS", "maxLength": 50 }, { "name": "statusCode", "kind": "required", "type": "string", "description": "Verification status code", "example": "100", "maxLength": 50 }, { "name": "statusMessage", "kind": "required", "type": "string", "description": "Text describes the verification status", "example": "Verification code sent", "maxLength": 50 }, { "name": "type", "kind": "required", "type": "string", "description": "Verification method type", "example": "THREE_DS", "enum": [ "OTP_SMS", "OTP_EMAIL", "THREE_DS" ], "maxLength": 50 }, { "name": "verificationId", "kind": "required", "type": "string", "description": "A unique identifier assigned to that specific verification", "example": "345H3DEHGJ7512" }, { "name": "verificationSpecificData", "kind": "required", "type": "object", "description": "Data specific to the verification type performed", "modelRef": "#/components/schemas/VerificationData", "customType": "VerificationData", "schema": [ { "name": "ThreeDS", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureResponse", "description": "", "modelRef": "#/components/schemas/ThreeDSecureResponse", "schema": [ { "name": "ACSUrl", "kind": "required", "type": "string", "description": "

In case of challange, this url is needed to be passed to client side and trigger ftr__.init3DS function

", "example": "https:/ /acs-us-east-1.nd.nds-sandbox-issuer.com/api/v1/acs/browser_sdk_challenges", "maxLength": 2048 }, { "name": "ECIValue", "kind": "required", "type": "string", "description": "

Electronic Commerce Indicator (ECI) is a value that is returned from the Directory Server (Visa, MasterCard, etc) to indicate the authentication results of your customer's credit card payment on 3D Secure. ECI only available when the challenge is not needed or after challenge had been completed. Possible values: 00, 01, 02, 04, 05, 06, 07

", "example": "02", "maxLength": 300 }, { "name": "acsChallengeMandated", "kind": "required", "type": "string", "description": "

Indication of whether a challenge is required for the transaction to be authorised due to local/regional mandates or other variable (Y - Challenge is mandated, N - Challenge is not mandated)

", "example": "Y", "maxLength": 1 }, { "name": "acsReferenceNumber", "kind": "required", "type": "string", "description": "

Unique identifier assigned by the EMVCo Secretariat = required for mobile app implementation

", "example": "ftr-internal-acs-approval", "maxLength": 32 }, { "name": "acsSignedContent", "kind": "required", "type": "string", "description": "ACS Signed Content required for mobile app implementation", "example": "", "maxLength": 1000 }, { "name": "acsTransID", "kind": "required", "type": "string", "description": "

Universally Unique transaction identifier assigned by the ACS to identify a single transaction - required for mobile app implementation

", "example": "6fd30e89-8171-4cc3-b86e-3d59582af2f6", "maxLength": 36 }, { "name": "authenticationType", "kind": "required", "type": "string", "description": "

Optional authentication type (01 - Static, 02 - Dynamic, 03 - OOB, 04 - Decoupled)

", "example": "01", "maxLength": 2 }, { "name": "authenticationValue", "kind": "required", "type": "string", "description": "

3DS Authentication value (AV) should be sent to the payment gateway in the authorization call

", "example": "tSvPDt3PINNaoL+ERXdg0jVrmWc=", "maxLength": 28 }, { "name": "bankLiabilityShift", "kind": "required", "type": "boolean", "description": "Indicates whether transaction is supposed to get liability shift from issuer", "example": true, "maxLength": 1 }, { "name": "cardEnrolled", "kind": "required", "type": "string", "description": "

3DS transaction card Enrolled status - should be sent to the payment gateway in the authorization call in some payment gateways

", "example": "Y", "maxLength": 1 }, { "name": "cavvAlgorithm", "kind": "required", "type": "string", "description": "

3DS Authentication value algorithm - should be sent to the payment gateway in the authorization call in some payment gateways. Possible values (3DS1 only): 0, 1, 2, 3, 4, 7

", "example": "3", "maxLength": 1 }, { "name": "challengeCancel", "kind": "required", "type": "string", "description": "

Indicator informing the ACS and the DS that the authentication has been canceled. Possible values: 01-99

", "example": "01", "maxLength": 2 }, { "name": "challengeStatus", "kind": "required", "type": "string", "description": "

Ares transStatus value (Possible values: U, N, Y, A, C, D, R, I)

", "example": "Y", "maxLength": 1 }, { "name": "dsTransID", "kind": "required", "type": "string", "description": "Universally unique transaction identifier assigned by the DS to identify a single transaction", "example": "38bbf46f-c023-4f4c-ae2c-35fb301632a5", "maxLength": 100 }, { "name": "encodedChallengeRequest", "kind": "required", "type": "string", "description": "

This value will only be available when challenge is needed, in the challenge flow - this must be passed to browser in order to trigger the challenge

", "example": "eyJhY3NUcmFuc0lEIjoiMTEyY2RiNWItMGFlYy00MTY5LThjMWYtYWMyN2JlNjAxMjhhIiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA0IiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsIm1lc3NhZ2VUeXBlIjoiQ1JlcSIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiZWRhM2MwMzYtZWMyYS00NmZkLTlmYWItNzBlZTgyYjJjNzQ5In0=" }, { "name": "exemption", "kind": "optional", "type": "string", "nullable": true, "description": "Exemption that should be used during the authorization process", "example": "TRANSACTION_RISK_ANALYSIS", "enum": [ "LOW_VALUE", "TRANSACTION_RISK_ANALYSIS", "SECURE_CORPORATE", "TRUSTED_BENEFICIARY" ] }, { "name": "interactionCounter", "kind": "required", "type": "string", "description": "Indicates the number of authentication cycles attempted by the Cardholder", "example": "01", "maxLength": 2 }, { "name": "isFallback", "kind": "required", "type": "boolean", "description": "Indication of whether a 3DS1 challenge was performed as a fallback to 3DS2 error", "example": false, "maxLength": 5 }, { "name": "messageCategory", "kind": "required", "type": "string", "description": "

Identifies the category of the message for a specific use case (01 - PA, 02 - NPA)

", "example": "01", "maxLength": 2 }, { "name": "outOfScopeForPSD2", "kind": "optional", "type": "string", "nullable": true, "description": "This field indicate if transaction is out of scope for PSD2 and exclusion should be requested", "example": "ANONYMOUS_PREPAID_CARD", "enum": [ "ANONYMOUS_PREPAID_CARD", "MERCHANT_INITIATED_TRANSACTIONS", "ONE_LEG_OUT_EEA", "MAIL_ORDER_TELEPHONE_ORDER" ] }, { "name": "threeDSServerTransID", "kind": "required", "type": "string", "description": "

Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction (in 3DS1 equal to XID)

", "example": "26d648a9-da8a-4f8b-a76d-094801d2fd45", "maxLength": 100 }, { "name": "threeDSecureMode", "kind": "required", "type": "string", "description": "

Indicate if the transaction is Frictionless or SCA. Being used by some payment gateways. Possible values: sca, frictionless

", "example": "sca", "maxLength": 15 }, { "name": "threeDSecurePreference", "kind": "required", "type": "string", "description": "

The challenge indicator used. Being used by some payment gateways. Possible values: nopref, frictionless, sca, scamandate

", "example": "nopref", "maxLength": 15 }, { "name": "threeDSecureResult", "kind": "required", "type": "string", "description": "This field is relevant for 3DS1 and being used by some payment gateways", "example": "590040", "maxLength": 6 }, { "name": "transStatus", "kind": "required", "type": "string", "description": "

3DS transStatus value - Indicates whether a transaction qualifies as an authenticated transaction or account verification. should be sent to the payment gateway in the authorization call (Possible values: U, N, Y, A, C, D, R, I)

", "example": "Y", "maxLength": 1 }, { "name": "transStatusReason", "kind": "required", "type": "string", "description": "

Provides information on why the Transaction Status field has the specified value. Possible values: 01-99

", "example": "01", "maxLength": 2 }, { "name": "verifyStatus", "kind": "required", "type": "string", "description": "

Cres transStatus value (Possible values: U, N, Y, A, C, D, R, I, null)

", "example": "Y", "maxLength": 1 }, { "name": "version", "kind": "required", "type": "string", "description": "

Version. Possible values: 1.0.2, 2.1.0, 2.2.0

", "example": "2.1.0", "maxLength": 50 } ] } ], "schema": [] }, { "name": "email", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Email", "description": "", "modelRef": "#/components/schemas/Email", "schema": [ { "name": "email", "kind": "required", "type": "string", "description": "Email address", "example": "john_s@test.com", "maxLength": 256 }, { "name": "emailVerification", "kind": "required", "type": "object", "description": "

True if customer received email verification message to this address and clicked-through back to merchant's site

", "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": "phone", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Phone", "description": "", "modelRef": "#/components/schemas/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": [] } ] } ] } ], "modelRef": "#/components/schemas/adaptiveAuthAccountsResponse", "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": "ySbBD6jEgPIbngdZ1JPKO", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.forter-secure.com/v2/accounts/login/{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 --data-raw '{\n \"accountData\": {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"addressesInAccount\": [\n {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n }\n ],\n \"customerEngagement\": {\n \"communityPostsWritten\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"invites\": [\n {\n \"type\": \"SENT\"\n }\n ],\n \"likedItems\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"messagesReceived\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"messagesSent\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"newsletters\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"reviewsWritten\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"savedLocations\": [\n {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n }\n ],\n \"sharedItems\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"wishlist\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n }\n },\n \"emailsInAccount\": [\n {\n \"email\": \"john_s@test.com\",\n \"emailVerification\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ],\n \"phonesInAccount\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ],\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n }\n },\n \"accountId\": \"e520-ba9a-367-60b\",\n \"additionalAuthenticationMethod\": {\n \"correlationId\": \"HGJ7512345H3DE\",\n \"documentVerification\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"emailVerification\": {\n \"email\": \"john_s@test.com\",\n \"emailVerification\": {\n \"sent\": true,\n \"verified\": false\n }\n },\n \"oneTimePasswordVerification\": {\n \"verificationMethod\": \"Google Authenticator\",\n \"verified\": false\n },\n \"paymentInstrumentVerification\": {},\n \"phoneVerification\": {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n },\n \"verificationOutcome\": \"SUCCESS\"\n },\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 \"eventTime\": 1415287568000,\n \"loginMethodType\": \"PASSWORD\",\n \"loginStatus\": \"SUCCESS\",\n \"merchantIdentifiers\": {},\n \"userInput\": {\n \"additionalInformation\": {},\n \"customerSignedInUsingSocialNetworkAccount\": {},\n \"inputType\": \"EMAIL\"\n }\n }'" }, { "id": "1KfJDJC0pscrMJt9q8yti", "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\");\n\nvar raw = JSON.stringify({\n \"accountData\": {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"addressesInAccount\": [\n {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n }\n ],\n \"customerEngagement\": {\n \"communityPostsWritten\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"invites\": [\n {\n \"type\": \"SENT\"\n }\n ],\n \"likedItems\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"messagesReceived\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"messagesSent\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"newsletters\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"reviewsWritten\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"savedLocations\": [\n {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n }\n ],\n \"sharedItems\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"wishlist\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n }\n },\n \"emailsInAccount\": [\n {\n \"email\": \"john_s@test.com\",\n \"emailVerification\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ],\n \"phonesInAccount\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ],\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n }\n },\n \"accountId\": \"e520-ba9a-367-60b\",\n \"additionalAuthenticationMethod\": {\n \"correlationId\": \"HGJ7512345H3DE\",\n \"documentVerification\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"emailVerification\": {\n \"email\": \"john_s@test.com\",\n \"emailVerification\": {\n \"sent\": true,\n \"verified\": false\n }\n },\n \"oneTimePasswordVerification\": {\n \"verificationMethod\": \"Google Authenticator\",\n \"verified\": false\n },\n \"paymentInstrumentVerification\": {},\n \"phoneVerification\": {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n },\n \"verificationOutcome\": \"SUCCESS\"\n },\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 \"eventTime\": 1415287568000,\n \"loginMethodType\": \"PASSWORD\",\n \"loginStatus\": \"SUCCESS\",\n \"merchantIdentifiers\": {},\n \"userInput\": {\n \"additionalInformation\": {},\n \"customerSignedInUsingSocialNetworkAccount\": {},\n \"inputType\": \"EMAIL\"\n }\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/accounts/login/{id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "aTczTUQZjyakE6WgBmrln", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.forter-secure.com/v2/accounts/login/{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.body = JSON.dump({\n \"accountData\": {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"addressesInAccount\": [\n {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n }\n ],\n \"customerEngagement\": {\n \"communityPostsWritten\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"invites\": [\n {\n \"type\": \"SENT\"\n }\n ],\n \"likedItems\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"messagesReceived\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"messagesSent\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"newsletters\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"reviewsWritten\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"savedLocations\": [\n {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n }\n ],\n \"sharedItems\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"wishlist\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n }\n },\n \"emailsInAccount\": [\n {\n \"email\": \"john_s@test.com\",\n \"emailVerification\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ],\n \"phonesInAccount\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ],\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n }\n },\n \"accountId\": \"e520-ba9a-367-60b\",\n \"additionalAuthenticationMethod\": {\n \"correlationId\": \"HGJ7512345H3DE\",\n \"documentVerification\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"emailVerification\": {\n \"email\": \"john_s@test.com\",\n \"emailVerification\": {\n \"sent\": true,\n \"verified\": false\n }\n },\n \"oneTimePasswordVerification\": {\n \"verificationMethod\": \"Google Authenticator\",\n \"verified\": false\n },\n \"paymentInstrumentVerification\": {},\n \"phoneVerification\": {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n },\n \"verificationOutcome\": \"SUCCESS\"\n },\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 \"eventTime\": 1415287568000,\n \"loginMethodType\": \"PASSWORD\",\n \"loginStatus\": \"SUCCESS\",\n \"merchantIdentifiers\": {},\n \"userInput\": {\n \"additionalInformation\": {},\n \"customerSignedInUsingSocialNetworkAccount\": {},\n \"inputType\": \"EMAIL\"\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "06hmhtSOhGZKKKtJiXeew", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.forter-secure.com/v2/accounts/login/{id}\"\n\npayload = json.dumps({\n \"accountData\": {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"addressesInAccount\": [\n {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": True\n }\n }\n ],\n \"customerEngagement\": {\n \"communityPostsWritten\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"invites\": [\n {\n \"type\": \"SENT\"\n }\n ],\n \"likedItems\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"messagesReceived\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"messagesSent\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"newsletters\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"reviewsWritten\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"savedLocations\": [\n {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n }\n ],\n \"sharedItems\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"wishlist\": {\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n }\n },\n \"emailsInAccount\": [\n {\n \"email\": \"john_s@test.com\",\n \"emailVerification\": {\n \"sent\": True,\n \"verified\": False\n }\n }\n ],\n \"phonesInAccount\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": True,\n \"verified\": False\n }\n }\n ],\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n }\n },\n \"accountId\": \"e520-ba9a-367-60b\",\n \"additionalAuthenticationMethod\": {\n \"correlationId\": \"HGJ7512345H3DE\",\n \"documentVerification\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"emailVerification\": {\n \"email\": \"john_s@test.com\",\n \"emailVerification\": {\n \"sent\": True,\n \"verified\": False\n }\n },\n \"oneTimePasswordVerification\": {\n \"verificationMethod\": \"Google Authenticator\",\n \"verified\": False\n },\n \"paymentInstrumentVerification\": {},\n \"phoneVerification\": {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": True,\n \"verified\": False\n }\n },\n \"verificationOutcome\": \"SUCCESS\"\n },\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 \"eventTime\": 1415287568000,\n \"loginMethodType\": \"PASSWORD\",\n \"loginStatus\": \"SUCCESS\",\n \"merchantIdentifiers\": {},\n \"userInput\": {\n \"additionalInformation\": {},\n \"customerSignedInUsingSocialNetworkAccount\": {},\n \"inputType\": \"EMAIL\"\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'api-version': '10.3',\n 'x-forter-siteid': 'a1b2c3d4e5f6'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "ySbBD6jEgPIbngdZ1JPKO" }, "results": { "languages": [ { "id": "vgnIzQpSqr3_Lta0qQgMg", "language": "200", "code": "// Example adaptiveAuthAccountsResponse\n{\n \"accountId\": \"e520-ba9a-367-60b\",\n \"correlationId\": \"HGJ7512345H3DE\",\n \"decisionReason\": \"\",\n \"forterDecision\": \"\",\n \"merchantPolicyId\": \"0ee8ba28a8654c659addbae9253b707c\",\n \"recommendation\": \"\",\n \"verificationMethod\": {\n \"correlationId\": \"HGJ7512345H3DE\",\n \"status\": \"FRICTIONLESS\",\n \"statusCode\": \"100\",\n \"statusMessage\": \"Verification code sent\",\n \"type\": \"THREE_DS\",\n \"verificationId\": \"345H3DEHGJ7512\",\n \"verificationSpecificData\": {\n \"ThreeDS\": {},\n \"email\": {},\n \"phone\": {}\n }\n }\n}" }, { "id": "4B06tAPuZSNz463imfYSm", "language": "400", "code": "// Bad Request (Often missing a required parameter)\n" }, { "id": "G3MbuzIbrFFIanul-5Mda", "language": "401", "code": "// Unauthorized (No valid API key provided)\n" }, { "id": "28zzY2U0SU6ZUiUaECia0", "language": "404", "code": "// Not Found (The requested item doesn't exist)\n" }, { "id": "XE3ycafEQ0Ssx3K2VqHZB", "language": "500", "code": "// Server Error (Something went wrong on Forter's end)\n" } ], "selectedLanguageId": "vgnIzQpSqr3_Lta0qQgMg" } }, "children": [ { "text": "" } ] }