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

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.

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

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

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

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.

", "customType": "statusRequest", "schema": [ { "name": "additionalInformation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "additionalOrderId", "kind": "optional", "type": "string", "nullable": true, "description": "

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.

", "example": "12fdsh09820fdvr65", "maxLength": 100 }, { "name": "cartItems", "kind": "optional", "type": "array", "conditional": true, "nullable": true, "description": "Conditional.\nAn updated list of all items purchased and shipping details. Required only if one or more items have changed.", "modelRef": "#/components/schemas/Item", "customType": "Item[]", "schema": [ { "name": "basicItemData", "kind": "required", "type": "object", "description": "

General data regarding item such as name, price, etc.

", "modelRef": "#/components/schemas/BasicItemData", "customType": "BasicItemData", "schema": [ { "name": "category", "kind": "optional", "type": "string", "nullable": true, "description": "Item category", "example": "Apparel and accessories", "maxLength": 1000 }, { "name": "discount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Discount", "description": "", "modelRef": "#/components/schemas/Discount", "schema": [ { "name": "couponCodeUsed", "kind": "required", "type": "string", "description": "Coupon code used", "example": "FATHERSDAY2015", "maxLength": 150 }, { "name": "couponDiscountAmount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "couponDiscountPercent", "kind": "optional", "type": "string", "nullable": true, "description": "Coupon discount amount" } ] } ], "schema": [] }, { "name": "name", "kind": "required", "type": "string", "description": "Item name", "example": "White GenericBrand handbag", "maxLength": 500 }, { "name": "price", "kind": "required", "type": "object", "description": "

Final amount due for purchase, after all discounts and promotions

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

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] }, { "name": "productId", "kind": "optional", "type": "string", "nullable": true, "description": "

Unique identifier for item that is common to all identical items (such as SKU, ISBN, etc.)

", "example": "Ag54352R7768kkO", "maxLength": 70 }, { "name": "quantity", "kind": "required", "type": "number", "description": "Item quantity", "example": 1 }, { "name": "type", "kind": "required", "type": "string", "description": "

Tangible if physical item, non-tangible if any other product

", "example": "TANGIBLE", "enum": [ "TANGIBLE", "NON_TANGIBLE" ] } ] }, { "name": "beneficiaries", "kind": "optional", "type": "array", "nullable": true, "description": "

List of all entities receiving or using purchased item (Recipients of physical or digital goods, passengers of transport services, guests of accommodation services, etc.)

", "modelRef": "#/components/schemas/Beneficiary", "customType": "Beneficiary[]", "schema": [ { "name": "additionalVerificationDocuments", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AdditionalVerificationDocuments", "description": "", "modelRef": "#/components/schemas/AdditionalVerificationDocuments", "schema": [ { "name": "documentDateOfBirth", "kind": "optional", "type": "string", "nullable": true, "description": "

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

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

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

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

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

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

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

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

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

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

Type of document (Passport, ID, Driving license)

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

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

is 1420070400

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

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

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

Unit-level address

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

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

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

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

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

Bank account unique identifier (IBAN or equivalent)

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

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

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

Unique transaction identifier (sent by gateway)

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

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

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

Customer's rewards/loyalty/frequent flyer account number

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

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

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

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

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

Personal information such as name, birthdate and email

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

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

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

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

", "example": 1389567341 }, { "name": "verified", "kind": "required", "type": "boolean", "description": "

True if customer received email verification message to this address and clicked-through back to merchant's site, or received SMS message and enterd code in merchant's site (two-factor authentication)

", "example": false } ] } ] } ] }, { "name": "deliveryDetails", "kind": "required", "type": "object", "description": "Delivery details used for this item. Required if different items have different delivery information not specified in primaryDeliveryDetails", "modelRef": "#/components/schemas/DeliveryDetails", "customType": "DeliveryDetails", "schema": [ { "name": "delayedDeliveryDate", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Use only if customer explicitly selected a delayed delivery date beyond the merchant’s standard options. Use YYYY-MM-DD format.

", "example": "2014-12-15", "format": "date" }, { "name": "delayedDeliveryTime", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\n

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).

", "example": 1415273168 }, { "name": "deliveryComments", "kind": "optional", "type": "string", "nullable": true, "description": "Any comments or requests customer had for delivery", "example": "Please call before arriving, Thanks!", "maxLength": 255 }, { "name": "deliveryMethod", "kind": "required", "type": "string", "description": "

Delivery method chosen by customer such as postal service, email, in game transfer, etc.

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

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "deliveryType", "kind": "required", "type": "string", "description": "

Type of delivery: PHYSICAL for any type of shipped goods. DIGITAL for non-shipped goods (services, gift cards etc.)

", "example": "PHYSICAL", "enum": [ "DIGITAL", "PHYSICAL", "HYBRID" ] } ] }, { "name": "itemReturnData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ReturnData", "description": "", "modelRef": "#/components/schemas/ReturnData", "schema": [ { "name": "posDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PointOfSaleDetails", "description": "", "modelRef": "#/components/schemas/PointOfSaleDetails", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "cardEntryMethod", "kind": "required", "type": "string", "description": "Credit card entry method", "example": "SCANNED", "enum": [ "SCANNED", "HAND_KEYED", "CHIP_READ", "UNKNOWN", "SAVED_IN_ACCOUNT", "SWIPED" ] }, { "name": "cashierId", "kind": "required", "type": "string", "description": "Employee identifier", "example": "fgh5e0rr48923d", "maxLength": 40 }, { "name": "departmentId", "kind": "required", "type": "string", "description": "Unique store department identifier", "example": "e0r4592356fds", "maxLength": 40 }, { "name": "storeBusinessUnit", "kind": "required", "type": "string", "description": "Store business unit", "example": "Full Line", "maxLength": 40 }, { "name": "storeId", "kind": "required", "type": "string", "description": "Unique store identifier", "example": "2356fdse0rr489", "maxLength": 40 }, { "name": "storeName", "kind": "required", "type": "string", "description": "Store name", "example": "Union Square", "maxLength": 40 }, { "name": "workStationId", "kind": "required", "type": "string", "description": "

Unique work-station identifier

", "example": "923e5th5e0rr48", "maxLength": 40 } ] } ], "schema": [] }, { "name": "returnCondition", "kind": "optional", "type": "string", "nullable": true, "description": "Condition of the item returned", "example": "DAMAGED", "maxLength": 40 }, { "name": "returnInternalReasonCategory", "kind": "optional", "type": "string", "nullable": true, "description": "The reason for the return as defined by the merchant", "example": "defective item", "maxLength": 40 }, { "name": "returnMethod", "kind": "optional", "type": "string", "nullable": true, "description": "

Method of return, e.g. online, in-store

", "example": "ONLINE", "enum": [ "ONLINE", "IN-STORE" ] }, { "name": "returnReasonCategory", "kind": "optional", "type": "string", "nullable": true, "description": "Reason for return", "example": "CHANGED_MY_MIND", "enum": [ "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" ] }, { "name": "returnSegment", "kind": "optional", "type": "string", "nullable": true, "description": "Specific return segment as defined by the merchant", "example": "GENERAL", "maxLength": 40 }, { "name": "returnStatusLog", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ReturnStatusLog", "description": "", "modelRef": "#/components/schemas/ReturnStatusLog", "schema": [ { "name": "arrivedToWarehouse", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates that the returned items arrived to the merchant's warehouse", "example": true }, { "name": "arrivedToWarehouseTime", "kind": "optional", "type": "number", "nullable": true, "description": "Time returned items arrived to the merchant's warehouse", "example": 1420070400000 }, { "name": "returnInitiated", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates that the customer initiated a return process online", "example": true }, { "name": "returnInitiationTime", "kind": "optional", "type": "number", "nullable": true, "description": "Time online return was initiated", "example": 1420070400000 }, { "name": "shippedByCustomer", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates that the customer has shipped the returned items back to the merchant", "example": true }, { "name": "shippedByCustomerTime", "kind": "optional", "type": "number", "nullable": true, "description": "Time returned items were shipped by the customer", "example": 1420070400000 } ] } ], "schema": [] }, { "name": "typeOfCompensationRequested", "kind": "optional", "type": "string", "nullable": true, "description": "

Indicates whether the customer requested a refund, store credit, replacement etc.

", "example": "REFUND", "enum": [ "REPLACEMENT", "REFUND", "REFUND_UPON_RETURN", "CREDIT", "MIXED", "UNKNOWN", "NO_COMPENSATION" ] }, { "name": "updatedReturnStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThe updated status of the return on the merchant's side", "example": "ACCEPTED_BY_MERCHANT", "enum": [ "ACCEPTED_BY_MERCHANT", "REJECTED_BY_MERCHANT", "PARTIALLY_ACCEPTED_BY_MERCHANT" ] } ] } ], "schema": [] }, { "name": "itemSpecificData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ItemSpecificData", "description": "", "modelRef": "#/components/schemas/ItemSpecificData", "schema": [ { "name": "accommodation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AccommodationItem", "description": "", "modelRef": "#/components/schemas/AccommodationItem", "schema": [ { "name": "accommodationAddress", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "accommodationName", "kind": "optional", "type": "string", "nullable": true, "description": "Name of the facility", "maxLength": 100 }, { "name": "duration", "kind": "required", "type": "object", "description": "Duration of stay", "modelRef": "#/components/schemas/Duration", "customType": "Duration", "schema": [ { "name": "endDate", "kind": "required", "type": "string", "description": "

Date service/item ends or becomes unavailable. Use YYYY-MM-DD format.

", "example": "2014-11-15", "format": "date" }, { "name": "startDate", "kind": "required", "type": "string", "description": "

Date service/item begins or becomes available. Use YYYY-MM-DD format.

", "example": "2014-10-28", "format": "date" } ] }, { "name": "housingType", "kind": "optional", "type": "string", "nullable": true, "description": "

Type of room/housing

", "example": "Presidential Suite", "maxLength": 100 }, { "name": "isRefundable", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if order can be cancelled and refunded", "example": false }, { "name": "location", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "RoughLocation", "description": "", "modelRef": "#/components/schemas/RoughLocation", "schema": [ { "name": "airportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThree letter IATA airport code", "example": "JFK", "pattern": "[A-Z]{3}" }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "City", "example": "Anytown" }, { "name": "country", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

Top-level administrative subdivision - state/province/department/etc.

", "example": "New York" }, { "name": "seaportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFive letter seaport code", "example": "USNYC", "pattern": "[A-Z]{5}" } ] } ], "schema": [] }, { "name": "numberOfGuests", "kind": "required", "type": "number", "description": "Number of guests", "example": 2 }, { "name": "rating", "kind": "optional", "type": "array", "conditional": true, "nullable": true, "description": "Conditional.\n

All ratings given to item or service. Can include internal peer rating, merchant rating, official professional association ratings, etc.

", "modelRef": "#/components/schemas/Rating", "customType": "Rating[]", "schema": [ { "name": "score", "kind": "required", "type": "string", "description": "

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

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

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

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

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

", "example": "INTERNAL_PEERS", "enum": [ "INTERNAL_PEERS", "INTERNAL_MERCHANT", "EXTERNAL_PEERS", "EXTERNAL_INDEPENDENT" ] } ] }, { "name": "type", "kind": "required", "type": "string", "description": "Type of accommodation service", "example": "HOTEL", "enum": [ "HOTEL", "APARTMENT", "CRUISE", "STUDIO", "EVENT_VENUE" ] } ] } ], "schema": [] }, { "name": "cryptocurrency", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CryptoItem", "description": "", "modelRef": "#/components/schemas/CryptoItem", "schema": [ { "name": "destinationWallet", "kind": "optional", "type": "string", "nullable": true, "description": "Destination wallet address", "example": "3JQiwG88SQvwihDAHg9M2EnqEisharz49c" } ] } ], "schema": [] }, { "name": "digitalGoodsAndServices", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ServiceItem", "description": "", "modelRef": "#/components/schemas/ServiceItem", "schema": [ { "name": "automaticRenewal", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to have service automatically renewed once current service ends", "example": true }, { "name": "billingFrequency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThe frequency customer has chosen for billing", "example": "MONTHLY", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "SEMI_ANNUAL", "ANNUAL", "MULTI_ANNUAL", "OTHER" ] }, { "name": "duration", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Duration", "description": "", "modelRef": "#/components/schemas/Duration", "schema": [ { "name": "endDate", "kind": "required", "type": "string", "description": "

Date service/item ends or becomes unavailable. Use YYYY-MM-DD format.

", "example": "2014-11-15", "format": "date" }, { "name": "startDate", "kind": "required", "type": "string", "description": "

Date service/item begins or becomes available. Use YYYY-MM-DD format.

", "example": "2014-10-28", "format": "date" } ] } ], "schema": [] }, { "name": "isTrial", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\n

True if the product\\service begins with a free trial

", "example": false }, { "name": "webHosting", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "WebHostingItem", "description": "", "modelRef": "#/components/schemas/WebHostingItem", "schema": [ { "name": "SSLcertificates", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if customer asked or paid extra for SSL certificates to be included", "example": false }, { "name": "domains", "kind": "required", "type": "array", "description": "List of domains purchased", "example": "[\"testforterdomain.com\",\"testforterdomain.me\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "emailService", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if customer asked or paid extra for Email functionality", "example": false }, { "name": "privateRegistration", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if customer asked or paid extra to hide registrant details from whois services", "example": false }, { "name": "sercurityUpgrades", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\n

True if customer asked or paid extra for security upgrades (antivirus, firewall, etc.)

", "example": false }, { "name": "webPromotion", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if customer asked or paid extra for promotion services such as SEO", "example": false }, { "name": "websiteBuilder", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if customer asked or paid extra for website builder wizard services", "example": false } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "food", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "FoodItem", "description": "", "modelRef": "#/components/schemas/FoodItem", "schema": [ { "name": "restaurantAddress", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "restaurantId", "kind": "optional", "type": "string", "nullable": true, "description": "Restaurant unique identifier", "example": "eh674df9", "maxLength": 50 }, { "name": "restaurantName", "kind": "optional", "type": "string", "nullable": true, "description": "The name of the restaurant", "example": "Ron's Steak House", "maxLength": 100 }, { "name": "tipAmount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "gaming", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GamingItem", "description": "", "modelRef": "#/components/schemas/GamingItem", "schema": [ { "name": "characterName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

In-game character name

", "example": "JohnTheGamer", "maxLength": 100 }, { "name": "characterRole", "kind": "optional", "type": "string", "nullable": true, "description": "Character's role in the game", "example": "Warrior", "maxLength": 100 }, { "name": "gameGenre", "kind": "optional", "type": "string", "nullable": true, "description": "

Game type/genre

", "example": "MMORPG", "maxLength": 50 }, { "name": "gameItemAmount", "kind": "required", "type": "number", "description": "

Number of game items or commodities bought (100 coins, 2000 gold, 10 experience points, etc.)

", "example": 1000 }, { "name": "gameName", "kind": "required", "type": "string", "description": "Game name", "example": "WorldOfSampleGamecrat", "maxLength": 50 }, { "name": "gamePlatform", "kind": "optional", "type": "string", "nullable": true, "description": "Game platform", "example": "XBOX", "maxLength": 50 }, { "name": "gameServerCountry", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "DK", "maxLength": 2, "pattern": "[A-Za-z]{2}" }, { "name": "gameServerName", "kind": "optional", "type": "string", "nullable": true, "description": "Game server name", "example": "5ample5erver", "maxLength": 100 }, { "name": "inGameTradeLocation", "kind": "optional", "type": "string", "nullable": true, "description": "

In-Game trade location

", "example": "At the mouth of the Sampletradelocation river" }, { "name": "playerFaction", "kind": "optional", "type": "string", "nullable": true, "description": "

Player's in-game faction/clan/group

", "example": "TestC1an", "maxLength": 100 }, { "name": "playerLeague", "kind": "optional", "type": "string", "nullable": true, "description": "

Player's in-game league

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

Player's in-game level

", "example": "59", "maxLength": 50 }, { "name": "playerPosition", "kind": "optional", "type": "string", "nullable": true, "description": "

Player's in-game position

", "example": "10", "maxLength": 50 } ] } ], "schema": [] }, { "name": "personNameRecord", "kind": "optional", "type": "string", "nullable": true, "description": "

Person Name Record (PNR). Combined with a passenger name, it serves as an identifier for a flight reservation (also for multiple passengers)

", "example": "P52DKC", "maxLength": 20 }, { "name": "physicalGoods", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PhysicalItem", "description": "", "modelRef": "#/components/schemas/PhysicalItem", "schema": [ { "name": "wrapAsGift", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to have item wrapped as a gift", "example": true } ] } ], "schema": [] }, { "name": "professionalServices", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ProfessionalServices", "description": "", "modelRef": "#/components/schemas/ProfessionalServices", "schema": [ { "name": "numberOfParticipatingClients", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\n

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.

", "example": 1 }, { "name": "numberOfParticipatingVendors", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\nNumber of vendors associated with this service. Would be greater than 1 in cases where several vendors collaborate to offer the service.", "example": 1 }, { "name": "tipAmount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "ticketsAndEvents", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "TicketItem", "description": "", "modelRef": "#/components/schemas/TicketItem", "schema": [ { "name": "eventLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "eventName", "kind": "required", "type": "string", "description": "Name of the event", "example": "FIFA World Cup Final" }, { "name": "eventTime", "kind": "optional", "type": "number", "nullable": true, "description": "

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

is 1420070400

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

Type of event (movie, concert, sports, etc.)

", "example": "sports", "maxLength": 100 }, { "name": "eventVenueName", "kind": "optional", "type": "string", "nullable": true, "description": "Name of venue where event takes place", "example": "Maracana Stadium" }, { "name": "ticketCategory", "kind": "optional", "type": "string", "nullable": true, "description": "

Ticket category (adult, student, senior, child, etc.)

", "example": "ADULT", "enum": [ "ADULT", "CHILD", "ENFANT", "SENIOR", "STUDENT", "VETERAN", "OTHER" ], "maxLength": 25 }, { "name": "ticketClass", "kind": "optional", "type": "string", "nullable": true, "description": "

Class of tickets purchased (Standing, VIP, Platinum, etc.)

", "example": "court side", "maxLength": 25 } ] } ], "schema": [] }, { "name": "transport", "kind": "optional", "type": "array", "nullable": true, "description": "Additional information regarding transportation services or products", "modelRef": "#/components/schemas/TransportItem", "customType": "TransportItem[]", "schema": [ { "name": "bookingSource", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Use to indicate the affiliate, origin, internal source or flow that this part of the booking is associated with

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

Company operating transportation service purchased (airline, car rental company, etc.)

", "example": "Forter airlines" }, { "name": "class", "kind": "optional", "type": "string", "nullable": true, "description": "

Seating class (Tourist, business, first, etc.)

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

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "dateOfFirstSale", "kind": "optional", "type": "number", "nullable": true, "description": "

Date of first sale by seller, in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1430997968 }, { "name": "ratingAsBuyer", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Rating", "description": "", "modelRef": "#/components/schemas/Rating", "schema": [ { "name": "score", "kind": "required", "type": "string", "description": "

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

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

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

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

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

", "example": "INTERNAL_PEERS", "enum": [ "INTERNAL_PEERS", "INTERNAL_MERCHANT", "EXTERNAL_PEERS", "EXTERNAL_INDEPENDENT" ] } ] } ], "schema": [] }, { "name": "ratingAsSeller", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Rating", "description": "", "modelRef": "#/components/schemas/Rating", "schema": [ { "name": "score", "kind": "required", "type": "string", "description": "

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

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

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

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

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

", "example": "INTERNAL_PEERS", "enum": [ "INTERNAL_PEERS", "INTERNAL_MERCHANT", "EXTERNAL_PEERS", "EXTERNAL_INDEPENDENT" ] } ] } ], "schema": [] }, { "name": "sellerAccountCreationDate", "kind": "required", "type": "number", "description": "

Date seller account was created in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1415273168 }, { "name": "sellerLastLoginIP", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "IP", "description": "", "modelRef": "#/components/schemas/IP", "schema": [ { "name": "ip", "kind": "required", "type": "string", "description": "Customer IP address in v4 format", "example": "10.0.0.128" }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "sellerPastSalesCount", "kind": "optional", "type": "integer", "nullable": true, "description": "Count of all successfully fulfilled sales made", "example": 8 }, { "name": "sellerPersonalDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PersonalDetails", "description": "", "modelRef": "#/components/schemas/PersonalDetails", "schema": [ { "name": "birthdate", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "1987-05-22", "format": "date" }, { "name": "email", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nEmail address", "example": "john_s@test.com", "maxLength": 256 }, { "name": "firstName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFirst name", "example": "John", "maxLength": 75 }, { "name": "fullName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFull name. Not Needed if firstName and LastName are provided independently.", "example": "John Smith", "maxLength": 150 }, { "name": "gender", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nGender", "example": "MALE", "enum": [ "MALE", "FEMALE", "CHOSE_NOT_TO_SPECIFY", "NONE" ] }, { "name": "lastName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nLast name", "example": "Smith", "maxLength": 75 } ] } ], "schema": [] }, { "name": "sellerRegistrationIP", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "IP", "description": "", "modelRef": "#/components/schemas/IP", "schema": [ { "name": "ip", "kind": "required", "type": "string", "description": "Customer IP address in v4 format", "example": "10.0.0.128" }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "duration", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ExactDuration", "description": "", "modelRef": "#/components/schemas/ExactDuration", "schema": [ { "name": "endTime", "kind": "optional", "type": "integer", "nullable": true, "description": "

Unix timestamp in seconds of when service/item ends or becomes unavailable in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1420294711 }, { "name": "startTime", "kind": "required", "type": "number", "description": "

Unix timestamp in seconds of when service/item begins or becomes available in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1412345911 } ] } ], "schema": [] }, { "name": "endPoint", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Location", "description": "", "modelRef": "#/components/schemas/Location", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "exactLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ExactLocation", "description": "", "modelRef": "#/components/schemas/ExactLocation", "schema": [ { "name": "latitude", "kind": "required", "type": "number", "description": "

Latitude in Decimal Degrees (WGS84)

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

Longitude in Decimal Degrees (WGS84)

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

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)

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

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)

", "example": "Times Square" }, { "name": "specificLocationType", "kind": "optional", "type": "string", "nullable": true, "description": "Specific location type.", "example": "Event" } ] } ], "schema": [] }, { "name": "roughLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "RoughLocation", "description": "", "modelRef": "#/components/schemas/RoughLocation", "schema": [ { "name": "airportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThree letter IATA airport code", "example": "JFK", "pattern": "[A-Z]{3}" }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "City", "example": "Anytown" }, { "name": "country", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

Top-level administrative subdivision - state/province/department/etc.

", "example": "New York" }, { "name": "seaportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFive letter seaport code", "example": "USNYC", "pattern": "[A-Z]{5}" } ] } ], "schema": [] }, { "name": "savedLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "expeditedBoarding", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer paid extra for expedited boarding", "example": false }, { "name": "extraBaggage", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer paid extra to bring extra baggage", "example": false }, { "name": "leg", "kind": "optional", "type": "integer", "conditional": true, "nullable": true, "description": "Conditional.\n

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)

", "example": 2 }, { "name": "locationAtTimeOfReservation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Location", "description": "", "modelRef": "#/components/schemas/Location", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "exactLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ExactLocation", "description": "", "modelRef": "#/components/schemas/ExactLocation", "schema": [ { "name": "latitude", "kind": "required", "type": "number", "description": "

Latitude in Decimal Degrees (WGS84)

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

Longitude in Decimal Degrees (WGS84)

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

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)

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

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)

", "example": "Times Square" }, { "name": "specificLocationType", "kind": "optional", "type": "string", "nullable": true, "description": "Specific location type.", "example": "Event" } ] } ], "schema": [] }, { "name": "roughLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "RoughLocation", "description": "", "modelRef": "#/components/schemas/RoughLocation", "schema": [ { "name": "airportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThree letter IATA airport code", "example": "JFK", "pattern": "[A-Z]{3}" }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "City", "example": "Anytown" }, { "name": "country", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

Top-level administrative subdivision - state/province/department/etc.

", "example": "New York" }, { "name": "seaportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFive letter seaport code", "example": "USNYC", "pattern": "[A-Z]{5}" } ] } ], "schema": [] }, { "name": "savedLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "passengers", "kind": "optional", "type": "number", "nullable": true, "description": "Number of passengers", "example": 2 }, { "name": "purchasedMeals", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer paid extra to receive meals on board", "example": false }, { "name": "selectSeat", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer paid extra to select a seat", "example": false }, { "name": "startPoint", "kind": "required", "type": "object", "description": "Trip starting point", "modelRef": "#/components/schemas/Location", "customType": "Location", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "exactLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ExactLocation", "description": "", "modelRef": "#/components/schemas/ExactLocation", "schema": [ { "name": "latitude", "kind": "required", "type": "number", "description": "

Latitude in Decimal Degrees (WGS84)

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

Longitude in Decimal Degrees (WGS84)

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

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)

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

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)

", "example": "Times Square" }, { "name": "specificLocationType", "kind": "optional", "type": "string", "nullable": true, "description": "Specific location type.", "example": "Event" } ] } ], "schema": [] }, { "name": "roughLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "RoughLocation", "description": "", "modelRef": "#/components/schemas/RoughLocation", "schema": [ { "name": "airportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThree letter IATA airport code", "example": "JFK", "pattern": "[A-Z]{3}" }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "City", "example": "Anytown" }, { "name": "country", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

Top-level administrative subdivision - state/province/department/etc.

", "example": "New York" }, { "name": "seaportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFive letter seaport code", "example": "USNYC", "pattern": "[A-Z]{5}" } ] } ], "schema": [] }, { "name": "savedLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] } ] }, { "name": "type", "kind": "required", "type": "string", "description": "Type of transportation service", "example": "AIR_TRAVEL", "enum": [ "PRIVATE_TAXI", "PRIVATE_VIP_TAXI", "PRIVATE_LARGE_TAXI", "SHARED_RIDE", "SHARED_RIDE_DISCOUNT", "AIR_TRAVEL", "RAIL", "FERRY", "BUS", "CAR_RENTAL", "PARKING", "CRUISE_LINE" ] } ] } ] } ], "schema": [] }, { "name": "seller", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SellerData", "description": "", "modelRef": "#/components/schemas/SellerData", "schema": [ { "name": "sellerBusinessWebsite", "kind": "optional", "type": "string", "nullable": true, "description": "Seller's business website URL", "example": "www.acme-events.net" }, { "name": "sellerCategory", "kind": "optional", "type": "string", "nullable": true, "description": "Type of service offered by the seller", "example": "Event Planner" }, { "name": "sellerDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "BasicSellerData", "description": "", "modelRef": "#/components/schemas/BasicSellerData", "schema": [ { "name": "availableFundsForWithdrawal", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "dateOfFirstSale", "kind": "optional", "type": "number", "nullable": true, "description": "

Date of first sale by seller, in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1430997968 }, { "name": "ratingAsBuyer", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Rating", "description": "", "modelRef": "#/components/schemas/Rating", "schema": [ { "name": "score", "kind": "required", "type": "string", "description": "

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

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

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

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

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

", "example": "INTERNAL_PEERS", "enum": [ "INTERNAL_PEERS", "INTERNAL_MERCHANT", "EXTERNAL_PEERS", "EXTERNAL_INDEPENDENT" ] } ] } ], "schema": [] }, { "name": "ratingAsSeller", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Rating", "description": "", "modelRef": "#/components/schemas/Rating", "schema": [ { "name": "score", "kind": "required", "type": "string", "description": "

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

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

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

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

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

", "example": "INTERNAL_PEERS", "enum": [ "INTERNAL_PEERS", "INTERNAL_MERCHANT", "EXTERNAL_PEERS", "EXTERNAL_INDEPENDENT" ] } ] } ], "schema": [] }, { "name": "sellerAccountCreationDate", "kind": "required", "type": "number", "description": "

Date seller account was created in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1415273168 }, { "name": "sellerLastLoginIP", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "IP", "description": "", "modelRef": "#/components/schemas/IP", "schema": [ { "name": "ip", "kind": "required", "type": "string", "description": "Customer IP address in v4 format", "example": "10.0.0.128" }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "creationTime", "kind": "required", "type": "number", "description": "

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

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

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

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

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

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

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

", "example": 1448895522 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "sellerPastSalesCount", "kind": "optional", "type": "integer", "nullable": true, "description": "Count of all successfully fulfilled sales made", "example": 8 }, { "name": "sellerPersonalDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PersonalDetails", "description": "", "modelRef": "#/components/schemas/PersonalDetails", "schema": [ { "name": "birthdate", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "1987-05-22", "format": "date" }, { "name": "email", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nEmail address", "example": "john_s@test.com", "maxLength": 256 }, { "name": "firstName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFirst name", "example": "John", "maxLength": 75 }, { "name": "fullName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFull name. Not Needed if firstName and LastName are provided independently.", "example": "John Smith", "maxLength": 150 }, { "name": "gender", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nGender", "example": "MALE", "enum": [ "MALE", "FEMALE", "CHOSE_NOT_TO_SPECIFY", "NONE" ] }, { "name": "lastName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nLast name", "example": "Smith", "maxLength": 75 } ] } ], "schema": [] }, { "name": "sellerRegistrationIP", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "IP", "description": "", "modelRef": "#/components/schemas/IP", "schema": [ { "name": "ip", "kind": "required", "type": "string", "description": "Customer IP address in v4 format", "example": "10.0.0.128" }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "creationTime", "kind": "required", "type": "number", "description": "

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

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

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

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

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

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

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

", "example": 1448895522 } ] } ], "schema": [] } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "sellerVendorName", "kind": "optional", "type": "string", "nullable": true, "description": "Name of the vendor", "example": "Acme Event Planners Inc." } ] } ], "schema": [] }, { "name": "shopifyAdditionalItemData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ShopifyAdditionalItemData", "description": "", "modelRef": "#/components/schemas/ShopifyAdditionalItemData", "schema": [ { "name": "properties", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] } ] } ], "schema": [] } ] }, { "name": "compensationStatus", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CompensationStatus", "description": "", "modelRef": "#/components/schemas/CompensationStatus", "schema": [ { "name": "hasProofOfPurchase", "kind": "optional", "type": "boolean", "nullable": true, "description": "" }, { "name": "itemStatus", "kind": "required", "type": "array", "description": "A list of all items for which compensation was requested", "modelRef": "#/components/schemas/ItemCompensationStatus", "customType": "ItemCompensationStatus[]", "schema": [ { "name": "basicItemData", "kind": "required", "type": "object", "description": "

General data regarding item such as name, price, etc.

", "modelRef": "#/components/schemas/BasicItemData", "customType": "BasicItemData", "schema": [ { "name": "category", "kind": "optional", "type": "string", "nullable": true, "description": "Item category", "example": "Apparel and accessories", "maxLength": 1000 }, { "name": "discount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Discount", "description": "", "modelRef": "#/components/schemas/Discount", "schema": [ { "name": "couponCodeUsed", "kind": "required", "type": "string", "description": "Coupon code used", "example": "FATHERSDAY2015", "maxLength": 150 }, { "name": "couponDiscountAmount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "couponDiscountPercent", "kind": "optional", "type": "string", "nullable": true, "description": "Coupon discount amount" } ] } ], "schema": [] }, { "name": "name", "kind": "required", "type": "string", "description": "Item name", "example": "White GenericBrand handbag", "maxLength": 500 }, { "name": "price", "kind": "required", "type": "object", "description": "

Final amount due for purchase, after all discounts and promotions

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

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] }, { "name": "productId", "kind": "optional", "type": "string", "nullable": true, "description": "

Unique identifier for item that is common to all identical items (such as SKU, ISBN, etc.)

", "example": "Ag54352R7768kkO", "maxLength": 70 }, { "name": "quantity", "kind": "required", "type": "number", "description": "Item quantity", "example": 1 }, { "name": "type", "kind": "required", "type": "string", "description": "

Tangible if physical item, non-tangible if any other product

", "example": "TANGIBLE", "enum": [ "TANGIBLE", "NON_TANGIBLE" ] } ] }, { "name": "statusData", "kind": "required", "type": "object", "description": "Data relating to the return of the item", "modelRef": "#/components/schemas/ItemCompensationStatusData", "customType": "ItemCompensationStatusData", "schema": [ { "name": "compensationTypeGranted", "kind": "required", "type": "string", "description": "

Indicates whether the customer was granted a refund, store credit, replacement etc.

", "example": "REFUND", "enum": [ "REPLACEMENT", "REFUND", "REFUND_UPON_RETURN", "CREDIT", "MIXED", "UNKNOWN", "NO_COMPENSATION" ] }, { "name": "internalReasonCategory", "kind": "optional", "type": "string", "nullable": true, "description": "The reason for the request as defined by the merchant", "example": "defective item", "maxLength": 40 }, { "name": "reasonCategory", "kind": "required", "type": "string", "description": "Reason for compensation request", "example": "CHANGED_MY_MIND", "enum": [ "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" ] }, { "name": "returnCondition", "kind": "optional", "type": "string", "nullable": true, "description": "Condition of the item returned", "example": "DAMAGED", "enum": [ "GOOD_CONDITION", "DAMAGED", "WRONG_ITEM", "NO_ITEM", "NOT_ARRIVED", "NO_RETURN" ], "maxLength": 40 }, { "name": "returnMethodGranted", "kind": "required", "type": "string", "description": "Method of return granted to customer", "example": "SHIP_TO_WAREHOUSE", "enum": [ "SHIP_TO_WAREHOUSE", "IN_STORE", "NO_RETURN" ] }, { "name": "statusLog", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CompensationStatusLog", "description": "", "modelRef": "#/components/schemas/CompensationStatusLog", "schema": [ { "name": "arrivedToWarehouseTime", "kind": "optional", "type": "number", "nullable": true, "description": "Time returned items arrived to the merchant's warehouse", "example": 1420070400000 }, { "name": "initiationTime", "kind": "optional", "type": "number", "nullable": true, "description": "

The time that the customer initiated the request for compensation in MILLISECONDS since unix epoch (Jan 1, 1970)

", "example": 1415287568000 }, { "name": "initiationType", "kind": "optional", "type": "string", "nullable": true, "description": "What channel did the customer use to initiate the request for compensation", "example": "CALL_CENTER", "enum": [ "CALL_CENTER", "IN_STORE", "CHAT", "ONLINE", "SELF_SERVICE" ] }, { "name": "shippedByCustomerTime", "kind": "optional", "type": "number", "nullable": true, "description": "Time returned items were shipped by the customer", "example": 1420070400000 } ] } ], "schema": [] }, { "name": "updatedStatus", "kind": "required", "type": "string", "description": "The updated compensation request status", "example": "ACCEPTED_BY_MERCHANT", "enum": [ "ACCEPTED_BY_MERCHANT", "REJECTED_BY_MERCHANT", "WITHDRAWN_BY_CUSTOMER" ] } ] } ] }, { "name": "merchantAgentData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantAgentData", "description": "", "modelRef": "#/components/schemas/MerchantAgentData", "schema": [ { "name": "merchantAgentId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique identifier of the agent processing the customer's request", "example": "HG36885TZ" }, { "name": "merchantAgentName", "kind": "optional", "type": "string", "nullable": true, "description": "Name of the agent processing the customer's request", "example": "John Smith" } ] } ], "schema": [] }, { "name": "replacementOrderId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique order/transaction identifier for a replacement order issued by the merchant in response to this request

", "example": "2356fdse0rr489", "maxLength": 40 }, { "name": "shippingRefunded", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates whether merchant reimbursed the customer for shipping expenses" }, { "name": "shippingRefundedAmount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "statusData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ItemCompensationStatusData", "description": "", "modelRef": "#/components/schemas/ItemCompensationStatusData", "schema": [ { "name": "compensationTypeGranted", "kind": "required", "type": "string", "description": "

Indicates whether the customer was granted a refund, store credit, replacement etc.

", "example": "REFUND", "enum": [ "REPLACEMENT", "REFUND", "REFUND_UPON_RETURN", "CREDIT", "MIXED", "UNKNOWN", "NO_COMPENSATION" ] }, { "name": "internalReasonCategory", "kind": "optional", "type": "string", "nullable": true, "description": "The reason for the request as defined by the merchant", "example": "defective item", "maxLength": 40 }, { "name": "reasonCategory", "kind": "required", "type": "string", "description": "Reason for compensation request", "example": "CHANGED_MY_MIND", "enum": [ "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" ] }, { "name": "returnCondition", "kind": "optional", "type": "string", "nullable": true, "description": "Condition of the item returned", "example": "DAMAGED", "enum": [ "GOOD_CONDITION", "DAMAGED", "WRONG_ITEM", "NO_ITEM", "NOT_ARRIVED", "NO_RETURN" ], "maxLength": 40 }, { "name": "returnMethodGranted", "kind": "required", "type": "string", "description": "Method of return granted to customer", "example": "SHIP_TO_WAREHOUSE", "enum": [ "SHIP_TO_WAREHOUSE", "IN_STORE", "NO_RETURN" ] }, { "name": "statusLog", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CompensationStatusLog", "description": "", "modelRef": "#/components/schemas/CompensationStatusLog", "schema": [ { "name": "arrivedToWarehouseTime", "kind": "optional", "type": "number", "nullable": true, "description": "Time returned items arrived to the merchant's warehouse", "example": 1420070400000 }, { "name": "initiationTime", "kind": "optional", "type": "number", "nullable": true, "description": "

The time that the customer initiated the request for compensation in MILLISECONDS since unix epoch (Jan 1, 1970)

", "example": 1415287568000 }, { "name": "initiationType", "kind": "optional", "type": "string", "nullable": true, "description": "What channel did the customer use to initiate the request for compensation", "example": "CALL_CENTER", "enum": [ "CALL_CENTER", "IN_STORE", "CHAT", "ONLINE", "SELF_SERVICE" ] }, { "name": "shippedByCustomerTime", "kind": "optional", "type": "number", "nullable": true, "description": "Time returned items were shipped by the customer", "example": 1420070400000 } ] } ], "schema": [] }, { "name": "updatedStatus", "kind": "required", "type": "string", "description": "The updated compensation request status", "example": "ACCEPTED_BY_MERCHANT", "enum": [ "ACCEPTED_BY_MERCHANT", "REJECTED_BY_MERCHANT", "WITHDRAWN_BY_CUSTOMER" ] } ] } ], "schema": [] }, { "name": "totalGrantedAmount", "kind": "required", "type": "object", "description": "

Total amount of the compensation granted to customer (excluding shippingRefundedAmount)

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

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ] } ], "schema": [] }, { "name": "correlationId", "kind": "optional", "type": "string", "nullable": true, "description": "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", "example": "HGJ7512345H3DE" }, { "name": "deliveryStatusInfo", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "OrderShippingInfo", "description": "", "modelRef": "#/components/schemas/OrderShippingInfo", "schema": [ { "name": "additionalShippingInfo", "kind": "optional", "type": "string", "nullable": true, "description": "Aditional identification document details and verification", "example": "PO Box 3297", "maxLength": 100 }, { "name": "carrier", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nShipping carrier name", "example": "UPS", "maxLength": 50 }, { "name": "customerOpenedEmail", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if there's an indication that the customer opened the purchase confirmation email sent by the merchant", "example": false }, { "name": "downloadTime", "kind": "optional", "type": "number", "nullable": true, "description": "

The time when the buyer downloaded the digital item to their device in SECONDS since unix epoch (Jan 1, 1970)

", "example": 1415273168 }, { "name": "proofOfShippingURL", "kind": "optional", "type": "string", "nullable": true, "description": "URL to the proof of shipping in the merchant's system", "example": "true", "maxLength": 1024 }, { "name": "signedProofOfShipping", "kind": "optional", "type": "boolean", "nullable": true, "description": "Whether the user has signed a proof of shipping", "example": true }, { "name": "trackingNumber", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nOrder tracking number", "example": "123456", "maxLength": 50 } ] } ], "schema": [] }, { "name": "endPointLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Location", "description": "", "modelRef": "#/components/schemas/Location", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "exactLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ExactLocation", "description": "", "modelRef": "#/components/schemas/ExactLocation", "schema": [ { "name": "latitude", "kind": "required", "type": "number", "description": "

Latitude in Decimal Degrees (WGS84)

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

Longitude in Decimal Degrees (WGS84)

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

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)

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

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)

", "example": "Times Square" }, { "name": "specificLocationType", "kind": "optional", "type": "string", "nullable": true, "description": "Specific location type.", "example": "Event" } ] } ], "schema": [] }, { "name": "roughLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "RoughLocation", "description": "", "modelRef": "#/components/schemas/RoughLocation", "schema": [ { "name": "airportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThree letter IATA airport code", "example": "JFK", "pattern": "[A-Z]{3}" }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "City", "example": "Anytown" }, { "name": "country", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

Top-level administrative subdivision - state/province/department/etc.

", "example": "New York" }, { "name": "seaportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFive letter seaport code", "example": "USNYC", "pattern": "[A-Z]{5}" } ] } ], "schema": [] }, { "name": "savedLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "eventId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique identifier of compensation update, should match previous compensation request identifier, if applicable, and any subsequent status updates of the same compensation request

", "example": "r48987fgdse0r", "maxLength": 40 }, { "name": "eventTime", "kind": "required", "type": "number", "description": "

The time the status change event took place in MILLISECONDS since unix epoch (Jan 1, 1970)

", "example": 1415287568000 }, { "name": "itemIds", "kind": "optional", "type": "array", "nullable": true, "description": "

/**\nUnique item identifiers. Should match the item ids as described under the BasicItemData object.

", "example": "[\"a98751422\",\"a98751423\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "orderId", "kind": "required", "type": "string", "description": "

Unique order/transaction identifier. Note that Forter treats this ID as case-insensitive; Order123 and ORDER123 will be identified as the same order. Must be identical to the orderId used in the order validation API

", "example": "2356fdse0rr489", "maxLength": 40 }, { "name": "payment", "kind": "optional", "type": "array", "conditional": true, "nullable": true, "description": "Conditional.\nAn updated list of all payment methods and billing details used in the transaction. Required only if there has been a change to the payment.", "modelRef": "#/components/schemas/Payment", "customType": "Payment[]", "schema": [ { "name": "allowedMerchantInitiatedTransactions", "kind": "optional", "type": "boolean", "nullable": true, "description": "

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

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

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

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

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

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

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

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

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

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

Credit card's expiration month, in MM format

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

Credit card's expiration year, in YYYY format

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

Unique transaction identifier (sent by processor)

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

Bank acquirer BIN (Bank Identification Number)

", "example": "457173", "maxLength": 12 }, { "name": "acquirerCountry", "kind": "optional", "type": "string", "nullable": true, "description": "Acquirer country", "example": "US", "enum": [ "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "TP", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "GB", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "SH", "KN", "LC", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TJ", "TZ", "TH", "CD", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "YU", "ZM", "ZW" ] }, { "name": "acquirerMerchantId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.

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

Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs

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

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

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

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

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

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

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

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

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

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

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

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

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

3DSecure - ECI value recieved from authorization/authentication response

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

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

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

3DSecure - Party executed the 3DS authentication

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

3DSecure - Indication of the friction that the user experienced

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

3DSecure - Status text received from 3D secure vendor

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

3DSecure - Version used in the transaction

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

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

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

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

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

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

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

Credit card's expiration month, in MM format

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

Credit card's expiration year, in YYYY format

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

Unique transaction identifier (sent by processor)

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

Bank acquirer BIN (Bank Identification Number)

", "example": "457173", "maxLength": 12 }, { "name": "acquirerCountry", "kind": "optional", "type": "string", "nullable": true, "description": "Acquirer country", "example": "US", "enum": [ "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "TP", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "GB", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "SH", "KN", "LC", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TJ", "TZ", "TH", "CD", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "YU", "ZM", "ZW" ] }, { "name": "acquirerMerchantId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.

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

Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs

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

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

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

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

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

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

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

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

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

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

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

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

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

3DSecure - ECI value recieved from authorization/authentication response

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

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

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

3DSecure - Party executed the 3DS authentication

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

3DSecure - Indication of the friction that the user experienced

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

3DSecure - Status text received from 3D secure vendor

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

3DSecure - Version used in the transaction

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

Bank account unique identifier (IBAN or equivalent)

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

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

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

Unique transaction identifier (sent by gateway)

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

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

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

Unit-level address

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type of document (Passport, ID, Driving license)

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

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

is 1420070400

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

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

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

Unit-level address

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

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

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

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

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

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

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

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

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

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

", "example": 1389567341 }, { "name": "verified", "kind": "required", "type": "boolean", "description": "

True if customer received email verification message to this address and clicked-through back to merchant's site, or received SMS message and enterd code in merchant's site (two-factor authentication)

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

Credit card's BIN (Bank Identification Number)

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

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

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

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

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

Credit card's expiration month, in MM format

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

Credit card's expiration year, in YYYY format

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

Unique identifier for card (sent by gateway or processor)

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

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

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

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

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

Unique transaction identifier (sent by processor)

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

Bank acquirer BIN (Bank Identification Number)

", "example": "457173", "maxLength": 12 }, { "name": "acquirerCountry", "kind": "optional", "type": "string", "nullable": true, "description": "Acquirer country", "example": "US", "enum": [ "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "TP", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "GB", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "SH", "KN", "LC", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TJ", "TZ", "TH", "CD", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "YU", "ZM", "ZW" ] }, { "name": "acquirerMerchantId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.

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

Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs

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

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

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

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

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

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

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

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

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

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

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

3DSecure - ECI value recieved from authorization/authentication response

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

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

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

3DSecure - Party executed the 3DS authentication

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

3DSecure - Indication of the friction that the user experienced

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

3DSecure - Status text received from 3D secure vendor

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

3DSecure - Version used in the transaction

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

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

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

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

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

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

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

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

", "example": "EXTERNAL", "enum": [ "INTERNAL", "EXTERNAL" ] } ] } ], "schema": [] }, { "name": "digitalWallet", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "DigitalWallet", "description": "", "modelRef": "#/components/schemas/DigitalWallet", "schema": [ { "name": "digitalWalletName", "kind": "required", "type": "string", "description": "Digital wallet name", "example": "ALIPAY", "enum": [ "AMAZONPAY", "FACEBOOKPAY", "ALIPAY", "WECHAT", "AMEDIGITAL", "MERCADOPAGO", "DUE", "ZELLE", "PAYONEER", "ALLIEDWALLET", "KONBINI", "UNIONPAY", "IYZICO", "VENMO", "BARTER", "PAYNOW", "PAYCO", "KAKAOPAY", "NAVERPAY", "LINEPAY", "BANCONTACT", "MBWAY", "AIIA", "BLIK", "EPS", "OVO", "DANA", "GCASH", "GOPAY", "RAKUTENPAY", "APLAZO", "GRABPAY", "TWINT", "TRUEMONEY", "SWISH", "KLARNA", "SHOPBACK", "OTHER", "PAYPAY" ] }, { "name": "digitalWalletPayerEmail", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nEmail address associated with the digital wallet account", "example": "john_s@test.com", "maxLength": 75 }, { "name": "digitalWalletPayerId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

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

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

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

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

Bank account unique identifier (IBAN or equivalent)

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

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

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

Unique transaction identifier (sent by gateway)

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

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

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

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

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

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

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

Credit card's expiration month, in MM format

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

Credit card's expiration year, in YYYY format

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

Unique transaction identifier (sent by processor)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "threeDSecure", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureInput", "description": "", "modelRef": "#/components/schemas/ThreeDSecureInput", "schema": [ { "name": "acquirerData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AcquirerData", "description": "", "modelRef": "#/components/schemas/AcquirerData", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "challengeIndicator", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation", "example": "NO_PREFERENCE", "enum": [ "NO_PREFERENCE", "NO_CHALLENGE", "CHALLENGE", "CHALLENGE_AS_MANDATE" ] }, { "name": "execute3ds", "kind": "optional", "type": "string", "nullable": true, "description": "Request your preference regarding the execution of 3DS", "example": "DYNAMIC_FORTER_DECISION", "enum": [ "FORCE_3DS", "NOT_SUPPORTED_BY_MERCHANT", "DYNAMIC_FORTER_DECISION" ] }, { "name": "forcePsd2Exemption", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureForcePsd2Exemption", "description": "", "modelRef": "#/components/schemas/ThreeDSecureForcePsd2Exemption", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "requestChallenge", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates if a 3DS challenge should be requested from the Issuer ACS.", "example": false }, { "name": "threeDSServerTransID", "kind": "required", "type": "string", "description": "Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call", "example": "26d648a9-da8a-4f8b-a76d-094801d2fd45", "maxLength": 100 }, { "name": "threeDsExecutor", "kind": "optional", "type": "string", "nullable": true, "description": "

Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs

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

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

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

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

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

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

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

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

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

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

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

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

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

3DSecure - ECI value recieved from authorization/authentication response

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

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

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

3DSecure - Party executed the 3DS authentication

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

3DSecure - Indication of the friction that the user experienced

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

3DSecure - Status text received from 3D secure vendor

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

3DSecure - Version used in the transaction

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

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

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

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

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

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

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

Number of points (miles, stars, etc.)

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

Source of points (promo, referral, etc.)

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

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

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

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

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

Specifies the type of merchant-initiated payment

", "enum": [ "RECURRING_TRANSACTION", "INSTALMENT_TRANSACTION", "ADD_CARD", "MAINTAIN_CARD_INFORMATION", "ACCOUNT_VERIFICATION", "SPLIT_OR_DELAYED_SHIPMENT", "TOP_UP", "MAIL_ORDER", "TELEPHONE_ORDER", "WHITELIST_STATUS_CHECK", "OTHER_PAYMENT" ] } ] } ], "schema": [] }, { "name": "mobileMoney", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MobileMoney", "description": "", "modelRef": "#/components/schemas/MobileMoney", "schema": [ { "name": "fullResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "mobileMoneyNetwork", "kind": "required", "type": "string", "description": "Mobile money provider name", "example": "MPESA", "enum": [ "MPESA", "MTN", "MPAWA", "MSHWAEI", "SAFARICOM", "DASH" ] }, { "name": "paymentAcquirerData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AcquirerData", "description": "", "modelRef": "#/components/schemas/AcquirerData", "schema": [ { "name": "acquirerBIN", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Bank acquirer BIN (Bank Identification Number)

", "example": "457173", "maxLength": 12 }, { "name": "acquirerCountry", "kind": "optional", "type": "string", "nullable": true, "description": "Acquirer country", "example": "US", "enum": [ "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "TP", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "GB", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "SH", "KN", "LC", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TJ", "TZ", "TH", "CD", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "YU", "ZM", "ZW" ] }, { "name": "acquirerMerchantId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.

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

Unique transaction identifier (sent by gateway)

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

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

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

Unique transaction identifier (sent by gateway)

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

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

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

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

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

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

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

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

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

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

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

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

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

Credit card's expiration month, in MM format

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

Credit card's expiration year, in YYYY format

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

Unique transaction identifier (sent by processor)

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

Bank acquirer BIN (Bank Identification Number)

", "example": "457173", "maxLength": 12 }, { "name": "acquirerCountry", "kind": "optional", "type": "string", "nullable": true, "description": "Acquirer country", "example": "US", "enum": [ "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "TP", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "GB", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "SH", "KN", "LC", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TJ", "TZ", "TH", "CD", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "YU", "ZM", "ZW" ] }, { "name": "acquirerMerchantId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.

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

Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs

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

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

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

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

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

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

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

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

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

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

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

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

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

3DSecure - ECI value recieved from authorization/authentication response

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

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

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

3DSecure - Party executed the 3DS authentication

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

3DSecure - Indication of the friction that the user experienced

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

3DSecure - Status text received from 3D secure vendor

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

3DSecure - Version used in the transaction

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

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

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

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

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

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

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

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

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

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

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

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

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

Credit card's expiration month, in MM format

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

Credit card's expiration year, in YYYY format

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

Unique transaction identifier (sent by processor)

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

Bank acquirer BIN (Bank Identification Number)

", "example": "457173", "maxLength": 12 }, { "name": "acquirerCountry", "kind": "optional", "type": "string", "nullable": true, "description": "Acquirer country", "example": "US", "enum": [ "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "TP", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "GB", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "SH", "KN", "LC", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TJ", "TZ", "TH", "CD", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "YU", "ZM", "ZW" ] }, { "name": "acquirerMerchantId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.

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

Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs

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

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

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

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

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

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

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

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

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

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

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

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

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

3DSecure - ECI value recieved from authorization/authentication response

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

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

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

3DSecure - Party executed the 3DS authentication

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

3DSecure - Indication of the friction that the user experienced

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

3DSecure - Status text received from 3D secure vendor

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

3DSecure - Version used in the transaction

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

True if automated - cases where refund is generated automatically by merchnat. For example where end user changed ordered item into a cheaper one

", "example": false }, { "name": "isFullRefund", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\n

True, if refund is for the full transaction amount. False, if refund is only for partial amount of transaction.

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

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "refundAuthorizationCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nRefund authorization code from payment gateway", "example": "B44233", "maxLength": 255 }, { "name": "refundDate", "kind": "optional", "type": "string", "nullable": true, "description": "

Date the refund was payed. Use YYYY-MM-DD format.

", "example": "2015-06-12", "format": "date" }, { "name": "refundInitiatedBy", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

By whom the refund was intitiated (merchant or customer).

", "example": "MERCHANT", "enum": [ "MERCHANT", "CUSTOMER" ] }, { "name": "refundMethod", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Description of the type of return method (bank, gift card points, loyalty points, etc.).

", "example": "ORIGINAL_PAYMENT_METHOD", "enum": [ "BANK", "PAYPAL", "STORE_CREDIT", "ORIGINAL_PAYMENT_METHOD", "DIFFERENT_PAYMENT_METHOD" ] }, { "name": "refundStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

The updated refund request status (When refund status is COMPLETED order status type should be RETURNED)

", "example": "COMPLETED", "enum": [ "REQUESTED", "DECLINED", "COMPLETED" ] } ] } ], "schema": [] }, { "name": "returnedCartItems", "kind": "optional", "type": "array", "nullable": true, "description": "A list of returned items. Required only if one or more items have been returned.", "modelRef": "#/components/schemas/Item", "customType": "Item[]", "schema": [ { "name": "basicItemData", "kind": "required", "type": "object", "description": "

General data regarding item such as name, price, etc.

", "modelRef": "#/components/schemas/BasicItemData", "customType": "BasicItemData", "schema": [ { "name": "category", "kind": "optional", "type": "string", "nullable": true, "description": "Item category", "example": "Apparel and accessories", "maxLength": 1000 }, { "name": "discount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Discount", "description": "", "modelRef": "#/components/schemas/Discount", "schema": [ { "name": "couponCodeUsed", "kind": "required", "type": "string", "description": "Coupon code used", "example": "FATHERSDAY2015", "maxLength": 150 }, { "name": "couponDiscountAmount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "couponDiscountPercent", "kind": "optional", "type": "string", "nullable": true, "description": "Coupon discount amount" } ] } ], "schema": [] }, { "name": "name", "kind": "required", "type": "string", "description": "Item name", "example": "White GenericBrand handbag", "maxLength": 500 }, { "name": "price", "kind": "required", "type": "object", "description": "

Final amount due for purchase, after all discounts and promotions

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

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] }, { "name": "productId", "kind": "optional", "type": "string", "nullable": true, "description": "

Unique identifier for item that is common to all identical items (such as SKU, ISBN, etc.)

", "example": "Ag54352R7768kkO", "maxLength": 70 }, { "name": "quantity", "kind": "required", "type": "number", "description": "Item quantity", "example": 1 }, { "name": "type", "kind": "required", "type": "string", "description": "

Tangible if physical item, non-tangible if any other product

", "example": "TANGIBLE", "enum": [ "TANGIBLE", "NON_TANGIBLE" ] } ] }, { "name": "beneficiaries", "kind": "optional", "type": "array", "nullable": true, "description": "

List of all entities receiving or using purchased item (Recipients of physical or digital goods, passengers of transport services, guests of accommodation services, etc.)

", "modelRef": "#/components/schemas/Beneficiary", "customType": "Beneficiary[]", "schema": [ { "name": "additionalVerificationDocuments", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AdditionalVerificationDocuments", "description": "", "modelRef": "#/components/schemas/AdditionalVerificationDocuments", "schema": [ { "name": "documentDateOfBirth", "kind": "optional", "type": "string", "nullable": true, "description": "

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

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

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

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

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

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

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

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

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

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

Type of document (Passport, ID, Driving license)

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

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

is 1420070400

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

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

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

Unit-level address

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

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

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

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

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

Bank account unique identifier (IBAN or equivalent)

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

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

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

Unique transaction identifier (sent by gateway)

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

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

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

Customer's rewards/loyalty/frequent flyer account number

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

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

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

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

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

Personal information such as name, birthdate and email

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

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

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

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

", "example": 1389567341 }, { "name": "verified", "kind": "required", "type": "boolean", "description": "

True if customer received email verification message to this address and clicked-through back to merchant's site, or received SMS message and enterd code in merchant's site (two-factor authentication)

", "example": false } ] } ] } ] }, { "name": "deliveryDetails", "kind": "required", "type": "object", "description": "Delivery details used for this item. Required if different items have different delivery information not specified in primaryDeliveryDetails", "modelRef": "#/components/schemas/DeliveryDetails", "customType": "DeliveryDetails", "schema": [ { "name": "delayedDeliveryDate", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Use only if customer explicitly selected a delayed delivery date beyond the merchant’s standard options. Use YYYY-MM-DD format.

", "example": "2014-12-15", "format": "date" }, { "name": "delayedDeliveryTime", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\n

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).

", "example": 1415273168 }, { "name": "deliveryComments", "kind": "optional", "type": "string", "nullable": true, "description": "Any comments or requests customer had for delivery", "example": "Please call before arriving, Thanks!", "maxLength": 255 }, { "name": "deliveryMethod", "kind": "required", "type": "string", "description": "

Delivery method chosen by customer such as postal service, email, in game transfer, etc.

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

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "deliveryType", "kind": "required", "type": "string", "description": "

Type of delivery: PHYSICAL for any type of shipped goods. DIGITAL for non-shipped goods (services, gift cards etc.)

", "example": "PHYSICAL", "enum": [ "DIGITAL", "PHYSICAL", "HYBRID" ] } ] }, { "name": "itemReturnData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ReturnData", "description": "", "modelRef": "#/components/schemas/ReturnData", "schema": [ { "name": "posDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PointOfSaleDetails", "description": "", "modelRef": "#/components/schemas/PointOfSaleDetails", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "cardEntryMethod", "kind": "required", "type": "string", "description": "Credit card entry method", "example": "SCANNED", "enum": [ "SCANNED", "HAND_KEYED", "CHIP_READ", "UNKNOWN", "SAVED_IN_ACCOUNT", "SWIPED" ] }, { "name": "cashierId", "kind": "required", "type": "string", "description": "Employee identifier", "example": "fgh5e0rr48923d", "maxLength": 40 }, { "name": "departmentId", "kind": "required", "type": "string", "description": "Unique store department identifier", "example": "e0r4592356fds", "maxLength": 40 }, { "name": "storeBusinessUnit", "kind": "required", "type": "string", "description": "Store business unit", "example": "Full Line", "maxLength": 40 }, { "name": "storeId", "kind": "required", "type": "string", "description": "Unique store identifier", "example": "2356fdse0rr489", "maxLength": 40 }, { "name": "storeName", "kind": "required", "type": "string", "description": "Store name", "example": "Union Square", "maxLength": 40 }, { "name": "workStationId", "kind": "required", "type": "string", "description": "

Unique work-station identifier

", "example": "923e5th5e0rr48", "maxLength": 40 } ] } ], "schema": [] }, { "name": "returnCondition", "kind": "optional", "type": "string", "nullable": true, "description": "Condition of the item returned", "example": "DAMAGED", "maxLength": 40 }, { "name": "returnInternalReasonCategory", "kind": "optional", "type": "string", "nullable": true, "description": "The reason for the return as defined by the merchant", "example": "defective item", "maxLength": 40 }, { "name": "returnMethod", "kind": "optional", "type": "string", "nullable": true, "description": "

Method of return, e.g. online, in-store

", "example": "ONLINE", "enum": [ "ONLINE", "IN-STORE" ] }, { "name": "returnReasonCategory", "kind": "optional", "type": "string", "nullable": true, "description": "Reason for return", "example": "CHANGED_MY_MIND", "enum": [ "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" ] }, { "name": "returnSegment", "kind": "optional", "type": "string", "nullable": true, "description": "Specific return segment as defined by the merchant", "example": "GENERAL", "maxLength": 40 }, { "name": "returnStatusLog", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ReturnStatusLog", "description": "", "modelRef": "#/components/schemas/ReturnStatusLog", "schema": [ { "name": "arrivedToWarehouse", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates that the returned items arrived to the merchant's warehouse", "example": true }, { "name": "arrivedToWarehouseTime", "kind": "optional", "type": "number", "nullable": true, "description": "Time returned items arrived to the merchant's warehouse", "example": 1420070400000 }, { "name": "returnInitiated", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates that the customer initiated a return process online", "example": true }, { "name": "returnInitiationTime", "kind": "optional", "type": "number", "nullable": true, "description": "Time online return was initiated", "example": 1420070400000 }, { "name": "shippedByCustomer", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates that the customer has shipped the returned items back to the merchant", "example": true }, { "name": "shippedByCustomerTime", "kind": "optional", "type": "number", "nullable": true, "description": "Time returned items were shipped by the customer", "example": 1420070400000 } ] } ], "schema": [] }, { "name": "typeOfCompensationRequested", "kind": "optional", "type": "string", "nullable": true, "description": "

Indicates whether the customer requested a refund, store credit, replacement etc.

", "example": "REFUND", "enum": [ "REPLACEMENT", "REFUND", "REFUND_UPON_RETURN", "CREDIT", "MIXED", "UNKNOWN", "NO_COMPENSATION" ] }, { "name": "updatedReturnStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThe updated status of the return on the merchant's side", "example": "ACCEPTED_BY_MERCHANT", "enum": [ "ACCEPTED_BY_MERCHANT", "REJECTED_BY_MERCHANT", "PARTIALLY_ACCEPTED_BY_MERCHANT" ] } ] } ], "schema": [] }, { "name": "itemSpecificData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ItemSpecificData", "description": "", "modelRef": "#/components/schemas/ItemSpecificData", "schema": [ { "name": "accommodation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AccommodationItem", "description": "", "modelRef": "#/components/schemas/AccommodationItem", "schema": [ { "name": "accommodationAddress", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "accommodationName", "kind": "optional", "type": "string", "nullable": true, "description": "Name of the facility", "maxLength": 100 }, { "name": "duration", "kind": "required", "type": "object", "description": "Duration of stay", "modelRef": "#/components/schemas/Duration", "customType": "Duration", "schema": [ { "name": "endDate", "kind": "required", "type": "string", "description": "

Date service/item ends or becomes unavailable. Use YYYY-MM-DD format.

", "example": "2014-11-15", "format": "date" }, { "name": "startDate", "kind": "required", "type": "string", "description": "

Date service/item begins or becomes available. Use YYYY-MM-DD format.

", "example": "2014-10-28", "format": "date" } ] }, { "name": "housingType", "kind": "optional", "type": "string", "nullable": true, "description": "

Type of room/housing

", "example": "Presidential Suite", "maxLength": 100 }, { "name": "isRefundable", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if order can be cancelled and refunded", "example": false }, { "name": "location", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "RoughLocation", "description": "", "modelRef": "#/components/schemas/RoughLocation", "schema": [ { "name": "airportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThree letter IATA airport code", "example": "JFK", "pattern": "[A-Z]{3}" }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "City", "example": "Anytown" }, { "name": "country", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

Top-level administrative subdivision - state/province/department/etc.

", "example": "New York" }, { "name": "seaportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFive letter seaport code", "example": "USNYC", "pattern": "[A-Z]{5}" } ] } ], "schema": [] }, { "name": "numberOfGuests", "kind": "required", "type": "number", "description": "Number of guests", "example": 2 }, { "name": "rating", "kind": "optional", "type": "array", "conditional": true, "nullable": true, "description": "Conditional.\n

All ratings given to item or service. Can include internal peer rating, merchant rating, official professional association ratings, etc.

", "modelRef": "#/components/schemas/Rating", "customType": "Rating[]", "schema": [ { "name": "score", "kind": "required", "type": "string", "description": "

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

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

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

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

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

", "example": "INTERNAL_PEERS", "enum": [ "INTERNAL_PEERS", "INTERNAL_MERCHANT", "EXTERNAL_PEERS", "EXTERNAL_INDEPENDENT" ] } ] }, { "name": "type", "kind": "required", "type": "string", "description": "Type of accommodation service", "example": "HOTEL", "enum": [ "HOTEL", "APARTMENT", "CRUISE", "STUDIO", "EVENT_VENUE" ] } ] } ], "schema": [] }, { "name": "cryptocurrency", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CryptoItem", "description": "", "modelRef": "#/components/schemas/CryptoItem", "schema": [ { "name": "destinationWallet", "kind": "optional", "type": "string", "nullable": true, "description": "Destination wallet address", "example": "3JQiwG88SQvwihDAHg9M2EnqEisharz49c" } ] } ], "schema": [] }, { "name": "digitalGoodsAndServices", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ServiceItem", "description": "", "modelRef": "#/components/schemas/ServiceItem", "schema": [ { "name": "automaticRenewal", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to have service automatically renewed once current service ends", "example": true }, { "name": "billingFrequency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThe frequency customer has chosen for billing", "example": "MONTHLY", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "SEMI_ANNUAL", "ANNUAL", "MULTI_ANNUAL", "OTHER" ] }, { "name": "duration", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Duration", "description": "", "modelRef": "#/components/schemas/Duration", "schema": [ { "name": "endDate", "kind": "required", "type": "string", "description": "

Date service/item ends or becomes unavailable. Use YYYY-MM-DD format.

", "example": "2014-11-15", "format": "date" }, { "name": "startDate", "kind": "required", "type": "string", "description": "

Date service/item begins or becomes available. Use YYYY-MM-DD format.

", "example": "2014-10-28", "format": "date" } ] } ], "schema": [] }, { "name": "isTrial", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\n

True if the product\\service begins with a free trial

", "example": false }, { "name": "webHosting", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "WebHostingItem", "description": "", "modelRef": "#/components/schemas/WebHostingItem", "schema": [ { "name": "SSLcertificates", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if customer asked or paid extra for SSL certificates to be included", "example": false }, { "name": "domains", "kind": "required", "type": "array", "description": "List of domains purchased", "example": "[\"testforterdomain.com\",\"testforterdomain.me\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "emailService", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if customer asked or paid extra for Email functionality", "example": false }, { "name": "privateRegistration", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if customer asked or paid extra to hide registrant details from whois services", "example": false }, { "name": "sercurityUpgrades", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\n

True if customer asked or paid extra for security upgrades (antivirus, firewall, etc.)

", "example": false }, { "name": "webPromotion", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if customer asked or paid extra for promotion services such as SEO", "example": false }, { "name": "websiteBuilder", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if customer asked or paid extra for website builder wizard services", "example": false } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "food", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "FoodItem", "description": "", "modelRef": "#/components/schemas/FoodItem", "schema": [ { "name": "restaurantAddress", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "restaurantId", "kind": "optional", "type": "string", "nullable": true, "description": "Restaurant unique identifier", "example": "eh674df9", "maxLength": 50 }, { "name": "restaurantName", "kind": "optional", "type": "string", "nullable": true, "description": "The name of the restaurant", "example": "Ron's Steak House", "maxLength": 100 }, { "name": "tipAmount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "gaming", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GamingItem", "description": "", "modelRef": "#/components/schemas/GamingItem", "schema": [ { "name": "characterName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

In-game character name

", "example": "JohnTheGamer", "maxLength": 100 }, { "name": "characterRole", "kind": "optional", "type": "string", "nullable": true, "description": "Character's role in the game", "example": "Warrior", "maxLength": 100 }, { "name": "gameGenre", "kind": "optional", "type": "string", "nullable": true, "description": "

Game type/genre

", "example": "MMORPG", "maxLength": 50 }, { "name": "gameItemAmount", "kind": "required", "type": "number", "description": "

Number of game items or commodities bought (100 coins, 2000 gold, 10 experience points, etc.)

", "example": 1000 }, { "name": "gameName", "kind": "required", "type": "string", "description": "Game name", "example": "WorldOfSampleGamecrat", "maxLength": 50 }, { "name": "gamePlatform", "kind": "optional", "type": "string", "nullable": true, "description": "Game platform", "example": "XBOX", "maxLength": 50 }, { "name": "gameServerCountry", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "DK", "maxLength": 2, "pattern": "[A-Za-z]{2}" }, { "name": "gameServerName", "kind": "optional", "type": "string", "nullable": true, "description": "Game server name", "example": "5ample5erver", "maxLength": 100 }, { "name": "inGameTradeLocation", "kind": "optional", "type": "string", "nullable": true, "description": "

In-Game trade location

", "example": "At the mouth of the Sampletradelocation river" }, { "name": "playerFaction", "kind": "optional", "type": "string", "nullable": true, "description": "

Player's in-game faction/clan/group

", "example": "TestC1an", "maxLength": 100 }, { "name": "playerLeague", "kind": "optional", "type": "string", "nullable": true, "description": "

Player's in-game league

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

Player's in-game level

", "example": "59", "maxLength": 50 }, { "name": "playerPosition", "kind": "optional", "type": "string", "nullable": true, "description": "

Player's in-game position

", "example": "10", "maxLength": 50 } ] } ], "schema": [] }, { "name": "personNameRecord", "kind": "optional", "type": "string", "nullable": true, "description": "

Person Name Record (PNR). Combined with a passenger name, it serves as an identifier for a flight reservation (also for multiple passengers)

", "example": "P52DKC", "maxLength": 20 }, { "name": "physicalGoods", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PhysicalItem", "description": "", "modelRef": "#/components/schemas/PhysicalItem", "schema": [ { "name": "wrapAsGift", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to have item wrapped as a gift", "example": true } ] } ], "schema": [] }, { "name": "professionalServices", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ProfessionalServices", "description": "", "modelRef": "#/components/schemas/ProfessionalServices", "schema": [ { "name": "numberOfParticipatingClients", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\n

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.

", "example": 1 }, { "name": "numberOfParticipatingVendors", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\nNumber of vendors associated with this service. Would be greater than 1 in cases where several vendors collaborate to offer the service.", "example": 1 }, { "name": "tipAmount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "ticketsAndEvents", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "TicketItem", "description": "", "modelRef": "#/components/schemas/TicketItem", "schema": [ { "name": "eventLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "eventName", "kind": "required", "type": "string", "description": "Name of the event", "example": "FIFA World Cup Final" }, { "name": "eventTime", "kind": "optional", "type": "number", "nullable": true, "description": "

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

is 1420070400

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

Type of event (movie, concert, sports, etc.)

", "example": "sports", "maxLength": 100 }, { "name": "eventVenueName", "kind": "optional", "type": "string", "nullable": true, "description": "Name of venue where event takes place", "example": "Maracana Stadium" }, { "name": "ticketCategory", "kind": "optional", "type": "string", "nullable": true, "description": "

Ticket category (adult, student, senior, child, etc.)

", "example": "ADULT", "enum": [ "ADULT", "CHILD", "ENFANT", "SENIOR", "STUDENT", "VETERAN", "OTHER" ], "maxLength": 25 }, { "name": "ticketClass", "kind": "optional", "type": "string", "nullable": true, "description": "

Class of tickets purchased (Standing, VIP, Platinum, etc.)

", "example": "court side", "maxLength": 25 } ] } ], "schema": [] }, { "name": "transport", "kind": "optional", "type": "array", "nullable": true, "description": "Additional information regarding transportation services or products", "modelRef": "#/components/schemas/TransportItem", "customType": "TransportItem[]", "schema": [ { "name": "bookingSource", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Use to indicate the affiliate, origin, internal source or flow that this part of the booking is associated with

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

Company operating transportation service purchased (airline, car rental company, etc.)

", "example": "Forter airlines" }, { "name": "class", "kind": "optional", "type": "string", "nullable": true, "description": "

Seating class (Tourist, business, first, etc.)

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

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "dateOfFirstSale", "kind": "optional", "type": "number", "nullable": true, "description": "

Date of first sale by seller, in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1430997968 }, { "name": "ratingAsBuyer", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Rating", "description": "", "modelRef": "#/components/schemas/Rating", "schema": [ { "name": "score", "kind": "required", "type": "string", "description": "

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

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

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

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

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

", "example": "INTERNAL_PEERS", "enum": [ "INTERNAL_PEERS", "INTERNAL_MERCHANT", "EXTERNAL_PEERS", "EXTERNAL_INDEPENDENT" ] } ] } ], "schema": [] }, { "name": "ratingAsSeller", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Rating", "description": "", "modelRef": "#/components/schemas/Rating", "schema": [ { "name": "score", "kind": "required", "type": "string", "description": "

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

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

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

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

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

", "example": "INTERNAL_PEERS", "enum": [ "INTERNAL_PEERS", "INTERNAL_MERCHANT", "EXTERNAL_PEERS", "EXTERNAL_INDEPENDENT" ] } ] } ], "schema": [] }, { "name": "sellerAccountCreationDate", "kind": "required", "type": "number", "description": "

Date seller account was created in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1415273168 }, { "name": "sellerLastLoginIP", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "IP", "description": "", "modelRef": "#/components/schemas/IP", "schema": [ { "name": "ip", "kind": "required", "type": "string", "description": "Customer IP address in v4 format", "example": "10.0.0.128" }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "sellerPastSalesCount", "kind": "optional", "type": "integer", "nullable": true, "description": "Count of all successfully fulfilled sales made", "example": 8 }, { "name": "sellerPersonalDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PersonalDetails", "description": "", "modelRef": "#/components/schemas/PersonalDetails", "schema": [ { "name": "birthdate", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "1987-05-22", "format": "date" }, { "name": "email", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nEmail address", "example": "john_s@test.com", "maxLength": 256 }, { "name": "firstName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFirst name", "example": "John", "maxLength": 75 }, { "name": "fullName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFull name. Not Needed if firstName and LastName are provided independently.", "example": "John Smith", "maxLength": 150 }, { "name": "gender", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nGender", "example": "MALE", "enum": [ "MALE", "FEMALE", "CHOSE_NOT_TO_SPECIFY", "NONE" ] }, { "name": "lastName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nLast name", "example": "Smith", "maxLength": 75 } ] } ], "schema": [] }, { "name": "sellerRegistrationIP", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "IP", "description": "", "modelRef": "#/components/schemas/IP", "schema": [ { "name": "ip", "kind": "required", "type": "string", "description": "Customer IP address in v4 format", "example": "10.0.0.128" }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "duration", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ExactDuration", "description": "", "modelRef": "#/components/schemas/ExactDuration", "schema": [ { "name": "endTime", "kind": "optional", "type": "integer", "nullable": true, "description": "

Unix timestamp in seconds of when service/item ends or becomes unavailable in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1420294711 }, { "name": "startTime", "kind": "required", "type": "number", "description": "

Unix timestamp in seconds of when service/item begins or becomes available in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1412345911 } ] } ], "schema": [] }, { "name": "endPoint", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Location", "description": "", "modelRef": "#/components/schemas/Location", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "exactLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ExactLocation", "description": "", "modelRef": "#/components/schemas/ExactLocation", "schema": [ { "name": "latitude", "kind": "required", "type": "number", "description": "

Latitude in Decimal Degrees (WGS84)

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

Longitude in Decimal Degrees (WGS84)

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

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)

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

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)

", "example": "Times Square" }, { "name": "specificLocationType", "kind": "optional", "type": "string", "nullable": true, "description": "Specific location type.", "example": "Event" } ] } ], "schema": [] }, { "name": "roughLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "RoughLocation", "description": "", "modelRef": "#/components/schemas/RoughLocation", "schema": [ { "name": "airportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThree letter IATA airport code", "example": "JFK", "pattern": "[A-Z]{3}" }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "City", "example": "Anytown" }, { "name": "country", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

Top-level administrative subdivision - state/province/department/etc.

", "example": "New York" }, { "name": "seaportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFive letter seaport code", "example": "USNYC", "pattern": "[A-Z]{5}" } ] } ], "schema": [] }, { "name": "savedLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "expeditedBoarding", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer paid extra for expedited boarding", "example": false }, { "name": "extraBaggage", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer paid extra to bring extra baggage", "example": false }, { "name": "leg", "kind": "optional", "type": "integer", "conditional": true, "nullable": true, "description": "Conditional.\n

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)

", "example": 2 }, { "name": "locationAtTimeOfReservation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Location", "description": "", "modelRef": "#/components/schemas/Location", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "exactLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ExactLocation", "description": "", "modelRef": "#/components/schemas/ExactLocation", "schema": [ { "name": "latitude", "kind": "required", "type": "number", "description": "

Latitude in Decimal Degrees (WGS84)

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

Longitude in Decimal Degrees (WGS84)

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

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)

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

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)

", "example": "Times Square" }, { "name": "specificLocationType", "kind": "optional", "type": "string", "nullable": true, "description": "Specific location type.", "example": "Event" } ] } ], "schema": [] }, { "name": "roughLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "RoughLocation", "description": "", "modelRef": "#/components/schemas/RoughLocation", "schema": [ { "name": "airportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThree letter IATA airport code", "example": "JFK", "pattern": "[A-Z]{3}" }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "City", "example": "Anytown" }, { "name": "country", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

Top-level administrative subdivision - state/province/department/etc.

", "example": "New York" }, { "name": "seaportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFive letter seaport code", "example": "USNYC", "pattern": "[A-Z]{5}" } ] } ], "schema": [] }, { "name": "savedLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "passengers", "kind": "optional", "type": "number", "nullable": true, "description": "Number of passengers", "example": 2 }, { "name": "purchasedMeals", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer paid extra to receive meals on board", "example": false }, { "name": "selectSeat", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer paid extra to select a seat", "example": false }, { "name": "startPoint", "kind": "required", "type": "object", "description": "Trip starting point", "modelRef": "#/components/schemas/Location", "customType": "Location", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "address1", "kind": "required", "type": "string", "description": "

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

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

Unit-level address

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

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

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

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

", "example": "CA", "maxLength": 200 }, { "name": "savedData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "schema": [] }, { "name": "zip", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode", "example": "94104", "maxLength": 20 } ] } ], "schema": [] }, { "name": "exactLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ExactLocation", "description": "", "modelRef": "#/components/schemas/ExactLocation", "schema": [ { "name": "latitude", "kind": "required", "type": "number", "description": "

Latitude in Decimal Degrees (WGS84)

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

Longitude in Decimal Degrees (WGS84)

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

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)

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

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)

", "example": "Times Square" }, { "name": "specificLocationType", "kind": "optional", "type": "string", "nullable": true, "description": "Specific location type.", "example": "Event" } ] } ], "schema": [] }, { "name": "roughLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "RoughLocation", "description": "", "modelRef": "#/components/schemas/RoughLocation", "schema": [ { "name": "airportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThree letter IATA airport code", "example": "JFK", "pattern": "[A-Z]{3}" }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "City", "example": "Anytown" }, { "name": "country", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

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

Top-level administrative subdivision - state/province/department/etc.

", "example": "New York" }, { "name": "seaportCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFive letter seaport code", "example": "USNYC", "pattern": "[A-Z]{5}" } ] } ], "schema": [] }, { "name": "savedLocation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SavedData", "description": "", "modelRef": "#/components/schemas/SavedData", "schema": [ { "name": "choseToSaveData", "kind": "optional", "type": "boolean", "nullable": true, "description": "True if customer chose to save data in the account for future use", "example": false }, { "name": "usedSavedData", "kind": "required", "type": "boolean", "description": "True if customer chose to use data saved in the account", "example": true } ] } ], "schema": [] } ] }, { "name": "type", "kind": "required", "type": "string", "description": "Type of transportation service", "example": "AIR_TRAVEL", "enum": [ "PRIVATE_TAXI", "PRIVATE_VIP_TAXI", "PRIVATE_LARGE_TAXI", "SHARED_RIDE", "SHARED_RIDE_DISCOUNT", "AIR_TRAVEL", "RAIL", "FERRY", "BUS", "CAR_RENTAL", "PARKING", "CRUISE_LINE" ] } ] } ] } ], "schema": [] }, { "name": "seller", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SellerData", "description": "", "modelRef": "#/components/schemas/SellerData", "schema": [ { "name": "sellerBusinessWebsite", "kind": "optional", "type": "string", "nullable": true, "description": "Seller's business website URL", "example": "www.acme-events.net" }, { "name": "sellerCategory", "kind": "optional", "type": "string", "nullable": true, "description": "Type of service offered by the seller", "example": "Event Planner" }, { "name": "sellerDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "BasicSellerData", "description": "", "modelRef": "#/components/schemas/BasicSellerData", "schema": [ { "name": "availableFundsForWithdrawal", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "dateOfFirstSale", "kind": "optional", "type": "number", "nullable": true, "description": "

Date of first sale by seller, in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1430997968 }, { "name": "ratingAsBuyer", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Rating", "description": "", "modelRef": "#/components/schemas/Rating", "schema": [ { "name": "score", "kind": "required", "type": "string", "description": "

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

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

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

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

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

", "example": "INTERNAL_PEERS", "enum": [ "INTERNAL_PEERS", "INTERNAL_MERCHANT", "EXTERNAL_PEERS", "EXTERNAL_INDEPENDENT" ] } ] } ], "schema": [] }, { "name": "ratingAsSeller", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Rating", "description": "", "modelRef": "#/components/schemas/Rating", "schema": [ { "name": "score", "kind": "required", "type": "string", "description": "

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

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

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

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

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

", "example": "INTERNAL_PEERS", "enum": [ "INTERNAL_PEERS", "INTERNAL_MERCHANT", "EXTERNAL_PEERS", "EXTERNAL_INDEPENDENT" ] } ] } ], "schema": [] }, { "name": "sellerAccountCreationDate", "kind": "required", "type": "number", "description": "

Date seller account was created in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1415273168 }, { "name": "sellerLastLoginIP", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "IP", "description": "", "modelRef": "#/components/schemas/IP", "schema": [ { "name": "ip", "kind": "required", "type": "string", "description": "Customer IP address in v4 format", "example": "10.0.0.128" }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "creationTime", "kind": "required", "type": "number", "description": "

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

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

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

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

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

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

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

", "example": 1448895522 } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "sellerPastSalesCount", "kind": "optional", "type": "integer", "nullable": true, "description": "Count of all successfully fulfilled sales made", "example": 8 }, { "name": "sellerPersonalDetails", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PersonalDetails", "description": "", "modelRef": "#/components/schemas/PersonalDetails", "schema": [ { "name": "birthdate", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "1987-05-22", "format": "date" }, { "name": "email", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nEmail address", "example": "john_s@test.com", "maxLength": 256 }, { "name": "firstName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFirst name", "example": "John", "maxLength": 75 }, { "name": "fullName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nFull name. Not Needed if firstName and LastName are provided independently.", "example": "John Smith", "maxLength": 150 }, { "name": "gender", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nGender", "example": "MALE", "enum": [ "MALE", "FEMALE", "CHOSE_NOT_TO_SPECIFY", "NONE" ] }, { "name": "lastName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nLast name", "example": "Smith", "maxLength": 75 } ] } ], "schema": [] }, { "name": "sellerRegistrationIP", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "IP", "description": "", "modelRef": "#/components/schemas/IP", "schema": [ { "name": "ip", "kind": "required", "type": "string", "description": "Customer IP address in v4 format", "example": "10.0.0.128" }, { "name": "updateTimes", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UpdateTimes", "description": "", "modelRef": "#/components/schemas/UpdateTimes", "schema": [ { "name": "creationTime", "kind": "required", "type": "number", "description": "

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

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

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

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

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

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

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

", "example": 1448895522 } ] } ], "schema": [] } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "sellerVendorName", "kind": "optional", "type": "string", "nullable": true, "description": "Name of the vendor", "example": "Acme Event Planners Inc." } ] } ], "schema": [] }, { "name": "shopifyAdditionalItemData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ShopifyAdditionalItemData", "description": "", "modelRef": "#/components/schemas/ShopifyAdditionalItemData", "schema": [ { "name": "properties", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] } ] } ], "schema": [] } ] }, { "name": "statusChangeReason", "kind": "optional", "type": "string", "nullable": true, "description": "

Reason the status changed, if applicable. Mainly relevant for cases an order was canceled (due to a fraud decision / stock / customer request / etc)

", "example": "Fraud_Team_Manual_Decline", "maxLength": 150 }, { "name": "updatedMerchantStatus", "kind": "optional", "type": "string", "nullable": true, "description": "The new status as defined in the merchant's system", "example": "Shipped", "maxLength": 150 }, { "name": "updatedStatus", "kind": "required", "type": "string", "description": "The updated order status type", "example": "SENT", "enum": [ "PROCESSING", "SENT", "COMPLETED", "CANCELED_BY_MERCHANT", "CANCELED_BY_CUSTOMER", "RETURNED", "NO_SHOW", "REPLACED" ] }, { "name": "updatedTotalAmount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "updatedTotalDiscount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Discount", "description": "", "modelRef": "#/components/schemas/Discount", "schema": [ { "name": "couponCodeUsed", "kind": "required", "type": "string", "description": "Coupon code used", "example": "FATHERSDAY2015", "maxLength": 150 }, { "name": "couponDiscountAmount", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Amount", "description": "", "modelRef": "#/components/schemas/Amount", "schema": [ { "name": "amountLocalCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in currency chosen by the buyer", "example": "105.55", "maxLength": 20 }, { "name": "amountUSD", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction amount in USD", "example": "99.95", "maxLength": 12 }, { "name": "currency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

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

", "example": "CAD", "maxLength": 3, "pattern": "[A-Z]{3}" } ] } ], "schema": [] }, { "name": "couponDiscountPercent", "kind": "optional", "type": "string", "nullable": true, "description": "Coupon discount amount" } ] } ], "schema": [] }, { "name": "updatedTryOutStatus", "kind": "optional", "type": "string", "nullable": true, "description": "The updated TryOut flow status type", "example": "EMAIL_SENT_TO_CUSTOMER", "enum": [ "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" ] }, { "name": "verificationResults", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CreditCardVerification", "description": "", "modelRef": "#/components/schemas/CreditCardVerification", "schema": [ { "name": "authorizationCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCard authorization code from payment gateway", "example": "A33244", "maxLength": 255 }, { "name": "authorizationProcessedWith3DS", "kind": "optional", "type": "boolean", "nullable": true, "description": "

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

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

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

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

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

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

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

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

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

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

3DSecure - ECI value recieved from authorization/authentication response

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

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

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

3DSecure - Party executed the 3DS authentication

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

3DSecure - Indication of the friction that the user experienced

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

3DSecure - Status text received from 3D secure vendor

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

3DSecure - Version used in the transaction

", "example": "2.1.0", "maxLength": 5 } ] } ], "schema": [] } ], "modelRef": "#/components/schemas/statusRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "basicAuth", "name": "basicAuth", "kind": "optional", "type": "http", "scheme": "basic" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Example statusResponse", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "The response object following status request to the system", "customType": "statusResponse", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "The message containing status response text", "example": "Transaction #:id status recieved", "maxLength": 1000 }, { "name": "status", "kind": "required", "type": "string", "description": "Status of the request processing", "example": "success", "maxLength": 50 } ], "modelRef": "#/components/schemas/statusResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "

Bad Request (Often missing a required parameter)

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

Unauthorized (No valid API key provided)

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

Not Found (The requested item doesn't exist)

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

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

", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "NkaMOaQAZyXiWoLPfaV28", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.forter-secure.com/v2/status/{id} \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'api-version: 10.1' \\\n --header 'x-forter-siteid: a1b2c3d4e5f6' \\\n --data '{\n \"additionalInformation\": {},\n \"cartItems\": [\n {\n \"basicItemData\": {\n \"discount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"name\": \"White GenericBrand handbag\",\n \"price\": {},\n \"quantity\": 1,\n \"type\": \"TANGIBLE\"\n },\n \"beneficiaries\": [\n {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"bankAccount\": {\n \"paymentGatewayData\": {}\n },\n \"comments\": {},\n \"cryptoWallet\": {\n \"cryptoWalletType\": \"EXTERNAL\"\n },\n \"personalDetails\": {},\n \"phone\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ]\n }\n ],\n \"deliveryDetails\": {\n \"deliveryMethod\": \"USPS - Ground Mail\",\n \"deliveryPrice\": {},\n \"deliveryType\": \"PHYSICAL\"\n },\n \"itemReturnData\": {\n \"posDetails\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"cardEntryMethod\": \"SCANNED\",\n \"cashierId\": \"fgh5e0rr48923d\",\n \"departmentId\": \"e0r4592356fds\",\n \"storeBusinessUnit\": \"Full Line\",\n \"storeId\": \"2356fdse0rr489\",\n \"storeName\": \"Union Square\",\n \"workStationId\": \"923e5th5e0rr48\"\n },\n \"returnStatusLog\": {}\n },\n \"itemSpecificData\": {\n \"accommodation\": {\n \"accommodationAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"location\": {},\n \"numberOfGuests\": 2,\n \"rating\": [\n {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n }\n ],\n \"type\": \"HOTEL\"\n },\n \"cryptocurrency\": {},\n \"digitalGoodsAndServices\": {\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"webHosting\": {\n \"domains\": []\n }\n },\n \"food\": {\n \"restaurantAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"tipAmount\": {}\n },\n \"gaming\": {\n \"gameItemAmount\": 1000,\n \"gameName\": \"WorldOfSampleGamecrat\"\n },\n \"physicalGoods\": {},\n \"professionalServices\": {\n \"tipAmount\": {}\n },\n \"ticketsAndEvents\": {\n \"eventLocation\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"eventName\": \"FIFA World Cup Final\"\n },\n \"transport\": [\n {\n \"driverDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n }\n },\n \"duration\": {\n \"startTime\": 1412345911\n },\n \"endPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"locationAtTimeOfReservation\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"startPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"type\": \"AIR_TRAVEL\"\n }\n ]\n },\n \"seller\": {\n \"sellerDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n }\n }\n },\n \"shopifyAdditionalItemData\": {\n \"properties\": {}\n }\n }\n ],\n \"compensationStatus\": {\n \"itemStatus\": [\n {\n \"basicItemData\": {\n \"discount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"name\": \"White GenericBrand handbag\",\n \"price\": {},\n \"quantity\": 1,\n \"type\": \"TANGIBLE\"\n },\n \"statusData\": {\n \"compensationTypeGranted\": \"REFUND\",\n \"reasonCategory\": \"CHANGED_MY_MIND\",\n \"returnMethodGranted\": \"SHIP_TO_WAREHOUSE\",\n \"statusLog\": {},\n \"updatedStatus\": \"ACCEPTED_BY_MERCHANT\"\n }\n }\n ],\n \"merchantAgentData\": {},\n \"shippingRefundedAmount\": {},\n \"statusData\": {\n \"compensationTypeGranted\": \"REFUND\",\n \"reasonCategory\": \"CHANGED_MY_MIND\",\n \"returnMethodGranted\": \"SHIP_TO_WAREHOUSE\",\n \"statusLog\": {},\n \"updatedStatus\": \"ACCEPTED_BY_MERCHANT\"\n },\n \"totalGrantedAmount\": {}\n },\n \"deliveryStatusInfo\": {},\n \"endPointLocation\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"eventTime\": 1415287568000,\n \"orderId\": \"2356fdse0rr489\",\n \"refundInformation\": {\n \"refundAmount\": {}\n },\n \"returnedCartItems\": [\n {\n \"basicItemData\": {\n \"discount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"name\": \"White GenericBrand handbag\",\n \"price\": {},\n \"quantity\": 1,\n \"type\": \"TANGIBLE\"\n },\n \"beneficiaries\": [\n {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"bankAccount\": {\n \"paymentGatewayData\": {}\n },\n \"comments\": {},\n \"cryptoWallet\": {\n \"cryptoWalletType\": \"EXTERNAL\"\n },\n \"personalDetails\": {},\n \"phone\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ]\n }\n ],\n \"deliveryDetails\": {\n \"deliveryMethod\": \"USPS - Ground Mail\",\n \"deliveryPrice\": {},\n \"deliveryType\": \"PHYSICAL\"\n },\n \"itemReturnData\": {\n \"posDetails\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"cardEntryMethod\": \"SCANNED\",\n \"cashierId\": \"fgh5e0rr48923d\",\n \"departmentId\": \"e0r4592356fds\",\n \"storeBusinessUnit\": \"Full Line\",\n \"storeId\": \"2356fdse0rr489\",\n \"storeName\": \"Union Square\",\n \"workStationId\": \"923e5th5e0rr48\"\n },\n \"returnStatusLog\": {}\n },\n \"itemSpecificData\": {\n \"accommodation\": {\n \"accommodationAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"location\": {},\n \"numberOfGuests\": 2,\n \"rating\": [\n {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n }\n ],\n \"type\": \"HOTEL\"\n },\n \"cryptocurrency\": {},\n \"digitalGoodsAndServices\": {\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"webHosting\": {\n \"domains\": []\n }\n },\n \"food\": {\n \"restaurantAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"tipAmount\": {}\n },\n \"gaming\": {\n \"gameItemAmount\": 1000,\n \"gameName\": \"WorldOfSampleGamecrat\"\n },\n \"physicalGoods\": {},\n \"professionalServices\": {\n \"tipAmount\": {}\n },\n \"ticketsAndEvents\": {\n \"eventLocation\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"eventName\": \"FIFA World Cup Final\"\n },\n \"transport\": [\n {\n \"driverDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n }\n },\n \"duration\": {\n \"startTime\": 1412345911\n },\n \"endPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"locationAtTimeOfReservation\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"startPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"type\": \"AIR_TRAVEL\"\n }\n ]\n },\n \"seller\": {\n \"sellerDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n }\n }\n },\n \"shopifyAdditionalItemData\": {\n \"properties\": {}\n }\n }\n ],\n \"updatedStatus\": \"SENT\",\n \"updatedTotalAmount\": {},\n \"updatedTotalDiscount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"verificationResults\": {\n \"external3dsVendorPayload\": {}\n }\n }'" }, { "id": "iKaOqcxxFdtlJyt8iQhK1", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"api-version\", \"10.1\");\nmyHeaders.append(\"x-forter-siteid\", \"a1b2c3d4e5f6\");\n\nvar raw = JSON.stringify({\n \"additionalInformation\": {},\n \"cartItems\": [\n {\n \"basicItemData\": {\n \"discount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"name\": \"White GenericBrand handbag\",\n \"price\": {},\n \"quantity\": 1,\n \"type\": \"TANGIBLE\"\n },\n \"beneficiaries\": [\n {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"bankAccount\": {\n \"paymentGatewayData\": {}\n },\n \"comments\": {},\n \"cryptoWallet\": {\n \"cryptoWalletType\": \"EXTERNAL\"\n },\n \"personalDetails\": {},\n \"phone\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ]\n }\n ],\n \"deliveryDetails\": {\n \"deliveryMethod\": \"USPS - Ground Mail\",\n \"deliveryPrice\": {},\n \"deliveryType\": \"PHYSICAL\"\n },\n \"itemReturnData\": {\n \"posDetails\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"cardEntryMethod\": \"SCANNED\",\n \"cashierId\": \"fgh5e0rr48923d\",\n \"departmentId\": \"e0r4592356fds\",\n \"storeBusinessUnit\": \"Full Line\",\n \"storeId\": \"2356fdse0rr489\",\n \"storeName\": \"Union Square\",\n \"workStationId\": \"923e5th5e0rr48\"\n },\n \"returnStatusLog\": {}\n },\n \"itemSpecificData\": {\n \"accommodation\": {\n \"accommodationAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"location\": {},\n \"numberOfGuests\": 2,\n \"rating\": [\n {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n }\n ],\n \"type\": \"HOTEL\"\n },\n \"cryptocurrency\": {},\n \"digitalGoodsAndServices\": {\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"webHosting\": {\n \"domains\": []\n }\n },\n \"food\": {\n \"restaurantAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"tipAmount\": {}\n },\n \"gaming\": {\n \"gameItemAmount\": 1000,\n \"gameName\": \"WorldOfSampleGamecrat\"\n },\n \"physicalGoods\": {},\n \"professionalServices\": {\n \"tipAmount\": {}\n },\n \"ticketsAndEvents\": {\n \"eventLocation\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"eventName\": \"FIFA World Cup Final\"\n },\n \"transport\": [\n {\n \"driverDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n }\n },\n \"duration\": {\n \"startTime\": 1412345911\n },\n \"endPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"locationAtTimeOfReservation\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"startPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"type\": \"AIR_TRAVEL\"\n }\n ]\n },\n \"seller\": {\n \"sellerDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n }\n }\n },\n \"shopifyAdditionalItemData\": {\n \"properties\": {}\n }\n }\n ],\n \"compensationStatus\": {\n \"itemStatus\": [\n {\n \"basicItemData\": {\n \"discount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"name\": \"White GenericBrand handbag\",\n \"price\": {},\n \"quantity\": 1,\n \"type\": \"TANGIBLE\"\n },\n \"statusData\": {\n \"compensationTypeGranted\": \"REFUND\",\n \"reasonCategory\": \"CHANGED_MY_MIND\",\n \"returnMethodGranted\": \"SHIP_TO_WAREHOUSE\",\n \"statusLog\": {},\n \"updatedStatus\": \"ACCEPTED_BY_MERCHANT\"\n }\n }\n ],\n \"merchantAgentData\": {},\n \"shippingRefundedAmount\": {},\n \"statusData\": {\n \"compensationTypeGranted\": \"REFUND\",\n \"reasonCategory\": \"CHANGED_MY_MIND\",\n \"returnMethodGranted\": \"SHIP_TO_WAREHOUSE\",\n \"statusLog\": {},\n \"updatedStatus\": \"ACCEPTED_BY_MERCHANT\"\n },\n \"totalGrantedAmount\": {}\n },\n \"deliveryStatusInfo\": {},\n \"endPointLocation\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"eventTime\": 1415287568000,\n \"orderId\": \"2356fdse0rr489\",\n \"refundInformation\": {\n \"refundAmount\": {}\n },\n \"returnedCartItems\": [\n {\n \"basicItemData\": {\n \"discount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"name\": \"White GenericBrand handbag\",\n \"price\": {},\n \"quantity\": 1,\n \"type\": \"TANGIBLE\"\n },\n \"beneficiaries\": [\n {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"bankAccount\": {\n \"paymentGatewayData\": {}\n },\n \"comments\": {},\n \"cryptoWallet\": {\n \"cryptoWalletType\": \"EXTERNAL\"\n },\n \"personalDetails\": {},\n \"phone\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ]\n }\n ],\n \"deliveryDetails\": {\n \"deliveryMethod\": \"USPS - Ground Mail\",\n \"deliveryPrice\": {},\n \"deliveryType\": \"PHYSICAL\"\n },\n \"itemReturnData\": {\n \"posDetails\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"cardEntryMethod\": \"SCANNED\",\n \"cashierId\": \"fgh5e0rr48923d\",\n \"departmentId\": \"e0r4592356fds\",\n \"storeBusinessUnit\": \"Full Line\",\n \"storeId\": \"2356fdse0rr489\",\n \"storeName\": \"Union Square\",\n \"workStationId\": \"923e5th5e0rr48\"\n },\n \"returnStatusLog\": {}\n },\n \"itemSpecificData\": {\n \"accommodation\": {\n \"accommodationAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"location\": {},\n \"numberOfGuests\": 2,\n \"rating\": [\n {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n }\n ],\n \"type\": \"HOTEL\"\n },\n \"cryptocurrency\": {},\n \"digitalGoodsAndServices\": {\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"webHosting\": {\n \"domains\": []\n }\n },\n \"food\": {\n \"restaurantAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"tipAmount\": {}\n },\n \"gaming\": {\n \"gameItemAmount\": 1000,\n \"gameName\": \"WorldOfSampleGamecrat\"\n },\n \"physicalGoods\": {},\n \"professionalServices\": {\n \"tipAmount\": {}\n },\n \"ticketsAndEvents\": {\n \"eventLocation\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"eventName\": \"FIFA World Cup Final\"\n },\n \"transport\": [\n {\n \"driverDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n }\n },\n \"duration\": {\n \"startTime\": 1412345911\n },\n \"endPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"locationAtTimeOfReservation\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"startPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"type\": \"AIR_TRAVEL\"\n }\n ]\n },\n \"seller\": {\n \"sellerDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n }\n }\n },\n \"shopifyAdditionalItemData\": {\n \"properties\": {}\n }\n }\n ],\n \"updatedStatus\": \"SENT\",\n \"updatedTotalAmount\": {},\n \"updatedTotalDiscount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"verificationResults\": {\n \"external3dsVendorPayload\": {}\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.forter-secure.com/v2/status/{id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "RMwJUBNeFpGxamOioQlj2", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.forter-secure.com/v2/status/{id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"api-version\"] = \"10.1\"\nrequest[\"x-forter-siteid\"] = \"a1b2c3d4e5f6\"\nrequest.body = JSON.dump({\n \"additionalInformation\": {},\n \"cartItems\": [\n {\n \"basicItemData\": {\n \"discount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"name\": \"White GenericBrand handbag\",\n \"price\": {},\n \"quantity\": 1,\n \"type\": \"TANGIBLE\"\n },\n \"beneficiaries\": [\n {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"bankAccount\": {\n \"paymentGatewayData\": {}\n },\n \"comments\": {},\n \"cryptoWallet\": {\n \"cryptoWalletType\": \"EXTERNAL\"\n },\n \"personalDetails\": {},\n \"phone\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ]\n }\n ],\n \"deliveryDetails\": {\n \"deliveryMethod\": \"USPS - Ground Mail\",\n \"deliveryPrice\": {},\n \"deliveryType\": \"PHYSICAL\"\n },\n \"itemReturnData\": {\n \"posDetails\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"cardEntryMethod\": \"SCANNED\",\n \"cashierId\": \"fgh5e0rr48923d\",\n \"departmentId\": \"e0r4592356fds\",\n \"storeBusinessUnit\": \"Full Line\",\n \"storeId\": \"2356fdse0rr489\",\n \"storeName\": \"Union Square\",\n \"workStationId\": \"923e5th5e0rr48\"\n },\n \"returnStatusLog\": {}\n },\n \"itemSpecificData\": {\n \"accommodation\": {\n \"accommodationAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"location\": {},\n \"numberOfGuests\": 2,\n \"rating\": [\n {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n }\n ],\n \"type\": \"HOTEL\"\n },\n \"cryptocurrency\": {},\n \"digitalGoodsAndServices\": {\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"webHosting\": {\n \"domains\": []\n }\n },\n \"food\": {\n \"restaurantAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"tipAmount\": {}\n },\n \"gaming\": {\n \"gameItemAmount\": 1000,\n \"gameName\": \"WorldOfSampleGamecrat\"\n },\n \"physicalGoods\": {},\n \"professionalServices\": {\n \"tipAmount\": {}\n },\n \"ticketsAndEvents\": {\n \"eventLocation\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"eventName\": \"FIFA World Cup Final\"\n },\n \"transport\": [\n {\n \"driverDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n }\n },\n \"duration\": {\n \"startTime\": 1412345911\n },\n \"endPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"locationAtTimeOfReservation\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"startPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"type\": \"AIR_TRAVEL\"\n }\n ]\n },\n \"seller\": {\n \"sellerDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n }\n }\n },\n \"shopifyAdditionalItemData\": {\n \"properties\": {}\n }\n }\n ],\n \"compensationStatus\": {\n \"itemStatus\": [\n {\n \"basicItemData\": {\n \"discount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"name\": \"White GenericBrand handbag\",\n \"price\": {},\n \"quantity\": 1,\n \"type\": \"TANGIBLE\"\n },\n \"statusData\": {\n \"compensationTypeGranted\": \"REFUND\",\n \"reasonCategory\": \"CHANGED_MY_MIND\",\n \"returnMethodGranted\": \"SHIP_TO_WAREHOUSE\",\n \"statusLog\": {},\n \"updatedStatus\": \"ACCEPTED_BY_MERCHANT\"\n }\n }\n ],\n \"merchantAgentData\": {},\n \"shippingRefundedAmount\": {},\n \"statusData\": {\n \"compensationTypeGranted\": \"REFUND\",\n \"reasonCategory\": \"CHANGED_MY_MIND\",\n \"returnMethodGranted\": \"SHIP_TO_WAREHOUSE\",\n \"statusLog\": {},\n \"updatedStatus\": \"ACCEPTED_BY_MERCHANT\"\n },\n \"totalGrantedAmount\": {}\n },\n \"deliveryStatusInfo\": {},\n \"endPointLocation\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"eventTime\": 1415287568000,\n \"orderId\": \"2356fdse0rr489\",\n \"refundInformation\": {\n \"refundAmount\": {}\n },\n \"returnedCartItems\": [\n {\n \"basicItemData\": {\n \"discount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"name\": \"White GenericBrand handbag\",\n \"price\": {},\n \"quantity\": 1,\n \"type\": \"TANGIBLE\"\n },\n \"beneficiaries\": [\n {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"bankAccount\": {\n \"paymentGatewayData\": {}\n },\n \"comments\": {},\n \"cryptoWallet\": {\n \"cryptoWalletType\": \"EXTERNAL\"\n },\n \"personalDetails\": {},\n \"phone\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n }\n ]\n }\n ],\n \"deliveryDetails\": {\n \"deliveryMethod\": \"USPS - Ground Mail\",\n \"deliveryPrice\": {},\n \"deliveryType\": \"PHYSICAL\"\n },\n \"itemReturnData\": {\n \"posDetails\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"cardEntryMethod\": \"SCANNED\",\n \"cashierId\": \"fgh5e0rr48923d\",\n \"departmentId\": \"e0r4592356fds\",\n \"storeBusinessUnit\": \"Full Line\",\n \"storeId\": \"2356fdse0rr489\",\n \"storeName\": \"Union Square\",\n \"workStationId\": \"923e5th5e0rr48\"\n },\n \"returnStatusLog\": {}\n },\n \"itemSpecificData\": {\n \"accommodation\": {\n \"accommodationAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"location\": {},\n \"numberOfGuests\": 2,\n \"rating\": [\n {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n }\n ],\n \"type\": \"HOTEL\"\n },\n \"cryptocurrency\": {},\n \"digitalGoodsAndServices\": {\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"webHosting\": {\n \"domains\": []\n }\n },\n \"food\": {\n \"restaurantAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"tipAmount\": {}\n },\n \"gaming\": {\n \"gameItemAmount\": 1000,\n \"gameName\": \"WorldOfSampleGamecrat\"\n },\n \"physicalGoods\": {},\n \"professionalServices\": {\n \"tipAmount\": {}\n },\n \"ticketsAndEvents\": {\n \"eventLocation\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": true\n }\n },\n \"eventName\": \"FIFA World Cup Final\"\n },\n \"transport\": [\n {\n \"driverDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n }\n },\n \"duration\": {\n \"startTime\": 1412345911\n },\n \"endPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"locationAtTimeOfReservation\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"startPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": true\n }\n },\n \"type\": \"AIR_TRAVEL\"\n }\n ]\n },\n \"seller\": {\n \"sellerDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n }\n }\n },\n \"shopifyAdditionalItemData\": {\n \"properties\": {}\n }\n }\n ],\n \"updatedStatus\": \"SENT\",\n \"updatedTotalAmount\": {},\n \"updatedTotalDiscount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"verificationResults\": {\n \"external3dsVendorPayload\": {}\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "VGiltu-q8UDw8ETT4GEoL", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.forter-secure.com/v2/status/{id}\"\n\npayload = json.dumps({\n \"additionalInformation\": {},\n \"cartItems\": [\n {\n \"basicItemData\": {\n \"discount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"name\": \"White GenericBrand handbag\",\n \"price\": {},\n \"quantity\": 1,\n \"type\": \"TANGIBLE\"\n },\n \"beneficiaries\": [\n {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": True\n }\n },\n \"bankAccount\": {\n \"paymentGatewayData\": {}\n },\n \"comments\": {},\n \"cryptoWallet\": {\n \"cryptoWalletType\": \"EXTERNAL\"\n },\n \"personalDetails\": {},\n \"phone\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": True,\n \"verified\": False\n }\n }\n ]\n }\n ],\n \"deliveryDetails\": {\n \"deliveryMethod\": \"USPS - Ground Mail\",\n \"deliveryPrice\": {},\n \"deliveryType\": \"PHYSICAL\"\n },\n \"itemReturnData\": {\n \"posDetails\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": True\n }\n },\n \"cardEntryMethod\": \"SCANNED\",\n \"cashierId\": \"fgh5e0rr48923d\",\n \"departmentId\": \"e0r4592356fds\",\n \"storeBusinessUnit\": \"Full Line\",\n \"storeId\": \"2356fdse0rr489\",\n \"storeName\": \"Union Square\",\n \"workStationId\": \"923e5th5e0rr48\"\n },\n \"returnStatusLog\": {}\n },\n \"itemSpecificData\": {\n \"accommodation\": {\n \"accommodationAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": True\n }\n },\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"location\": {},\n \"numberOfGuests\": 2,\n \"rating\": [\n {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n }\n ],\n \"type\": \"HOTEL\"\n },\n \"cryptocurrency\": {},\n \"digitalGoodsAndServices\": {\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"webHosting\": {\n \"domains\": []\n }\n },\n \"food\": {\n \"restaurantAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": True\n }\n },\n \"tipAmount\": {}\n },\n \"gaming\": {\n \"gameItemAmount\": 1000,\n \"gameName\": \"WorldOfSampleGamecrat\"\n },\n \"physicalGoods\": {},\n \"professionalServices\": {\n \"tipAmount\": {}\n },\n \"ticketsAndEvents\": {\n \"eventLocation\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": True\n }\n },\n \"eventName\": \"FIFA World Cup Final\"\n },\n \"transport\": [\n {\n \"driverDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n }\n },\n \"duration\": {\n \"startTime\": 1412345911\n },\n \"endPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": True\n }\n },\n \"locationAtTimeOfReservation\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": True\n }\n },\n \"startPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": True\n }\n },\n \"type\": \"AIR_TRAVEL\"\n }\n ]\n },\n \"seller\": {\n \"sellerDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n }\n }\n },\n \"shopifyAdditionalItemData\": {\n \"properties\": {}\n }\n }\n ],\n \"compensationStatus\": {\n \"itemStatus\": [\n {\n \"basicItemData\": {\n \"discount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"name\": \"White GenericBrand handbag\",\n \"price\": {},\n \"quantity\": 1,\n \"type\": \"TANGIBLE\"\n },\n \"statusData\": {\n \"compensationTypeGranted\": \"REFUND\",\n \"reasonCategory\": \"CHANGED_MY_MIND\",\n \"returnMethodGranted\": \"SHIP_TO_WAREHOUSE\",\n \"statusLog\": {},\n \"updatedStatus\": \"ACCEPTED_BY_MERCHANT\"\n }\n }\n ],\n \"merchantAgentData\": {},\n \"shippingRefundedAmount\": {},\n \"statusData\": {\n \"compensationTypeGranted\": \"REFUND\",\n \"reasonCategory\": \"CHANGED_MY_MIND\",\n \"returnMethodGranted\": \"SHIP_TO_WAREHOUSE\",\n \"statusLog\": {},\n \"updatedStatus\": \"ACCEPTED_BY_MERCHANT\"\n },\n \"totalGrantedAmount\": {}\n },\n \"deliveryStatusInfo\": {},\n \"endPointLocation\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": True\n }\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": True\n }\n },\n \"eventTime\": 1415287568000,\n \"orderId\": \"2356fdse0rr489\",\n \"refundInformation\": {\n \"refundAmount\": {}\n },\n \"returnedCartItems\": [\n {\n \"basicItemData\": {\n \"discount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"name\": \"White GenericBrand handbag\",\n \"price\": {},\n \"quantity\": 1,\n \"type\": \"TANGIBLE\"\n },\n \"beneficiaries\": [\n {\n \"additionalVerificationDocuments\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": True\n }\n },\n \"bankAccount\": {\n \"paymentGatewayData\": {}\n },\n \"comments\": {},\n \"cryptoWallet\": {\n \"cryptoWalletType\": \"EXTERNAL\"\n },\n \"personalDetails\": {},\n \"phone\": [\n {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": True,\n \"verified\": False\n }\n }\n ]\n }\n ],\n \"deliveryDetails\": {\n \"deliveryMethod\": \"USPS - Ground Mail\",\n \"deliveryPrice\": {},\n \"deliveryType\": \"PHYSICAL\"\n },\n \"itemReturnData\": {\n \"posDetails\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": True\n }\n },\n \"cardEntryMethod\": \"SCANNED\",\n \"cashierId\": \"fgh5e0rr48923d\",\n \"departmentId\": \"e0r4592356fds\",\n \"storeBusinessUnit\": \"Full Line\",\n \"storeId\": \"2356fdse0rr489\",\n \"storeName\": \"Union Square\",\n \"workStationId\": \"923e5th5e0rr48\"\n },\n \"returnStatusLog\": {}\n },\n \"itemSpecificData\": {\n \"accommodation\": {\n \"accommodationAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": True\n }\n },\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"location\": {},\n \"numberOfGuests\": 2,\n \"rating\": [\n {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n }\n ],\n \"type\": \"HOTEL\"\n },\n \"cryptocurrency\": {},\n \"digitalGoodsAndServices\": {\n \"duration\": {\n \"endDate\": \"2014-11-15\",\n \"startDate\": \"2014-10-28\"\n },\n \"webHosting\": {\n \"domains\": []\n }\n },\n \"food\": {\n \"restaurantAddress\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": True\n }\n },\n \"tipAmount\": {}\n },\n \"gaming\": {\n \"gameItemAmount\": 1000,\n \"gameName\": \"WorldOfSampleGamecrat\"\n },\n \"physicalGoods\": {},\n \"professionalServices\": {\n \"tipAmount\": {}\n },\n \"ticketsAndEvents\": {\n \"eventLocation\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {\n \"usedSavedData\": True\n }\n },\n \"eventName\": \"FIFA World Cup Final\"\n },\n \"transport\": [\n {\n \"driverDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {}\n }\n },\n \"duration\": {\n \"startTime\": 1412345911\n },\n \"endPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": True\n }\n },\n \"locationAtTimeOfReservation\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": True\n }\n },\n \"startPoint\": {\n \"address\": {\n \"address1\": \"235 Montgomery st.\",\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"savedData\": {}\n },\n \"exactLocation\": {\n \"latitude\": 32.07332,\n \"longitude\": 34.79675,\n \"source\": \"MOBILE\"\n },\n \"locationName\": {},\n \"roughLocation\": {},\n \"savedLocation\": {\n \"usedSavedData\": True\n }\n },\n \"type\": \"AIR_TRAVEL\"\n }\n ]\n },\n \"seller\": {\n \"sellerDetails\": {\n \"availableFundsForWithdrawal\": {},\n \"ratingAsBuyer\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"ratingAsSeller\": {\n \"score\": \"4.5\",\n \"source\": \"yelp\",\n \"type\": \"INTERNAL_PEERS\"\n },\n \"sellerAccountCreationDate\": 1415273168,\n \"sellerLastLoginIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n },\n \"sellerPersonalDetails\": {},\n \"sellerRegistrationIP\": {\n \"ip\": \"10.0.0.128\",\n \"updateTimes\": {\n \"creationTime\": 1448549922\n }\n }\n }\n },\n \"shopifyAdditionalItemData\": {\n \"properties\": {}\n }\n }\n ],\n \"updatedStatus\": \"SENT\",\n \"updatedTotalAmount\": {},\n \"updatedTotalDiscount\": {\n \"couponCodeUsed\": \"FATHERSDAY2015\",\n \"couponDiscountAmount\": {}\n },\n \"verificationResults\": {\n \"external3dsVendorPayload\": {}\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'api-version': '10.1',\n 'x-forter-siteid': 'a1b2c3d4e5f6'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "NkaMOaQAZyXiWoLPfaV28" }, "results": { "languages": [ { "id": "xgotNHbh3U_E6fsIStQr_", "language": "200", "code": "// Example statusResponse\n{\n \"message\": \"Transaction #:id status recieved\",\n \"status\": \"success\"\n}" }, { "id": "loPxd-9C5qnxCeES_VDiz", "language": "400", "code": "// Bad Request (Often missing a required parameter)\n" }, { "id": "5SVttk02aWdU1AiMO-tYs", "language": "401", "code": "// Unauthorized (No valid API key provided)\n" }, { "id": "EOpPIAjvZSpDydx3Hge-y", "language": "404", "code": "// Not Found (The requested item doesn't exist)\n" }, { "id": "iov2ScNOCQnlB9E9cD3ee", "language": "500", "code": "// Server Error (Something went wrong on Forter's end)\n" } ], "selectedLanguageId": "xgotNHbh3U_E6fsIStQr_" } }, "children": [ { "text": "" } ] }