payments_settings Reference

Messenger Profile API

payment_settings is a property of the Messenger Profile API. For information on retrieving, setting, updating, and deleting payment_settings, see the Messenger Profile API Reference.

The payment_settings property of your app's Messenger Profile provides the Messenger Platform with several settings needed to implement various aspects of payments in your app:

For complete details on implementing payments in your app, see Payments.

Contents

Requirements

To set or update payment settings you must have the 'Administrator' role for the Page associated with the app.

payment_settings Format

Beta Access

You need to be accepted to our beta program to use payment features in your bot in production. You can still test payment features in development mode until then.

Request Access
"payment_settings":{
  "privacy_url":"<PRIVACY_POLICY_URL>",
  "public_key":"<YOUR_PUBLIC_KEY>",    
  "testers":[
    <TESTER_FBID>,
    <TESTER_FBID>,
    ...
  ]      
}

Properties

PropertyTypeDescription

privacy_url

String

The URL of the privacy policy for your app. Required for buy button payments.

public_key

String

Your public key. Used to encrypt all webview payments, and buy button implementations that use tokenized payments.

testers

Array<Integer>

A list of IDs for people that will test payments in your app. These people will send a mock payment when they tap the buy button.