Create web experience profile

Creates a web experience profile. In the JSON request body, specify the profile name and details.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

In: header

Scope: https://uri.paypal.com/services/payments/payment

Header Parameters

PayPal-Request-Id*string

The server stores keys for three hours.

Content-Type*string

Required for operations with a request body. The value is application/. Where the 'format' is 'json'.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://api-m.paypal.com/v1/payment-experience/v1/payment-experience/web-profiles" \  -H "PayPal-Request-Id: string" \  -H "Content-Type: string" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{
  "id": "stringstringstringstri",
  "name": "string",
  "temporary": true,
  "flow_config": {
    "landing_page_type": "login",
    "bank_txn_pending_url": "http://example.com",
    "user_action": "COMMIT",
    "return_uri_http_method": "GET"
  },
  "input_fields": {
    "no_shipping": 0,
    "address_override": 0
  },
  "presentation": {
    "brand_name": "string",
    "logo_image": "string",
    "locale_code": "strin"
  }
}

{
  "id": "stringstringstringstri",
  "name": "string",
  "temporary": true,
  "flow_config": {
    "landing_page_type": "login",
    "bank_txn_pending_url": "http://example.com",
    "user_action": "COMMIT",
    "return_uri_http_method": "GET"
  },
  "input_fields": {
    "no_shipping": 0,
    "address_override": 0
  },
  "presentation": {
    "brand_name": "string",
    "logo_image": "string",
    "locale_code": "strin"
  }
}

{
  "name": "string",
  "debug_id": "string",
  "message": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "issue": "string"
    }
  ]
}

{
  "name": "string",
  "debug_id": "string",
  "message": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "issue": "string"
    }
  ]
}

Header Parameters

PayPal-Request-Id*string

The server stores keys for three hours.

Content-Type*string

Required for operations with a request body. The value is application/. Where the 'format' is 'json'.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

The web experience profile name. Must be unique for a set of profiles for a merchant.

Length1 <= length <= 50

temporary?boolean

Indicates whether the profile persists for three hours or permanently. To persist the profile permanently, set to false. To persist the profile for three hours, set to true.

flow_config?

The flow configuration parameters.

input_fields?

The input field customization parameters.

presentation?

The style and presentation parameters.

curl -X POST "https://api-m.paypal.com/v1/payment-experience/v1/payment-experience/web-profiles" \ -H "PayPal-Request-Id: string" \ -H "Content-Type: string" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'

{ "id": "stringstringstringstri", "name": "string", "temporary": true, "flow_config": { "landing_page_type": "login", "bank_txn_pending_url": "http://example.com", "user_action": "COMMIT", "return_uri_http_method": "GET" }, "input_fields": { "no_shipping": 0, "address_override": 0 }, "presentation": { "brand_name": "string", "logo_image": "string", "locale_code": "strin" } }

Create web experience profile

200application/json

201application/json

500application/json

defaultapplication/json

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Create web experience profile

200application/json

201application/json

500application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`