Attributes

Attribute

Data type

Description

shipping_type

string

Customer contact information.

entity_name

string

Internal sub-brand name.

platform_type

string

Name of the platform the merchant is on (e.g shopify, etc.).

platform_version

string

Version of the platform the merchant is on

platform_affirm

string

Version of the Affirm module or extension being used to integrate with the platform

webhook_session_id

string

Customer or session specific ID that's used to reconcile incoming webhooks. Optional unless Affirm webhooks are used.

mode

string

Set to modal to enable the modal checkout flow (default uses redirect checkout flow). Possible values:

customer

object

A customer object containing additional information.

itinerary

array

An array of itinerary item. Each itinerary contained within this array will define a portion a trip. For instance, in a roundtrip booking, each flight should be defined in its own.

checkout_channel_type

string

This is a checkout channel type.

BOPIS

boolean

Indicates whether or not the checkout includes a BOPIS order.

{ 
  "shipping_type":"UPS ground",
  "entity_name":"affirm-x",
  "platform_type":"shopify",
  "webhook_session_id":"1234-4321-2324-1233",
  "mode":"modal",
  "checkout_channel_type":""
}