Meta Pay Integration

This page documents a feature that is currently in development. This documentation might not match the final implementation.

FulfillmentOption

Use an object based on FulfillmentOption to represent each fulfillment option that appears in the payment sheet when the customer interacts with Meta Pay.

When FulfillmentType is:

  1. SHIPPING - use FulfillmentOption directly to pass in shipping option.
  2. PICKUP - use child interface PickupFulfillmentOption (see below) to pass in pickup option.

FulfillmentOption provides data for PaymentDetails.

Properties

PropertyTypeDescriptionRequired

id

string

The unique identifier for the fulfillment option.

Yes

label

string

Information about the fulfillment option that appears to the customer (e.g. UPS Ground, USPS Priority, pickup store name, etc).

Yes

amount

PaymentCurrencyAmount

The cost of the fulfillment option. amount is required even when the cost is zero.

Yes

dateTimeRangeStart

Date

Earliest estimated datetime (or guaranteed datetime) of fulfillment.

No

dateTimeRangeEnd

Date

Latest estimated datetime of fulfillment.

No

NOTE: Please be sure to specify the correct time zone for Date; otherwise, it will default to UTC time zone.

PickupFulfillmentOption : FulfillmentOption

Use an object based on PickupFulfillmentOption to represent each pickup option that appears in the payment sheet when the customer interacts with Meta Pay.

PickupFulfillmentOption is a subclass of FulfillmentOption and inherits all of its members listed above.

Use only when FulfillmentType is PICKUP.

PickupFulfillmentOption provides data for PaymentDetails.

Properties

PropertyTypeDescriptionRequired

pickupLocationAddress

PaymentAddress

The address of the store for the order to be picked up at.

Yes

pickupStoreAvailability

boolean

Whether the store is available for the order to be picked up at.

Yes

pickupStoreDistance

Distance

Approximate distance between the user and the store.

No

See Also