Installment Service Order

Installment Service Orders

The below example request outlines how Installment Service Orders should be formatted within the dedicated "installmentService" object of the payment array in the Validation and Adaptive Auth Orders APIs. Common Installment Service payment methods include:

Klarna
AfterPay
Affirm
Splitit
Bread

The "installmentService" object should be populated with the buyer's first name, last name, the service response code from the installment service processor, and - if available - the raw installment service data from the processor.

🚧
Note: Installment Service NoAuths
Often installment service payment methods do NOT provide authorization rejections or authorization response codes - in which case all installment service orders may have a response code of "200" or "authorized"

InstallmentService Object Parameters

The example below outlines how the "installmentService" object of the payment array should be populated. Note the only required field is the serviceName although Forter analysts will typically request additional parameters like the "serviceResponseCode" and "firstName" and "lastName"in order to more accurately evaluate the order.

Parameter	Data Type	Required/Optional	Description	Example Value
serviceName	string	required	Installment service's name	"Affirm"
firstName	string	optional	Account holder's first name	"John"
lastName	string	optional	Account holder's last name	"Smith"
serviceResponseCode	string	optional	Response code received from installment service	"200"
paymentId	string	optional	Installment payment ID	"YTZ8IATEGAWRRVVG"
fullResponsePayload	object	optional	Full installment service response object (if available)	{}

{
    "serviceName": "Affirm",
    "firstName": "John",
    "lastName": "Smith", 
    "serviceResponseCode": "200", 
    "paymentId": "YTZ8IATEGAWRRVVG", 
    "fullResponsePayload": {} 
}

Example Installment Service Request

{
  "orderId": "7istlmnt934",
  "orderType": "WEB",
  "timeSentToForter": 1672177899353,
  "checkoutTime": 1672177899151,
  "connectionInformation": {
    "customerIP": "172.88.123.91",
    "userAgent": "Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Mobile Safari/537.36",
    "forterTokenCookie": "65b78bb073c34000a4404c83228d5035"
  },
  "totalAmount": {
    "amountLocalCurrency": "120.73",
    "currency": "USD"
  },
  "cartItems": [
    {
      "basicItemData": {
        "name": "generic shoe",
        "quantity": 1,
        "type": "TANGIBLE",
        "price": {
          "amountLocalCurrency": "110.00",
          "currency": "USD"
        }
      }
    }
  ],
  "payment": [
    {
      "billingDetails": {
        "personalDetails": {
          "firstName": "John",
          "lastName": "Smith",
          "email": "[email protected]"
        },
        "address": {
          "address1": "92 Montgomery ln",
          "city": "Nashville",
          "country": "US",
          "zip": "37081",
          "region": "TN"
        },
        "phone": [
          {
            "phone": "2126129007"
          }
        ]
      },
      "installmentService": {
          "serviceName": "Klarna",
          "firstName": "John",
          "lastName": "Smith",
          "serviceResponseCode": "200",
          "paymentId": "YTZ8IATEGAWRRVVG",
          "fullResponsePayload": {}
      },
      "amount": {
        "amountLocalCurrency": "120.73",
        "currency": "USD"
      },
    }
  ],
  "primaryDeliveryDetails": {
    "deliveryType": "PHYSICAL",
    "deliveryMethod": "Standard",
    "deliveryPrice": {
      "amountLocalCurrency": "0.00",
      "currency": "USD"
    },
    "expectedDeliveryDate": "2023-01-12",
  },
  "primaryRecipient": {
    "personalDetails": {
      "firstName": "John",
      "lastName": "Smith",
      "email": "[email protected]"
    },
    "address": {
      "address1": "92 Montgomery ln",
      "city": "Nashville",
      "country": "US",
      "zip": "37081",
      "region": "TN"
    },
    "phone": [
      {
        "phone": "2126129007"
      }
    ]
  },
  "accountOwner": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "[email protected]",
    "accountId": "abc-86a7-83ebdd57ad5c",
    "created": 1652926635460
  },
  "customerAccountData": {
    "personalDetails": {
      "firstName": "John",
      "lastName": "Smith",
      "email": "[email protected]"
    }
  }
}