Meta Pay Integration

PaymentConfiguration

Use an object based on PaymentConfiguration to represent configuration details for a payment request and to provide information such as the merchant and payment partner.

PaymentConfiguration provides data for a PaymentRequest.

Properties

PropertyTypeDescriptionRequired

mode

PaymentMode

Whether the payment is a real payment or a test payment.

Yes

partnerId

string

The partner ID associated with the merchant payment processor.

Yes

partnerMerchantId

string

The merchant account identifier used by the payment processor.

Yes

acquirerCountryCode

string

The Alpha-2 code from the ISO 3166-1 standard for the country of the bank account that acquires funds in the transaction. For merchants that use payment processors, the country where the processor acquires funds on behalf of the merchant.

Yes

supportedContainers

{[key: ContainerType]: object;}

A map of container types that are supported for this payment request.

Yes

containerContext

string

An opaque value associated with the payment that the PaymentRequest represents. This value is required for subsequent payment processing, so it must be available to the partner that is processing the order and payment. When partners securely associate the containerContext to the order and payment, verifying this value guards against the container being used in a context for which it is not intended.

Yes

requestId

string

An unique string identifier for the request. If not specified, the SDK generates a unique identifier.

No

userID

string

The Facebook login user ID for an app with public profile privileges for the customer. You can use this to personalize the Meta Pay button, for example to display the customer's Facebook profile picture on the button.

No

pixelId

string

An optional Pixel Id used for attribution and deduplication of events sent by multiple sources e.g. via the Meta Pixel. See the Pixel ID setup page for more details on the Pixel ID.

No

eventId

string

An optional unique string used to deduplicate events sent by both web (via the Meta Pixel) and events associated with the user interactions with Meta Pay experiences. See event_id Conversions API documentation for more details.

No

uxFlags

Array< string>

An array of strings used to further customize the checkout experience. Supported string values include:

  • DISABLE_PROACTIVE_CHECKOUT; see Proactive Checkout
  • PIXEL_COOKIE_DETECTED - include this flag when you have detected a Meta Pixel cookie (fbc) on merchant website
  • META_CHECKOUT - include this flag for use of the Meta Checkout experience

No

merchantName

string

An optional field used to display merchant name to the user. Only used in certain scenarios where merchant has not been registered with Meta Pay prior to sending PaymentRequest.

No

sessionUsage

SessionUsageType

An optional value indicating whether the request is for an on-session or off-session payment. This value defaults to ON_SESSION.

No

See Also