--- title: "Order status" method: POST path: "/v2/status/{id}" tags: ["Orders"] --- # Order status `POST /v2/status/{id}` Inform of updates to the status of an order, including payment authorization, fulfillment, shipping details, and compensation granted. For pre-authorization flows, use this endpoint to supply Forter with authorization results from your payment processor. While no decision is provided on this request, it is a required input that improves the decision model. ## Path parameters - `id` string, required ## Headers - `api-version` string, required - `x-forter-siteid` string, required - `Authorization` string, required ## Request body - StatusRequest — Inform of updates to the status of an order, including payment authorization, fulfillment, shipping details, and compensation granted. For pre-authorization flows, use this endpoint to supply Forter with authorization results from your payment processor. While no decision is provided on this request, it is a required input that improves the decision model. - `additionalInformation` object, nullable — General payload object - `additionalOrderId` string, nullable — Additional order/transaction identifier. Used primarily for IDs received after processing the order, such as settlement ID, capture ID, or any other type of ID that may help relate an order to financial data. - `cartItems` Item[], nullable — An updated list of all items purchased and shipping details. Required only if one or more items have changed. - `basicItemData` BasicItemData, required — This is an item associated with the customer or transaction. - `category` string, nullable — Item category - `discount` object, nullable — This provides information relating to any kind of offer, coupon or other discount used by the customer. - `couponCodeUsed` string, required — Coupon code used - `couponDiscountAmount` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `couponDiscountPercent` string, nullable — Coupon discount amount - `name` string, required — Item name - `price` Amount, required — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `productId` string, nullable — Unique identifier for item that is common to all identical items (such as SKU, ISBN, etc.) - `quantity` number, required — Item quantity - `type` 'TANGIBLE' | 'NON_TANGIBLE', required — Tangible if physical item, non-tangible if any other product - `beneficiaries` Beneficiary[], nullable — List of all entities receiving or using purchased item (Recipients of physical or digital goods, passengers of transport services, guests of accommodation services, etc.) - `additionalVerificationDocuments` object, nullable — Additional Verification Documents includes any details gained from identifying documents or materials which the customer has shared. - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `documentDateOfBirth` string, date, nullable — Date of birth as appears on the document. Use YYYY-MM-DD format. - `documentExpiration` string, date, nullable — Document's exipration date. Use YYYY-MM-DD format. - `documentFirstName` string, nullable — First name as appears on the document - `documentIssuingState` string, nullable — Document issuing state or region - `documentLastName` string, nullable — Last name as appears on the document - `documentNumber` string, nullable — Official document's number (e.g. passport number, driving license number, etc.) - `documentSource` 'CAMERA_CAPTURED' | 'UPLOADED_FILE' | 'TYPED' | 'OTHER', required — Source of document (e.g. uploaded file, captured by camera, typed in by customer, etc.) - `documentStatus` 'SENT_TO_CLIENT' | 'RECEIVED_FROM_CLIENT' | 'ABANDONED_BY_CLIENT' | 'RECEIVED_FROM_CLIENT_FAULTY', nullable — Status of verification document (e.g. sent to customer, received by customer, abandoned by customer ). - `documentType` string, required — Type of document (Passport, ID, Driving license) - `documentVerificationServiceAnswer` string, nullable — Answer received from 3rd party document verification services - `documentVerificationServiceName` string, nullable — Name of 3rd party document verifcation service - `documentVerificationServiceResponsePayload` object, nullable — General payload object - `documentVerified` boolean, nullable — True if document was verified as authentic by merchant or 3rd party service - `eventTime` number, nullable — Time of event in seconds since unix epoch (UTC, Jan 1, 1970). For example, 01/01/2015 00:00 is 1420070400 - `nationality` string, nullable — Document holder's nationality - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `bankAccount` object, nullable — This object contains information regarding bank transfer payment methods. - `accountHolderFirstName` string, nullable — Bank account holder first name - `accountHolderLastName` string, nullable — Bank account holder last name - `achProcessingType` string, nullable — Type of ACH processing used in the transaction - `bankAccountIdentifier` string, required — Bank account unique identifier (IBAN or equivalent) - `bankAccountType` string, nullable — Type of bank account payment is made from (e.g. savings/checking, etc.) - `bankName` string, nullable — Name of bank payment is made from - `paymentGatewayData` object, nullable — This provides information about the payment gateway - `gatewayName` string, nullable — Payment gateway name - `gatewayTransactionId` string, nullable — Unique transaction identifier (sent by gateway) - `paymentSuccessStatus` string, nullable — Response text as received from the service provider - `serviceName` string, nullable — Payment method name - `comments` object, nullable — Comments are notes the customer included as part of their transaction, whether directed to the merchant or to the intended recipient. - `merchantComments` string, nullable — Comments by the merchant - `messageToBeneficiary` string, nullable — Comments the customer left to the beneficiary of the purchase made - `userCommentsToMerchant` string, nullable — Comments the customer left to the merchant - `cryptoWallet` object, nullable — This provides information about the digital crypto wallet associated with the resipient or transaction. - `cryptoWalletName` string, nullable — Crypto wallet name - `cryptoWalletPaymentId` string, nullable — Crypto wallet payment ID - `cryptoWalletType` 'INTERNAL' | 'EXTERNAL', required — Crypto wallet type (Indicate whether wallet provider is internal to the site ecosystem) - `identityCard` string, nullable — Recipient's identity card number - `loyaltyProgram` LoyaltyProgram[], nullable — Details regarding loyalty program customer entered to receive points for this order - `accountNumber` string, nullable — Customer's rewards/loyalty/frequent flyer account number - `loyaltyPointsValue` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `programName` string, nullable — Name of program - `programPoints` number, nullable — Customer's rewards/loyalty/frequent flyer miles/point/stars - `tier` string, nullable — Program tier name - `personalDetails` PersonalDetails, required — Personal details are those which contribute to building up a picture of the person as an individual, such as name, title, etc.. - `birthdate` string, date, nullable — Date of birth. Use YYYY-MM-DD format. - `email` string, nullable — Email address - `firstName` string, nullable — First name - `fullName` string, nullable — Full name. Not Needed if firstName and LastName are provided independently. - `gender` 'MALE' | 'FEMALE' | 'CHOSE_NOT_TO_SPECIFY' | 'NONE', nullable — Gender - `lastName` string, nullable — Last name - `phone` Phone[], nullable — Phone details - `phone` string, required — Phone number including all country and local access codes - `smsVerified` object, nullable — This object contains information about steps taken to verify the customer's identity such as email or phone verifcations. - `sent` boolean, nullable — True if verification email was sent to email address or verification SMS was sent to phone number - `timeSent` number, nullable — Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970) - `verified` boolean, required — 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) - `deliveryDetails` object, nullable — Delivery Details provides further information about the kind of delivery chosen by the customer. - `delayedDeliveryDate` string, date, nullable — Use only if customer explicitly selected a delayed delivery date beyond the merchant’s standard options. Use YYYY-MM-DD format. - `delayedDeliveryTime` number, nullable — Use only if customer explicitly selected a delayed delivery date, with specific time of day, beyond the merchant’s standard options. Should be sent in seconds since unix epoch (UTC, Jan 1, 1970). - `deliveryComments` string, nullable — Any comments or requests customer had for delivery - `deliveryMethod` string, required — Delivery method chosen by customer such as postal service, email, in game transfer, etc. - `deliveryPrice` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `deliveryType` 'DIGITAL' | 'PHYSICAL' | 'HYBRID', required — Type of delivery: PHYSICAL for any type of shipped goods. DIGITAL for non-shipped goods (services, gift cards etc.) - `itemReturnData` object, nullable — Additional data about the return - `posDetails` object, nullable — Point of sale information. - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `cardEntryMethod` 'SCANNED' | 'HAND_KEYED' | 'CHIP_READ' | 'UNKNOWN' | 'SAVED_IN_ACCOUNT' | 'SWIPED', required — Credit card entry method - `cashierId` string, required — Employee identifier - `departmentId` string, required — Unique store department identifier - `storeBusinessUnit` string, required — Store business unit - `storeId` string, required — Unique store identifier - `storeName` string, required — Store name - `workStationId` string, required — Unique work-station identifier - `returnCondition` string, nullable — Condition of the item returned - `returnInternalReasonCategory` string, nullable — The reason for the return as defined by the merchant - `returnMethod` 'ONLINE' | 'IN-STORE', nullable — Method of return, e.g. online, in-store - `returnReasonCategory` 'CHANGED_MY_MIND' | 'DOES_NOT_FIT' | 'NOT_AS_DESCRIBED' | 'WRONG_ITEM' | 'ARRIVED_TOO_LATE' | 'LOW_QUALITY' | 'DAMAGED_GOODS' | 'GIFT_RETURN' | 'RETURN_TO_SENDER' | 'RETURN_POLICY_EXCEPTION' | 'OTHER' | 'UNKNOWN' | 'ENTIRE_ORDER_NOT_RECEIVED' | 'OUTBOUND_ISSUE_CARRIER' | 'OUTBOUND_ISSUE_MERCHANT' | 'FAILED_DELIVERY' | 'INBOUND_LOSS' | 'INBOUND_ISSUE_CARRIER', nullable — Reason for return - `returnSegment` string, nullable — Specific return segment as defined by the merchant - `returnStatusLog` object, nullable — Status of the return process - `arrivedToWarehouse` boolean, nullable — Indicates that the returned items arrived to the merchant's warehouse - `arrivedToWarehouseTime` number, nullable — Time returned items arrived to the merchant's warehouse - `returnInitiated` boolean, nullable — Indicates that the customer initiated a return process online - `returnInitiationTime` number, nullable — Time online return was initiated - `shippedByCustomer` boolean, nullable — Indicates that the customer has shipped the returned items back to the merchant - `shippedByCustomerTime` number, nullable — Time returned items were shipped by the customer - `typeOfCompensationRequested` 'REPLACEMENT' | 'REFUND' | 'REFUND_UPON_RETURN' | 'CREDIT' | 'MIXED' | 'UNKNOWN' | 'NO_COMPENSATION', nullable — Indicates whether the customer requested a refund, store credit, replacement etc. - `updatedReturnStatus` 'ACCEPTED_BY_MERCHANT' | 'REJECTED_BY_MERCHANT' | 'PARTIALLY_ACCEPTED_BY_MERCHANT', nullable — The updated status of the return on the merchant's side - `itemSpecificData` object, nullable — These are the details relating to the particular item purchased. This object should be used whenever additional industry specific data is available on a cart item - `accommodation` object, nullable — In cases where the transaction involves purchasing accommodation, Accommodation Item gives details relating to the type of accommodation purchased. - `accommodationAddress` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `accommodationName` string, nullable — Name of the facility - `duration` object, nullable — An object that represents a duration in days. Note that the endDate must be greater than or equal to the startDate. The required date format is YYYY-MM-DD. - `endDate` string, date, required — Date service/item ends or becomes unavailable. Use YYYY-MM-DD format. - `startDate` string, date, required — Date service/item begins or becomes available. Use YYYY-MM-DD format. - `housingType` string, nullable — Type of room/housing - `isRefundable` boolean, nullable — True if order can be cancelled and refunded - `location` object, nullable — General location (city level) - `airportCode` string, nullable — Three letter IATA airport code - `city` string, nullable — City - `country` string, nullable — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. - `seaportCode` string, nullable — Five letter seaport code - `numberOfGuests` number, required — Number of guests - `rating` Rating[], nullable — All ratings given to item or service. Can include internal peer rating, merchant rating, official professional association ratings, etc. - `score` string, nullable — Rating score (numeric - 97 or textual - 'Excellent') - `source` string, nullable — Source of rating, for example tripAdvisor, yelp, etc. - `type` 'INTERNAL_PEERS' | 'INTERNAL_MERCHANT' | 'EXTERNAL_PEERS' | 'EXTERNAL_INDEPENDENT', nullable — Rating type. Internal if rating was generated within the merchant's site or community, otherwise external. - `type` 'HOTEL' | 'APARTMENT' | 'CRUISE' | 'STUDIO' | 'EVENT_VENUE', nullable — Type of accommodation service - `cryptocurrency` object, nullable — Details relating to cryptocurrency purchases - `destinationWallet` string, nullable — Destination wallet address - `digitalGoodsAndServices` object, nullable — Service Item is used for services sold such as subscriptions, outsourcing projects, etc. - `automaticRenewal` boolean, nullable — True if customer chose to have service automatically renewed once current service ends - `billingFrequency` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'MULTI_ANNUAL' | 'OTHER', nullable — The frequency customer has chosen for billing - `duration` object, nullable — An object that represents a duration in days. Note that the endDate must be greater than or equal to the startDate. The required date format is YYYY-MM-DD. - `endDate` string, date, required — Date service/item ends or becomes unavailable. Use YYYY-MM-DD format. - `startDate` string, date, required — Date service/item begins or becomes available. Use YYYY-MM-DD format. - `isTrial` boolean, nullable — True if the product\service begins with a free trial - `webHosting` object, nullable — Details relating to web hosting related items or products - `SSLcertificates` boolean, nullable — True if customer asked or paid extra for SSL certificates to be included - `domains` string[], nullable — List of domains purchased - `emailService` boolean, nullable — True if customer asked or paid extra for Email functionality - `privateRegistration` boolean, nullable — True if customer asked or paid extra to hide registrant details from whois services - `sercurityUpgrades` boolean, nullable — True if customer asked or paid extra for security upgrades (antivirus, firewall, etc.) - `webPromotion` boolean, nullable — True if customer asked or paid extra for promotion services such as SEO - `websiteBuilder` boolean, nullable — True if customer asked or paid extra for website builder wizard services - `food` object, nullable — If the item purchased is somekind of food, this gives further details describing the item more precisely. - `restaurantAddress` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `restaurantId` string, nullable — Restaurant unique identifier - `restaurantName` string, nullable — The name of the restaurant - `tipAmount` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `gaming` object, nullable — This includes details relevant to computer gaming related items, the player involved and how it is being played by the customer. - `characterName` string, nullable — In-game character name - `characterRole` string, nullable — Character's role in the game - `gameGenre` string, nullable — Game type/genre - `gameItemAmount` number, nullable — Number of game items or commodities bought (100 coins, 2000 gold, 10 experience points, etc.) - `gameName` string, required — Game name - `gamePlatform` string, nullable — Game platform - `gameServerCountry` string, nullable — Country, two-letter ISO 3166-1 alpha-2 country code - `gameServerName` string, nullable — Game server name - `inGameTradeLocation` string, nullable — In-Game trade location - `playerFaction` string, nullable — Player's in-game faction/clan/group - `playerLeague` string, nullable — Player's in-game league - `playerLevel` string, nullable — Player's in-game level - `playerPosition` string, nullable — Player's in-game position - `personNameRecord` string, nullable — Person Name Record (PNR). Combined with a passenger name, it serves as an identifier for a flight reservation (also for multiple passengers) - `physicalGoods` object, nullable — If the item purchased is a physical item, this gives further details describing the item more precisely. - `wrapAsGift` boolean, nullable — True if customer chose to have item wrapped as a gift - `professionalServices` object, nullable — Additional information regarding professional services, such as event planning, web design, etc. - `numberOfParticipatingClients` number, nullable — Number of clients associated with this service. Would be greater than 1 in cases where the service is given to multiple clients, for example, a bride and a groom at a wedding. - `numberOfParticipatingVendors` number, nullable — Number of vendors associated with this service. Would be greater than 1 in cases where several vendors collaborate to offer the service. - `tipAmount` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `ticketsAndEvents` object, nullable — Ticket Item is used for tickets and events. - `eventLocation` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `eventName` string, required — Name of the event - `eventTime` number, nullable — Time of event in seconds since unix epoch (UTC, Jan 1, 1970). For example, 01/01/2015 00:00 is 1420070400 - `eventType` string, nullable — Type of event (movie, concert, sports, etc.) - `eventVenueName` string, nullable — Name of venue where event takes place - `ticketCategory` 'ADULT' | 'CHILD' | 'ENFANT' | 'SENIOR' | 'STUDENT' | 'VETERAN' | 'OTHER', nullable — Ticket category (adult, student, senior, child, etc.) - `ticketClass` string, nullable — Class of tickets purchased (Standing, VIP, Platinum, etc.) - `transport` TransportItem[], nullable — Additional information regarding transportation services or products - `bookingSource` string, nullable — Use to indicate the affiliate, origin, internal source or flow that this part of the booking is associated with - `carrier` string, nullable — Company operating transportation service purchased (airline, car rental company, etc.) - `class` string, nullable — Seating class (Tourist, business, first, etc.) - `driverDetails` object, nullable — This provides a more detailed picture of the seller - their details, actions etc.. - `availableFundsForWithdrawal` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `dateOfFirstSale` number, nullable — Date of first sale by seller, in seconds since unix epoch (UTC, Jan 1, 1970) - `ratingAsBuyer` object, nullable — With the increasingly peer-led, peer-reviewed, highly social nature of online commerce, ratings are often available connected to the customer or the purchase. - `score` string, nullable — Rating score (numeric - 97 or textual - 'Excellent') - `source` string, nullable — Source of rating, for example tripAdvisor, yelp, etc. - `type` 'INTERNAL_PEERS' | 'INTERNAL_MERCHANT' | 'EXTERNAL_PEERS' | 'EXTERNAL_INDEPENDENT', nullable — Rating type. Internal if rating was generated within the merchant's site or community, otherwise external. - `ratingAsSeller` object, nullable — With the increasingly peer-led, peer-reviewed, highly social nature of online commerce, ratings are often available connected to the customer or the purchase. - `score` string, nullable — Rating score (numeric - 97 or textual - 'Excellent') - `source` string, nullable — Source of rating, for example tripAdvisor, yelp, etc. - `type` 'INTERNAL_PEERS' | 'INTERNAL_MERCHANT' | 'EXTERNAL_PEERS' | 'EXTERNAL_INDEPENDENT', nullable — Rating type. Internal if rating was generated within the merchant's site or community, otherwise external. - `sellerAccountCreationDate` number, required — Date seller account was created in seconds since unix epoch (UTC, Jan 1, 1970) - `sellerLastLoginIP` object, nullable — This provides information about the IP address associated with the customer or transaction. - `ip` string, required — Customer IP address in v4 format - `updateTimes` object, nullable — This provides information regarding the times associated with any updates made to the account or transaction. - … - `sellerPastSalesCount` integer, nullable — Count of all successfully fulfilled sales made - `sellerPersonalDetails` object, nullable — Personal details are those which contribute to building up a picture of the person as an individual, such as name, title, etc.. - `birthdate` string, date, nullable — Date of birth. Use YYYY-MM-DD format. - `email` string, nullable — Email address - `firstName` string, nullable — First name - `fullName` string, nullable — Full name. Not Needed if firstName and LastName are provided independently. - `gender` 'MALE' | 'FEMALE' | 'CHOSE_NOT_TO_SPECIFY' | 'NONE', nullable — Gender - `lastName` string, nullable — Last name - `sellerRegistrationIP` object, nullable — This provides information about the IP address associated with the customer or transaction. - `ip` string, required — Customer IP address in v4 format - `updateTimes` object, nullable — This provides information regarding the times associated with any updates made to the account or transaction. - … - `duration` object, nullable — An object that represents exact duration in seconds. Note that the endTime must be greater than or equal to the startTime. The required timestamp format is seconds since unix epoch (UTC, Jan 1, 1970) - `endTime` integer, required — Unix timestamp in seconds of when service/item ends or becomes unavailable in seconds since unix epoch (UTC, Jan 1, 1970) - `startTime` number, required — Unix timestamp in seconds of when service/item begins or becomes available in seconds since unix epoch (UTC, Jan 1, 1970) - `endPoint` object, nullable — An object that contains either exact or broad information about a physical location associated with the transaction or customer. - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - … - `zip` string, nullable — Zipcode - `exactLocation` object, nullable — Details of a location in lat/long coordinates - `latitude` number, nullable — Latitude in Decimal Degrees (WGS84) - `longitude` number, nullable — Longitude in Decimal Degrees (WGS84) - `source` string, nullable — Source of location data - `locationName` object, nullable — An object that contains the name of a physical location, either as submitted by the end-user, or as assigned by the merchant. - `isTextSearchResult` boolean, nullable — Set to true if the user searched for the location name to find the exact location (as opposed to location being generated by the app based on device location) - `specificLocationName` string, nullable — Specific location name. Can be used for locations named by the end-user (e.g. "Beth's office") or for merchant assigned names (based on 3rd party tools or other sources) - `specificLocationType` string, nullable — Specific location type. - `roughLocation` object, nullable — General location (city level) - `airportCode` string, nullable — Three letter IATA airport code - `city` string, nullable — City - `country` string, nullable — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. - `seaportCode` string, nullable — Five letter seaport code - `savedLocation` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `expeditedBoarding` boolean, nullable — True if customer paid extra for expedited boarding - `extraBaggage` boolean, nullable — True if customer paid extra to bring extra baggage - `leg` integer, nullable — Use to indicate the order of arrival to each point on the route. Original departure point should get leg=0, first connection should get leg=1, etc. final destination should get leg=(number of stops-1) - `locationAtTimeOfReservation` object, nullable — An object that contains either exact or broad information about a physical location associated with the transaction or customer. - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - … - `zip` string, nullable — Zipcode - `exactLocation` object, nullable — Details of a location in lat/long coordinates - `latitude` number, nullable — Latitude in Decimal Degrees (WGS84) - `longitude` number, nullable — Longitude in Decimal Degrees (WGS84) - `source` string, nullable — Source of location data - `locationName` object, nullable — An object that contains the name of a physical location, either as submitted by the end-user, or as assigned by the merchant. - `isTextSearchResult` boolean, nullable — Set to true if the user searched for the location name to find the exact location (as opposed to location being generated by the app based on device location) - `specificLocationName` string, nullable — Specific location name. Can be used for locations named by the end-user (e.g. "Beth's office") or for merchant assigned names (based on 3rd party tools or other sources) - `specificLocationType` string, nullable — Specific location type. - `roughLocation` object, nullable — General location (city level) - `airportCode` string, nullable — Three letter IATA airport code - `city` string, nullable — City - `country` string, nullable — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. - `seaportCode` string, nullable — Five letter seaport code - `savedLocation` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `passengers` number, nullable — Number of passengers - `purchasedMeals` boolean, nullable — True if customer paid extra to receive meals on board - `selectSeat` boolean, nullable — True if customer paid extra to select a seat - `startPoint` Location, required — An object that contains either exact or broad information about a physical location associated with the transaction or customer. - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - … - `zip` string, nullable — Zipcode - `exactLocation` object, nullable — Details of a location in lat/long coordinates - `latitude` number, nullable — Latitude in Decimal Degrees (WGS84) - `longitude` number, nullable — Longitude in Decimal Degrees (WGS84) - `source` string, nullable — Source of location data - `locationName` object, nullable — An object that contains the name of a physical location, either as submitted by the end-user, or as assigned by the merchant. - `isTextSearchResult` boolean, nullable — Set to true if the user searched for the location name to find the exact location (as opposed to location being generated by the app based on device location) - `specificLocationName` string, nullable — Specific location name. Can be used for locations named by the end-user (e.g. "Beth's office") or for merchant assigned names (based on 3rd party tools or other sources) - `specificLocationType` string, nullable — Specific location type. - `roughLocation` object, nullable — General location (city level) - `airportCode` string, nullable — Three letter IATA airport code - `city` string, nullable — City - `country` string, nullable — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. - `seaportCode` string, nullable — Five letter seaport code - `savedLocation` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `type` 'PRIVATE_TAXI' | 'PRIVATE_VIP_TAXI' | 'PRIVATE_LARGE_TAXI' | 'SHARED_RIDE' | 'SHARED_RIDE_DISCOUNT' | 'AIR_TRAVEL' | 'RAIL' | 'FERRY' | 'BUS' | 'CAR_RENTAL' | 'PARKING' | 'CRUISE_LINE', required — Type of transportation service - `pendingAddition` boolean, nullable — Indicates whether the item is pending decision to be added to cart - `seller` object, nullable — This reflects the information known about the seller. - `sellerBusinessWebsite` string, nullable — Seller's business website URL - `sellerCategory` string, nullable — Type of service offered by the seller - `sellerDetails` BasicSellerData, required — This provides a more detailed picture of the seller - their details, actions etc.. - `availableFundsForWithdrawal` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `dateOfFirstSale` number, nullable — Date of first sale by seller, in seconds since unix epoch (UTC, Jan 1, 1970) - `ratingAsBuyer` object, nullable — With the increasingly peer-led, peer-reviewed, highly social nature of online commerce, ratings are often available connected to the customer or the purchase. - `score` string, nullable — Rating score (numeric - 97 or textual - 'Excellent') - `source` string, nullable — Source of rating, for example tripAdvisor, yelp, etc. - `type` 'INTERNAL_PEERS' | 'INTERNAL_MERCHANT' | 'EXTERNAL_PEERS' | 'EXTERNAL_INDEPENDENT', nullable — Rating type. Internal if rating was generated within the merchant's site or community, otherwise external. - `ratingAsSeller` object, nullable — With the increasingly peer-led, peer-reviewed, highly social nature of online commerce, ratings are often available connected to the customer or the purchase. - `score` string, nullable — Rating score (numeric - 97 or textual - 'Excellent') - `source` string, nullable — Source of rating, for example tripAdvisor, yelp, etc. - `type` 'INTERNAL_PEERS' | 'INTERNAL_MERCHANT' | 'EXTERNAL_PEERS' | 'EXTERNAL_INDEPENDENT', nullable — Rating type. Internal if rating was generated within the merchant's site or community, otherwise external. - `sellerAccountCreationDate` number, required — Date seller account was created in seconds since unix epoch (UTC, Jan 1, 1970) - `sellerLastLoginIP` object, nullable — This provides information about the IP address associated with the customer or transaction. - `ip` string, required — Customer IP address in v4 format - `updateTimes` object, nullable — This provides information regarding the times associated with any updates made to the account or transaction. - `creationTime` number, nullable — Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970) - `lastModifiedTime` number, nullable — Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970) - `lastUsed` number, nullable — Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970) - `removalTime` number, nullable — Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970) - `sellerPastSalesCount` integer, nullable — Count of all successfully fulfilled sales made - `sellerPersonalDetails` object, nullable — Personal details are those which contribute to building up a picture of the person as an individual, such as name, title, etc.. - `birthdate` string, date, nullable — Date of birth. Use YYYY-MM-DD format. - `email` string, nullable — Email address - `firstName` string, nullable — First name - `fullName` string, nullable — Full name. Not Needed if firstName and LastName are provided independently. - `gender` 'MALE' | 'FEMALE' | 'CHOSE_NOT_TO_SPECIFY' | 'NONE', nullable — Gender - `lastName` string, nullable — Last name - `sellerRegistrationIP` object, nullable — This provides information about the IP address associated with the customer or transaction. - `ip` string, required — Customer IP address in v4 format - `updateTimes` object, nullable — This provides information regarding the times associated with any updates made to the account or transaction. - `creationTime` number, nullable — Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970) - `lastModifiedTime` number, nullable — Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970) - `lastUsed` number, nullable — Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970) - `removalTime` number, nullable — Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970) - `sellerVendorName` string, nullable — Name of the vendor - `shopifyAdditionalItemData` object, nullable — Object for additional Shopify cart item data - `properties` object, nullable — General payload object - `compensationStatus` object, nullable — Status of the compensation request - `hasProofOfPurchase` boolean, nullable - `itemStatus` ItemCompensationStatus[], required — A list of all items for which compensation was requested - `basicItemData` BasicItemData, required — This is an item associated with the customer or transaction. - `category` string, nullable — Item category - `discount` object, nullable — This provides information relating to any kind of offer, coupon or other discount used by the customer. - `couponCodeUsed` string, required — Coupon code used - `couponDiscountAmount` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `couponDiscountPercent` string, nullable — Coupon discount amount - `name` string, required — Item name - `price` Amount, required — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `productId` string, nullable — Unique identifier for item that is common to all identical items (such as SKU, ISBN, etc.) - `quantity` number, required — Item quantity - `type` 'TANGIBLE' | 'NON_TANGIBLE', required — Tangible if physical item, non-tangible if any other product - `statusData` ItemCompensationStatusData, required — This is update on the specific data regarding the compensation requested by the customer for this item. - `compensationTypeGranted` 'REPLACEMENT' | 'REFUND' | 'REFUND_UPON_RETURN' | 'CREDIT' | 'MIXED' | 'UNKNOWN' | 'NO_COMPENSATION', required — Indicates whether the customer was granted a refund, store credit, replacement etc. - `internalReasonCategory` string, nullable — The reason for the request as defined by the merchant - `reasonCategory` 'CHANGED_MY_MIND' | 'DOES_NOT_FIT' | 'NOT_AS_DESCRIBED' | 'WRONG_ITEM' | 'ARRIVED_TOO_LATE' | 'LOW_QUALITY' | 'DAMAGED_GOODS' | 'GIFT_RETURN' | 'RETURN_TO_SENDER' | 'RETURN_POLICY_EXCEPTION' | 'OTHER' | 'UNKNOWN' | 'ITEM_NOT_RECEIVED' | 'ENTIRE_ORDER_NOT_RECEIVED' | 'OUTBOUND_ISSUE_CARRIER' | 'OUTBOUND_ISSUE_MERCHANT' | 'FAILED_DELIVERY' | 'INBOUND_LOSS' | 'INBOUND_ISSUE_CARRIER', required — Reason for compensation request - `returnCondition` 'GOOD_CONDITION' | 'DAMAGED' | 'WRONG_ITEM' | 'NO_ITEM' | 'NOT_ARRIVED' | 'NO_RETURN', nullable — Condition of the item returned - `returnMethodGranted` 'SHIP_TO_WAREHOUSE' | 'IN_STORE' | 'NO_RETURN', required — Method of return granted to customer - `statusLog` object, nullable — Status of the return process per item - `arrivedToWarehouseTime` number, nullable — Time returned items arrived to the merchant's warehouse - `initiationTime` number, nullable — The time that the customer initiated the request for compensation in MILLISECONDS since unix epoch (Jan 1, 1970) - `initiationType` 'CALL_CENTER' | 'IN_STORE' | 'CHAT' | 'ONLINE' | 'SELF_SERVICE', nullable — What channel did the customer use to initiate the request for compensation - `shippedByCustomerTime` number, nullable — Time returned items were shipped by the customer - `updatedStatus` 'ACCEPTED_BY_MERCHANT' | 'REJECTED_BY_MERCHANT' | 'WITHDRAWN_BY_CUSTOMER', required — The updated compensation request status - `merchantAgentData` object, nullable — Name and Id of the merchant's agent processing the compensation request - `merchantAgentId` string, nullable — Unique identifier of the agent processing the customer's request - `merchantAgentName` string, nullable — Name of the agent processing the customer's request - `replacementOrderId` string, nullable — Unique order/transaction identifier for a replacement order issued by the merchant in response to this request - `shippingRefunded` boolean, nullable — Indicates whether merchant reimbursed the customer for shipping expenses - `shippingRefundedAmount` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `statusData` object, nullable — This is update on the specific data regarding the compensation requested by the customer for this item. - `compensationTypeGranted` 'REPLACEMENT' | 'REFUND' | 'REFUND_UPON_RETURN' | 'CREDIT' | 'MIXED' | 'UNKNOWN' | 'NO_COMPENSATION', required — Indicates whether the customer was granted a refund, store credit, replacement etc. - `internalReasonCategory` string, nullable — The reason for the request as defined by the merchant - `reasonCategory` 'CHANGED_MY_MIND' | 'DOES_NOT_FIT' | 'NOT_AS_DESCRIBED' | 'WRONG_ITEM' | 'ARRIVED_TOO_LATE' | 'LOW_QUALITY' | 'DAMAGED_GOODS' | 'GIFT_RETURN' | 'RETURN_TO_SENDER' | 'RETURN_POLICY_EXCEPTION' | 'OTHER' | 'UNKNOWN' | 'ITEM_NOT_RECEIVED' | 'ENTIRE_ORDER_NOT_RECEIVED' | 'OUTBOUND_ISSUE_CARRIER' | 'OUTBOUND_ISSUE_MERCHANT' | 'FAILED_DELIVERY' | 'INBOUND_LOSS' | 'INBOUND_ISSUE_CARRIER', required — Reason for compensation request - `returnCondition` 'GOOD_CONDITION' | 'DAMAGED' | 'WRONG_ITEM' | 'NO_ITEM' | 'NOT_ARRIVED' | 'NO_RETURN', nullable — Condition of the item returned - `returnMethodGranted` 'SHIP_TO_WAREHOUSE' | 'IN_STORE' | 'NO_RETURN', required — Method of return granted to customer - `statusLog` object, nullable — Status of the return process per item - `arrivedToWarehouseTime` number, nullable — Time returned items arrived to the merchant's warehouse - `initiationTime` number, nullable — The time that the customer initiated the request for compensation in MILLISECONDS since unix epoch (Jan 1, 1970) - `initiationType` 'CALL_CENTER' | 'IN_STORE' | 'CHAT' | 'ONLINE' | 'SELF_SERVICE', nullable — What channel did the customer use to initiate the request for compensation - `shippedByCustomerTime` number, nullable — Time returned items were shipped by the customer - `updatedStatus` 'ACCEPTED_BY_MERCHANT' | 'REJECTED_BY_MERCHANT' | 'WITHDRAWN_BY_CUSTOMER', required — The updated compensation request status - `totalGrantedAmount` Amount, required — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `correlationId` string, nullable — A Forter unique identifier that was provided as part of a Forter API response. Used to correlate between the compensation request event and final status update - `deliveryStatusInfo` object, nullable — Order Shipping Info - `additionalShippingInfo` string, nullable — Aditional identification document details and verification - `carrier` string, nullable — Shipping carrier name - `customerOpenedEmail` boolean, nullable — True if there's an indication that the customer opened the purchase confirmation email sent by the merchant - `downloadTime` number, nullable — The time when the buyer downloaded the digital item to their device in SECONDS since unix epoch (Jan 1, 1970) - `proofOfShippingURL` string, nullable — URL to the proof of shipping in the merchant's system - `signedProofOfShipping` boolean, nullable — Whether the user has signed a proof of shipping - `trackingNumber` string, nullable — Order tracking number - `endPointLocation` object, nullable — An object that contains either exact or broad information about a physical location associated with the transaction or customer. - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `exactLocation` object, nullable — Details of a location in lat/long coordinates - `latitude` number, nullable — Latitude in Decimal Degrees (WGS84) - `longitude` number, nullable — Longitude in Decimal Degrees (WGS84) - `source` string, nullable — Source of location data - `locationName` object, nullable — An object that contains the name of a physical location, either as submitted by the end-user, or as assigned by the merchant. - `isTextSearchResult` boolean, nullable — Set to true if the user searched for the location name to find the exact location (as opposed to location being generated by the app based on device location) - `specificLocationName` string, nullable — Specific location name. Can be used for locations named by the end-user (e.g. "Beth's office") or for merchant assigned names (based on 3rd party tools or other sources) - `specificLocationType` string, nullable — Specific location type. - `roughLocation` object, nullable — General location (city level) - `airportCode` string, nullable — Three letter IATA airport code - `city` string, nullable — City - `country` string, nullable — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. - `seaportCode` string, nullable — Five letter seaport code - `savedLocation` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `eventId` string, nullable — Unique identifier of compensation update, should match previous compensation request identifier, if applicable, and any subsequent status updates of the same compensation request - `eventTime` number, required — The time the status change event took place in MILLISECONDS since unix epoch (Jan 1, 1970) - `itemIds` string[], nullable — /** Unique item identifiers. Should match the item ids as described under the BasicItemData object. - `orderId` string, required — Unique order/transaction identifier. Note that Forter treats this ID as case-insensitive; Order123 and ORDER123 will be identified as the same order. **Must be identical to the orderId used in the order validation API** - `payment` Payment[], nullable — An updated list of all payment methods and billing details used in the transaction. Required only if there has been a change to the payment. - `allowedMerchantInitiatedTransactions` boolean, nullable — True if customer chose to allow future transactions to initiate without taking further action (payment that's initiated on behalf of a customer) - `amount` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `androidPay` object, nullable — This provides details relating to a tokenized card. - `bin` string, nullable — Credit card's BIN (Bank Identification Number) - `cardBank` string, nullable — Credit card's issuing bank - `cardBrand` string, nullable — Credit card's issuer brand - `cardType` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'UNKNOWN', nullable — Payment card type - `countryOfIssuance` string, nullable — Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code - `creationTime` number, nullable — Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970) - `creditCardCorrelationId` string, nullable — Credit card - CorrelationId that was recieved by the init 3DS API - `expirationMonth` string, required — Credit card's expiration month, in MM format - `expirationYear` string, required — Credit card's expiration year, in YYYY format - `fullResponsePayload` object, nullable — General payload object - `lastFourDigits` string, nullable — Credit card's last 4 digits - `nameOnCard` string, nullable — Cardholder's full name - `paymentProcessorData` object, nullable — This provides information about the payment processor - `processorName` string, nullable — Payment processor name - `processorTransactionId` string, nullable — Unique transaction identifier (sent by processor) - `threeDSecure` object, nullable - `acquirerData` object, nullable — This provides information about the Acquirer of the transaction - `acquirerBIN` string, nullable — Bank acquirer BIN (Bank Identification Number) - `acquirerCountry` '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', nullable — Acquirer country - `acquirerMerchantId` string, nullable — Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor - `acquirerMerchantName` string, nullable — Merchant Name as appearing in processor records - `acquirerName` string, nullable — Bank acquirer Name - `merchantCategoryCode` number, nullable — 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. - `merchantCountryCode` number, nullable — Merchant country code is a three-digit number listed in ISO 3166‑1 (zero‑padded) - `challengeIndicator` 'NO_PREFERENCE' | 'NO_CHALLENGE' | 'CHALLENGE' | 'CHALLENGE_AS_MANDATE', nullable — Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation - `execute3ds` 'FORCE_3DS' | 'FORCE_DATA_ONLY' | 'NOT_SUPPORTED_BY_MERCHANT' | 'DYNAMIC_FORTER_DECISION', nullable — Request your preference regarding the execution of 3DS - `forcePsd2Exemption` object, nullable - `channel` 'THREEDS_RAILS' | 'AUTHORIZATION', required — The channel through which the exemption is requested - `type` 'LOW_VALUE' | 'TRANSACTION_RISK_ANALYSIS' | 'SECURE_CORPORATE' | 'TRUSTED_BENEFICIARY', required — The type of exemption requested - `requestChallenge` boolean, nullable — Indicates if a 3DS challenge should be requested from the Issuer ACS. - `threeDSServerTransID` string, required — 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 - `threeDsExecutor` 'FORTER' | 'MERCHANT', nullable — 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 - `token` string, required — Credit card token used by the merchant - `tokenType` 'PSP' | 'EMV_PAYMENT_TOKEN' | 'MERCHANT_GENERATED' | 'FORTER_TOKEN' | 'OTHER', nullable — Token type, determined by the party/protocol the token created by - `verificationResults` CreditCardVerification, required — Credit card CVV and AVS results - `authorizationCode` string, nullable — Card authorization code from payment gateway. Required if both processorResponseText and processorResponseCode are not provided. - `authorizationProcessedWith3DS` boolean, nullable — 3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization - `avsFullResult` string, nullable — Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string - `avsNameResult` string, nullable — Name portion of card's AVS result (when available) - `avsStreetResult` string, nullable — Street address portion of card's AVS result - `avsZipResult` string, nullable — Zipcode portion of card's AVS result - `cavvResult` string, nullable — 3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response - `cvvResult` string, nullable — CVV result (if no data please send the value U) - `eciValue` string, nullable — 3DSecure - ECI value recieved from authorization/authentication response - `exemptionStatus` string, nullable — Exemption status as received from the processor - `external3dsVendorPayload` object, nullable — General payload object - `issuerResponseCode` string, nullable — Response code received from issuer - `issuerResponseText` string, nullable — Response text received from issuer - `liabilityShift` boolean, nullable — 3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer - `partyExecuted3DS` 'PSP' | 'FORTER' | 'BOTH', nullable — 3DSecure - Party executed the 3DS authentication - `processorResponseCode` string, nullable — Response code received from processor. Required if both processorResponseText and authorizationCode are not provided. - `processorResponseText` string, nullable — Response text received from processor. Required if both processorResponseCode and authorizationCode are not provided. - `threeDsInteractionMode` 'FRICTIONLESS' | 'CHALLENGED', nullable — 3DSecure - Indication of the friction that the user experienced - `threeDsStatus` string, nullable — 3DSecure - Status text received from 3D secure vendor - `threeDsVersion` string, nullable — 3DSecure - Version used in the transaction - `applePay` object, nullable — This provides details relating to a tokenized card. - `bin` string, nullable — Credit card's BIN (Bank Identification Number) - `cardBank` string, nullable — Credit card's issuing bank - `cardBrand` string, nullable — Credit card's issuer brand - `cardType` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'UNKNOWN', nullable — Payment card type - `countryOfIssuance` string, nullable — Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code - `creationTime` number, nullable — Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970) - `creditCardCorrelationId` string, nullable — Credit card - CorrelationId that was recieved by the init 3DS API - `expirationMonth` string, required — Credit card's expiration month, in MM format - `expirationYear` string, required — Credit card's expiration year, in YYYY format - `fullResponsePayload` object, nullable — General payload object - `lastFourDigits` string, nullable — Credit card's last 4 digits - `nameOnCard` string, nullable — Cardholder's full name - `paymentProcessorData` object, nullable — This provides information about the payment processor - `processorName` string, nullable — Payment processor name - `processorTransactionId` string, nullable — Unique transaction identifier (sent by processor) - `threeDSecure` object, nullable - `acquirerData` object, nullable — This provides information about the Acquirer of the transaction - `acquirerBIN` string, nullable — Bank acquirer BIN (Bank Identification Number) - `acquirerCountry` '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', nullable — Acquirer country - `acquirerMerchantId` string, nullable — Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor - `acquirerMerchantName` string, nullable — Merchant Name as appearing in processor records - `acquirerName` string, nullable — Bank acquirer Name - `merchantCategoryCode` number, nullable — 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. - `merchantCountryCode` number, nullable — Merchant country code is a three-digit number listed in ISO 3166‑1 (zero‑padded) - `challengeIndicator` 'NO_PREFERENCE' | 'NO_CHALLENGE' | 'CHALLENGE' | 'CHALLENGE_AS_MANDATE', nullable — Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation - `execute3ds` 'FORCE_3DS' | 'FORCE_DATA_ONLY' | 'NOT_SUPPORTED_BY_MERCHANT' | 'DYNAMIC_FORTER_DECISION', nullable — Request your preference regarding the execution of 3DS - `forcePsd2Exemption` object, nullable - `channel` 'THREEDS_RAILS' | 'AUTHORIZATION', required — The channel through which the exemption is requested - `type` 'LOW_VALUE' | 'TRANSACTION_RISK_ANALYSIS' | 'SECURE_CORPORATE' | 'TRUSTED_BENEFICIARY', required — The type of exemption requested - `requestChallenge` boolean, nullable — Indicates if a 3DS challenge should be requested from the Issuer ACS. - `threeDSServerTransID` string, required — 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 - `threeDsExecutor` 'FORTER' | 'MERCHANT', nullable — 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 - `token` string, required — Credit card token used by the merchant - `tokenType` 'PSP' | 'EMV_PAYMENT_TOKEN' | 'MERCHANT_GENERATED' | 'FORTER_TOKEN' | 'OTHER', nullable — Token type, determined by the party/protocol the token created by - `verificationResults` CreditCardVerification, required — Credit card CVV and AVS results - `authorizationCode` string, nullable — Card authorization code from payment gateway. Required if both processorResponseText and processorResponseCode are not provided. - `authorizationProcessedWith3DS` boolean, nullable — 3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization - `avsFullResult` string, nullable — Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string - `avsNameResult` string, nullable — Name portion of card's AVS result (when available) - `avsStreetResult` string, nullable — Street address portion of card's AVS result - `avsZipResult` string, nullable — Zipcode portion of card's AVS result - `cavvResult` string, nullable — 3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response - `cvvResult` string, nullable — CVV result (if no data please send the value U) - `eciValue` string, nullable — 3DSecure - ECI value recieved from authorization/authentication response - `exemptionStatus` string, nullable — Exemption status as received from the processor - `external3dsVendorPayload` object, nullable — General payload object - `issuerResponseCode` string, nullable — Response code received from issuer - `issuerResponseText` string, nullable — Response text received from issuer - `liabilityShift` boolean, nullable — 3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer - `partyExecuted3DS` 'PSP' | 'FORTER' | 'BOTH', nullable — 3DSecure - Party executed the 3DS authentication - `processorResponseCode` string, nullable — Response code received from processor. Required if both processorResponseText and authorizationCode are not provided. - `processorResponseText` string, nullable — Response text received from processor. Required if both processorResponseCode and authorizationCode are not provided. - `threeDsInteractionMode` 'FRICTIONLESS' | 'CHALLENGED', nullable — 3DSecure - Indication of the friction that the user experienced - `threeDsStatus` string, nullable — 3DSecure - Status text received from 3D secure vendor - `threeDsVersion` string, nullable — 3DSecure - Version used in the transaction - `bankTransfer` object, nullable — This object contains information regarding bank transfer payment methods. - `accountHolderFirstName` string, nullable — Bank account holder first name - `accountHolderLastName` string, nullable — Bank account holder last name - `achProcessingType` string, nullable — Type of ACH processing used in the transaction - `bankAccountIdentifier` string, required — Bank account unique identifier (IBAN or equivalent) - `bankAccountType` string, nullable — Type of bank account payment is made from (e.g. savings/checking, etc.) - `bankName` string, nullable — Name of bank payment is made from - `paymentGatewayData` object, nullable — This provides information about the payment gateway - `gatewayName` string, nullable — Payment gateway name - `gatewayTransactionId` string, nullable — Unique transaction identifier (sent by gateway) - `paymentSuccessStatus` string, nullable — Response text as received from the service provider - `serviceName` string, nullable — Payment method name - `billingDetails` Person, required — This object combines a number of pieces of data which contribute to building up an understanding of the person as an individual, both online and offline. - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `allAdditionalVerificationDocuments` AdditionalVerificationDocuments[], nullable — Additional identification documents details and verification - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `documentDateOfBirth` string, date, nullable — Date of birth as appears on the document. Use YYYY-MM-DD format. - `documentExpiration` string, date, nullable — Document's exipration date. Use YYYY-MM-DD format. - `documentFirstName` string, nullable — First name as appears on the document - `documentIssuingState` string, nullable — Document issuing state or region - `documentLastName` string, nullable — Last name as appears on the document - `documentNumber` string, nullable — Official document's number (e.g. passport number, driving license number, etc.) - `documentSource` 'CAMERA_CAPTURED' | 'UPLOADED_FILE' | 'TYPED' | 'OTHER', required — Source of document (e.g. uploaded file, captured by camera, typed in by customer, etc.) - `documentStatus` 'SENT_TO_CLIENT' | 'RECEIVED_FROM_CLIENT' | 'ABANDONED_BY_CLIENT' | 'RECEIVED_FROM_CLIENT_FAULTY', nullable — Status of verification document (e.g. sent to customer, received by customer, abandoned by customer ). - `documentType` string, required — Type of document (Passport, ID, Driving license) - `documentVerificationServiceAnswer` string, nullable — Answer received from 3rd party document verification services - `documentVerificationServiceName` string, nullable — Name of 3rd party document verifcation service - `documentVerificationServiceResponsePayload` object, nullable — General payload object - `documentVerified` boolean, nullable — True if document was verified as authentic by merchant or 3rd party service - `eventTime` number, nullable — Time of event in seconds since unix epoch (UTC, Jan 1, 1970). For example, 01/01/2015 00:00 is 1420070400 - `nationality` string, nullable — Document holder's nationality - `employmentInformation` EmploymentInformation[], nullable — Credit applicant's employment information - `employerAddress` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `employerCompanySizeRange` string, nullable — Employing company's number of employees - `employerIndustry` string, nullable — Employing company's industry - `employerName` string, nullable — Employing company's name - `employerPhone` string, nullable — Employing company's phone - `income` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `jobTitle` string, nullable — Job title - `personalDetails` PersonalDetails, required — Personal details are those which contribute to building up a picture of the person as an individual, such as name, title, etc.. - `birthdate` string, date, nullable — Date of birth. Use YYYY-MM-DD format. - `email` string, nullable — Email address - `firstName` string, nullable — First name - `fullName` string, nullable — Full name. Not Needed if firstName and LastName are provided independently. - `gender` 'MALE' | 'FEMALE' | 'CHOSE_NOT_TO_SPECIFY' | 'NONE', nullable — Gender - `lastName` string, nullable — Last name - `phone` Phone[], nullable — Phone details - `phone` string, required — Phone number including all country and local access codes - `smsVerified` object, nullable — This object contains information about steps taken to verify the customer's identity such as email or phone verifcations. - `sent` boolean, nullable — True if verification email was sent to email address or verification SMS was sent to phone number - `timeSent` number, nullable — Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970) - `verified` boolean, required — 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) - `cameraCaptured` boolean, nullable — True if payment instrument details were captured by OCR from a picture. False if payment instrument details were manually typed in - `cash` boolean, nullable — Payed with cash - `creditCard` object, nullable — This provides details relating to the credit card used. - `bin` string, required — Credit card's BIN (Bank Identification Number) - `cardBank` string, nullable — Credit card's issuing bank - `cardBrand` string, nullable — Credit Card's issuer brand - `cardType` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'UNKNOWN', nullable — Payment card type - `countryOfIssuance` string, nullable — Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code - `creditCardCorrelationId` string, nullable — Credit card - CorrelationId that was recieved by the init 3DS API - `expirationMonth` string, required — Credit card's expiration month, in MM format - `expirationYear` string, required — Credit card's expiration year, in YYYY format - `fingerprint` string, nullable — Unique identifier for card (sent by gateway or processor) - `fullCreditCard` string, nullable — Credit Card's full PAN - needed for the 3DS secure implementation - `fullResponsePayload` object, nullable — General payload object - `lastFourDigits` string, required — Credit card's last 4 digits (For Amex, take 4 digits from last digit) - `nameOnCard` string, required — Cardholder's full name - `paymentGatewayData` object, nullable — This provides information about the payment gateway - `gatewayName` string, nullable — Payment gateway name - `gatewayTransactionId` string, nullable — Unique transaction identifier (sent by gateway) - `paymentProcessorData` object, nullable — This provides information about the payment processor - `processorName` string, nullable — Payment processor name - `processorTransactionId` string, nullable — Unique transaction identifier (sent by processor) - `threeDSecure` object, nullable - `acquirerData` object, nullable — This provides information about the Acquirer of the transaction - `acquirerBIN` string, nullable — Bank acquirer BIN (Bank Identification Number) - `acquirerCountry` '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', nullable — Acquirer country - `acquirerMerchantId` string, nullable — Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor - `acquirerMerchantName` string, nullable — Merchant Name as appearing in processor records - `acquirerName` string, nullable — Bank acquirer Name - `merchantCategoryCode` number, nullable — 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. - `merchantCountryCode` number, nullable — Merchant country code is a three-digit number listed in ISO 3166‑1 (zero‑padded) - `challengeIndicator` 'NO_PREFERENCE' | 'NO_CHALLENGE' | 'CHALLENGE' | 'CHALLENGE_AS_MANDATE', nullable — Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation - `execute3ds` 'FORCE_3DS' | 'FORCE_DATA_ONLY' | 'NOT_SUPPORTED_BY_MERCHANT' | 'DYNAMIC_FORTER_DECISION', nullable — Request your preference regarding the execution of 3DS - `forcePsd2Exemption` object, nullable - `channel` 'THREEDS_RAILS' | 'AUTHORIZATION', required — The channel through which the exemption is requested - `type` 'LOW_VALUE' | 'TRANSACTION_RISK_ANALYSIS' | 'SECURE_CORPORATE' | 'TRUSTED_BENEFICIARY', required — The type of exemption requested - `requestChallenge` boolean, nullable — Indicates if a 3DS challenge should be requested from the Issuer ACS. - `threeDSServerTransID` string, required — 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 - `threeDsExecutor` 'FORTER' | 'MERCHANT', nullable — 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 - `verificationResults` CreditCardVerification, required — Credit card CVV and AVS results - `authorizationCode` string, nullable — Card authorization code from payment gateway. Required if both processorResponseText and processorResponseCode are not provided. - `authorizationProcessedWith3DS` boolean, nullable — 3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization - `avsFullResult` string, nullable — Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string - `avsNameResult` string, nullable — Name portion of card's AVS result (when available) - `avsStreetResult` string, nullable — Street address portion of card's AVS result - `avsZipResult` string, nullable — Zipcode portion of card's AVS result - `cavvResult` string, nullable — 3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response - `cvvResult` string, nullable — CVV result (if no data please send the value U) - `eciValue` string, nullable — 3DSecure - ECI value recieved from authorization/authentication response - `exemptionStatus` string, nullable — Exemption status as received from the processor - `external3dsVendorPayload` object, nullable — General payload object - `issuerResponseCode` string, nullable — Response code received from issuer - `issuerResponseText` string, nullable — Response text received from issuer - `liabilityShift` boolean, nullable — 3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer - `partyExecuted3DS` 'PSP' | 'FORTER' | 'BOTH', nullable — 3DSecure - Party executed the 3DS authentication - `processorResponseCode` string, nullable — Response code received from processor. Required if both processorResponseText and authorizationCode are not provided. - `processorResponseText` string, nullable — Response text received from processor. Required if both processorResponseCode and authorizationCode are not provided. - `threeDsInteractionMode` 'FRICTIONLESS' | 'CHALLENGED', nullable — 3DSecure - Indication of the friction that the user experienced - `threeDsStatus` string, nullable — 3DSecure - Status text received from 3D secure vendor - `threeDsVersion` string, nullable — 3DSecure - Version used in the transaction - `creditLineDetails` object, nullable — Details of credit line. - `askedToIncreaseCreditLineLimit` boolean, nullable — True if customer asked to increase credit line limit - `creditLineLimitIncreaseMethod` 'PRE_APPROVAL' | 'AT_PURCHASE', nullable — Method customer chose to ask to increase credit line limit - PRE_APPROVAL, AT_PURCHASE - `currentCreditLineLimit` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `originalCreditLineLimit` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `cryptoWallet` object, nullable — This provides information about the digital crypto wallet associated with the resipient or transaction. - `cryptoWalletName` string, nullable — Crypto wallet name - `cryptoWalletPaymentId` string, nullable — Crypto wallet payment ID - `cryptoWalletType` 'INTERNAL' | 'EXTERNAL', required — Crypto wallet type (Indicate whether wallet provider is internal to the site ecosystem) - `digitalWallet` object, nullable — This provides information about the digital wallet account associated with the customer or transaction. - `digitalWalletName` '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' | 'TRUSTLY' | 'PIX' | 'PAYCONIQ' | 'QRIS', required — Digital wallet name - `digitalWalletPayerEmail` string, nullable — Email address associated with the digital wallet account - `digitalWalletPayerId` string, nullable — Unique identifier for each digital wallet account. This ID should persist across all orders made by the same user, regardless of underlying payment methods. - `digitalWalletpaymentId` string, nullable — Digital wallet payment ID - `freeTextDigitalWalletName` string, nullable — Specifics about the source of the wallet such as the name / 3rd party name, etc. (required for OTHER digitalWalletName) - `fullDigitalWalletResponsePayload` object, nullable — General payload object - `payerAccountCountry` string, nullable — Digital wallet account country, two-letter ISO 3166-1 alpha-2 country code - `paymentSuccessStatus` string, nullable — Digital wallet payment status - `underlyingPaymentMethod` UnderlyingPaymentMethod, required — This provides details relating to an underlying payment method belongs to a digital wallet. - `bankTransfer` object, nullable — This object contains information regarding bank transfer payment methods. - `accountHolderFirstName` string, nullable — Bank account holder first name - `accountHolderLastName` string, nullable — Bank account holder last name - `achProcessingType` string, nullable — Type of ACH processing used in the transaction - `bankAccountIdentifier` string, required — Bank account unique identifier (IBAN or equivalent) - `bankAccountType` string, nullable — Type of bank account payment is made from (e.g. savings/checking, etc.) - `bankName` string, nullable — Name of bank payment is made from - `paymentGatewayData` object, nullable — This provides information about the payment gateway - `gatewayName` string, nullable — Payment gateway name - `gatewayTransactionId` string, nullable — Unique transaction identifier (sent by gateway) - `paymentSuccessStatus` string, nullable — Response text as received from the service provider - `serviceName` string, nullable — Payment method name - `bitcoin` boolean, nullable — Bitcoin payment details - `cash` boolean, nullable — Payed with cash - `creditCard` object, nullable — This provides details relating to a tokenized card. - `bin` string, nullable — Credit card's BIN (Bank Identification Number) - `cardBank` string, nullable — Credit card's issuing bank - `cardBrand` string, nullable — Credit card's issuer brand - `cardType` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'UNKNOWN', nullable — Payment card type - `countryOfIssuance` string, nullable — Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code - `creationTime` number, nullable — Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970) - `creditCardCorrelationId` string, nullable — Credit card - CorrelationId that was recieved by the init 3DS API - `expirationMonth` string, required — Credit card's expiration month, in MM format - `expirationYear` string, required — Credit card's expiration year, in YYYY format - `fullResponsePayload` object, nullable — General payload object - `lastFourDigits` string, nullable — Credit card's last 4 digits - `nameOnCard` string, nullable — Cardholder's full name - `paymentProcessorData` object, nullable — This provides information about the payment processor - `processorName` string, nullable — Payment processor name - `processorTransactionId` string, nullable — Unique transaction identifier (sent by processor) - `threeDSecure` object, nullable - `acquirerData` object, nullable — This provides information about the Acquirer of the transaction - … - `challengeIndicator` 'NO_PREFERENCE' | 'NO_CHALLENGE' | 'CHALLENGE' | 'CHALLENGE_AS_MANDATE', nullable — Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation - `execute3ds` 'FORCE_3DS' | 'FORCE_DATA_ONLY' | 'NOT_SUPPORTED_BY_MERCHANT' | 'DYNAMIC_FORTER_DECISION', nullable — Request your preference regarding the execution of 3DS - `forcePsd2Exemption` object, nullable - … - `requestChallenge` boolean, nullable — Indicates if a 3DS challenge should be requested from the Issuer ACS. - `threeDSServerTransID` string, required — 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 - `threeDsExecutor` 'FORTER' | 'MERCHANT', nullable — 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 - `token` string, required — Credit card token used by the merchant - `tokenType` 'PSP' | 'EMV_PAYMENT_TOKEN' | 'MERCHANT_GENERATED' | 'FORTER_TOKEN' | 'OTHER', nullable — Token type, determined by the party/protocol the token created by - `verificationResults` CreditCardVerification, required — Credit card CVV and AVS results - `authorizationCode` string, nullable — Card authorization code from payment gateway. Required if both processorResponseText and processorResponseCode are not provided. - `authorizationProcessedWith3DS` boolean, nullable — 3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization - `avsFullResult` string, nullable — Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string - `avsNameResult` string, nullable — Name portion of card's AVS result (when available) - `avsStreetResult` string, nullable — Street address portion of card's AVS result - `avsZipResult` string, nullable — Zipcode portion of card's AVS result - `cavvResult` string, nullable — 3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response - `cvvResult` string, nullable — CVV result (if no data please send the value U) - `eciValue` string, nullable — 3DSecure - ECI value recieved from authorization/authentication response - `exemptionStatus` string, nullable — Exemption status as received from the processor - `external3dsVendorPayload` object, nullable — General payload object - `issuerResponseCode` string, nullable — Response code received from issuer - `issuerResponseText` string, nullable — Response text received from issuer - `liabilityShift` boolean, nullable — 3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer - `partyExecuted3DS` 'PSP' | 'FORTER' | 'BOTH', nullable — 3DSecure - Party executed the 3DS authentication - `processorResponseCode` string, nullable — Response code received from processor. Required if both processorResponseText and authorizationCode are not provided. - `processorResponseText` string, nullable — Response text received from processor. Required if both processorResponseCode and authorizationCode are not provided. - `threeDsInteractionMode` 'FRICTIONLESS' | 'CHALLENGED', nullable — 3DSecure - Indication of the friction that the user experienced - `threeDsStatus` string, nullable — 3DSecure - Status text received from 3D secure vendor - `threeDsVersion` string, nullable — 3DSecure - Version used in the transaction - `underlyingPaymentMethodType` 'UNKNOWN' | 'CREDITCARD' | 'BANKTRANSFER' | 'CASH' | 'BITCOIN', required — Underlying payment method type used in current transaction - `giftCard` object, nullable — Information about various types of credits used to finance a transaction - `activationTime` number, nullable — Time credit/gift card was activated in the account, in seconds since unix epoch (UTC, Jan 1, 1970) - `creditCurrency` string, nullable — Original transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `creditOrigin` string, nullable — Source which created gift card for customer. - `merchantPaymentId` string, nullable — unique payment identifier for the merchant reference. - `value` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `installmentService` object, nullable — This provides details relating to the credit card used. - `firstName` string, nullable — Account holder's first name - `fullResponsePayload` object, nullable — General payload object - `lastName` string, nullable — Account holder's last name - `paymentId` string, nullable — Installment payment ID - `serviceName` string, nullable — Installment service's name - `serviceResponseCode` string, nullable — Response code received from installment service - `loyaltyPoints` object, nullable — Loyalty Points information is relevant when customers have entered some kind of loyalty program and are receiving points or other related value as a result - `loyaltyPointsCount` number, nullable — Number of points (miles, stars, etc.) - `loyaltyPointsSource` 'REFERRAL' | 'IN_ACCOUNT_PURCHASES' | 'PROMOTION' | 'COMPENSATION' | 'CARD_SCHEME_POINTS', nullable — Source of points (promo, referral, etc.) - `loyaltyPointsValue` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `merchantPaymentId` string, nullable — unique payment identifier for the merchant reference. - `merchantInitiated` object, nullable — Details about merchant initiated payment - `initialOrderId` string, nullable — Unique order/transaction identifier of the initial order (CIT). - `type` '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', nullable — Specifies the type of merchant-initiated payment - `mobileMoney` object, nullable — This provides information about the mobile money account associated with the customer or transaction. - `fullResponsePayload` object, nullable — General payload object - `mobileMoneyNetwork` 'MPESA' | 'MTN' | 'MPAWA' | 'MSHWAEI' | 'SAFARICOM' | 'DASH', required — Mobile money provider name - `paymentAcquirerData` object, nullable — This provides information about the Acquirer of the transaction - `acquirerBIN` string, nullable — Bank acquirer BIN (Bank Identification Number) - `acquirerCountry` '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', nullable — Acquirer country - `acquirerMerchantId` string, nullable — Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor - `acquirerMerchantName` string, nullable — Merchant Name as appearing in processor records - `acquirerName` string, nullable — Bank acquirer Name - `merchantCategoryCode` number, nullable — 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. - `merchantCountryCode` number, nullable — Merchant country code is a three-digit number listed in ISO 3166‑1 (zero‑padded) - `paymentGatewayData` object, nullable — This provides information about the payment gateway - `gatewayName` string, nullable — Payment gateway name - `gatewayTransactionId` string, nullable — Unique transaction identifier (sent by gateway) - `paymentSuccessStatus` string, required — Mobile money payment status - `phoneNumber` string, required — Account phone number - `numberOfInstallments` integer, nullable — Number of payments if customer chose to pay in several installments - `paymentMethodNickname` string, nullable — Nickname assigned to this payment method by the user - `paypal` object, nullable - `authorizationId` string, nullable — PayPal authorization ID - `fullPaypalResponsePayload` object, nullable — General payload object - `payerAccountCountry` string, nullable — PayPal account country, two-letter ISO 3166-1 alpha-2 country code - `payerAddressStatus` string, nullable — PayPal payer address status - `payerEmail` string, required — PayPal payer Email address - `payerId` string, required — PayPal payer ID - `payerStatus` string, nullable — PayPal payer status - `paymentGatewayData` object, nullable — This provides information about the payment gateway - `gatewayName` string, nullable — Payment gateway name - `gatewayTransactionId` string, nullable — Unique transaction identifier (sent by gateway) - `paymentId` string, nullable — PayPal payment ID - `paymentStatus` string, required — PayPal payment status - `protectionEligibility` string, nullable — PayPal protection eligibility - `recurringPayment` object, nullable - `currentPaymentNumber` integer, nullable — The number of payments processed in this recurring event including current transaction (1 for the original transaction) - `initialPaymentOrderId` string, required — Original order/transaction identifier that started the recurring event (payment number 1) - `isPaymentAmountIdenticalForAllPayments` boolean, nullable — True if the amount is constant between payments - `recurringPaymentExpirationDate` string, date, nullable — Date of last expected payment event. Use YYYY-MM-DD format. - `recurringPaymentFrequency` string, required — The number of days between transactions. - `totalNumberOfPayments` integer, nullable — Expected number of payments processed in this recurring event - `samsungPay` object, nullable — This provides details relating to a tokenized card. - `bin` string, nullable — Credit card's BIN (Bank Identification Number) - `cardBank` string, nullable — Credit card's issuing bank - `cardBrand` string, nullable — Credit card's issuer brand - `cardType` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'UNKNOWN', nullable — Payment card type - `countryOfIssuance` string, nullable — Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code - `creationTime` number, nullable — Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970) - `creditCardCorrelationId` string, nullable — Credit card - CorrelationId that was recieved by the init 3DS API - `expirationMonth` string, required — Credit card's expiration month, in MM format - `expirationYear` string, required — Credit card's expiration year, in YYYY format - `fullResponsePayload` object, nullable — General payload object - `lastFourDigits` string, nullable — Credit card's last 4 digits - `nameOnCard` string, nullable — Cardholder's full name - `paymentProcessorData` object, nullable — This provides information about the payment processor - `processorName` string, nullable — Payment processor name - `processorTransactionId` string, nullable — Unique transaction identifier (sent by processor) - `threeDSecure` object, nullable - `acquirerData` object, nullable — This provides information about the Acquirer of the transaction - `acquirerBIN` string, nullable — Bank acquirer BIN (Bank Identification Number) - `acquirerCountry` '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', nullable — Acquirer country - `acquirerMerchantId` string, nullable — Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor - `acquirerMerchantName` string, nullable — Merchant Name as appearing in processor records - `acquirerName` string, nullable — Bank acquirer Name - `merchantCategoryCode` number, nullable — 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. - `merchantCountryCode` number, nullable — Merchant country code is a three-digit number listed in ISO 3166‑1 (zero‑padded) - `challengeIndicator` 'NO_PREFERENCE' | 'NO_CHALLENGE' | 'CHALLENGE' | 'CHALLENGE_AS_MANDATE', nullable — Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation - `execute3ds` 'FORCE_3DS' | 'FORCE_DATA_ONLY' | 'NOT_SUPPORTED_BY_MERCHANT' | 'DYNAMIC_FORTER_DECISION', nullable — Request your preference regarding the execution of 3DS - `forcePsd2Exemption` object, nullable - `channel` 'THREEDS_RAILS' | 'AUTHORIZATION', required — The channel through which the exemption is requested - `type` 'LOW_VALUE' | 'TRANSACTION_RISK_ANALYSIS' | 'SECURE_CORPORATE' | 'TRUSTED_BENEFICIARY', required — The type of exemption requested - `requestChallenge` boolean, nullable — Indicates if a 3DS challenge should be requested from the Issuer ACS. - `threeDSServerTransID` string, required — 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 - `threeDsExecutor` 'FORTER' | 'MERCHANT', nullable — 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 - `token` string, required — Credit card token used by the merchant - `tokenType` 'PSP' | 'EMV_PAYMENT_TOKEN' | 'MERCHANT_GENERATED' | 'FORTER_TOKEN' | 'OTHER', nullable — Token type, determined by the party/protocol the token created by - `verificationResults` CreditCardVerification, required — Credit card CVV and AVS results - `authorizationCode` string, nullable — Card authorization code from payment gateway. Required if both processorResponseText and processorResponseCode are not provided. - `authorizationProcessedWith3DS` boolean, nullable — 3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization - `avsFullResult` string, nullable — Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string - `avsNameResult` string, nullable — Name portion of card's AVS result (when available) - `avsStreetResult` string, nullable — Street address portion of card's AVS result - `avsZipResult` string, nullable — Zipcode portion of card's AVS result - `cavvResult` string, nullable — 3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response - `cvvResult` string, nullable — CVV result (if no data please send the value U) - `eciValue` string, nullable — 3DSecure - ECI value recieved from authorization/authentication response - `exemptionStatus` string, nullable — Exemption status as received from the processor - `external3dsVendorPayload` object, nullable — General payload object - `issuerResponseCode` string, nullable — Response code received from issuer - `issuerResponseText` string, nullable — Response text received from issuer - `liabilityShift` boolean, nullable — 3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer - `partyExecuted3DS` 'PSP' | 'FORTER' | 'BOTH', nullable — 3DSecure - Party executed the 3DS authentication - `processorResponseCode` string, nullable — Response code received from processor. Required if both processorResponseText and authorizationCode are not provided. - `processorResponseText` string, nullable — Response text received from processor. Required if both processorResponseCode and authorizationCode are not provided. - `threeDsInteractionMode` 'FRICTIONLESS' | 'CHALLENGED', nullable — 3DSecure - Indication of the friction that the user experienced - `threeDsStatus` string, nullable — 3DSecure - Status text received from 3D secure vendor - `threeDsVersion` string, nullable — 3DSecure - Version used in the transaction - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `storeCreditUsed` object, nullable — Information about various types of credits used to finance a transaction - `activationTime` number, nullable — Time credit/gift card was activated in the account, in seconds since unix epoch (UTC, Jan 1, 1970) - `creditCurrency` string, nullable — Original transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `creditOrigin` string, nullable — Source which created gift card for customer. - `merchantPaymentId` string, nullable — unique payment identifier for the merchant reference. - `value` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `tokenizedCard` object, nullable — This provides details relating to a tokenized card. - `bin` string, nullable — Credit card's BIN (Bank Identification Number) - `cardBank` string, nullable — Credit card's issuing bank - `cardBrand` string, nullable — Credit card's issuer brand - `cardType` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'UNKNOWN', nullable — Payment card type - `countryOfIssuance` string, nullable — Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code - `creationTime` number, nullable — Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970) - `creditCardCorrelationId` string, nullable — Credit card - CorrelationId that was recieved by the init 3DS API - `expirationMonth` string, required — Credit card's expiration month, in MM format - `expirationYear` string, required — Credit card's expiration year, in YYYY format - `fullResponsePayload` object, nullable — General payload object - `lastFourDigits` string, nullable — Credit card's last 4 digits - `nameOnCard` string, nullable — Cardholder's full name - `paymentProcessorData` object, nullable — This provides information about the payment processor - `processorName` string, nullable — Payment processor name - `processorTransactionId` string, nullable — Unique transaction identifier (sent by processor) - `threeDSecure` object, nullable - `acquirerData` object, nullable — This provides information about the Acquirer of the transaction - `acquirerBIN` string, nullable — Bank acquirer BIN (Bank Identification Number) - `acquirerCountry` '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', nullable — Acquirer country - `acquirerMerchantId` string, nullable — Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor - `acquirerMerchantName` string, nullable — Merchant Name as appearing in processor records - `acquirerName` string, nullable — Bank acquirer Name - `merchantCategoryCode` number, nullable — 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. - `merchantCountryCode` number, nullable — Merchant country code is a three-digit number listed in ISO 3166‑1 (zero‑padded) - `challengeIndicator` 'NO_PREFERENCE' | 'NO_CHALLENGE' | 'CHALLENGE' | 'CHALLENGE_AS_MANDATE', nullable — Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation - `execute3ds` 'FORCE_3DS' | 'FORCE_DATA_ONLY' | 'NOT_SUPPORTED_BY_MERCHANT' | 'DYNAMIC_FORTER_DECISION', nullable — Request your preference regarding the execution of 3DS - `forcePsd2Exemption` object, nullable - `channel` 'THREEDS_RAILS' | 'AUTHORIZATION', required — The channel through which the exemption is requested - `type` 'LOW_VALUE' | 'TRANSACTION_RISK_ANALYSIS' | 'SECURE_CORPORATE' | 'TRUSTED_BENEFICIARY', required — The type of exemption requested - `requestChallenge` boolean, nullable — Indicates if a 3DS challenge should be requested from the Issuer ACS. - `threeDSServerTransID` string, required — 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 - `threeDsExecutor` 'FORTER' | 'MERCHANT', nullable — 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 - `token` string, required — Credit card token used by the merchant - `tokenType` 'PSP' | 'EMV_PAYMENT_TOKEN' | 'MERCHANT_GENERATED' | 'FORTER_TOKEN' | 'OTHER', nullable — Token type, determined by the party/protocol the token created by - `verificationResults` CreditCardVerification, required — Credit card CVV and AVS results - `authorizationCode` string, nullable — Card authorization code from payment gateway. Required if both processorResponseText and processorResponseCode are not provided. - `authorizationProcessedWith3DS` boolean, nullable — 3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization - `avsFullResult` string, nullable — Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string - `avsNameResult` string, nullable — Name portion of card's AVS result (when available) - `avsStreetResult` string, nullable — Street address portion of card's AVS result - `avsZipResult` string, nullable — Zipcode portion of card's AVS result - `cavvResult` string, nullable — 3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response - `cvvResult` string, nullable — CVV result (if no data please send the value U) - `eciValue` string, nullable — 3DSecure - ECI value recieved from authorization/authentication response - `exemptionStatus` string, nullable — Exemption status as received from the processor - `external3dsVendorPayload` object, nullable — General payload object - `issuerResponseCode` string, nullable — Response code received from issuer - `issuerResponseText` string, nullable — Response text received from issuer - `liabilityShift` boolean, nullable — 3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer - `partyExecuted3DS` 'PSP' | 'FORTER' | 'BOTH', nullable — 3DSecure - Party executed the 3DS authentication - `processorResponseCode` string, nullable — Response code received from processor. Required if both processorResponseText and authorizationCode are not provided. - `processorResponseText` string, nullable — Response text received from processor. Required if both processorResponseCode and authorizationCode are not provided. - `threeDsInteractionMode` 'FRICTIONLESS' | 'CHALLENGED', nullable — 3DSecure - Indication of the friction that the user experienced - `threeDsStatus` string, nullable — 3DSecure - Status text received from 3D secure vendor - `threeDsVersion` string, nullable — 3DSecure - Version used in the transaction - `venmo` object, nullable — This provides information about the Venmo account associated with the customer or transaction. - `fullVenmoResponsePayload` object, nullable — General payload object - `paymentId` string, nullable — Venmo payment ID - `token` string, required — Token representing the specific payment method used within the Venmo vault - `userId` string, required — Venmo userID - `userName` string, required — Venmo user name - `refundInformation` object, nullable — Details regarding the refund if the transaction has been refunded. - `isAutomatedRefund` boolean, nullable — True if automated - cases where refund is generated automatically by merchnat. For example where end user changed ordered item into a cheaper one - `isFullRefund` boolean, nullable — True, if refund is for the full transaction amount. False, if refund is only for partial amount of transaction. - `refundAmount` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `refundAuthorizationCode` string, nullable — Refund authorization code from payment gateway - `refundDate` string, date, nullable — Date the refund was payed. Use YYYY-MM-DD format. - `refundInitiatedBy` 'MERCHANT' | 'CUSTOMER', nullable — By whom the refund was intitiated (merchant or customer). - `refundMethod` 'BANK' | 'PAYPAL' | 'STORE_CREDIT' | 'ORIGINAL_PAYMENT_METHOD' | 'DIFFERENT_PAYMENT_METHOD', nullable — Description of the type of return method (bank, gift card points, loyalty points, etc.). - `refundStatus` 'REQUESTED' | 'DECLINED' | 'COMPLETED', nullable — The updated refund request status (When refund status is COMPLETED order status type should be RETURNED) - `returnedCartItems` Item[], nullable — A list of returned items. Required only if one or more items have been returned. - `basicItemData` BasicItemData, required — This is an item associated with the customer or transaction. - `category` string, nullable — Item category - `discount` object, nullable — This provides information relating to any kind of offer, coupon or other discount used by the customer. - `couponCodeUsed` string, required — Coupon code used - `couponDiscountAmount` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `couponDiscountPercent` string, nullable — Coupon discount amount - `name` string, required — Item name - `price` Amount, required — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `productId` string, nullable — Unique identifier for item that is common to all identical items (such as SKU, ISBN, etc.) - `quantity` number, required — Item quantity - `type` 'TANGIBLE' | 'NON_TANGIBLE', required — Tangible if physical item, non-tangible if any other product - `beneficiaries` Beneficiary[], nullable — List of all entities receiving or using purchased item (Recipients of physical or digital goods, passengers of transport services, guests of accommodation services, etc.) - `additionalVerificationDocuments` object, nullable — Additional Verification Documents includes any details gained from identifying documents or materials which the customer has shared. - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `documentDateOfBirth` string, date, nullable — Date of birth as appears on the document. Use YYYY-MM-DD format. - `documentExpiration` string, date, nullable — Document's exipration date. Use YYYY-MM-DD format. - `documentFirstName` string, nullable — First name as appears on the document - `documentIssuingState` string, nullable — Document issuing state or region - `documentLastName` string, nullable — Last name as appears on the document - `documentNumber` string, nullable — Official document's number (e.g. passport number, driving license number, etc.) - `documentSource` 'CAMERA_CAPTURED' | 'UPLOADED_FILE' | 'TYPED' | 'OTHER', required — Source of document (e.g. uploaded file, captured by camera, typed in by customer, etc.) - `documentStatus` 'SENT_TO_CLIENT' | 'RECEIVED_FROM_CLIENT' | 'ABANDONED_BY_CLIENT' | 'RECEIVED_FROM_CLIENT_FAULTY', nullable — Status of verification document (e.g. sent to customer, received by customer, abandoned by customer ). - `documentType` string, required — Type of document (Passport, ID, Driving license) - `documentVerificationServiceAnswer` string, nullable — Answer received from 3rd party document verification services - `documentVerificationServiceName` string, nullable — Name of 3rd party document verifcation service - `documentVerificationServiceResponsePayload` object, nullable — General payload object - `documentVerified` boolean, nullable — True if document was verified as authentic by merchant or 3rd party service - `eventTime` number, nullable — Time of event in seconds since unix epoch (UTC, Jan 1, 1970). For example, 01/01/2015 00:00 is 1420070400 - `nationality` string, nullable — Document holder's nationality - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `bankAccount` object, nullable — This object contains information regarding bank transfer payment methods. - `accountHolderFirstName` string, nullable — Bank account holder first name - `accountHolderLastName` string, nullable — Bank account holder last name - `achProcessingType` string, nullable — Type of ACH processing used in the transaction - `bankAccountIdentifier` string, required — Bank account unique identifier (IBAN or equivalent) - `bankAccountType` string, nullable — Type of bank account payment is made from (e.g. savings/checking, etc.) - `bankName` string, nullable — Name of bank payment is made from - `paymentGatewayData` object, nullable — This provides information about the payment gateway - `gatewayName` string, nullable — Payment gateway name - `gatewayTransactionId` string, nullable — Unique transaction identifier (sent by gateway) - `paymentSuccessStatus` string, nullable — Response text as received from the service provider - `serviceName` string, nullable — Payment method name - `comments` object, nullable — Comments are notes the customer included as part of their transaction, whether directed to the merchant or to the intended recipient. - `merchantComments` string, nullable — Comments by the merchant - `messageToBeneficiary` string, nullable — Comments the customer left to the beneficiary of the purchase made - `userCommentsToMerchant` string, nullable — Comments the customer left to the merchant - `cryptoWallet` object, nullable — This provides information about the digital crypto wallet associated with the resipient or transaction. - `cryptoWalletName` string, nullable — Crypto wallet name - `cryptoWalletPaymentId` string, nullable — Crypto wallet payment ID - `cryptoWalletType` 'INTERNAL' | 'EXTERNAL', required — Crypto wallet type (Indicate whether wallet provider is internal to the site ecosystem) - `identityCard` string, nullable — Recipient's identity card number - `loyaltyProgram` LoyaltyProgram[], nullable — Details regarding loyalty program customer entered to receive points for this order - `accountNumber` string, nullable — Customer's rewards/loyalty/frequent flyer account number - `loyaltyPointsValue` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `programName` string, nullable — Name of program - `programPoints` number, nullable — Customer's rewards/loyalty/frequent flyer miles/point/stars - `tier` string, nullable — Program tier name - `personalDetails` PersonalDetails, required — Personal details are those which contribute to building up a picture of the person as an individual, such as name, title, etc.. - `birthdate` string, date, nullable — Date of birth. Use YYYY-MM-DD format. - `email` string, nullable — Email address - `firstName` string, nullable — First name - `fullName` string, nullable — Full name. Not Needed if firstName and LastName are provided independently. - `gender` 'MALE' | 'FEMALE' | 'CHOSE_NOT_TO_SPECIFY' | 'NONE', nullable — Gender - `lastName` string, nullable — Last name - `phone` Phone[], nullable — Phone details - `phone` string, required — Phone number including all country and local access codes - `smsVerified` object, nullable — This object contains information about steps taken to verify the customer's identity such as email or phone verifcations. - `sent` boolean, nullable — True if verification email was sent to email address or verification SMS was sent to phone number - `timeSent` number, nullable — Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970) - `verified` boolean, required — 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) - `deliveryDetails` object, nullable — Delivery Details provides further information about the kind of delivery chosen by the customer. - `delayedDeliveryDate` string, date, nullable — Use only if customer explicitly selected a delayed delivery date beyond the merchant’s standard options. Use YYYY-MM-DD format. - `delayedDeliveryTime` number, nullable — Use only if customer explicitly selected a delayed delivery date, with specific time of day, beyond the merchant’s standard options. Should be sent in seconds since unix epoch (UTC, Jan 1, 1970). - `deliveryComments` string, nullable — Any comments or requests customer had for delivery - `deliveryMethod` string, required — Delivery method chosen by customer such as postal service, email, in game transfer, etc. - `deliveryPrice` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `deliveryType` 'DIGITAL' | 'PHYSICAL' | 'HYBRID', required — Type of delivery: PHYSICAL for any type of shipped goods. DIGITAL for non-shipped goods (services, gift cards etc.) - `itemReturnData` object, nullable — Additional data about the return - `posDetails` object, nullable — Point of sale information. - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `cardEntryMethod` 'SCANNED' | 'HAND_KEYED' | 'CHIP_READ' | 'UNKNOWN' | 'SAVED_IN_ACCOUNT' | 'SWIPED', required — Credit card entry method - `cashierId` string, required — Employee identifier - `departmentId` string, required — Unique store department identifier - `storeBusinessUnit` string, required — Store business unit - `storeId` string, required — Unique store identifier - `storeName` string, required — Store name - `workStationId` string, required — Unique work-station identifier - `returnCondition` string, nullable — Condition of the item returned - `returnInternalReasonCategory` string, nullable — The reason for the return as defined by the merchant - `returnMethod` 'ONLINE' | 'IN-STORE', nullable — Method of return, e.g. online, in-store - `returnReasonCategory` 'CHANGED_MY_MIND' | 'DOES_NOT_FIT' | 'NOT_AS_DESCRIBED' | 'WRONG_ITEM' | 'ARRIVED_TOO_LATE' | 'LOW_QUALITY' | 'DAMAGED_GOODS' | 'GIFT_RETURN' | 'RETURN_TO_SENDER' | 'RETURN_POLICY_EXCEPTION' | 'OTHER' | 'UNKNOWN' | 'ENTIRE_ORDER_NOT_RECEIVED' | 'OUTBOUND_ISSUE_CARRIER' | 'OUTBOUND_ISSUE_MERCHANT' | 'FAILED_DELIVERY' | 'INBOUND_LOSS' | 'INBOUND_ISSUE_CARRIER', nullable — Reason for return - `returnSegment` string, nullable — Specific return segment as defined by the merchant - `returnStatusLog` object, nullable — Status of the return process - `arrivedToWarehouse` boolean, nullable — Indicates that the returned items arrived to the merchant's warehouse - `arrivedToWarehouseTime` number, nullable — Time returned items arrived to the merchant's warehouse - `returnInitiated` boolean, nullable — Indicates that the customer initiated a return process online - `returnInitiationTime` number, nullable — Time online return was initiated - `shippedByCustomer` boolean, nullable — Indicates that the customer has shipped the returned items back to the merchant - `shippedByCustomerTime` number, nullable — Time returned items were shipped by the customer - `typeOfCompensationRequested` 'REPLACEMENT' | 'REFUND' | 'REFUND_UPON_RETURN' | 'CREDIT' | 'MIXED' | 'UNKNOWN' | 'NO_COMPENSATION', nullable — Indicates whether the customer requested a refund, store credit, replacement etc. - `updatedReturnStatus` 'ACCEPTED_BY_MERCHANT' | 'REJECTED_BY_MERCHANT' | 'PARTIALLY_ACCEPTED_BY_MERCHANT', nullable — The updated status of the return on the merchant's side - `itemSpecificData` object, nullable — These are the details relating to the particular item purchased. This object should be used whenever additional industry specific data is available on a cart item - `accommodation` object, nullable — In cases where the transaction involves purchasing accommodation, Accommodation Item gives details relating to the type of accommodation purchased. - `accommodationAddress` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `accommodationName` string, nullable — Name of the facility - `duration` object, nullable — An object that represents a duration in days. Note that the endDate must be greater than or equal to the startDate. The required date format is YYYY-MM-DD. - `endDate` string, date, required — Date service/item ends or becomes unavailable. Use YYYY-MM-DD format. - `startDate` string, date, required — Date service/item begins or becomes available. Use YYYY-MM-DD format. - `housingType` string, nullable — Type of room/housing - `isRefundable` boolean, nullable — True if order can be cancelled and refunded - `location` object, nullable — General location (city level) - `airportCode` string, nullable — Three letter IATA airport code - `city` string, nullable — City - `country` string, nullable — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. - `seaportCode` string, nullable — Five letter seaport code - `numberOfGuests` number, required — Number of guests - `rating` Rating[], nullable — All ratings given to item or service. Can include internal peer rating, merchant rating, official professional association ratings, etc. - `score` string, nullable — Rating score (numeric - 97 or textual - 'Excellent') - `source` string, nullable — Source of rating, for example tripAdvisor, yelp, etc. - `type` 'INTERNAL_PEERS' | 'INTERNAL_MERCHANT' | 'EXTERNAL_PEERS' | 'EXTERNAL_INDEPENDENT', nullable — Rating type. Internal if rating was generated within the merchant's site or community, otherwise external. - `type` 'HOTEL' | 'APARTMENT' | 'CRUISE' | 'STUDIO' | 'EVENT_VENUE', nullable — Type of accommodation service - `cryptocurrency` object, nullable — Details relating to cryptocurrency purchases - `destinationWallet` string, nullable — Destination wallet address - `digitalGoodsAndServices` object, nullable — Service Item is used for services sold such as subscriptions, outsourcing projects, etc. - `automaticRenewal` boolean, nullable — True if customer chose to have service automatically renewed once current service ends - `billingFrequency` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'MULTI_ANNUAL' | 'OTHER', nullable — The frequency customer has chosen for billing - `duration` object, nullable — An object that represents a duration in days. Note that the endDate must be greater than or equal to the startDate. The required date format is YYYY-MM-DD. - `endDate` string, date, required — Date service/item ends or becomes unavailable. Use YYYY-MM-DD format. - `startDate` string, date, required — Date service/item begins or becomes available. Use YYYY-MM-DD format. - `isTrial` boolean, nullable — True if the product\service begins with a free trial - `webHosting` object, nullable — Details relating to web hosting related items or products - `SSLcertificates` boolean, nullable — True if customer asked or paid extra for SSL certificates to be included - `domains` string[], nullable — List of domains purchased - `emailService` boolean, nullable — True if customer asked or paid extra for Email functionality - `privateRegistration` boolean, nullable — True if customer asked or paid extra to hide registrant details from whois services - `sercurityUpgrades` boolean, nullable — True if customer asked or paid extra for security upgrades (antivirus, firewall, etc.) - `webPromotion` boolean, nullable — True if customer asked or paid extra for promotion services such as SEO - `websiteBuilder` boolean, nullable — True if customer asked or paid extra for website builder wizard services - `food` object, nullable — If the item purchased is somekind of food, this gives further details describing the item more precisely. - `restaurantAddress` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `restaurantId` string, nullable — Restaurant unique identifier - `restaurantName` string, nullable — The name of the restaurant - `tipAmount` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `gaming` object, nullable — This includes details relevant to computer gaming related items, the player involved and how it is being played by the customer. - `characterName` string, nullable — In-game character name - `characterRole` string, nullable — Character's role in the game - `gameGenre` string, nullable — Game type/genre - `gameItemAmount` number, nullable — Number of game items or commodities bought (100 coins, 2000 gold, 10 experience points, etc.) - `gameName` string, required — Game name - `gamePlatform` string, nullable — Game platform - `gameServerCountry` string, nullable — Country, two-letter ISO 3166-1 alpha-2 country code - `gameServerName` string, nullable — Game server name - `inGameTradeLocation` string, nullable — In-Game trade location - `playerFaction` string, nullable — Player's in-game faction/clan/group - `playerLeague` string, nullable — Player's in-game league - `playerLevel` string, nullable — Player's in-game level - `playerPosition` string, nullable — Player's in-game position - `personNameRecord` string, nullable — Person Name Record (PNR). Combined with a passenger name, it serves as an identifier for a flight reservation (also for multiple passengers) - `physicalGoods` object, nullable — If the item purchased is a physical item, this gives further details describing the item more precisely. - `wrapAsGift` boolean, nullable — True if customer chose to have item wrapped as a gift - `professionalServices` object, nullable — Additional information regarding professional services, such as event planning, web design, etc. - `numberOfParticipatingClients` number, nullable — Number of clients associated with this service. Would be greater than 1 in cases where the service is given to multiple clients, for example, a bride and a groom at a wedding. - `numberOfParticipatingVendors` number, nullable — Number of vendors associated with this service. Would be greater than 1 in cases where several vendors collaborate to offer the service. - `tipAmount` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `ticketsAndEvents` object, nullable — Ticket Item is used for tickets and events. - `eventLocation` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `zip` string, nullable — Zipcode - `eventName` string, required — Name of the event - `eventTime` number, nullable — Time of event in seconds since unix epoch (UTC, Jan 1, 1970). For example, 01/01/2015 00:00 is 1420070400 - `eventType` string, nullable — Type of event (movie, concert, sports, etc.) - `eventVenueName` string, nullable — Name of venue where event takes place - `ticketCategory` 'ADULT' | 'CHILD' | 'ENFANT' | 'SENIOR' | 'STUDENT' | 'VETERAN' | 'OTHER', nullable — Ticket category (adult, student, senior, child, etc.) - `ticketClass` string, nullable — Class of tickets purchased (Standing, VIP, Platinum, etc.) - `transport` TransportItem[], nullable — Additional information regarding transportation services or products - `bookingSource` string, nullable — Use to indicate the affiliate, origin, internal source or flow that this part of the booking is associated with - `carrier` string, nullable — Company operating transportation service purchased (airline, car rental company, etc.) - `class` string, nullable — Seating class (Tourist, business, first, etc.) - `driverDetails` object, nullable — This provides a more detailed picture of the seller - their details, actions etc.. - `availableFundsForWithdrawal` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `dateOfFirstSale` number, nullable — Date of first sale by seller, in seconds since unix epoch (UTC, Jan 1, 1970) - `ratingAsBuyer` object, nullable — With the increasingly peer-led, peer-reviewed, highly social nature of online commerce, ratings are often available connected to the customer or the purchase. - `score` string, nullable — Rating score (numeric - 97 or textual - 'Excellent') - `source` string, nullable — Source of rating, for example tripAdvisor, yelp, etc. - `type` 'INTERNAL_PEERS' | 'INTERNAL_MERCHANT' | 'EXTERNAL_PEERS' | 'EXTERNAL_INDEPENDENT', nullable — Rating type. Internal if rating was generated within the merchant's site or community, otherwise external. - `ratingAsSeller` object, nullable — With the increasingly peer-led, peer-reviewed, highly social nature of online commerce, ratings are often available connected to the customer or the purchase. - `score` string, nullable — Rating score (numeric - 97 or textual - 'Excellent') - `source` string, nullable — Source of rating, for example tripAdvisor, yelp, etc. - `type` 'INTERNAL_PEERS' | 'INTERNAL_MERCHANT' | 'EXTERNAL_PEERS' | 'EXTERNAL_INDEPENDENT', nullable — Rating type. Internal if rating was generated within the merchant's site or community, otherwise external. - `sellerAccountCreationDate` number, required — Date seller account was created in seconds since unix epoch (UTC, Jan 1, 1970) - `sellerLastLoginIP` object, nullable — This provides information about the IP address associated with the customer or transaction. - `ip` string, required — Customer IP address in v4 format - `updateTimes` object, nullable — This provides information regarding the times associated with any updates made to the account or transaction. - … - `sellerPastSalesCount` integer, nullable — Count of all successfully fulfilled sales made - `sellerPersonalDetails` object, nullable — Personal details are those which contribute to building up a picture of the person as an individual, such as name, title, etc.. - `birthdate` string, date, nullable — Date of birth. Use YYYY-MM-DD format. - `email` string, nullable — Email address - `firstName` string, nullable — First name - `fullName` string, nullable — Full name. Not Needed if firstName and LastName are provided independently. - `gender` 'MALE' | 'FEMALE' | 'CHOSE_NOT_TO_SPECIFY' | 'NONE', nullable — Gender - `lastName` string, nullable — Last name - `sellerRegistrationIP` object, nullable — This provides information about the IP address associated with the customer or transaction. - `ip` string, required — Customer IP address in v4 format - `updateTimes` object, nullable — This provides information regarding the times associated with any updates made to the account or transaction. - … - `duration` object, nullable — An object that represents exact duration in seconds. Note that the endTime must be greater than or equal to the startTime. The required timestamp format is seconds since unix epoch (UTC, Jan 1, 1970) - `endTime` integer, required — Unix timestamp in seconds of when service/item ends or becomes unavailable in seconds since unix epoch (UTC, Jan 1, 1970) - `startTime` number, required — Unix timestamp in seconds of when service/item begins or becomes available in seconds since unix epoch (UTC, Jan 1, 1970) - `endPoint` object, nullable — An object that contains either exact or broad information about a physical location associated with the transaction or customer. - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - … - `zip` string, nullable — Zipcode - `exactLocation` object, nullable — Details of a location in lat/long coordinates - `latitude` number, nullable — Latitude in Decimal Degrees (WGS84) - `longitude` number, nullable — Longitude in Decimal Degrees (WGS84) - `source` string, nullable — Source of location data - `locationName` object, nullable — An object that contains the name of a physical location, either as submitted by the end-user, or as assigned by the merchant. - `isTextSearchResult` boolean, nullable — Set to true if the user searched for the location name to find the exact location (as opposed to location being generated by the app based on device location) - `specificLocationName` string, nullable — Specific location name. Can be used for locations named by the end-user (e.g. "Beth's office") or for merchant assigned names (based on 3rd party tools or other sources) - `specificLocationType` string, nullable — Specific location type. - `roughLocation` object, nullable — General location (city level) - `airportCode` string, nullable — Three letter IATA airport code - `city` string, nullable — City - `country` string, nullable — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. - `seaportCode` string, nullable — Five letter seaport code - `savedLocation` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `expeditedBoarding` boolean, nullable — True if customer paid extra for expedited boarding - `extraBaggage` boolean, nullable — True if customer paid extra to bring extra baggage - `leg` integer, nullable — Use to indicate the order of arrival to each point on the route. Original departure point should get leg=0, first connection should get leg=1, etc. final destination should get leg=(number of stops-1) - `locationAtTimeOfReservation` object, nullable — An object that contains either exact or broad information about a physical location associated with the transaction or customer. - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - … - `zip` string, nullable — Zipcode - `exactLocation` object, nullable — Details of a location in lat/long coordinates - `latitude` number, nullable — Latitude in Decimal Degrees (WGS84) - `longitude` number, nullable — Longitude in Decimal Degrees (WGS84) - `source` string, nullable — Source of location data - `locationName` object, nullable — An object that contains the name of a physical location, either as submitted by the end-user, or as assigned by the merchant. - `isTextSearchResult` boolean, nullable — Set to true if the user searched for the location name to find the exact location (as opposed to location being generated by the app based on device location) - `specificLocationName` string, nullable — Specific location name. Can be used for locations named by the end-user (e.g. "Beth's office") or for merchant assigned names (based on 3rd party tools or other sources) - `specificLocationType` string, nullable — Specific location type. - `roughLocation` object, nullable — General location (city level) - `airportCode` string, nullable — Three letter IATA airport code - `city` string, nullable — City - `country` string, nullable — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. - `seaportCode` string, nullable — Five letter seaport code - `savedLocation` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `passengers` number, nullable — Number of passengers - `purchasedMeals` boolean, nullable — True if customer paid extra to receive meals on board - `selectSeat` boolean, nullable — True if customer paid extra to select a seat - `startPoint` Location, required — An object that contains either exact or broad information about a physical location associated with the transaction or customer. - `address` object, nullable — Address description - `address1` string, nullable — Street-level address. Required when full address details are available - `address2` string, nullable — Unit-level address - `city` string, nullable — City. Required when full address details are available - `company` string, nullable — Company - `country` string, required — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York) - `savedData` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - … - `zip` string, nullable — Zipcode - `exactLocation` object, nullable — Details of a location in lat/long coordinates - `latitude` number, nullable — Latitude in Decimal Degrees (WGS84) - `longitude` number, nullable — Longitude in Decimal Degrees (WGS84) - `source` string, nullable — Source of location data - `locationName` object, nullable — An object that contains the name of a physical location, either as submitted by the end-user, or as assigned by the merchant. - `isTextSearchResult` boolean, nullable — Set to true if the user searched for the location name to find the exact location (as opposed to location being generated by the app based on device location) - `specificLocationName` string, nullable — Specific location name. Can be used for locations named by the end-user (e.g. "Beth's office") or for merchant assigned names (based on 3rd party tools or other sources) - `specificLocationType` string, nullable — Specific location type. - `roughLocation` object, nullable — General location (city level) - `airportCode` string, nullable — Three letter IATA airport code - `city` string, nullable — City - `country` string, nullable — Country, two-letter ISO 3166-1 alpha-2 country code - `region` string, nullable — Top-level administrative subdivision - state/province/department/etc. - `seaportCode` string, nullable — Five letter seaport code - `savedLocation` object, nullable — Saved Data refers to information which persists in the account settings, such as address or payment information. - `choseToSaveData` boolean, nullable — True if customer chose to save data in the account for future use - `usedSavedData` boolean, nullable — True if customer chose to use data saved in the account - `type` 'PRIVATE_TAXI' | 'PRIVATE_VIP_TAXI' | 'PRIVATE_LARGE_TAXI' | 'SHARED_RIDE' | 'SHARED_RIDE_DISCOUNT' | 'AIR_TRAVEL' | 'RAIL' | 'FERRY' | 'BUS' | 'CAR_RENTAL' | 'PARKING' | 'CRUISE_LINE', required — Type of transportation service - `pendingAddition` boolean, nullable — Indicates whether the item is pending decision to be added to cart - `seller` object, nullable — This reflects the information known about the seller. - `sellerBusinessWebsite` string, nullable — Seller's business website URL - `sellerCategory` string, nullable — Type of service offered by the seller - `sellerDetails` BasicSellerData, required — This provides a more detailed picture of the seller - their details, actions etc.. - `availableFundsForWithdrawal` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `dateOfFirstSale` number, nullable — Date of first sale by seller, in seconds since unix epoch (UTC, Jan 1, 1970) - `ratingAsBuyer` object, nullable — With the increasingly peer-led, peer-reviewed, highly social nature of online commerce, ratings are often available connected to the customer or the purchase. - `score` string, nullable — Rating score (numeric - 97 or textual - 'Excellent') - `source` string, nullable — Source of rating, for example tripAdvisor, yelp, etc. - `type` 'INTERNAL_PEERS' | 'INTERNAL_MERCHANT' | 'EXTERNAL_PEERS' | 'EXTERNAL_INDEPENDENT', nullable — Rating type. Internal if rating was generated within the merchant's site or community, otherwise external. - `ratingAsSeller` object, nullable — With the increasingly peer-led, peer-reviewed, highly social nature of online commerce, ratings are often available connected to the customer or the purchase. - `score` string, nullable — Rating score (numeric - 97 or textual - 'Excellent') - `source` string, nullable — Source of rating, for example tripAdvisor, yelp, etc. - `type` 'INTERNAL_PEERS' | 'INTERNAL_MERCHANT' | 'EXTERNAL_PEERS' | 'EXTERNAL_INDEPENDENT', nullable — Rating type. Internal if rating was generated within the merchant's site or community, otherwise external. - `sellerAccountCreationDate` number, required — Date seller account was created in seconds since unix epoch (UTC, Jan 1, 1970) - `sellerLastLoginIP` object, nullable — This provides information about the IP address associated with the customer or transaction. - `ip` string, required — Customer IP address in v4 format - `updateTimes` object, nullable — This provides information regarding the times associated with any updates made to the account or transaction. - `creationTime` number, nullable — Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970) - `lastModifiedTime` number, nullable — Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970) - `lastUsed` number, nullable — Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970) - `removalTime` number, nullable — Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970) - `sellerPastSalesCount` integer, nullable — Count of all successfully fulfilled sales made - `sellerPersonalDetails` object, nullable — Personal details are those which contribute to building up a picture of the person as an individual, such as name, title, etc.. - `birthdate` string, date, nullable — Date of birth. Use YYYY-MM-DD format. - `email` string, nullable — Email address - `firstName` string, nullable — First name - `fullName` string, nullable — Full name. Not Needed if firstName and LastName are provided independently. - `gender` 'MALE' | 'FEMALE' | 'CHOSE_NOT_TO_SPECIFY' | 'NONE', nullable — Gender - `lastName` string, nullable — Last name - `sellerRegistrationIP` object, nullable — This provides information about the IP address associated with the customer or transaction. - `ip` string, required — Customer IP address in v4 format - `updateTimes` object, nullable — This provides information regarding the times associated with any updates made to the account or transaction. - `creationTime` number, nullable — Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970) - `lastModifiedTime` number, nullable — Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970) - `lastUsed` number, nullable — Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970) - `removalTime` number, nullable — Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970) - `sellerVendorName` string, nullable — Name of the vendor - `shopifyAdditionalItemData` object, nullable — Object for additional Shopify cart item data - `properties` object, nullable — General payload object - `statusChangeReason` string, nullable — Reason the status changed, if applicable. Mainly relevant for cases an order was canceled (due to a fraud decision / stock / customer request / etc) - `updatedMerchantStatus` string, nullable — The new status as defined in the merchant's system - `updatedStatus` 'PROCESSING' | 'SENT' | 'COMPLETED' | 'CANCELED_BY_MERCHANT' | 'CANCELED_BY_CUSTOMER' | 'RETURNED' | 'NO_SHOW' | 'REPLACED', required — The updated order status type - `updatedTotalAmount` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `updatedTotalDiscount` object, nullable — This provides information relating to any kind of offer, coupon or other discount used by the customer. - `couponCodeUsed` string, required — Coupon code used - `couponDiscountAmount` object, nullable — A monetary amount in USD or local currenncy. - `amountLocalCurrency` string, nullable — Transaction amount in currency chosen by the buyer - `amountUSD` string, nullable — Transaction amount in USD - `currency` string, nullable — Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code - `couponDiscountPercent` string, nullable — Coupon discount amount - `updatedTryOutStatus` 'NONE' | 'EMAIL_SENT_TO_CUSTOMER' | 'CALLED_TO_CUSTOMER' | 'CUSTOMER_VISITED_PAGE' | 'CUSTOMER_DECLARED_SENDBACK' | 'SHIPPING_REPORTED_SENDBACK' | 'RETURNED_ITEMS_ARRIVED_PENDING' | 'MISSING_ITEMS' | 'MANUAL_RESOLUTION' | 'CHARGE_ATTEMPT' | 'FORFEIT' | 'COMPLETED', nullable — The updated TryOut flow status type - `verificationResults` object, nullable — Credit card CVV and AVS results - `authorizationCode` string, nullable — Card authorization code from payment gateway. Required if both processorResponseText and processorResponseCode are not provided. - `authorizationProcessedWith3DS` boolean, nullable — 3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization - `avsFullResult` string, nullable — Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string - `avsNameResult` string, nullable — Name portion of card's AVS result (when available) - `avsStreetResult` string, nullable — Street address portion of card's AVS result - `avsZipResult` string, nullable — Zipcode portion of card's AVS result - `cavvResult` string, nullable — 3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response - `cvvResult` string, nullable — CVV result (if no data please send the value U) - `eciValue` string, nullable — 3DSecure - ECI value recieved from authorization/authentication response - `exemptionStatus` string, nullable — Exemption status as received from the processor - `external3dsVendorPayload` object, nullable — General payload object - `issuerResponseCode` string, nullable — Response code received from issuer - `issuerResponseText` string, nullable — Response text received from issuer - `liabilityShift` boolean, nullable — 3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer - `partyExecuted3DS` 'PSP' | 'FORTER' | 'BOTH', nullable — 3DSecure - Party executed the 3DS authentication - `processorResponseCode` string, nullable — Response code received from processor. Required if both processorResponseText and authorizationCode are not provided. - `processorResponseText` string, nullable — Response text received from processor. Required if both processorResponseCode and authorizationCode are not provided. - `threeDsInteractionMode` 'FRICTIONLESS' | 'CHALLENGED', nullable — 3DSecure - Indication of the friction that the user experienced - `threeDsStatus` string, nullable — 3DSecure - Status text received from 3D secure vendor - `threeDsVersion` string, nullable — 3DSecure - Version used in the transaction ## Response `200` Example statusResponse - StatusResponse — The response object following status request to the system - `message` string, required — The message containing status response text - `status` string, required — Status of the request processing ## Other responses - `400` — Bad Request (Often missing a required parameter) - `401` — Unauthorized (No valid API key provided) - `404` — Not Found (The requested item doesn't exist) - `429` — Too Many Requests (The client exceeded a rate limit). Honor Retry-After before retrying. - `500` — Server Error (Something went wrong on Forter's end) - `default` — Typed error envelope for any undeclared 4xx / 5xx status. --- [API](https://skmtc.net/forter/apis/forter-api.md) · [All operations](https://skmtc.net/forter/apis/forter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/forter/forter-api/revisions/d7b02e919b34/schema)